General frame to describe entities with Description (Simple or Complex) More...

#include <StepData_Described.hxx>

Inheritance diagram for StepData_Described:

[legend]

Public Member Functions
occ::handle< StepData_EDescr >	Description () const
	Returns the Description used to define this entity.

virtual bool	IsComplex () const =0
	Tells if a described entity is complex.

virtual bool	Matches (const char *const 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 occ::handle< StepData_Simple >	As (const char *const 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 bool	HasField (const char *const name) const =0
	Tells if a Field brings a given name.

virtual const StepData_Field &	Field (const char *const name) const =0
	Returns a Field from its name; read-only.

virtual StepData_Field &	CField (const char *const name)=0
	Returns a Field from its name; read or write.

virtual void	Check (occ::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 ()=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.

Protected Member Functions
	StepData_Described (const occ::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()

StepData_Described::StepData_Described ( const occ::handle< StepData_EDescr > & descr )

protected

Initializes a Described Entity from a Description (i.e. puts it in a field ...)

Member Function Documentation

◆ As()

virtual occ::handle< StepData_Simple > StepData_Described::As ( const char *const steptype ) const

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.