BLinearUnit Class Reference

#include <BLinearUnit.h>

Inheritance diagram for BLinearUnit:

[legend]

List of all members.

---

Detailed Description

Defines a unit of measurement for linear values.

Public Member Functions
	BLinearUnit (const GeoCalc::ML::CLinearUnit &lu)
	Constructs a BLinearUnit from a GeoCalcCore CLinearUnit.
	BLinearUnit (const BLinearUnit &unit)
	Copy constructor.
	BLinearUnit ()
	Default constructor.
BLinearUnit &	BLinearUnit::operator= (const BLinearUnit &lu)
	Assignment operator.
virtual BString	GetAbbreviation (void) const
	Gets the abbreviation for this BLinearUnit.
virtual bool	GetIdentifier (const BString &issuer, BIdentifier &identifier) const
	Gets the BIdentifier for the given issuer for this BLinearUnit.
virtual BIdentifierVector	GetIdentifiers () const
	Gets a collection containing all BIdentifiers for this BLinearUnit.
virtual BString	GetName (void) const
	Gets the common name for this BLinearUnit.
virtual EUnitType	GetType (void) const
	Gets the type of this BUnit.
virtual double	GetUnitsPerBaseUnit () const
	Gets the conversion factor used to convert between this BLinearUnit and meters.
double	GetUnitsPerMeter () const
	Gets the conversion factor used to convert between this BLinearUnit and meters.
virtual	~BLinearUnit ()
	Destructor.
Static Public Member Functions
static BLinearUnitPtrVector	GetListOfAvailableLinearUnits ()
	Returns a list of all BLinearUnit objects that are available for use.
Protected Member Functions
const GeoCalc::ML::CLinearUnit *	GetGCLinearUnit () const
	Gets the GeoCalcCore CLinearUnit object that underlies this BLinearUnit.
Friends
class	BCoordSysRepository

---

Constructor & Destructor Documentation

BLinearUnit

(

)

[inline]

Default constructor.

This constructs a BLinearUnit that is equivalent to meters.

BLinearUnit

(

const BLinearUnit &

unit

)

[inline]

Copy constructor.

Parameters:

unit

The BLinearUnit object to copy.

BLinearUnit

(

const GeoCalc::ML::CLinearUnit &

lu

)

Constructs a BLinearUnit from a GeoCalcCore CLinearUnit.

Parameters:

lu

The GeoCalcCore CLinearUnit object.

virtual ~BLinearUnit

(

)

[virtual]

Destructor.

---

Member Function Documentation

BLinearUnit& BLinearUnit::operator=

(

const BLinearUnit &

lu

)

Assignment operator.

Parameters:

lu

The BLinearUnit whose value will be copied into this one.

Returns:

A reference to this BLinearUnit.

virtual BString GetAbbreviation

(

void

)

const [virtual]

Gets the abbreviation for this BLinearUnit.

Returns:

The abbreviation for this BLinearUnit.

Implements BUnit.

const GeoCalc::ML::CLinearUnit* GetGCLinearUnit

(

)

const [protected]

Gets the GeoCalcCore CLinearUnit object that underlies this BLinearUnit.

Returns:

The GeoCalcCore CLinearUnit object that underlies this BLinearUnit.

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

Gets the BIdentifier for the given issuer for this BLinearUnit.

Parameters:

	issuer	The issuer of the desired BIdentifier.
	identifier	This parameter will hold the value of the desired BIdentifier after this method returns.

Returns:

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

Implements BUnit.

virtual BIdentifierVector GetIdentifiers

(

)

const [virtual]

Gets a collection containing all BIdentifiers for this BLinearUnit.

Returns:

A collection containing all BIdentifiers for this BLinearUnit.

Implements BUnit.

static BLinearUnitPtrVector GetListOfAvailableLinearUnits

(

)

[static]

Returns a list of all BLinearUnit objects that are available for use.

Returns:

A collection of BLinearUnit objects.

virtual BString GetName

(

void

)

const [virtual]

Gets the common name for this BLinearUnit.

Returns:

The common name for this BLinearUnit.

Implements BUnit.

virtual EUnitType GetType

(

void

)

const [inline, virtual]

Gets the type of this BUnit.

Returns:

The type of this BUnit.

Implements BUnit.

virtual double GetUnitsPerBaseUnit

(

)

const [virtual]

Gets the conversion factor used to convert between this BLinearUnit and meters.

Returns:

The conversion factor used to convert between this BLinearUnit and meters.

Implements BUnit.

double GetUnitsPerMeter

(

)

const

Gets the conversion factor used to convert between this BLinearUnit and meters.

Returns:

The conversion factor used to convert between this BLinearUnit and meters.

---

Friends And Related Function Documentation

friend class BCoordSysRepository [friend]

---

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

• BLinearUnit.h

---

GeoTranslate 5.0 From Blue Marble Geographics