Description of Protocol for IGESBasic. More...
#include <IGESBasic_Protocol.hxx>
Inheritance diagram for IGESBasic_Protocol:
Public Member Functions | |
| IGESBasic_Protocol () | |
| virtual Standard_Integer | NbResources () const override |
| Gives the count of Resource Protocol. Here, one (Protocol from IGESData) | |
| virtual Handle< Interface_Protocol > | Resource (const Standard_Integer num) const override |
| Returns a Resource, given a rank. | |
| virtual Standard_Integer | TypeNumber (const Handle< Standard_Type > &atype) const override |
| Returns a Case Number, specific of each recognized Type This Case Number is then used in Libraries : the various Modules attached to this class of Protocol must use them in accordance (for a given value of TypeNumber, they must consider the same Type as the Protocol defines) | |
 Public Member Functions inherited from IGESData_Protocol | |
| IGESData_Protocol () | |
| Standard_Integer | NbResources () const override |
| Gives the count of Resource Protocol. Here, none. | |
| Handle< Interface_Protocol > | Resource (const Standard_Integer num) const override |
| Returns a Resource, given a rank. Here, none. | |
| Standard_Integer | TypeNumber (const Handle< Standard_Type > &atype) const override |
| Returns a Case Number, specific of each recognized Type Here, Undefined and Free Format Entities have the Number 1. | |
| Handle< Interface_InterfaceModel > | NewModel () const override |
| Creates an empty Model for IGES Norm. | |
| Standard_Boolean | IsSuitableModel (const Handle< Interface_InterfaceModel > &model) const override |
| Returns True if <model> is a Model of IGES Norm. | |
| Handle< Standard_Transient > | UnknownEntity () const override |
| Creates a new Unknown Entity for IGES (UndefinedEntity) | |
| Standard_Boolean | IsUnknownEntity (const Handle< Standard_Transient > &ent) const override |
| Returns True if <ent> is an Unknown Entity for the Norm, i.e. Type UndefinedEntity, status Unknown. | |
| Public Member Functions inherited from Interface_Protocol | |
| virtual Standard_Integer | CaseNumber (const Handle< Standard_Transient > &obj) const |
| Returns a unique positive CaseNumber for each Recognized Object. By default, recognition is based on Type(1) By default, calls the following one which is deferred. | |
| 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. | |
| 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) | |
| 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. | |
| virtual Standard_Boolean | GlobalCheck (const Interface_Graph &G, 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 () |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| Standard_Boolean | 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. | |
| 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. | |
| 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. | |
| Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. | |
| Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. | |
| 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 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 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. | |
Detailed Description
Description of Protocol for IGESBasic.
Constructor & Destructor Documentation
◆ IGESBasic_Protocol()
| IGESBasic_Protocol::IGESBasic_Protocol | ( | ) |
Member Function Documentation
◆ NbResources()
|
overridevirtual |
Gives the count of Resource Protocol. Here, one (Protocol from IGESData)
Implements Interface_Protocol.
◆ Resource()
|
overridevirtual |
Returns a Resource, given a rank.
Implements Interface_Protocol.
◆ TypeNumber()
|
overridevirtual |
Returns a Case Number, specific of each recognized Type This Case Number is then used in Libraries : the various Modules attached to this class of Protocol must use them in accordance (for a given value of TypeNumber, they must consider the same Type as the Protocol defines)
Implements Interface_Protocol.
The documentation for this class was generated from the following file:
