Open CASCADE Technology  6.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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_ESDescr Base () const
 Returns the basic ESDescr, null if <me> is not derived
More...
 
Handle_StepData_ESDescr Super () 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_PDescr Field (const Standard_Integer num) const
 Returns the PDescr for the field <num> (or Null)
More...
 
Handle_StepData_PDescr NamedField (const Standard_CString name) const
 Returns the PDescr for the field named <name> (or Null)
More...
 
Standard_Boolean Matches (const Standard_CString steptype) const
 Tells if a ESDescr matches a step type : exact or super type
More...
 
Standard_Boolean IsComplex () const
 Returns False
More...
 
Handle_StepData_Described NewEntity () const
 Creates a described entity (i.e. a simple one)
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...
 

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

Creates an ESDescr with a type name

Member Function Documentation

Handle_StepData_ESDescr StepData_ESDescr::Base ( ) const

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

Handle_StepData_PDescr StepData_ESDescr::Field ( const Standard_Integer  num) const

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

Standard_Boolean StepData_ESDescr::IsComplex ( ) const
virtual

Returns False

Implements StepData_EDescr.

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

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

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

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

Implements StepData_EDescr.

Standard_CString StepData_ESDescr::Name ( const Standard_Integer  num) const

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

Handle_StepData_PDescr StepData_ESDescr::NamedField ( const Standard_CString  name) const

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

Standard_Integer StepData_ESDescr::NbFields ( ) const

Returns the count of fields

Handle_StepData_Described StepData_ESDescr::NewEntity ( ) const
virtual

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

Implements StepData_EDescr.

Standard_Integer StepData_ESDescr::Rank ( const Standard_CString  name) const

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

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

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

void StepData_ESDescr::SetNbFields ( const Standard_Integer  nb)

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

void StepData_ESDescr::SetSuper ( const Handle< StepData_ESDescr > &  super)

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

const TCollection_AsciiString& StepData_ESDescr::StepType ( ) const

Returns the type name as an AsciiString

Handle_StepData_ESDescr StepData_ESDescr::Super ( ) const

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

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: