Open CASCADE Technology 6.6.0
Public Member Functions
Units_UnitsSystem Class Reference

This class allows the user to define his own
system of units.

#include <Units_UnitsSystem.hxx>

Inheritance diagram for Units_UnitsSystem:
Inheritance graph
[legend]

Public Member Functions

 Units_UnitsSystem ()
 Returns an instance of UnitsSystem initialized to the
S.I. units system.

 Units_UnitsSystem (const Standard_CString aName, const Standard_Boolean Verbose=Standard_False)
 Returns an instance of UnitsSystem initialized to the
S.I. units system upgraded by the base system units decription
file.
Attempts to find the four following files:
$CSF_`aName`Defaults/.aName
$CSF_`aName`SiteDefaults/.aName
$CSF_`aName`GroupDefaults/.aName
$CSF_`aName`UserDefaults/.aName
See : Resource_Manager for the description of this file.

Handle_Units_QuantitiesSequence QuantitiesSequence () const
 Returns the sequence of refined quantities.

Handle_TColStd_HSequenceOfInteger ActiveUnitsSequence () const
 Returns a sequence of integer in correspondance with
the sequence of quantities, which indicates, for each
redefined quantity, the index into the sequence of
units, of the active unit.

void Specify (const Standard_CString aquantity, const Standard_CString aunit)
 Specifies for <aquantity> the unit <aunit> used.

void Remove (const Standard_CString aquantity, const Standard_CString aunit)
 Removes for <aquantity> the unit <aunit> used.

void Activate (const Standard_CString aquantity, const Standard_CString aunit)
 Specifies for <aquantity> the unit <aunit> used.

void Activates ()
 Activates the first unit of all defined system quantities

TCollection_AsciiString ActiveUnit (const Standard_CString aquantity) const
 Returns for <aquantity> the active unit.

Standard_Real ConvertValueToUserSystem (const Standard_CString aquantity, const Standard_Real avalue, const Standard_CString aunit) const
 Converts a real value <avalue> from the unit <aunit>
belonging to the physical dimensions <aquantity> to
the corresponding unit of the user system.

Standard_Real ConvertSIValueToUserSystem (const Standard_CString aquantity, const Standard_Real avalue) const
 Converts the real value <avalue> from the S.I. system
of units to the user system of units. <aquantity> is
the physical dimensions of the measurement.

Standard_Real ConvertUserSystemValueToSI (const Standard_CString aquantity, const Standard_Real avalue) const
 Converts the real value <avalue> from the user system
of units to the S.I. system of units. <aquantity> is
the physical dimensions of the measurement.

void Dump () const
Standard_Boolean IsEmpty () const
 Returns TRUE if no units has been defined in the system.


Constructor & Destructor Documentation

Units_UnitsSystem::Units_UnitsSystem ( )
Units_UnitsSystem::Units_UnitsSystem ( const Standard_CString  aName,
const Standard_Boolean  Verbose = Standard_False 
)

Member Function Documentation

void Units_UnitsSystem::Activate ( const Standard_CString  aquantity,
const Standard_CString  aunit 
)
void Units_UnitsSystem::Activates ( )
TCollection_AsciiString Units_UnitsSystem::ActiveUnit ( const Standard_CString  aquantity) const
Handle_TColStd_HSequenceOfInteger Units_UnitsSystem::ActiveUnitsSequence ( ) const
Standard_Real Units_UnitsSystem::ConvertSIValueToUserSystem ( const Standard_CString  aquantity,
const Standard_Real  avalue 
) const
Standard_Real Units_UnitsSystem::ConvertUserSystemValueToSI ( const Standard_CString  aquantity,
const Standard_Real  avalue 
) const
Standard_Real Units_UnitsSystem::ConvertValueToUserSystem ( const Standard_CString  aquantity,
const Standard_Real  avalue,
const Standard_CString  aunit 
) const
void Units_UnitsSystem::Dump ( ) const
Standard_Boolean Units_UnitsSystem::IsEmpty ( ) const
Handle_Units_QuantitiesSequence Units_UnitsSystem::QuantitiesSequence ( ) const
void Units_UnitsSystem::Remove ( const Standard_CString  aquantity,
const Standard_CString  aunit 
)
void Units_UnitsSystem::Specify ( const Standard_CString  aquantity,
const Standard_CString  aunit 
)

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines