Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
Units_Explorer Class Reference

This class provides all the services to explore
UnitsSystem or UnitsDictionary.

#include <Units_Explorer.hxx>

Public Member Functions

DEFINE_STANDARD_ALLOC Units_Explorer ()
 Empty contructor of the class.

 Units_Explorer (const Handle< Units_UnitsSystem > &aunitssystem)
 Creates a new instance of the class, initialized with
the UnitsSystem <aunitssystem>.

 Units_Explorer (const Handle< Units_UnitsDictionary > &aunitsdictionary)
 Creates a new instance of the class, initialized with
the UnitsDictionary <aunitsdictionary>.

 Units_Explorer (const Handle< Units_UnitsSystem > &aunitssystem, const Standard_CString aquantity)
 Creates a new instance of the class, initialized with
the UnitsSystem <aunitssystem> and positioned at the
quantity <aquantity>.

 Units_Explorer (const Handle< Units_UnitsDictionary > &aunitsdictionary, const Standard_CString aquantity)
 Creates a new instance of the class, initialized with
the UnitsDictionary <aunitsdictionary> and positioned
at the quantity <aquantity>.

void Init (const Handle< Units_UnitsSystem > &aunitssystem)
 Initializes the instance of the class with the
UnitsSystem <aunitssystem>.

void Init (const Handle< Units_UnitsDictionary > &aunitsdictionary)
 Initializes the instance of the class with the
UnitsDictionary <aunitsdictionary>.

void Init (const Handle< Units_UnitsSystem > &aunitssystem, const Standard_CString aquantity)
 Initializes the instance of the class with the
UnitsSystem <aunitssystem> and positioned at the
quantity <aquantity>.

void Init (const Handle< Units_UnitsDictionary > &aunitsdictionary, const Standard_CString aquantity)
 Initializes the instance of the class with the
UnitsDictionary <aunitsdictionary> and positioned at
the quantity <aquantity>.

Standard_Boolean MoreQuantity () const
 Returns True if there is another Quantity to explore,
False otherwise.

void NextQuantity ()
 Sets the next Quantity current.

TCollection_AsciiString Quantity () const
 Returns the name of the current Quantity.

Standard_Boolean MoreUnit () const
 Returns True if there is another Unit to explore,
False otherwise.

void NextUnit ()
 Sets the next Unit current.

TCollection_AsciiString Unit () const
 Returns the name of the current unit.

Standard_Boolean IsActive () const
 If the units system to explore is a user system,
returns True if the current unit is active, False
otherwise.

If the units system to explore is the units
dictionary, returns True if the current unit is the
S.I. unit.


Constructor & Destructor Documentation


Member Function Documentation


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