Open CASCADE Technology 7.8.0
Public Member Functions
StepElement_VolumeElementPurpose Class Reference

Representation of STEP SELECT type VolumeElementPurpose. More...

#include <StepElement_VolumeElementPurpose.hxx>

Inheritance diagram for StepElement_VolumeElementPurpose:
Inheritance graph
[legend]

Public Member Functions

 StepElement_VolumeElementPurpose ()
 Empty constructor.
 
Standard_Integer CaseNum (const Handle< Standard_Transient > &ent) const override
 Recognizes a kind of VolumeElementPurpose select type return 0.
 
virtual Standard_Integer CaseMem (const Handle< StepData_SelectMember > &ent) const override
 Recognizes a items of select member VolumeElementPurposeMember 1 -> EnumeratedVolumeElementPurpose 2 -> ApplicationDefinedElementPurpose 0 else.
 
virtual Handle< StepData_SelectMemberNewMember () const override
 Returns a new select member the type VolumeElementPurposeMember.
 
void SetEnumeratedVolumeElementPurpose (const StepElement_EnumeratedVolumeElementPurpose aVal)
 Set Value for EnumeratedVolumeElementPurpose.
 
StepElement_EnumeratedVolumeElementPurpose EnumeratedVolumeElementPurpose () const
 Returns Value as EnumeratedVolumeElementPurpose (or Null if another type)
 
void SetApplicationDefinedElementPurpose (const Handle< TCollection_HAsciiString > &aVal)
 Set Value for ApplicationDefinedElementPurpose.
 
Handle< TCollection_HAsciiStringApplicationDefinedElementPurpose () const
 Returns Value as ApplicationDefinedElementPurpose (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_TypeType () 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_PDescrDescription () 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.
 
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_SelectMemberMember () 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 VolumeElementPurpose.

Constructor & Destructor Documentation

◆ StepElement_VolumeElementPurpose()

StepElement_VolumeElementPurpose::StepElement_VolumeElementPurpose ( )

Empty constructor.

Member Function Documentation

◆ ApplicationDefinedElementPurpose()

Handle< TCollection_HAsciiString > StepElement_VolumeElementPurpose::ApplicationDefinedElementPurpose ( ) const

Returns Value as ApplicationDefinedElementPurpose (or Null if another type)

◆ CaseMem()

virtual Standard_Integer StepElement_VolumeElementPurpose::CaseMem ( const Handle< StepData_SelectMember > &  ent) const
overridevirtual

Recognizes a items of select member VolumeElementPurposeMember 1 -> EnumeratedVolumeElementPurpose 2 -> ApplicationDefinedElementPurpose 0 else.

Reimplemented from StepData_SelectType.

◆ CaseNum()

Standard_Integer StepElement_VolumeElementPurpose::CaseNum ( const Handle< Standard_Transient > &  ent) const
overridevirtual

Recognizes a kind of VolumeElementPurpose select type return 0.

Implements StepData_SelectType.

◆ EnumeratedVolumeElementPurpose()

StepElement_EnumeratedVolumeElementPurpose StepElement_VolumeElementPurpose::EnumeratedVolumeElementPurpose ( ) const

Returns Value as EnumeratedVolumeElementPurpose (or Null if another type)

◆ NewMember()

virtual Handle< StepData_SelectMember > StepElement_VolumeElementPurpose::NewMember ( ) const
overridevirtual

Returns a new select member the type VolumeElementPurposeMember.

Reimplemented from StepData_SelectType.

◆ SetApplicationDefinedElementPurpose()

void StepElement_VolumeElementPurpose::SetApplicationDefinedElementPurpose ( const Handle< TCollection_HAsciiString > &  aVal)

Set Value for ApplicationDefinedElementPurpose.

◆ SetEnumeratedVolumeElementPurpose()

void StepElement_VolumeElementPurpose::SetEnumeratedVolumeElementPurpose ( const StepElement_EnumeratedVolumeElementPurpose  aVal)

Set Value for EnumeratedVolumeElementPurpose.


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