Representation of STEP SELECT type SourceItem. More...
#include <StepBasic_SourceItem.hxx>
Inheritance diagram for StepBasic_SourceItem:
Public Member Functions | |
| StepBasic_SourceItem () | |
| Empty constructor. | |
| Standard_Integer | CaseNum (const Handle< Standard_Transient > &ent) const override |
| Recognizes a kind of SourceItem select type 1 -> HAsciiString from TCollection 0 else. | |
| virtual Handle< StepData_SelectMember > | NewMember () const override |
| Returns a preferred SelectMember. Default returns a Null By default, a SelectMember can be set according to data type and Name : it is a SelectNamed if Name is defined. | |
| Handle< TCollection_HAsciiString > | Identifier () const |
| Returns Value as Identifier (or Null if another type) | |
 Public Member Functions inherited from StepData_SelectType | |
| Standard_Boolean | Matches (const Handle< Standard_Transient > &ent) const |
| Returns True if the Type of an Entity complies with the definition list of the SelectType. Also checks for a SelectMember Default Implementation looks for CaseNum or CaseMem positive. | |
| void | SetValue (const Handle< Standard_Transient > &ent) |
| Stores an Entity. This allows to define a specific SelectType class with one read method per member Type, which returns the Value casted with the good Type. | |
| void | Nullify () |
| Nullifies the Stored Entity. | |
| const Handle< Standard_Transient > & | Value () const |
| Returns the Stored Entity. Can be used to define specific read methods (see above) | |
| Standard_Boolean | IsNull () const |
| Returns True if there is no Stored Entity (i.e. it is Null) | |
| Handle< Standard_Type > | Type () const |
| Returns the Effective (Dynamic) Type of the Stored Entity If it is Null, returns TYPE(Transient) | |
| Standard_Integer | CaseNumber () const |
| Recognizes the Type of the stored Entity, or zero if it is Null or SelectMember. Calls the first method CaseNum on Value. | |
| virtual Handle< StepData_PDescr > | Description () const |
| Returns the Description which corresponds to <me> Null if no specific description to give. This description is used to control reading an check validity. Default returns a Null Handle, i.e. undefined description It can suffice if CaseNum and CaseMem give enough control. | |
| virtual Standard_Integer | CaseMem (const Handle< StepData_SelectMember > &ent) const |
| Recognize a SelectMember (kind, name). Returns a positive value which identifies the case in the List of immediate cases (distinct from the List of Entity Types). Zero if not recognizes Default returns 0, saying that no immediate value is allowed. | |
| Standard_Integer | CaseMember () const |
| Returns the Type of the stored SelectMember, or zero if it is Null or Entity. Calls the method CaseMem on Value. | |
| Handle< StepData_SelectMember > | Member () const |
| Returns Value as a SelectMember. Null if not a SelectMember. | |
| Standard_CString | SelectName () const |
| Returns the type name of SelectMember. If no SelectMember or with no type name, returns an empty string To change it, pass through the SelectMember itself. | |
| Standard_Integer | Int () const |
| This internal method gives access to a value implemented by an Integer (to read it) | |
| void | SetInt (const Standard_Integer val) |
| This internal method gives access to a value implemented by an Integer (to set it) : a SelectMember MUST ALREADY BE THERE ! | |
| Standard_Integer | Integer () const |
| Gets the value as an Integer. | |
| void | SetInteger (const Standard_Integer val, const Standard_CString name="") |
| Sets a new Integer value, with an optional type name Warning : If a SelectMember is already set, works on it : value and name must then be accepted by this SelectMember. | |
| Standard_Boolean | Boolean () const |
| void | SetBoolean (const Standard_Boolean val, const Standard_CString name="") |
| StepData_Logical | Logical () const |
| void | SetLogical (const StepData_Logical val, const Standard_CString name="") |
| Standard_Real | Real () const |
| void | SetReal (const Standard_Real val, const Standard_CString name="") |
| virtual | ~StepData_SelectType () |
Detailed Description
Representation of STEP SELECT type SourceItem.
Constructor & Destructor Documentation
◆ StepBasic_SourceItem()
| StepBasic_SourceItem::StepBasic_SourceItem | ( | ) |
Empty constructor.
Member Function Documentation
◆ CaseNum()
|
overridevirtual |
Recognizes a kind of SourceItem select type 1 -> HAsciiString from TCollection 0 else.
Implements StepData_SelectType.
◆ Identifier()
| Handle< TCollection_HAsciiString > StepBasic_SourceItem::Identifier | ( | ) | const |
Returns Value as Identifier (or Null if another type)
◆ NewMember()
|
overridevirtual |
Returns a preferred SelectMember. Default returns a Null By default, a SelectMember can be set according to data type and Name : it is a SelectNamed if Name is defined.
This method allows to define, for a specific SelectType, a specific SelectMember than SelectNamed. For instance for a Real plus a Name, a SelectReal plus a case number is a good solution, lighter than SelectNamed which is very multipurpose
Reimplemented from StepData_SelectType.
The documentation for this class was generated from the following file:
