General frame to describe entities with Description (Simple or Complex) More...
#include <StepData_Described.hxx>
Public Member Functions | |
| Handle< StepData_EDescr > | Description () const |
| Returns the Description used to define this entity. | |
| virtual Standard_Boolean | IsComplex () const =0 |
| Tells if a described entity is complex. | |
| virtual Standard_Boolean | Matches (const Standard_CString steptype) const =0 |
| Tells if a step type is matched by <me> For a Simple Entity : own type or super type For a Complex Entity : one of the members. | |
| virtual Handle< StepData_Simple > | As (const Standard_CString steptype) const =0 |
| Returns a Simple Entity which matches with a Type in <me> : For a Simple Entity : me if it matches, else a null handle For a Complex Entity : the member which matches, else null. | |
| virtual Standard_Boolean | HasField (const Standard_CString name) const =0 |
| Tells if a Field brings a given name. | |
| virtual const StepData_Field & | Field (const Standard_CString name) const =0 |
| Returns a Field from its name; read-only. | |
| virtual StepData_Field & | CField (const Standard_CString name)=0 |
| Returns a Field from its name; read or write. | |
| virtual void | Check (Handle< Interface_Check > &ach) const =0 |
| Fills a Check by using its Description. | |
| virtual void | Shared (Interface_EntityIterator &list) const =0 |
| Fills an EntityIterator with entities shared by <me> | |
 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. | |
Protected Member Functions | |
| StepData_Described (const Handle< StepData_EDescr > &descr) | |
| Initializes a Described Entity from a Description (i.e. puts it in a field ...) | |
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 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
General frame to describe entities with Description (Simple or Complex)
Constructor & Destructor Documentation
◆ StepData_Described()
|
protected |
Initializes a Described Entity from a Description (i.e. puts it in a field ...)
Member Function Documentation
◆ As()
|
pure virtual |
Returns a Simple Entity which matches with a Type in <me> : For a Simple Entity : me if it matches, else a null handle For a Complex Entity : the member which matches, else null.
Implemented in StepData_Plex, and StepData_Simple.
◆ CField()
|
pure virtual |
Returns a Field from its name; read or write.
Implemented in StepData_Plex, and StepData_Simple.
◆ Check()
|
pure virtual |
Fills a Check by using its Description.
Implemented in StepData_Plex, and StepData_Simple.
◆ Description()
| Handle< StepData_EDescr > StepData_Described::Description | ( | ) | const |
Returns the Description used to define this entity.
◆ Field()
|
pure virtual |
Returns a Field from its name; read-only.
Implemented in StepData_Plex, and StepData_Simple.
◆ HasField()
|
pure virtual |
Tells if a Field brings a given name.
Implemented in StepData_Plex, and StepData_Simple.
◆ IsComplex()
|
pure virtual |
Tells if a described entity is complex.
Implemented in StepData_Plex, and StepData_Simple.
◆ Matches()
|
pure virtual |
Tells if a step type is matched by <me> For a Simple Entity : own type or super type For a Complex Entity : one of the members.
Implemented in StepData_Plex, and StepData_Simple.
◆ Shared()
|
pure virtual |
Fills an EntityIterator with entities shared by <me>
Implemented in StepData_Plex, and StepData_Simple.
The documentation for this class was generated from the following file:
