StepData_Plex Class Reference

A Plex (for Complex) Entity is defined as a list of Simple Members ("external mapping") The types of these members must be in alphabetic order. More...

#include <StepData_Plex.hxx>

Inheritance diagram for StepData_Plex:

Public Member Functions
	StepData_Plex (const Handle< StepData_ECDescr > &descr)
	Creates a Plex (empty). The complete creation is made by the ECDescr itself, by calling Add.
void	Add (const Handle< StepData_Simple > &member)
	Adds a member to <me>
Handle< StepData_ECDescr >	ECDescr () const
	Returns the Description as for a Plex.
Standard_Boolean	IsComplex () const override
	Returns False.
Standard_Boolean	Matches (const Standard_CString 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.
Handle< StepData_Simple >	As (const Standard_CString 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.
Standard_Boolean	HasField (const Standard_CString name) const override
	Tells if a Field brings a given name.
const StepData_Field &	Field (const Standard_CString name) const override
	Returns a Field from its name; read-only.
StepData_Field &	CField (const Standard_CString name) override
	Returns a Field from its name; read or write.
Standard_Integer	NbMembers () const
	Returns the count of simple members.
Handle< StepData_Simple >	Member (const Standard_Integer num) const
	Returns a simple member from its rank.
Handle< TColStd_HSequenceOfAsciiString >	TypeList () const
	Returns the actual list of members types.
void	Check (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
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 ()
	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.

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 Handle< StepData_EDescr > &descr)
	Initializes a Described Entity from a Description (i.e. puts it in a field ...)

Detailed Description

A Plex (for Complex) Entity is defined as a list of Simple Members ("external mapping") The types of these members must be in alphabetic order.

Constructor & Destructor Documentation

StepData_Plex()

StepData_Plex::StepData_Plex

(

const Handle< StepData_ECDescr > &

descr

)

Creates a Plex (empty). The complete creation is made by the ECDescr itself, by calling Add.

Member Function Documentation

Add()

void StepData_Plex::Add

(

const Handle< StepData_Simple > &

member

)

Adds a member to <me>

As()

Handle< StepData_Simple > StepData_Plex::As ( const Standard_CString  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_Plex::CField ( const Standard_CString  name )

overridevirtual

Returns a Field from its name; read or write.

Implements StepData_Described.

Check()

void StepData_Plex::Check ( Handle< Interface_Check > &  ach ) const

overridevirtual

Fills a Check by using its Description.

Implements StepData_Described.

ECDescr()

Handle< StepData_ECDescr > StepData_Plex::ECDescr

(

)

const

Returns the Description as for a Plex.

Field()

const StepData_Field & StepData_Plex::Field ( const Standard_CString  name ) const

overridevirtual

Returns a Field from its name; read-only.

Implements StepData_Described.

HasField()

Standard_Boolean StepData_Plex::HasField ( const Standard_CString  name ) const

overridevirtual

Tells if a Field brings a given name.

Implements StepData_Described.

IsComplex()

Standard_Boolean StepData_Plex::IsComplex ( ) const

overridevirtual

Returns False.

Implements StepData_Described.

Matches()

Standard_Boolean StepData_Plex::Matches ( const Standard_CString  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.

Member()

Handle< StepData_Simple > StepData_Plex::Member

(

const Standard_Integer

num

)

const

Returns a simple member from its rank.

NbMembers()

Standard_Integer StepData_Plex::NbMembers

(

)

const

Returns the count of simple members.

Shared()

void StepData_Plex::Shared ( Interface_EntityIterator &  list ) const

overridevirtual

Fills an EntityIterator with entities shared by <me>

Implements StepData_Described.

TypeList()

Handle< TColStd_HSequenceOfAsciiString > StepData_Plex::TypeList

(

)

const

Returns the actual list of members types.

---

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

• StepData_Plex.hxx