OCC Main Page | DataExchange | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

DataExchange
TKXSBase
StepData


StepData_Protocol Class Reference

Description of Basic Protocol for Step
The class Protocol from StepData itself describes a default
Protocol, which recognizes only UnknownEntities.
Sub-classes will redefine CaseNumber and, if necessary,
NbResources and Resources.
.

#include <StepData_Protocol.hxx>

Inheritance diagram for StepData_Protocol:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT StepData_Protocol ()
Standard_EXPORT Standard_Integer NbResources () const
 Gives the count of Protocols used as Resource (can be zero)
Here, No resource
.
Standard_EXPORT Handle_Interface_Protocol Resource (const Standard_Integer num) const
 Returns a Resource, given a rank. Here, none
.
virtual Standard_EXPORT Standard_Integer CaseNumber (const Handle(Standard_Transient)&obj) const
 Returns a unique positive number for any recognized entity
Redefined to work by calling both TypeNumber and, for a
Described Entity (late binding) DescrNumber
.
Standard_EXPORT Standard_Integer TypeNumber (const Handle(Standard_Type)&atype) const
 Returns a Case Number, specific of each recognized Type
Here, only Unknown Entity is recognized
.
virtual Standard_EXPORT Standard_CString SchemaName () const
 Returns the Schema Name attached to each class of Protocol
To be redefined by each sub-class
Here, SchemaName returns "(DEFAULT)"
was C++ : return const
.
Standard_EXPORT Handle_Interface_InterfaceModel NewModel () const
 Creates an empty Model for Step Norm
.
Standard_EXPORT Standard_Boolean IsSuitableModel (const Handle(Interface_InterfaceModel)&model) const
 Returns True if <model> is a Model of Step Norm
.
Standard_EXPORT Handle_Standard_Transient UnknownEntity () const
 Creates a new Unknown Entity for Step (UndefinedEntity)
.
Standard_EXPORT Standard_Boolean IsUnknownEntity (const Handle(Standard_Transient)&ent) const
 Returns True if <ent> is an Unknown Entity for the Norm, i.e.
Type UndefinedEntity, status Unknown
.
virtual Standard_EXPORT Standard_Integer DescrNumber (const Handle(StepData_EDescr)&adescr) const
 Returns a unique positive CaseNumber for types described by
an EDescr (late binding)
Warning : TypeNumber and DescrNumber must give together a unique
positive case number for each distinct case, type or descr
.
Standard_EXPORT void AddDescr (const Handle(StepData_EDescr)&adescr, const Standard_Integer CN)
 Records an EDescr with its case number
Also records its name for an ESDescr (simple type): an ESDescr
is then used, for case number, or for type name
.
Standard_EXPORT Standard_Boolean HasDescr () const
 Tells if a Protocol brings at least one ESDescr, i.e. if it
defines at least one entity description by ESDescr mechanism
.
Standard_EXPORT Handle_StepData_EDescr Descr (const Standard_Integer num) const
 Returns the description attached to a case number, or null
.
Standard_EXPORT Handle_StepData_EDescr Descr (const Standard_CString name, const Standard_Boolean anylevel=Standard_True) const
 Returns a description according to its name
<anylevel> True (D) : for <me> and its resources
<anylevel> False : for <me> only
.
Standard_EXPORT Handle_StepData_ESDescr ESDescr (const Standard_CString name, const Standard_Boolean anylevel=Standard_True) const
 Idem as Descr but cast to simple description
.
Standard_EXPORT Handle_StepData_ECDescr ECDescr (const TColStd_SequenceOfAsciiString &names, const Standard_Boolean anylevel=Standard_True) const
 Returns a complex description according to list of names
<anylevel> True (D) : for <me> and its resources
<anylevel> False : for <me> only
.
Standard_EXPORT void AddPDescr (const Handle(StepData_PDescr)&pdescr)
 Records an PDescr
.
Standard_EXPORT Handle_StepData_PDescr PDescr (const Standard_CString name, const Standard_Boolean anylevel=Standard_True) const
 Returns a parameter description according to its name
<anylevel> True (D) : for <me> and its resources
<anylevel> False : for <me> only
.
Standard_EXPORT void AddBasicDescr (const Handle(StepData_ESDescr)&esdescr)
 Records an ESDescr, intended to build complex descriptions
.
Standard_EXPORT Handle_StepData_EDescr BasicDescr (const Standard_CString name, const Standard_Boolean anylevel=Standard_True) const
 Returns a basic description according to its name
<anylevel> True (D) : for <me> and its resources
<anylevel> False : for <me> only
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Private Attributes

Interface_DataMapOfTransientInteger thedscnum
Handle_Dico_DictionaryOfTransient thedscnam
Handle_Dico_DictionaryOfTransient thepdescr
Handle_Dico_DictionaryOfTransient thedscbas

Constructor & Destructor Documentation

Standard_EXPORT StepData_Protocol::StepData_Protocol  ) 
 


Member Function Documentation

Standard_EXPORT void StepData_Protocol::AddBasicDescr const Handle(StepData_ESDescr)&  esdescr  ) 
 

Standard_EXPORT void StepData_Protocol::AddDescr const Handle(StepData_EDescr)&  adescr,
const Standard_Integer  CN
 

Standard_EXPORT void StepData_Protocol::AddPDescr const Handle(StepData_PDescr)&  pdescr  ) 
 

Standard_EXPORT Handle_StepData_EDescr StepData_Protocol::BasicDescr const Standard_CString  name,
const Standard_Boolean  anylevel = Standard_True
const
 

virtual Standard_EXPORT Standard_Integer StepData_Protocol::CaseNumber const Handle(Standard_Transient)&  obj  )  const [virtual]
 

Reimplemented from Interface_Protocol.

Standard_EXPORT Handle_StepData_EDescr StepData_Protocol::Descr const Standard_CString  name,
const Standard_Boolean  anylevel = Standard_True
const
 

Standard_EXPORT Handle_StepData_EDescr StepData_Protocol::Descr const Standard_Integer  num  )  const
 

virtual Standard_EXPORT Standard_Integer StepData_Protocol::DescrNumber const Handle(StepData_EDescr)&  adescr  )  const [virtual]
 

Standard_EXPORT Handle_StepData_ECDescr StepData_Protocol::ECDescr const TColStd_SequenceOfAsciiString &  names,
const Standard_Boolean  anylevel = Standard_True
const
 

Standard_EXPORT Handle_StepData_ESDescr StepData_Protocol::ESDescr const Standard_CString  name,
const Standard_Boolean  anylevel = Standard_True
const
 

Standard_EXPORT const StepData_Protocol::Handle Standard_Type   )  const
 

Reimplemented from Interface_Protocol.

Reimplemented in HeaderSection_Protocol, StepAP214_Protocol, StepData_DescrProtocol, and StepData_FileProtocol.

Standard_EXPORT Standard_Boolean StepData_Protocol::HasDescr  )  const
 

Standard_EXPORT Standard_Boolean StepData_Protocol::IsSuitableModel const Handle(Interface_InterfaceModel)&  model  )  const [virtual]
 

Implements Interface_Protocol.

Standard_EXPORT Standard_Boolean StepData_Protocol::IsUnknownEntity const Handle(Standard_Transient)&  ent  )  const [virtual]
 

Implements Interface_Protocol.

Standard_EXPORT Standard_Integer StepData_Protocol::NbResources  )  const [virtual]
 

Implements Interface_Protocol.

Reimplemented in StepAP214_Protocol, and StepData_FileProtocol.

Standard_EXPORT Handle_Interface_InterfaceModel StepData_Protocol::NewModel  )  const [virtual]
 

Implements Interface_Protocol.

Standard_EXPORT Handle_StepData_PDescr StepData_Protocol::PDescr const Standard_CString  name,
const Standard_Boolean  anylevel = Standard_True
const
 

Standard_EXPORT Handle_Interface_Protocol StepData_Protocol::Resource const Standard_Integer  num  )  const [virtual]
 

Implements Interface_Protocol.

Reimplemented in StepAP214_Protocol, and StepData_FileProtocol.

virtual Standard_EXPORT Standard_CString StepData_Protocol::SchemaName  )  const [virtual]
 

Reimplemented in HeaderSection_Protocol, StepAP214_Protocol, StepData_DescrProtocol, and StepData_FileProtocol.

Standard_EXPORT Standard_Integer StepData_Protocol::TypeNumber const Handle(Standard_Type)&  atype  )  const [virtual]
 

Implements Interface_Protocol.

Reimplemented in HeaderSection_Protocol, StepAP214_Protocol, and StepData_FileProtocol.

Standard_EXPORT Handle_Standard_Transient StepData_Protocol::UnknownEntity  )  const [virtual]
 

Implements Interface_Protocol.


Field Documentation

Handle_Dico_DictionaryOfTransient StepData_Protocol::thedscbas [private]
 

Handle_Dico_DictionaryOfTransient StepData_Protocol::thedscnam [private]
 

Interface_DataMapOfTransientInteger StepData_Protocol::thedscnum [private]
 

Handle_Dico_DictionaryOfTransient StepData_Protocol::thepdescr [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 14:43:10 2008 for OpenCASCADE by  doxygen 1.4.1