Open CASCADE Technology  6.9.0
Public Member Functions | Protected Member Functions
StepData_Described Class Referenceabstract

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

#include <StepData_Described.hxx>

Inheritance diagram for StepData_Described:
Inheritance graph
[legend]

Public Member Functions

Handle< StepData_EDescrDescription () const
 Returns the Description used to define this entity. More...
 
virtual Standard_Boolean IsComplex () const =0
 Tells if a described entity is complex. More...
 
virtual Standard_Boolean Matches (const Standard_CString 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. More...
 
virtual Handle< StepData_SimpleAs (const Standard_CString 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. More...
 
virtual Standard_Boolean HasField (const Standard_CString name) const =0
 Tells if a Field brings a given name. More...
 
virtual const StepData_FieldField (const Standard_CString name) const =0
 Returns a Field from its name; read-only. More...
 
virtual StepData_FieldCField (const Standard_CString name)=0
 Returns a Field from its name; read or write. More...
 
virtual void Check (Handle< Interface_Check > &ach) const =0
 Fills a Check by using its Description. More...
 
virtual void Shared (Interface_EntityIterator &list) const =0
 Fills an EntityIterator with entities shared by <me> 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 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...
 

Protected Member Functions

 StepData_Described (const Handle< StepData_EDescr > &descr)
 Initializes a Described Entity from a Description (i.e. puts it in a field ...) More...
 

Detailed Description

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

Constructor & Destructor Documentation

StepData_Described::StepData_Described ( const Handle< StepData_EDescr > &  descr)
protected

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

Member Function Documentation

virtual Handle< StepData_Simple > StepData_Described::As ( const Standard_CString  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.

virtual StepData_Field& StepData_Described::CField ( const Standard_CString  name)
pure virtual

Returns a Field from its name; read or write.

Implemented in StepData_Plex, and StepData_Simple.

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

Fills a Check by using its Description.

Implemented in StepData_Simple, and StepData_Plex.

Handle< StepData_EDescr > StepData_Described::Description ( ) const

Returns the Description used to define this entity.

virtual const StepData_Field& StepData_Described::Field ( const Standard_CString  name) const
pure virtual

Returns a Field from its name; read-only.

Implemented in StepData_Plex, and StepData_Simple.

virtual Standard_Boolean StepData_Described::HasField ( const Standard_CString  name) const
pure virtual

Tells if a Field brings a given name.

Implemented in StepData_Plex, and StepData_Simple.

virtual Standard_Boolean StepData_Described::IsComplex ( ) const
pure virtual

Tells if a described entity is complex.

Implemented in StepData_Plex, and StepData_Simple.

virtual Standard_Boolean StepData_Described::Matches ( const Standard_CString  steptype) const
pure 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.

Implemented in StepData_Plex, and StepData_Simple.

virtual void StepData_Described::Shared ( Interface_EntityIterator list) const
pure virtual

Fills an EntityIterator with entities shared by <me>

Implemented in StepData_Simple, and StepData_Plex.


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