OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    UnitsMethods Class Reference

    Class for using global units variables. More...

    #include <UnitsMethods.hxx>

    Static Public Member Functions

    static double GetLengthFactorValue (const int theUnit)
     Returns value of unit encoded by parameter theUnit (integer value denoting unit, as described in IGES standard) in millimeters by default.
    static double GetCasCadeLengthUnit (const UnitsMethods_LengthUnit theBaseUnit=UnitsMethods_LengthUnit_Millimeter)
     Returns value of current internal unit for CASCADE in millemeters by default.
    static void SetCasCadeLengthUnit (const double theUnitValue, const UnitsMethods_LengthUnit theBaseUnit=UnitsMethods_LengthUnit_Millimeter)
     Sets value of current internal unit for CASCADE.
    static void SetCasCadeLengthUnit (const int theUnit)
     Sets value of current internal unit for CASCADE by parameter theUnit (integer value denoting unit, as described in IGES standard).
    static double GetLengthUnitScale (const UnitsMethods_LengthUnit theFromUnit, const UnitsMethods_LengthUnit theToUnit)
     Returns the scale factor for switch from first given unit to second given unit.
    static UnitsMethods_LengthUnit GetLengthUnitByFactorValue (const double theFactorValue, const UnitsMethods_LengthUnit theBaseUnit=UnitsMethods_LengthUnit_Millimeter)
     Returns the enumeration corresponding to the given scale factor.
    static const char * DumpLengthUnit (const double theScaleFactor, const UnitsMethods_LengthUnit theBaseUnit=UnitsMethods_LengthUnit_Millimeter)
     Returns string name for the given scale factor.
    static const char * DumpLengthUnit (const UnitsMethods_LengthUnit theUnit)
     Returns string for the given value of LengthUnit.
    static UnitsMethods_LengthUnit LengthUnitFromString (const char *theStr, const bool theCaseSensitive)
     Make conversion of given string to value of LengthUnit.

    Detailed Description

    Class for using global units variables.

    Member Function Documentation

    ◆ DumpLengthUnit() [1/2]

    const char * UnitsMethods::DumpLengthUnit ( const double theScaleFactor,
    const UnitsMethods_LengthUnit theBaseUnit = UnitsMethods_LengthUnit_Millimeter )
    static

    Returns string name for the given scale factor.

    ◆ DumpLengthUnit() [2/2]

    const char * UnitsMethods::DumpLengthUnit ( const UnitsMethods_LengthUnit theUnit)
    static

    Returns string for the given value of LengthUnit.

    ◆ GetCasCadeLengthUnit()

    double UnitsMethods::GetCasCadeLengthUnit ( const UnitsMethods_LengthUnit theBaseUnit = UnitsMethods_LengthUnit_Millimeter)
    static

    Returns value of current internal unit for CASCADE in millemeters by default.

    ◆ GetLengthFactorValue()

    double UnitsMethods::GetLengthFactorValue ( const int theUnit)
    static

    Returns value of unit encoded by parameter theUnit (integer value denoting unit, as described in IGES standard) in millimeters by default.

    ◆ GetLengthUnitByFactorValue()

    UnitsMethods_LengthUnit UnitsMethods::GetLengthUnitByFactorValue ( const double theFactorValue,
    const UnitsMethods_LengthUnit theBaseUnit = UnitsMethods_LengthUnit_Millimeter )
    static

    Returns the enumeration corresponding to the given scale factor.

    ◆ GetLengthUnitScale()

    double UnitsMethods::GetLengthUnitScale ( const UnitsMethods_LengthUnit theFromUnit,
    const UnitsMethods_LengthUnit theToUnit )
    static

    Returns the scale factor for switch from first given unit to second given unit.

    ◆ LengthUnitFromString()

    UnitsMethods_LengthUnit UnitsMethods::LengthUnitFromString ( const char * theStr,
    const bool theCaseSensitive )
    static

    Make conversion of given string to value of LengthUnit.

    ◆ SetCasCadeLengthUnit() [1/2]

    void UnitsMethods::SetCasCadeLengthUnit ( const double theUnitValue,
    const UnitsMethods_LengthUnit theBaseUnit = UnitsMethods_LengthUnit_Millimeter )
    static

    Sets value of current internal unit for CASCADE.

    ◆ SetCasCadeLengthUnit() [2/2]

    void UnitsMethods::SetCasCadeLengthUnit ( const int theUnit)
    static

    Sets value of current internal unit for CASCADE by parameter theUnit (integer value denoting unit, as described in IGES standard).


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