Open CASCADE Technology  6.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions
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:
Inheritance graph
[legend]

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
More...
 
void Add (const Handle< StepData_Simple > &member)
 Adds a member to <me>
More...
 
Handle_StepData_ECDescr ECDescr () const
 Returns the Description as for a Plex
More...
 
Standard_Boolean IsComplex () const
 Returns False
More...
 
Standard_Boolean Matches (const Standard_CString steptype) const
 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
More...
 
Handle_StepData_Simple As (const Standard_CString steptype) const
 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
More...
 
Standard_Boolean HasField (const Standard_CString name) const
 Tells if a Field brings a given name
More...
 
const StepData_FieldField (const Standard_CString name) const
 Returns a Field from its name; read-only
More...
 
StepData_FieldCField (const Standard_CString name)
 Returns a Field from its name; read or write
More...
 
Standard_Integer NbMembers () const
 Returns the count of simple members
More...
 
Handle_StepData_Simple Member (const Standard_Integer num) const
 Returns a simple member from its rank
More...
 
Handle_TColStd_HSequenceOfAsciiString TypeList () const
 Returns the actual list of members types
More...
 
void Check (Handle< Interface_Check > &ach) const
 Fills a Check by using its Description
More...
 
void Shared (Interface_EntityIterator &list) const
 Fills an EntityIterator with entities shared by <me>
More...
 
- Public Member Functions inherited from StepData_Described
Handle_StepData_EDescr Description () const
 Returns the Description used to define this entity
More...
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void ShallowDump (Standard_OStream &) const
 
virtual const
Handle_Standard_Type & 
DynamicType () const
 Returns a type information object about this object. More...
 
Standard_Boolean IsInstance (const Handle_Standard_Type &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const 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. More...
 
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. More...
 
virtual Handle_Standard_Transient This () const
 Returns a Handle which references this object. Must never be called to objects created in stack. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 

Additional Inherited Members

- 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 ...)
More...
 

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 ( const Handle< StepData_ECDescr > &  descr)

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

Member Function Documentation

void StepData_Plex::Add ( const Handle< StepData_Simple > &  member)

Adds a member to <me>

Handle_StepData_Simple StepData_Plex::As ( const Standard_CString  steptype) const
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

Implements StepData_Described.

StepData_Field& StepData_Plex::CField ( const Standard_CString  name)
virtual

Returns a Field from its name; read or write

Implements StepData_Described.

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

Fills a Check by using its Description

Implements StepData_Described.

Handle_StepData_ECDescr StepData_Plex::ECDescr ( ) const

Returns the Description as for a Plex

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

Returns a Field from its name; read-only

Implements StepData_Described.

Standard_Boolean StepData_Plex::HasField ( const Standard_CString  name) const
virtual

Tells if a Field brings a given name

Implements StepData_Described.

Standard_Boolean StepData_Plex::IsComplex ( ) const
virtual

Returns False

Implements StepData_Described.

Standard_Boolean StepData_Plex::Matches ( const Standard_CString  steptype) const
virtual

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.

Handle_StepData_Simple StepData_Plex::Member ( const Standard_Integer  num) const

Returns a simple member from its rank

Standard_Integer StepData_Plex::NbMembers ( ) const

Returns the count of simple members

void StepData_Plex::Shared ( Interface_EntityIterator list) const
virtual

Fills an EntityIterator with entities shared by <me>

Implements StepData_Described.

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: