Units_Explorer Class Reference

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

#include <Units_Explorer.hxx>

Public Member Functions
	Units_Explorer ()
	Empty constructor of the class.
	Units_Explorer (const occ::handle< Units_UnitsSystem > &aunitssystem)
	Creates a new instance of the class, initialized with the UnitsSystem <aunitssystem>.
	Units_Explorer (const occ::handle< Units_UnitsDictionary > &aunitsdictionary)
	Creates a new instance of the class, initialized with the UnitsDictionary <aunitsdictionary>.
	Units_Explorer (const occ::handle< Units_UnitsSystem > &aunitssystem, const char *const aquantity)
	Creates a new instance of the class, initialized with the UnitsSystem <aunitssystem> and positioned at the quantity <aquantity>.
	Units_Explorer (const occ::handle< Units_UnitsDictionary > &aunitsdictionary, const char *const aquantity)
	Creates a new instance of the class, initialized with the UnitsDictionary <aunitsdictionary> and positioned at the quantity <aquantity>.
void	Init (const occ::handle< Units_UnitsSystem > &aunitssystem)
	Initializes the instance of the class with the UnitsSystem <aunitssystem>.
void	Init (const occ::handle< Units_UnitsDictionary > &aunitsdictionary)
	Initializes the instance of the class with the UnitsDictionary <aunitsdictionary>.
void	Init (const occ::handle< Units_UnitsSystem > &aunitssystem, const char *const aquantity)
	Initializes the instance of the class with the UnitsSystem <aunitssystem> and positioned at the quantity <aquantity>.
void	Init (const occ::handle< Units_UnitsDictionary > &aunitsdictionary, const char *const aquantity)
	Initializes the instance of the class with the UnitsDictionary <aunitsdictionary> and positioned at the quantity <aquantity>.
bool	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.
bool	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.
bool	IsActive () const
	If the units system to explore is a user system, returns True if the current unit is active, False otherwise.

Detailed Description

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

Constructor & Destructor Documentation

Units_Explorer() [1/5]

Units_Explorer::Units_Explorer

(

)

Empty constructor of the class.

Units_Explorer() [2/5]

Units_Explorer::Units_Explorer

(

const occ::handle< Units_UnitsSystem > &

aunitssystem

)

Creates a new instance of the class, initialized with the UnitsSystem <aunitssystem>.

Units_Explorer() [3/5]

Units_Explorer::Units_Explorer

(

const occ::handle< Units_UnitsDictionary > &

aunitsdictionary

)

Creates a new instance of the class, initialized with the UnitsDictionary <aunitsdictionary>.

Units_Explorer() [4/5]

Units_Explorer::Units_Explorer	(	const occ::handle< Units_UnitsSystem > &	aunitssystem,
		const char *const	aquantity )

Creates a new instance of the class, initialized with the UnitsSystem <aunitssystem> and positioned at the quantity <aquantity>.

Units_Explorer() [5/5]

Units_Explorer::Units_Explorer	(	const occ::handle< Units_UnitsDictionary > &	aunitsdictionary,
		const char *const	aquantity )

Creates a new instance of the class, initialized with the UnitsDictionary <aunitsdictionary> and positioned at the quantity <aquantity>.

Member Function Documentation

Init() [1/4]

void Units_Explorer::Init

(

const occ::handle< Units_UnitsDictionary > &

aunitsdictionary

)

Initializes the instance of the class with the UnitsDictionary <aunitsdictionary>.

Init() [2/4]

void Units_Explorer::Init	(	const occ::handle< Units_UnitsDictionary > &	aunitsdictionary,
		const char *const	aquantity )

Initializes the instance of the class with the UnitsDictionary <aunitsdictionary> and positioned at the quantity <aquantity>.

Init() [3/4]

void Units_Explorer::Init

(

const occ::handle< Units_UnitsSystem > &

aunitssystem

)

Initializes the instance of the class with the UnitsSystem <aunitssystem>.

Init() [4/4]

void Units_Explorer::Init	(	const occ::handle< Units_UnitsSystem > &	aunitssystem,
		const char *const	aquantity )

Initializes the instance of the class with the UnitsSystem <aunitssystem> and positioned at the quantity <aquantity>.

IsActive()

bool Units_Explorer::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.

MoreQuantity()

bool Units_Explorer::MoreQuantity

(

)

const

Returns True if there is another Quantity to explore, False otherwise.

MoreUnit()

bool Units_Explorer::MoreUnit

(

)

const

Returns True if there is another Unit to explore, False otherwise.

NextQuantity()

void Units_Explorer::NextQuantity

(

)

Sets the next Quantity current.

NextUnit()

void Units_Explorer::NextUnit

(

)

Sets the next Unit current.

Quantity()

TCollection_AsciiString Units_Explorer::Quantity

(

)

const

Returns the name of the current Quantity.

Unit()

TCollection_AsciiString Units_Explorer::Unit

(

)

const

Returns the name of the current unit.

---

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

• Units_Explorer.hxx