A Free Form Entity allows to record any kind of STEP parameters, in any way of typing It is implemented with an array of fields A Complex entity can be defined, as a chain of FreeFormEntity (see Next and As) More...
#include <StepData_FreeFormEntity.hxx>
Public Member Functions | |
| StepData_FreeFormEntity () | |
| Creates a FreeFormEntity, with no field, no type. | |
| void | SetStepType (const Standard_CString typenam) |
| Sets the type of an entity For a complex one, the type of this member. | |
| Standard_CString | StepType () const |
| Returns the recorded StepType For a complex one, the type of this member. | |
| void | SetNext (const Handle< StepData_FreeFormEntity > &next, const Standard_Boolean last=Standard_True) |
| Sets a next member, in order to define or complete a Complex entity If <last> is True (D), this next will be set as last of list Else, it is inserted just as next of <me> If <next> is Null, Next is cleared. | |
| Handle< StepData_FreeFormEntity > | Next () const |
| Returns the next member of a Complex entity (remark : the last member has none) | |
| Standard_Boolean | IsComplex () const |
| Returns True if a FreeFormEntity is Complex (i.e. has Next) | |
| Handle< StepData_FreeFormEntity > | Typed (const Standard_CString typenam) const |
| Returns the member of a FreeFormEntity of which the type name is given (exact match, no sub-type) | |
| Handle< TColStd_HSequenceOfAsciiString > | TypeList () const |
| Returns the list of types (one type for a simple entity), as is (non reordered) | |
| void | SetNbFields (const Standard_Integer nb) |
| Sets a count of Fields, from scratch. | |
| Standard_Integer | NbFields () const |
| Returns the count of fields. | |
| const StepData_Field & | Field (const Standard_Integer num) const |
| Returns a field from its rank, for read-only use. | |
| StepData_Field & | CField (const Standard_Integer num) |
| Returns a field from its rank, in order to modify it. | |
 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. | |
Static Public Member Functions | |
| static Standard_Boolean | Reorder (Handle< StepData_FreeFormEntity > &ent) |
| Reorders a Complex entity if required, i.e. if member types are not in alphabetic order Returns False if nothing done (order was OK or simple entity), True plus modified <ent> if <ent> has been reordered. | |
| 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. | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
Detailed Description
A Free Form Entity allows to record any kind of STEP parameters, in any way of typing It is implemented with an array of fields A Complex entity can be defined, as a chain of FreeFormEntity (see Next and As)
Constructor & Destructor Documentation
◆ StepData_FreeFormEntity()
| StepData_FreeFormEntity::StepData_FreeFormEntity | ( | ) |
Creates a FreeFormEntity, with no field, no type.
Member Function Documentation
◆ CField()
| StepData_Field & StepData_FreeFormEntity::CField | ( | const Standard_Integer | num | ) |
Returns a field from its rank, in order to modify it.
◆ Field()
| const StepData_Field & StepData_FreeFormEntity::Field | ( | const Standard_Integer | num | ) | const |
Returns a field from its rank, for read-only use.
◆ IsComplex()
| Standard_Boolean StepData_FreeFormEntity::IsComplex | ( | ) | const |
Returns True if a FreeFormEntity is Complex (i.e. has Next)
◆ NbFields()
| Standard_Integer StepData_FreeFormEntity::NbFields | ( | ) | const |
Returns the count of fields.
◆ Next()
| Handle< StepData_FreeFormEntity > StepData_FreeFormEntity::Next | ( | ) | const |
Returns the next member of a Complex entity (remark : the last member has none)
◆ Reorder()
|
static |
Reorders a Complex entity if required, i.e. if member types are not in alphabetic order Returns False if nothing done (order was OK or simple entity), True plus modified <ent> if <ent> has been reordered.
◆ SetNbFields()
| void StepData_FreeFormEntity::SetNbFields | ( | const Standard_Integer | nb | ) |
Sets a count of Fields, from scratch.
◆ SetNext()
| void StepData_FreeFormEntity::SetNext | ( | const Handle< StepData_FreeFormEntity > & | next, |
| const Standard_Boolean | last = Standard_True |
||
| ) |
Sets a next member, in order to define or complete a Complex entity If <last> is True (D), this next will be set as last of list Else, it is inserted just as next of <me> If <next> is Null, Next is cleared.
◆ SetStepType()
| void StepData_FreeFormEntity::SetStepType | ( | const Standard_CString | typenam | ) |
Sets the type of an entity For a complex one, the type of this member.
◆ StepType()
| Standard_CString StepData_FreeFormEntity::StepType | ( | ) | const |
Returns the recorded StepType For a complex one, the type of this member.
◆ Typed()
| Handle< StepData_FreeFormEntity > StepData_FreeFormEntity::Typed | ( | const Standard_CString | typenam | ) | const |
Returns the member of a FreeFormEntity of which the type name is given (exact match, no sub-type)
◆ TypeList()
| Handle< TColStd_HSequenceOfAsciiString > StepData_FreeFormEntity::TypeList | ( | ) | const |
Returns the list of types (one type for a simple entity), as is (non reordered)
The documentation for this class was generated from the following file:
