BUnit Class Reference

#include <BUnit.h>

Inheritance diagram for BUnit:

[legend]

List of all members.

---

Detailed Description

An abstract base class that represents a unit of measurement.

Public Member Functions
	BUnit ()
	Default constructor.
virtual BString	GetAbbreviation (void) const =0
	Gets the abbreviation for this BUnit.
virtual bool	GetIdentifier (const BString &issuer, BIdentifier &identifier) const =0
	Gets the BIdentifier with the specified issuer for this BUnit.
virtual BIdentifierVector	GetIdentifiers () const =0
	Gets all BIdentifiers for this BUnit.
virtual BString	GetName (void) const =0
	Gets the common name of this BUnit.
virtual EUnitType	GetType (void) const =0
	Gets the type of this BUnit.
virtual double	GetUnitsPerBaseUnit () const =0
	Gets the base unit conversion for this unit.
virtual	~BUnit ()
	Destructor.
Static Public Member Functions
static BUnitPtr	GetUnit (const BIdentifier &identifier)
	Gets a BUnit from the data source based on the specified BIdentifier.

---

Constructor & Destructor Documentation

BUnit

(

)

[inline]

Default constructor.

virtual ~BUnit

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

virtual BString GetAbbreviation

(

void

)

const [pure virtual]

Gets the abbreviation for this BUnit.

Returns:

The abbreviation for this BUnit.

Implemented in BAngularUnit, and BLinearUnit.

virtual bool GetIdentifier	(	const BString &	issuer,
		BIdentifier &	identifier
	)			const [pure virtual]

Gets the BIdentifier with the specified issuer for this BUnit.

Parameters:

	issuer	The issuer of the desired BIdentifier.
	identifier	The identifier for this BUnit with the specified issuer.

Returns:

bool True if there exists a BIdentifier with the specified issuer and false otherwise.

Implemented in BAngularUnit, and BLinearUnit.

virtual BIdentifierVector GetIdentifiers

(

)

const [pure virtual]

Gets all BIdentifiers for this BUnit.

Returns:

A collection of all BIdentifiers for this BUnit.

Implemented in BAngularUnit, and BLinearUnit.

virtual BString GetName

(

void

)

const [pure virtual]

Gets the common name of this BUnit.

Returns:

The name of this BUnit.

Implemented in BAngularUnit, and BLinearUnit.

virtual EUnitType GetType

(

void

)

const [pure virtual]

Gets the type of this BUnit.

Returns:

The type of this BUnit.

Implemented in BAngularUnit, and BLinearUnit.

static BUnitPtr GetUnit

(

const BIdentifier &

identifier

)

[static]

Gets a BUnit from the data source based on the specified BIdentifier.

Parameters:

identifier

A BIdentifier that identifies the BUnit in the data source.

Returns:

The BUnit with the specified BIdentifier.

virtual double GetUnitsPerBaseUnit

(

)

const [pure virtual]

Gets the base unit conversion for this unit.

Returns:

The factor that is used to convert between this unit and the base units.

Implemented in BAngularUnit, and BLinearUnit.

---

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

• BUnit.h

---

GeoTranslate 5.0 From Blue Marble Geographics