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
    StepBasic_Unit Class Reference

    Implements a select type unit (NamedUnit or DerivedUnit). More...

    #include <StepBasic_Unit.hxx>

    Inheritance diagram for StepBasic_Unit:

    Public Member Functions

     StepBasic_Unit ()
     Creates empty object.
    int CaseNum (const occ::handle< Standard_Transient > &ent) const override
     Recognizes a type of Unit Entity 1 -> NamedUnit 2 -> DerivedUnit.
    occ::handle< StepBasic_NamedUnitNamedUnit () const
     returns Value as a NamedUnit (Null if another type)
    occ::handle< StepBasic_DerivedUnitDerivedUnit () const
     returns Value as a DerivedUnit (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_TypeType () 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_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.
    virtual occ::handle< StepData_SelectMemberNewMember () const
     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.
    virtual int CaseMem (const occ::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.
    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_SelectMemberMember () 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

    Implements a select type unit (NamedUnit or DerivedUnit).

    Constructor & Destructor Documentation

    ◆ StepBasic_Unit()

    StepBasic_Unit::StepBasic_Unit ( )

    Creates empty object.

    Member Function Documentation

    ◆ CaseNum()

    int StepBasic_Unit::CaseNum ( const occ::handle< Standard_Transient > & ent) const
    overridevirtual

    Recognizes a type of Unit Entity 1 -> NamedUnit 2 -> DerivedUnit.

    Implements StepData_SelectType.

    ◆ DerivedUnit()

    occ::handle< StepBasic_DerivedUnit > StepBasic_Unit::DerivedUnit ( ) const

    returns Value as a DerivedUnit (Null if another type)

    ◆ NamedUnit()

    occ::handle< StepBasic_NamedUnit > StepBasic_Unit::NamedUnit ( ) const

    returns Value as a NamedUnit (Null if another type)


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