StepData_Simple Class Reference

A Simple Entity is defined by a type (which can heve super types) and a list of parameters. More...

#include <StepData_Simple.hxx>

Inheritance diagram for StepData_Simple:

Public Member Functions
	StepData_Simple (const occ::handle< StepData_ESDescr > &descr)
	Creates a Simple Entity.
occ::handle< StepData_ESDescr >	ESDescr () const
	Returns description, as for simple.
const char *	StepType () const
	Returns the recorded StepType (TypeName of its ESDescr)
bool	IsComplex () const override
	Returns False.
bool	Matches (const char *const steptype) const override
	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.
occ::handle< StepData_Simple >	As (const char *const steptype) const override
	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.
bool	HasField (const char *const name) const override
	Tells if a Field brings a given name.
const StepData_Field &	Field (const char *const name) const override
	Returns a Field from its name; read-only.
StepData_Field &	CField (const char *const name) override
	Returns a Field from its name; read or write.
int	NbFields () const
	Returns the count of fields.
const StepData_Field &	FieldNum (const int num) const
	Returns a field from its rank, for read-only use.
StepData_Field &	CFieldNum (const int num)
	Returns a field from its rank, in order to modify it.
const StepData_FieldListN &	Fields () const
	Returns the entire field list, read-only.
StepData_FieldListN &	CFields ()
	Returns the entire field list, read or write.
void	Check (occ::handle< Interface_Check > &ach) const override
	Fills a Check by using its Description.
void	Shared (Interface_EntityIterator &list) const override
	Fills an EntityIterator with entities shared by <me>
Public Member Functions inherited from StepData_Described
occ::handle< StepData_EDescr >	Description () const
	Returns the Description used to define this entity.
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.

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.
Protected Member Functions inherited from StepData_Described
	StepData_Described (const occ::handle< StepData_EDescr > &descr)
	Initializes a Described Entity from a Description (i.e. puts it in a field ...)

Detailed Description

A Simple Entity is defined by a type (which can heve super types) and a list of parameters.

Constructor & Destructor Documentation

StepData_Simple()

StepData_Simple::StepData_Simple

(

const occ::handle< StepData_ESDescr > &

descr

)

Creates a Simple Entity.

Member Function Documentation

As()

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

overridevirtual

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.

Implements StepData_Described.

CField()

StepData_Field & StepData_Simple::CField ( const char *const name )

overridevirtual

Returns a Field from its name; read or write.

Implements StepData_Described.

CFieldNum()

StepData_Field & StepData_Simple::CFieldNum

(

const int

num

)

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

CFields()

StepData_FieldListN & StepData_Simple::CFields

(

)

Returns the entire field list, read or write.

Check()

void StepData_Simple::Check ( occ::handle< Interface_Check > & ach ) const

overridevirtual

Fills a Check by using its Description.

Implements StepData_Described.

ESDescr()

occ::handle< StepData_ESDescr > StepData_Simple::ESDescr

(

)

const

Returns description, as for simple.

Field()

const StepData_Field & StepData_Simple::Field ( const char *const name ) const

overridevirtual

Returns a Field from its name; read-only.

Implements StepData_Described.

FieldNum()

const StepData_Field & StepData_Simple::FieldNum

(

const int

num

)

const

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

Fields()

const StepData_FieldListN & StepData_Simple::Fields

(

)

const

Returns the entire field list, read-only.

HasField()

bool StepData_Simple::HasField ( const char *const name ) const

overridevirtual

Tells if a Field brings a given name.

Implements StepData_Described.

IsComplex()

bool StepData_Simple::IsComplex ( ) const

overridevirtual

Returns False.

Implements StepData_Described.

Matches()

bool StepData_Simple::Matches ( const char *const steptype ) const

overridevirtual

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.

Implements StepData_Described.

NbFields()

int StepData_Simple::NbFields

(

)

const

Returns the count of fields.

Shared()

void StepData_Simple::Shared ( Interface_EntityIterator & list ) const

overridevirtual

Fills an EntityIterator with entities shared by <me>

Implements StepData_Described.

StepType()

const char * StepData_Simple::StepType

(

)

const

Returns the recorded StepType (TypeName of its ESDescr)

---

The documentation for this class was generated from the following file:

• StepData_Simple.hxx