Open CASCADE Technology
6.5.4
|
Description of Basic Protocol for Step
The class Protocol from StepData itself describes a default
Protocol, which recognizes only UnknownEntities.
Sub-classes will redefine CaseNumber and, if necessary,
NbResources and Resources.
#include <StepData_Protocol.hxx>
Public Member Functions | |
StepData_Protocol () | |
Standard_Integer | NbResources () const |
Gives the count of Protocols used as Resource (can be zero) Here, No resource | |
Handle_Interface_Protocol | Resource (const Standard_Integer num) const |
Returns a Resource, given a rank. Here, none | |
virtual Standard_Integer | CaseNumber (const Handle< Standard_Transient > &obj) const |
Returns a unique positive number for any recognized entity Redefined to work by calling both TypeNumber and, for a Described Entity (late binding) DescrNumber | |
Standard_Integer | TypeNumber (const Handle< Standard_Type > &atype) const |
Returns a Case Number, specific of each recognized Type Here, only Unknown Entity is recognized | |
virtual Standard_CString | SchemaName () const |
Returns the Schema Name attached to each class of Protocol To be redefined by each sub-class Here, SchemaName returns "(DEFAULT)" was C++ : return const | |
Handle_Interface_InterfaceModel | NewModel () const |
Creates an empty Model for Step Norm | |
Standard_Boolean | IsSuitableModel (const Handle< Interface_InterfaceModel > &model) const |
Returns True if <model> is a Model of Step Norm | |
Handle_Standard_Transient | UnknownEntity () const |
Creates a new Unknown Entity for Step (UndefinedEntity) | |
Standard_Boolean | IsUnknownEntity (const Handle< Standard_Transient > &ent) const |
Returns True if <ent> is an Unknown Entity for the Norm, i.e. Type UndefinedEntity, status Unknown | |
virtual Standard_Integer | DescrNumber (const Handle< StepData_EDescr > &adescr) const |
Returns a unique positive CaseNumber for types described by an EDescr (late binding) Warning : TypeNumber and DescrNumber must give together a unique positive case number for each distinct case, type or descr | |
void | AddDescr (const Handle< StepData_EDescr > &adescr, const Standard_Integer CN) |
Records an EDescr with its case number Also records its name for an ESDescr (simple type): an ESDescr is then used, for case number, or for type name | |
Standard_Boolean | HasDescr () const |
Tells if a Protocol brings at least one ESDescr, i.e. if it defines at least one entity description by ESDescr mechanism | |
Handle_StepData_EDescr | Descr (const Standard_Integer num) const |
Returns the description attached to a case number, or null | |
Handle_StepData_EDescr | Descr (const Standard_CString name, const Standard_Boolean anylevel=Standard_True) const |
Returns a description according to its name <anylevel> True (D) : for <me> and its resources <anylevel> False : for <me> only | |
Handle_StepData_ESDescr | ESDescr (const Standard_CString name, const Standard_Boolean anylevel=Standard_True) const |
Idem as Descr but cast to simple description | |
Handle_StepData_ECDescr | ECDescr (const TColStd_SequenceOfAsciiString &names, const Standard_Boolean anylevel=Standard_True) const |
Returns a complex description according to list of names <anylevel> True (D) : for <me> and its resources <anylevel> False : for <me> only | |
void | AddPDescr (const Handle< StepData_PDescr > &pdescr) |
Records an PDescr | |
Handle_StepData_PDescr | PDescr (const Standard_CString name, const Standard_Boolean anylevel=Standard_True) const |
Returns a parameter description according to its name <anylevel> True (D) : for <me> and its resources <anylevel> False : for <me> only | |
void | AddBasicDescr (const Handle< StepData_ESDescr > &esdescr) |
Records an ESDescr, intended to build complex descriptions | |
Handle_StepData_EDescr | BasicDescr (const Standard_CString name, const Standard_Boolean anylevel=Standard_True) const |
Returns a basic description according to its name <anylevel> True (D) : for <me> and its resources <anylevel> False : for <me> only |
void StepData_Protocol::AddBasicDescr | ( | const Handle< StepData_ESDescr > & | esdescr | ) |
void StepData_Protocol::AddDescr | ( | const Handle< StepData_EDescr > & | adescr, |
const Standard_Integer | CN | ||
) |
void StepData_Protocol::AddPDescr | ( | const Handle< StepData_PDescr > & | pdescr | ) |
Handle_StepData_EDescr StepData_Protocol::BasicDescr | ( | const Standard_CString | name, |
const Standard_Boolean | anylevel = Standard_True |
||
) | const |
virtual Standard_Integer StepData_Protocol::CaseNumber | ( | const Handle< Standard_Transient > & | obj | ) | const [virtual] |
Reimplemented from Interface_Protocol.
Handle_StepData_EDescr StepData_Protocol::Descr | ( | const Standard_Integer | num | ) | const |
Handle_StepData_EDescr StepData_Protocol::Descr | ( | const Standard_CString | name, |
const Standard_Boolean | anylevel = Standard_True |
||
) | const |
virtual Standard_Integer StepData_Protocol::DescrNumber | ( | const Handle< StepData_EDescr > & | adescr | ) | const [virtual] |
Handle_StepData_ECDescr StepData_Protocol::ECDescr | ( | const TColStd_SequenceOfAsciiString & | names, |
const Standard_Boolean | anylevel = Standard_True |
||
) | const |
Handle_StepData_ESDescr StepData_Protocol::ESDescr | ( | const Standard_CString | name, |
const Standard_Boolean | anylevel = Standard_True |
||
) | const |
Standard_Boolean StepData_Protocol::HasDescr | ( | ) | const |
Standard_Boolean StepData_Protocol::IsSuitableModel | ( | const Handle< Interface_InterfaceModel > & | model | ) | const [virtual] |
Implements Interface_Protocol.
Standard_Boolean StepData_Protocol::IsUnknownEntity | ( | const Handle< Standard_Transient > & | ent | ) | const [virtual] |
Implements Interface_Protocol.
Standard_Integer StepData_Protocol::NbResources | ( | ) | const [virtual] |
Implements Interface_Protocol.
Reimplemented in StepData_FileProtocol, and StepAP214_Protocol.
Handle_Interface_InterfaceModel StepData_Protocol::NewModel | ( | ) | const [virtual] |
Implements Interface_Protocol.
Handle_StepData_PDescr StepData_Protocol::PDescr | ( | const Standard_CString | name, |
const Standard_Boolean | anylevel = Standard_True |
||
) | const |
Handle_Interface_Protocol StepData_Protocol::Resource | ( | const Standard_Integer | num | ) | const [virtual] |
Implements Interface_Protocol.
Reimplemented in StepData_FileProtocol, and StepAP214_Protocol.
virtual Standard_CString StepData_Protocol::SchemaName | ( | ) | const [virtual] |
Reimplemented in StepData_FileProtocol, StepData_DescrProtocol, StepAP214_Protocol, and HeaderSection_Protocol.
Standard_Integer StepData_Protocol::TypeNumber | ( | const Handle< Standard_Type > & | atype | ) | const [virtual] |
Implements Interface_Protocol.
Reimplemented in StepData_FileProtocol, StepAP214_Protocol, and HeaderSection_Protocol.
Handle_Standard_Transient StepData_Protocol::UnknownEntity | ( | ) | const [virtual] |
Implements Interface_Protocol.