Open CASCADE Technology  7.4.0
Public Member Functions

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:
Inheritance graph
[legend]

Public Member Functions

 StepData_ESDescr (const Standard_CString name)
 Creates an ESDescr with a type name. More...
 
void SetNbFields (const Standard_Integer nb)
 Sets a new count of fields Each one is described by a PDescr. More...
 
void SetField (const Standard_Integer num, const Standard_CString name, const Handle< StepData_PDescr > &descr)
 Sets a PDescr to describe a field A Field is designated by its rank and name. More...
 
void SetBase (const 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. More...
 
void SetSuper (const Handle< StepData_ESDescr > &super)
 Sets an ESDescr as "super-type". Applies an a base (non derived) ESDescr. More...
 
Standard_CString TypeName () const
 Returns the type name given at creation time. More...
 
const TCollection_AsciiStringStepType () const
 Returns the type name as an AsciiString. More...
 
Handle< StepData_ESDescrBase () const
 Returns the basic ESDescr, null if <me> is not derived. More...
 
Handle< StepData_ESDescrSuper () const
 Returns the super-type ESDescr, null if <me> is root. More...
 
Standard_Boolean IsSub (const Handle< StepData_ESDescr > &other) const
 Tells if <me> is sub-type of (or equal to) another one. More...
 
Standard_Integer NbFields () const
 Returns the count of fields. More...
 
Standard_Integer Rank (const Standard_CString name) const
 Returns the rank of a field from its name. 0 if unknown. More...
 
Standard_CString Name (const Standard_Integer num) const
 Returns the name of a field from its rank. empty if outofrange. More...
 
Handle< StepData_PDescrField (const Standard_Integer num) const
 Returns the PDescr for the field <num> (or Null) More...
 
Handle< StepData_PDescrNamedField (const Standard_CString name) const
 Returns the PDescr for the field named <name> (or Null) More...
 
Standard_Boolean Matches (const Standard_CString steptype) const override
 Tells if a ESDescr matches a step type : exact or super type. More...
 
Standard_Boolean IsComplex () const override
 Returns False. More...
 
Handle< StepData_DescribedNewEntity () const override
 Creates a described entity (i.e. a simple one) 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 Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::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 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. 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...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

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 Standard_CString  name)

Creates an ESDescr with a type name.

Member Function Documentation

◆ Base()

Handle< StepData_ESDescr > StepData_ESDescr::Base ( ) const

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

◆ Field()

Handle< StepData_PDescr > StepData_ESDescr::Field ( const Standard_Integer  num) const

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

◆ IsComplex()

Standard_Boolean StepData_ESDescr::IsComplex ( ) const
overridevirtual

Returns False.

Implements StepData_EDescr.

◆ IsSub()

Standard_Boolean StepData_ESDescr::IsSub ( const Handle< StepData_ESDescr > &  other) const

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

◆ Matches()

Standard_Boolean StepData_ESDescr::Matches ( const Standard_CString  steptype) const
overridevirtual

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

Implements StepData_EDescr.

◆ Name()

Standard_CString StepData_ESDescr::Name ( const Standard_Integer  num) const

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

◆ NamedField()

Handle< StepData_PDescr > StepData_ESDescr::NamedField ( const Standard_CString  name) const

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

◆ NbFields()

Standard_Integer StepData_ESDescr::NbFields ( ) const

Returns the count of fields.

◆ NewEntity()

Handle< StepData_Described > StepData_ESDescr::NewEntity ( ) const
overridevirtual

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

Implements StepData_EDescr.

◆ Rank()

Standard_Integer StepData_ESDescr::Rank ( const Standard_CString  name) const

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

◆ SetBase()

void StepData_ESDescr::SetBase ( const 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 Standard_Integer  num,
const Standard_CString  name,
const 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 Standard_Integer  nb)

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

◆ SetSuper()

void StepData_ESDescr::SetSuper ( const 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()

Handle< StepData_ESDescr > StepData_ESDescr::Super ( ) const

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

◆ TypeName()

Standard_CString StepData_ESDescr::TypeName ( ) const

Returns the type name given at creation time.


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