StepData_FreeFormEntity Class Reference

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>

Inheritance diagram for StepData_FreeFormEntity:

Public Member Functions
	StepData_FreeFormEntity ()
	Creates a FreeFormEntity, with no field, no type.
void	SetStepType (const char *const typenam)
	Sets the type of an entity For a complex one, the type of this member.
const char *	StepType () const
	Returns the recorded StepType For a complex one, the type of this member.
void	SetNext (const occ::handle< StepData_FreeFormEntity > &next, const bool last=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.
occ::handle< StepData_FreeFormEntity >	Next () const
	Returns the next member of a Complex entity (remark : the last member has none)
bool	IsComplex () const
	Returns True if a FreeFormEntity is Complex (i.e. has Next)
occ::handle< StepData_FreeFormEntity >	Typed (const char *const typenam) const
	Returns the member of a FreeFormEntity of which the type name is given (exact match, no sub-type)
occ::handle< NCollection_HSequence< TCollection_AsciiString > >	TypeList () const
	Returns the list of types (one type for a simple entity), as is (non reordered)
void	SetNbFields (const int nb)
	Sets a count of Fields, from scratch.
int	NbFields () const
	Returns the count of fields.
const StepData_Field &	Field (const int num) const
	Returns a field from its rank, for read-only use.
StepData_Field &	CField (const int 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 ()=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.

Static Public Member Functions
static bool	Reorder (occ::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 int

num

)

Returns a field from its rank, in order to modify it.

Field()

const StepData_Field & StepData_FreeFormEntity::Field

(

const int

num

)

const

Returns a field from its rank, for read-only use.

IsComplex()

bool StepData_FreeFormEntity::IsComplex

(

)

const

Returns True if a FreeFormEntity is Complex (i.e. has Next)

NbFields()

int StepData_FreeFormEntity::NbFields

(

)

const

Returns the count of fields.

Next()

occ::handle< StepData_FreeFormEntity > StepData_FreeFormEntity::Next

(

)

const

Returns the next member of a Complex entity (remark : the last member has none)

Reorder()

static bool StepData_FreeFormEntity::Reorder ( occ::handle< StepData_FreeFormEntity > & ent )

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 int

nb

)

Sets a count of Fields, from scratch.

SetNext()

void StepData_FreeFormEntity::SetNext	(	const occ::handle< StepData_FreeFormEntity > &	next,
		const bool	last = 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 char *const

typenam

)

Sets the type of an entity For a complex one, the type of this member.

StepType()

const char * StepData_FreeFormEntity::StepType

(

)

const

Returns the recorded StepType For a complex one, the type of this member.

Typed()

occ::handle< StepData_FreeFormEntity > StepData_FreeFormEntity::Typed

(

const char *const

typenam

)

const

Returns the member of a FreeFormEntity of which the type name is given (exact match, no sub-type)

TypeList()

occ::handle< NCollection_HSequence< TCollection_AsciiString > > 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:

• StepData_FreeFormEntity.hxx