 |
Open CASCADE Technology Reference Manual 8.0.0
|
Loading...
Searching...
No Matches
|
Open CASCADE Technology Reference Manual 8.0.0
|
Protocol for HeaderSection Entities It requires HeaderSection as a Resource. More...
#include <HeaderSection_Protocol.hxx>
Public Member Functions | |
| HeaderSection_Protocol () | |
| int | TypeNumber (const occ::handle< Standard_Type > &atype) const override |
| Returns a Case Number for each of the HeaderSection Entities. | |
| const char * | SchemaName (const occ::handle< Interface_InterfaceModel > &) const override |
| 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. | |
 Public Member Functions inherited from StepData_Protocol | |
| StepData_Protocol () | |
| int | NbResources () const override |
| Gives the count of Protocols used as Resource (can be zero) Here, No resource. | |
| occ::handle< Interface_Protocol > | Resource (const int num) const override |
| Returns a Resource, given a rank. Here, none. | |
| int | CaseNumber (const occ::handle< Standard_Transient > &obj) const override |
| Returns a unique positive number for any recognized entity Redefined to work by calling both TypeNumber and, for a Described Entity (late binding) DescrNumber. | |
| int | TypeNumber (const occ::handle< Standard_Type > &atype) const override |
| Returns a Case Number, specific of each recognized Type Here, only Unknown Entity is recognized. | |
| occ::handle< Interface_InterfaceModel > | NewModel () const override |
| Creates an empty Model for Step Norm. | |
| bool | IsSuitableModel (const occ::handle< Interface_InterfaceModel > &model) const override |
| Returns True if <model> is a Model of Step Norm. | |
| occ::handle< Standard_Transient > | UnknownEntity () const override |
| Creates a new Unknown Entity for Step (UndefinedEntity) | |
| bool | IsUnknownEntity (const occ::handle< Standard_Transient > &ent) const override |
| Returns True if <ent> is an Unknown Entity for the Norm, i.e. Type UndefinedEntity, status Unknown. | |
| virtual int | DescrNumber (const occ::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. | |
| void | AddDescr (const occ::handle< StepData_EDescr > &adescr, const int 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. | |
| bool | HasDescr () const |
| Tells if a Protocol brings at least one ESDescr, i.e. if it defines at least one entity description by ESDescr mechanism. | |
| occ::handle< StepData_EDescr > | Descr (const int num) const |
| Returns the description attached to a case number, or null. | |
| occ::handle< StepData_EDescr > | Descr (const char *const name, const bool anylevel=true) const |
| Returns a description according to its name <anylevel> True (D) : for <me> and its resources <anylevel> False : for <me> only. | |
| occ::handle< StepData_ESDescr > | ESDescr (const char *const name, const bool anylevel=true) const |
| Idem as Descr but cast to simple description. | |
| occ::handle< StepData_ECDescr > | ECDescr (const NCollection_Sequence< TCollection_AsciiString > &names, const bool anylevel=true) const |
| Returns a complex description according to list of names <anylevel> True (D) : for <me> and its resources <anylevel> False : for <me> only. | |
| void | AddPDescr (const occ::handle< StepData_PDescr > &pdescr) |
| Records an PDescr. | |
| occ::handle< StepData_PDescr > | PDescr (const char *const name, const bool anylevel=true) const |
| Returns a parameter description according to its name <anylevel> True (D) : for <me> and its resources <anylevel> False : for <me> only. | |
| void | AddBasicDescr (const occ::handle< StepData_ESDescr > &esdescr) |
| Records an ESDescr, intended to build complex descriptions. | |
| occ::handle< StepData_EDescr > | BasicDescr (const char *const name, const bool anylevel=true) const |
| Returns a basic description according to its name <anylevel> True (D) : for <me> and its resources <anylevel> False : for <me> only. | |
| Public Member Functions inherited from Interface_Protocol | |
| virtual bool | IsDynamicType (const occ::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. | |
| virtual int | NbTypes (const occ::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) | |
| occ::handle< Standard_Type > | Type (const occ::handle< Standard_Transient > &obj, const int 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. | |
| virtual bool | GlobalCheck (const Interface_Graph &G, occ::handle< Interface_Check > &ach) const |
| Evaluates a Global Check for a model (with its Graph) Returns True when done, False if data in model do not apply. | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. | |
| virtual | ~Standard_Transient ()=default |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| bool | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| bool | IsInstance (const char *const theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| bool | IsKind (const opencascade::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. | |
| bool | IsKind (const char *const 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. | |
| Standard_Transient * | This () const |
| Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. | |
| int | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations. | |
| int | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
| Static Public Member Functions inherited from Interface_Protocol | |
| static occ::handle< Interface_Protocol > | Active () |
| Returns the Active Protocol, if defined (else, returns a Null Handle, which means "no defined active protocol") | |
| static void | SetActive (const occ::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. | |
| static void | ClearActive () |
| Erases the Active Protocol (hence it becomes undefined) | |
| Static Public Member Functions inherited from Standard_Transient | |
| static constexpr const char * | get_type_name () |
| Returns a type descriptor about this object. | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. | |
Protocol for HeaderSection Entities It requires HeaderSection as a Resource.
| HeaderSection_Protocol::HeaderSection_Protocol | ( | ) |
|
overridevirtual |
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.
Reimplemented from StepData_Protocol.
|
overridevirtual |
Returns a Case Number for each of the HeaderSection Entities.
Implements Interface_Protocol.
1.10.0