OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    Units_Dimensions Class Reference

    This class includes all the methods to create and manipulate the dimensions of the physical quantities. More...

    #include <Units_Dimensions.hxx>

    Inheritance diagram for Units_Dimensions:

    Public Member Functions

     Units_Dimensions (const double amass, const double alength, const double atime, const double anelectriccurrent, const double athermodynamictemperature, const double anamountofsubstance, const double aluminousintensity, const double aplaneangle, const double asolidangle)
     Returns a Dimensions object which represents the dimension of a physical quantity. Each of the <amass>, <alength>, <atime>, <anelectriccurrent>, <athermodynamictemperature>, <anamountofsubstance>, <aluminousintensity>, <aplaneangle>, <asolidangle> are the powers for the 7 fundamental units of physical quantity and the 2 secondary fundamental units of physical quantity.
    double Mass () const
     Returns the power of mass stored in the dimensions.
    double Length () const
     Returns the power of length stored in the dimensions.
    double Time () const
     Returns the power of time stored in the dimensions.
    double ElectricCurrent () const
     Returns the power of electrical intensity (current) stored in the dimensions.
    double ThermodynamicTemperature () const
     Returns the power of temperature stored in the dimensions.
    double AmountOfSubstance () const
     Returns the power of quantity of material (mole) stored in the dimensions.
    double LuminousIntensity () const
     Returns the power of light intensity stored in the dimensions.
    double PlaneAngle () const
     Returns the power of plane angle stored in the dimensions.
    double SolidAngle () const
     Returns the power of solid angle stored in the dimensions.
    const char * Quantity () const
     Returns the quantity string of the dimension.
    occ::handle< Units_Dimensions > Multiply (const occ::handle< Units_Dimensions > &adimensions) const
     Creates and returns a new Dimensions object which is the result of the multiplication of <me> and <adimensions>.
    occ::handle< Units_Dimensions > Divide (const occ::handle< Units_Dimensions > &adimensions) const
     Creates and returns a new Dimensions object which is the result of the division of <me> by <adimensions>.
    occ::handle< Units_Dimensions > Power (const double anexponent) const
     Creates and returns a new Dimensions object which is the result of the power of <me> and <anexponent>.
    bool IsEqual (const occ::handle< Units_Dimensions > &adimensions) const
     Returns true if <me> and <adimensions> have the same dimensions, false otherwise.
    bool IsNotEqual (const occ::handle< Units_Dimensions > &adimensions) const
     Returns false if <me> and <adimensions> have the same dimensions, true otherwise.
    void Dump (const int ashift) const
     Useful for degugging.
    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 ()=default
     Destructor must be virtual.
    virtual const opencascade::handle< Standard_Type > & DynamicType () const
     Returns a type descriptor about this object.
    bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
     Returns a true value if this is an instance of Type.
    bool IsInstance (const char *const theTypeName) const
     Returns a true value if this is an instance of TypeName.
    bool 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.
    bool IsKind (const char *const 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.
    int GetRefCount () const noexcept
     Get the reference counter of this object.
    void IncrementRefCounter () noexcept
     Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
    int DecrementRefCounter () noexcept
     Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
    virtual void Delete () const
     Memory deallocator for transient classes.

    Static Public Member Functions

    static occ::handle< Units_Dimensions > ALess ()
    static occ::handle< Units_Dimensions > AMass ()
    static occ::handle< Units_Dimensions > ALength ()
    static occ::handle< Units_Dimensions > ATime ()
    static occ::handle< Units_Dimensions > AElectricCurrent ()
    static occ::handle< Units_Dimensions > AThermodynamicTemperature ()
    static occ::handle< Units_Dimensions > AAmountOfSubstance ()
    static occ::handle< Units_Dimensions > ALuminousIntensity ()
    static occ::handle< Units_Dimensions > APlaneAngle ()
    static occ::handle< Units_Dimensions > ASolidAngle ()
     Returns the basic dimensions.
    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.

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.

    Detailed Description

    This class includes all the methods to create and manipulate the dimensions of the physical quantities.

    Constructor & Destructor Documentation

    ◆ Units_Dimensions()

    Units_Dimensions::Units_Dimensions ( const double amass,
    const double alength,
    const double atime,
    const double anelectriccurrent,
    const double athermodynamictemperature,
    const double anamountofsubstance,
    const double aluminousintensity,
    const double aplaneangle,
    const double asolidangle )

    Returns a Dimensions object which represents the dimension of a physical quantity. Each of the <amass>, <alength>, <atime>, <anelectriccurrent>, <athermodynamictemperature>, <anamountofsubstance>, <aluminousintensity>, <aplaneangle>, <asolidangle> are the powers for the 7 fundamental units of physical quantity and the 2 secondary fundamental units of physical quantity.

    Member Function Documentation

    ◆ AAmountOfSubstance()

    occ::handle< Units_Dimensions > Units_Dimensions::AAmountOfSubstance ( )
    static

    ◆ AElectricCurrent()

    occ::handle< Units_Dimensions > Units_Dimensions::AElectricCurrent ( )
    static

    ◆ ALength()

    occ::handle< Units_Dimensions > Units_Dimensions::ALength ( )
    static

    ◆ ALess()

    occ::handle< Units_Dimensions > Units_Dimensions::ALess ( )
    static

    ◆ ALuminousIntensity()

    occ::handle< Units_Dimensions > Units_Dimensions::ALuminousIntensity ( )
    static

    ◆ AMass()

    occ::handle< Units_Dimensions > Units_Dimensions::AMass ( )
    static

    ◆ AmountOfSubstance()

    double Units_Dimensions::AmountOfSubstance ( ) const

    Returns the power of quantity of material (mole) stored in the dimensions.

    ◆ APlaneAngle()

    occ::handle< Units_Dimensions > Units_Dimensions::APlaneAngle ( )
    static

    ◆ ASolidAngle()

    occ::handle< Units_Dimensions > Units_Dimensions::ASolidAngle ( )
    static

    Returns the basic dimensions.

    ◆ AThermodynamicTemperature()

    occ::handle< Units_Dimensions > Units_Dimensions::AThermodynamicTemperature ( )
    static

    ◆ ATime()

    occ::handle< Units_Dimensions > Units_Dimensions::ATime ( )
    static

    ◆ Divide()

    occ::handle< Units_Dimensions > Units_Dimensions::Divide ( const occ::handle< Units_Dimensions > & adimensions) const

    Creates and returns a new Dimensions object which is the result of the division of <me> by <adimensions>.

    ◆ Dump()

    void Units_Dimensions::Dump ( const int ashift) const

    Useful for degugging.

    ◆ ElectricCurrent()

    double Units_Dimensions::ElectricCurrent ( ) const

    Returns the power of electrical intensity (current) stored in the dimensions.

    ◆ IsEqual()

    bool Units_Dimensions::IsEqual ( const occ::handle< Units_Dimensions > & adimensions) const

    Returns true if <me> and <adimensions> have the same dimensions, false otherwise.

    ◆ IsNotEqual()

    bool Units_Dimensions::IsNotEqual ( const occ::handle< Units_Dimensions > & adimensions) const

    Returns false if <me> and <adimensions> have the same dimensions, true otherwise.

    ◆ Length()

    double Units_Dimensions::Length ( ) const

    Returns the power of length stored in the dimensions.

    ◆ LuminousIntensity()

    double Units_Dimensions::LuminousIntensity ( ) const

    Returns the power of light intensity stored in the dimensions.

    ◆ Mass()

    double Units_Dimensions::Mass ( ) const

    Returns the power of mass stored in the dimensions.

    ◆ Multiply()

    occ::handle< Units_Dimensions > Units_Dimensions::Multiply ( const occ::handle< Units_Dimensions > & adimensions) const

    Creates and returns a new Dimensions object which is the result of the multiplication of <me> and <adimensions>.

    ◆ PlaneAngle()

    double Units_Dimensions::PlaneAngle ( ) const

    Returns the power of plane angle stored in the dimensions.

    ◆ Power()

    occ::handle< Units_Dimensions > Units_Dimensions::Power ( const double anexponent) const

    Creates and returns a new Dimensions object which is the result of the power of <me> and <anexponent>.

    ◆ Quantity()

    const char * Units_Dimensions::Quantity ( ) const

    Returns the quantity string of the dimension.

    ◆ SolidAngle()

    double Units_Dimensions::SolidAngle ( ) const

    Returns the power of solid angle stored in the dimensions.

    ◆ ThermodynamicTemperature()

    double Units_Dimensions::ThermodynamicTemperature ( ) const

    Returns the power of temperature stored in the dimensions.

    ◆ Time()

    double Units_Dimensions::Time ( ) const

    Returns the power of time stored in the dimensions.


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