Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
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

#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

void SetNbFields (const Standard_Integer nb)
 Sets a new count of fields
Each one is described by a PDescr

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

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

void SetSuper (const Handle< StepData_ESDescr > &super)
 Sets an ESDescr as "super-type". Applies an a base (non
derived) ESDescr

Standard_CString TypeName () const
 Returns the type name given at creation time

const TCollection_AsciiStringStepType () const
 Returns the type name as an AsciiString

Handle_StepData_ESDescr Base () const
 Returns the basic ESDescr, null if <me> is not derived

Handle_StepData_ESDescr Super () const
 Returns the super-type ESDescr, null if <me> is root

Standard_Boolean IsSub (const Handle< StepData_ESDescr > &other) const
 Tells if <me> is sub-type of (or equal to) another one

Standard_Integer NbFields () const
 Returns the count of fields

Standard_Integer Rank (const Standard_CString name) const
 Returns the rank of a field from its name. 0 if unknown

Standard_CString Name (const Standard_Integer num) const
 Returns the name of a field from its rank. empty if outofrange

Handle_StepData_PDescr Field (const Standard_Integer num) const
 Returns the PDescr for the field <num> (or Null)

Handle_StepData_PDescr NamedField (const Standard_CString name) const
 Returns the PDescr for the field named <name> (or Null)

Standard_Boolean Matches (const Standard_CString steptype) const
 Tells if a ESDescr matches a step type : exact or super type

Standard_Boolean IsComplex () const
 Returns False

Handle_StepData_Described NewEntity () const
 Creates a described entity (i.e. a simple one)


Constructor & Destructor Documentation


Member Function Documentation

Handle_StepData_ESDescr StepData_ESDescr::Base ( ) const
Handle_StepData_PDescr StepData_ESDescr::Field ( const Standard_Integer  num) const

Implements StepData_EDescr.

Implements StepData_EDescr.

Handle_StepData_PDescr StepData_ESDescr::NamedField ( const Standard_CString  name) const
Handle_StepData_Described StepData_ESDescr::NewEntity ( ) const [virtual]

Implements StepData_EDescr.

Handle_StepData_ESDescr StepData_ESDescr::Super ( ) const

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