OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.
    Open CASCADE Technology Reference Manual 8.0.1
    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.
    int CaseNum (const occ::handle< Standard_Transient > &ent) const override
     Recognizes a kind of VolumeElementPurpose select type return 0.
    int CaseMem (const occ::handle< StepData_SelectMember > &ent) const override
     Recognizes a items of select member VolumeElementPurposeMember 1 -> EnumeratedVolumeElementPurpose 2 -> ApplicationDefinedElementPurpose 0 else.
    occ::handle< StepData_SelectMember > NewMember () 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 occ::handle< TCollection_HAsciiString > &aVal)
     Set Value for ApplicationDefinedElementPurpose.
    occ::handle< TCollection_HAsciiString > ApplicationDefinedElementPurpose () const
     Returns Value as ApplicationDefinedElementPurpose (or Null if another type).
    Public Member Functions inherited from StepData_SelectType
    bool Matches (const occ::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 occ::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 occ::handle< Standard_Transient > & Value () const
     Returns the Stored Entity. Can be used to define specific read methods (see above).
    bool IsNull () const
     Returns True if there is no Stored Entity (i.e. it is Null).
    occ::handle< Standard_Type > Type () const
     Returns the Effective (Dynamic) Type of the Stored Entity If it is Null, returns TYPE(Transient).
    int 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 occ::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.
    int CaseMember () const
     Returns the Type of the stored SelectMember, or zero if it is Null or Entity. Calls the method CaseMem on Value.
    occ::handle< StepData_SelectMember > Member () const
     Returns Value as a SelectMember. Null if not a SelectMember.
    const char * 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.
    int Int () const
     This internal method gives access to a value implemented by an Integer (to read it).
    void SetInt (const int valval)
     This internal method gives access to a value implemented by an Integer (to set it) : a SelectMember MUST ALREADY BE THERE !
    int Integer () const
     Gets the value as an Integer.
    void SetInteger (const int valval, const char *const namename="")
     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.
    bool Boolean () const
    void SetBoolean (const bool valval, const char *const namename="")
    StepData_Logical Logical () const
    void SetLogical (const StepData_Logical valval, const char *const namename="")
    double Real () const
    void SetReal (const double valval, const char *const namename="")
    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()

    occ::handle< TCollection_HAsciiString > StepElement_VolumeElementPurpose::ApplicationDefinedElementPurpose ( ) const

    Returns Value as ApplicationDefinedElementPurpose (or Null if another type).

    ◆ CaseMem()

    int StepElement_VolumeElementPurpose::CaseMem ( const occ::handle< StepData_SelectMember > & ent) const
    		overridevirtual

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

    Reimplemented from StepData_SelectType.

    ◆ CaseNum()

    int StepElement_VolumeElementPurpose::CaseNum ( const occ::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()

    occ::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 occ::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: