|
Open CASCADE Technology
6.7.1
|
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
|
Open CASCADE Technology
6.7.1
|
A DescrProtocol is a protocol dynamically (at execution time)
defined with :
More...
#include <StepData_DescrProtocol.hxx>
Public Member Functions | |
| StepData_DescrProtocol () | |
| void | SetSchemaName (const Standard_CString name) |
| Defines a specific Schema Name for this Protocol More... | |
| void | LibRecord () const |
| Records this Protocol in the service libraries, with a DescrGeneral and a DescrReadWrite Does nothing if the Protocol brings no proper description More... | |
| virtual Standard_CString | SchemaName () const |
Returns the Schema Name attached to each class of Protocol <br>
here, returns the SchemaName set by SetSchemaName <br>
was C++ : return const | |
 Public Member Functions inherited from StepData_FileProtocol | |
| StepData_FileProtocol () | |
| Creates an empty FileProtocol More... | |
| void | Add (const Handle< StepData_Protocol > &protocol) |
| Adds a Protocol to the definition list of the FileProtocol But ensures that each class of Protocol is present only once in this list More... | |
| virtual Standard_Integer | NbResources () const |
| Gives the count of Protocols used as Resource (can be zero) i.e. the count of Protocol recorded by calling the method Add More... | |
| virtual Handle_Interface_Protocol | Resource (const Standard_Integer num) const |
| Returns a Resource, given a rank. Here, rank of calling Add More... | |
| virtual Standard_Integer | TypeNumber (const Handle< Standard_Type > &atype) const |
| Returns a Case Number, specific of each recognized Type Here, NO Type at all is recognized properly : all Types are recognized by the resources More... | |
| virtual Standard_Boolean | GlobalCheck (const Interface_Graph &G, Handle< Interface_Check > &ach) const |
| Calls GlobalCheck for each of its recorded ressources More... | |
| Public Member Functions inherited from StepData_Protocol | |
| StepData_Protocol () | |
| Standard_Integer | NbResources () const |
| Gives the count of Protocols used as Resource (can be zero) Here, No resource More... | |
| Handle_Interface_Protocol | Resource (const Standard_Integer num) const |
| Returns a Resource, given a rank. Here, none More... | |
| virtual 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 More... | |
| Standard_Integer | TypeNumber (const Handle< Standard_Type > &atype) const |
| Returns a Case Number, specific of each recognized Type Here, only Unknown Entity is recognized More... | |
| Handle_Interface_InterfaceModel | NewModel () const |
| Creates an empty Model for Step Norm More... | |
| Standard_Boolean | IsSuitableModel (const Handle< Interface_InterfaceModel > &model) const |
| Returns True if <model> is a Model of Step Norm More... | |
| Handle_Standard_Transient | UnknownEntity () const |
| Creates a new Unknown Entity for Step (UndefinedEntity) More... | |
| 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 More... | |
| virtual Standard_Integer | DescrNumber (const Handle< StepData_EDescr > &adescr) const |
Returns a unique positive CaseNumber for types described by <br>
an EDescr (late binding) <br>
Warning : TypeNumber and DescrNumber must give together a unique | |
| 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 More... | |
| 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 More... | |
| Handle_StepData_EDescr | Descr (const Standard_Integer num) const |
| Returns the description attached to a case number, or null More... | |
| 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 More... | |
| Handle_StepData_ESDescr | ESDescr (const Standard_CString name, const Standard_Boolean anylevel=Standard_True) const |
| Idem as Descr but cast to simple description More... | |
| 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 More... | |
| void | AddPDescr (const Handle< StepData_PDescr > &pdescr) |
| Records an PDescr More... | |
| 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 More... | |
| void | AddBasicDescr (const Handle< StepData_ESDescr > &esdescr) |
| Records an ESDescr, intended to build complex descriptions More... | |
| 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 More... | |
| Public Member Functions inherited from Interface_Protocol | |
| virtual Standard_Boolean | IsDynamicType (const Handle< Standard_Transient > &obj) const |
| Returns True if type of <obj> is that defined from CDL This is the default but it may change according implementation More... | |
| virtual Standard_Integer | NbTypes (const Handle< Standard_Transient > &obj) const |
| Returns the count of DISTINCT types under which an entity may be processed. Each one is candidate to be recognized by TypeNumber, <obj> is then processed according it By default, returns 1 (the DynamicType) More... | |
| Handle_Standard_Type | Type (const Handle< Standard_Transient > &obj, const Standard_Integer nt=1) const |
| Returns a type under which <obj> can be recognized and processed, according its rank in its definition list (see NbTypes). By default, returns DynamicType More... | |
| Public Member Functions inherited from MMgt_TShared | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. More... | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. More... | |
| virtual void | ShallowDump (Standard_OStream &) const |
| virtual const Handle_Standard_Type & | DynamicType () const |
| Returns a type information object about this object. More... | |
| Standard_Boolean | IsInstance (const Handle_Standard_Type &theType) const |
| Returns a true value if this is an instance of Type. More... | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. More... | |
| Standard_Boolean | IsKind (const Handle_Standard_Type &theType) const |
| Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
| Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
| Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
| virtual Handle_Standard_Transient | This () const |
| Returns a Handle which references this object. Must never be called to objects created in stack. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Interface_Protocol | |
| static Handle_Interface_Protocol | Active () |
| Returns the Active Protocol, if defined (else, returns a Null Handle, which means "no defined active protocol") More... | |
| static void | SetActive (const Handle< Interface_Protocol > &aprotocol) |
| Sets a given Protocol to be the Active one (for the users of Active, see just above). Applies to every sub-type of Protocol More... | |
| static void | ClearActive () |
| Erases the Active Protocol (hence it becomes undefined) More... | |
A DescrProtocol is a protocol dynamically (at execution time)
defined with :
| StepData_DescrProtocol::StepData_DescrProtocol | ( | ) |
| void StepData_DescrProtocol::LibRecord | ( | ) | const |
Records this Protocol in the service libraries, with a
DescrGeneral and a DescrReadWrite
Does nothing if the Protocol brings no proper description
|
virtual |
Returns the Schema Name attached to each class of Protocol <br>
here, returns the SchemaName set by SetSchemaName <br>
was C++ : return const
Reimplemented from StepData_FileProtocol.
| void StepData_DescrProtocol::SetSchemaName | ( | const Standard_CString | name | ) |
Defines a specific Schema Name for this Protocol
1.8.5