StepType is a Signature specific to Step definitions : it considers the type as defined in STEP Schemas, the same which is used in files. For a Complex Type, if its definition is known, StepType produces the list of basic types, separated by commas, the whole between brackets : "(TYPE1,TYPE2..)". If its precise definition is not known (simply it is known as Complex, it can be recognised, but the list is produced at Write time only), StepType produces : "(..COMPLEX TYPE..)". More...
#include <StepSelect_StepType.hxx>
Inheritance diagram for StepSelect_StepType:
Public Member Functions | |
| StepSelect_StepType () | |
| Creates a Signature for Step Type. Protocol is undefined here, hence no Signature may yet be produced. The StepType signature requires a Protocol before working. | |
| void | SetProtocol (const Handle< Interface_Protocol > &proto) |
| Sets the StepType signature to work with a Protocol : this initialises the library. | |
| Standard_CString | Value (const Handle< Standard_Transient > &ent, const Handle< Interface_InterfaceModel > &model) const override |
| Returns the Step Type defined from the Protocol (see above). If <ent> is not recognised, produces "..NOT FROM SCHEMA <name>..". | |
 Public Member Functions inherited from IFSelect_Signature | |
| void | SetIntCase (const Standard_Boolean hasmin, const Standard_Integer valmin, const Standard_Boolean hasmax, const Standard_Integer valmax) |
| Sets the information data to tell "integer cases" with possible min and max values To be called when creating. | |
| Standard_Boolean | IsIntCase (Standard_Boolean &hasmin, Standard_Integer &valmin, Standard_Boolean &hasmax, Standard_Integer &valmax) const |
| Tells if this Signature gives integer values and returns values from SetIntCase if True. | |
| void | AddCase (const Standard_CString acase) |
| Adds a possible case To be called when creating, IF the list of possible cases for Value is known when starting For instance, for CDL types, rather do not fill this, but for a specific enumeration (such as a status), can be used. | |
| Handle< TColStd_HSequenceOfAsciiString > | CaseList () const |
| Returns the predefined list of possible cases, filled by AddCase Null Handle if no predefined list (hence, to be counted) Useful to filter on really possible vase, for instance, or for a help. | |
| Standard_CString | Name () const override |
| Returns an identification of the Signature (a word), given at initialization time Returns the Signature for a Transient object. It is specific of each sub-class of Signature. For a Null Handle, it should provide "" It can work with the model which contains the entity. | |
| TCollection_AsciiString | Label () const |
| The label of a Signature uses its name as follow : "Signature : <name>". | |
| virtual Standard_Boolean | Matches (const Handle< Standard_Transient > &ent, const Handle< Interface_InterfaceModel > &model, const TCollection_AsciiString &text, const Standard_Boolean exact) const |
| Tells if the value for <ent> in <model> matches a text, with a criterium <exact>. The default definition calls MatchValue Can be redefined. | |
| Public Member Functions inherited from Interface_SignType | |
| TCollection_AsciiString | Text (const Handle< Standard_Transient > &ent, const Handle< Standard_Transient > &context) const override |
| Returns an identification of the Signature (a word), given at initialization time Specialised to consider context as an InterfaceModel. | |
| Public Member Functions inherited from MoniTool_SignText | |
| virtual TCollection_AsciiString | TextAlone (const Handle< Standard_Transient > &ent) const |
| Gives a text as a signature for a transient object alone, i.e. without defined context. By default, calls Text with undefined context (Null Handle) and if empty, then returns DynamicType. | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| 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. | |
| 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. | |
| Standard_Transient * | This () 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. | |
| Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. | |
| Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
Protected Attributes | |
| StepData_WriterLib | thelib |
| Protected Attributes inherited from IFSelect_Signature | |
| TCollection_AsciiString | thename |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
| Static Public Member Functions inherited from IFSelect_Signature | |
| static Standard_Boolean | MatchValue (const Standard_CString val, const TCollection_AsciiString &text, const Standard_Boolean exact) |
| Default procedure to tell if a value <val> matches a text with a criterium <exact>. <exact> = True requires equality, else only contained (no reg-exp) | |
| static Standard_CString | IntValue (const Standard_Integer val) |
| This procedure converts an Integer to a CString It is a convenient way when the value of a signature has the form of a simple integer value The value is to be used immediately (one buffer only, no copy) | |
| Static Public Member Functions inherited from Interface_SignType | |
| static Standard_CString | ClassName (const Standard_CString typnam) |
| From a CDL Type Name, returns the Class part (package dropped) WARNING : buffered, to be immediately copied or printed. | |
| Static Public Member Functions inherited from Standard_Transient | |
| static constexpr const char * | get_type_name () |
| Returns a type descriptor about this object. | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. | |
| Protected Member Functions inherited from IFSelect_Signature | |
| IFSelect_Signature (const Standard_CString name) | |
| Initializes a Signature with its name. | |
Detailed Description
StepType is a Signature specific to Step definitions : it considers the type as defined in STEP Schemas, the same which is used in files. For a Complex Type, if its definition is known, StepType produces the list of basic types, separated by commas, the whole between brackets : "(TYPE1,TYPE2..)". If its precise definition is not known (simply it is known as Complex, it can be recognised, but the list is produced at Write time only), StepType produces : "(..COMPLEX TYPE..)".
Constructor & Destructor Documentation
◆ StepSelect_StepType()
| StepSelect_StepType::StepSelect_StepType | ( | ) |
Creates a Signature for Step Type. Protocol is undefined here, hence no Signature may yet be produced. The StepType signature requires a Protocol before working.
Member Function Documentation
◆ SetProtocol()
| void StepSelect_StepType::SetProtocol | ( | const Handle< Interface_Protocol > & | proto | ) |
Sets the StepType signature to work with a Protocol : this initialises the library.
◆ Value()
|
overridevirtual |
Returns the Step Type defined from the Protocol (see above). If <ent> is not recognised, produces "..NOT FROM SCHEMA <name>..".
Implements Interface_SignType.
Field Documentation
◆ thelib
|
protected |
The documentation for this class was generated from the following file:
