StepData_ESDescr Class Reference

This class is intended to describe the authorized form for a Simple (not Plex) Entity, as a list of fields. More...

#include <StepData_ESDescr.hxx>

Inheritance diagram for StepData_ESDescr:

Public Member Functions
	StepData_ESDescr (const char *const namename)
	Creates an ESDescr with a type name.
void	SetNbFields (const int nb)
	Sets a new count of fields Each one is described by a PDescr.
void	SetField (const int numnum, const char *const namename, const occ::handle< StepData_PDescr > &descr)
	Sets a PDescr to describe a field A Field is designated by its rank and name.
void	SetBase (const occ::handle< StepData_ESDescr > &base)
	Sets an ESDescr as based on another one Hence, if there are inherited fields, the derived ESDescr cumulates all them, while the base just records its own ones.
void	SetSuper (const occ::handle< StepData_ESDescr > &super)
	Sets an ESDescr as "super-type". Applies an a base (non derived) ESDescr.
const char *	TypeName () const
	Returns the type name given at creation time.
const TCollection_AsciiString &	StepType () const
	Returns the type name as an AsciiString.
occ::handle< StepData_ESDescr >	Base () const
	Returns the basic ESDescr, null if <me> is not derived.
occ::handle< StepData_ESDescr >	Super () const
	Returns the super-type ESDescr, null if <me> is root.
bool	IsSub (const occ::handle< StepData_ESDescr > &other) const
	Tells if <me> is sub-type of (or equal to) another one.
int	NbFields () const
	Returns the count of fields.
int	Rank (const char *const namename) const
	Returns the rank of a field from its name. 0 if unknown.
const char *	Name (const int numnum) const
	Returns the name of a field from its rank. empty if outofrange.
occ::handle< StepData_PDescr >	Field (const int numnum) const
	Returns the PDescr for the field <num> (or Null).
occ::handle< StepData_PDescr >	NamedField (const char *const namename) const
	Returns the PDescr for the field named <name> (or Null).
bool	Matches (const char *const steptype) const override
	Tells if a ESDescr matches a step type : exact or super type.
bool	IsComplex () const override
	Returns False.
occ::handle< StepData_Described >	NewEntity () const override
	Creates a described entity (i.e. a simple one).
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
typedef void	base_type
	Returns a type descriptor about this object.
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

This class is intended to describe the authorized form for a Simple (not Plex) Entity, as a list of fields.

Constructor & Destructor Documentation

StepData_ESDescr()

StepData_ESDescr::StepData_ESDescr

(

const char *const

name

)

Creates an ESDescr with a type name.

Member Function Documentation

Base()

occ::handle< StepData_ESDescr > StepData_ESDescr::Base

(

)

const

Returns the basic ESDescr, null if <me> is not derived.

Field()

occ::handle< StepData_PDescr > StepData_ESDescr::Field

(

const int

num

)

const

Returns the PDescr for the field <num> (or Null).

IsComplex()

bool StepData_ESDescr::IsComplex ( ) const

overridevirtual

Returns False.

Implements StepData_EDescr.

IsSub()

bool StepData_ESDescr::IsSub

(

const occ::handle< StepData_ESDescr > &

other

)

const

Tells if <me> is sub-type of (or equal to) another one.

Matches()

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

overridevirtual

Tells if a ESDescr matches a step type : exact or super type.

Implements StepData_EDescr.

Name()

const char * StepData_ESDescr::Name

(

const int

num

)

const

Returns the name of a field from its rank. empty if outofrange.

NamedField()

occ::handle< StepData_PDescr > StepData_ESDescr::NamedField

(

const char *const

name

)

const

Returns the PDescr for the field named <name> (or Null).

NbFields()

int StepData_ESDescr::NbFields

(

)

const

Returns the count of fields.

NewEntity()

occ::handle< StepData_Described > StepData_ESDescr::NewEntity ( ) const

overridevirtual

Creates a described entity (i.e. a simple one).

Implements StepData_EDescr.

Rank()

int StepData_ESDescr::Rank

(

const char *const

name

)

const

Returns the rank of a field from its name. 0 if unknown.

SetBase()

void StepData_ESDescr::SetBase

(

const occ::handle< StepData_ESDescr > &

base

)

Sets an ESDescr as based on another one Hence, if there are inherited fields, the derived ESDescr cumulates all them, while the base just records its own ones.

SetField()

void StepData_ESDescr::SetField	(	const int	num,
		const char *const	name,
		const occ::handle< StepData_PDescr > &	descr )

Sets a PDescr to describe a field A Field is designated by its rank and name.

SetNbFields()

void StepData_ESDescr::SetNbFields

(

const int

nb

)

Sets a new count of fields Each one is described by a PDescr.

SetSuper()

void StepData_ESDescr::SetSuper

(

const occ::handle< StepData_ESDescr > &

super

)

Sets an ESDescr as "super-type". Applies an a base (non derived) ESDescr.

StepType()

const TCollection_AsciiString & StepData_ESDescr::StepType

(

)

const

Returns the type name as an AsciiString.

Super()

occ::handle< StepData_ESDescr > StepData_ESDescr::Super

(

)

const

Returns the super-type ESDescr, null if <me> is root.

TypeName()

const char * StepData_ESDescr::TypeName

(

)

const

Returns the type name given at creation time.

---

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

• StepData_ESDescr.hxx