BAngularUnit Class Reference

#include <BAngularUnit.h>

Inheritance diagram for BAngularUnit:

[legend]

List of all members.

---

Detailed Description

Defines a unit that can be used to measure angles.

Public Member Functions
	BAngularUnit (const GeoCalc::ML::CAngularUnit &au)
	Copy constructor that copies a GeoCalc CAngularUnit.
	BAngularUnit (const BAngularUnit &unit)
	Copy constructor.
	BAngularUnit ()
	Default constructor, which creates a BAngularUnit that is equivalent to degrees.
BAngularUnit &	BAngularUnit::operator= (const BAngularUnit &au)
	Assignment operator.
virtual BString	GetAbbreviation (void) const
	Gets the abbreviation (if it exists) for this BAngularUnit.
virtual bool	GetIdentifier (const BString &issuer, BIdentifier &identifier) const
	Get the BIdentifier with the given issuer for this BAngularUnit.
virtual BIdentifierVector	GetIdentifiers () const
	Returns a collection containing all BIdentifiers for this BAngularUnit.
virtual BString	GetName (void) const
	Gets the proper name of the BAngularUnit.
virtual EUnitType	GetType (void) const
	Gets the type of the BUnit.
virtual double	GetUnitsPerBaseUnit () const
	Gets the base unit conversion factor for this unit.
double	GetUnitsPerDegree () const
	Gets the number of these units that correspond to one degree.
virtual	~BAngularUnit ()
	Destructor.
Static Public Member Functions
static BAngularUnitPtrVector	GetListOfAvailableAngularUnits ()
	Returns a list of all BAngularUnits that are defined in the current data source.
Protected Member Functions
const GeoCalc::ML::CAngularUnit *	GetGCAngularUnit () const
	Returns the GeoCalc CAngularUnit object that this BAngularUnit is based upon.
Friends
class	BCoordSysRepository

---

Constructor & Destructor Documentation

BAngularUnit

(

)

[inline]

Default constructor, which creates a BAngularUnit that is equivalent to degrees.

BAngularUnit

(

const BAngularUnit &

unit

)

[inline]

Copy constructor.

Parameters:

unit

The BAngularUnit object to copy.

BAngularUnit

(

const GeoCalc::ML::CAngularUnit &

au

)

Copy constructor that copies a GeoCalc CAngularUnit.

Parameters:

au

The GeoCalc linear unit object.

virtual ~BAngularUnit

(

)

[virtual]

Destructor.

---

Member Function Documentation

BAngularUnit& BAngularUnit::operator=

(

const BAngularUnit &

au

)

Assignment operator.

Parameters:

au

The BAngularUnit whose value will be copied into this BAngularUnit.

Returns:

This BAngularUnit.

virtual BString GetAbbreviation

(

void

)

const [virtual]

Gets the abbreviation (if it exists) for this BAngularUnit.

Returns:

The abbreviation for this BAngularUnit.

Implements BUnit.

const GeoCalc::ML::CAngularUnit* GetGCAngularUnit

(

)

const [protected]

Returns the GeoCalc CAngularUnit object that this BAngularUnit is based upon.

Returns:

The GeoCalc AngularUnit object.

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

Get the BIdentifier with the given issuer for this BAngularUnit.

Parameters:

	issuer	The issuer for the desired BIdentifier.
	identifier	The identifier for this BAngularUnit that has the specified issuer

Returns:

True if this BAngularUnit has a BIdentifier with the specified issuer and false otherwise.

Implements BUnit.

virtual BIdentifierVector GetIdentifiers

(

)

const [virtual]

Returns a collection containing all BIdentifiers for this BAngularUnit.

Returns:

A collection containing all BIdentifiers for this BAngularUnit.

Implements BUnit.

static BAngularUnitPtrVector GetListOfAvailableAngularUnits

(

)

[static]

Returns a list of all BAngularUnits that are defined in the current data source.

Returns:

A vector containing all available BAngularUnits.

virtual BString GetName

(

void

)

const [virtual]

Gets the proper name of the BAngularUnit.

Returns:

The proper name of the BAngularUnit.

Implements BUnit.

virtual EUnitType GetType

(

void

)

const [inline, virtual]

Gets the type of the BUnit.

Since this is a BAngularUnit, this will always return eAngularUnit.

Returns:

The type of this BUnit.

Implements BUnit.

virtual double GetUnitsPerBaseUnit

(

)

const [virtual]

Gets the base unit conversion factor for this unit.

The base unit for a BAngularUnit is always degrees. This value indicates the number of these units that correspond to one degree.

Returns:

The base unit conversion factor for this unit.

Implements BUnit.

double GetUnitsPerDegree

(

)

const

Gets the number of these units that correspond to one degree.

Returns:

The number of these units that correspond to one degree.

---

Friends And Related Function Documentation

friend class BCoordSysRepository [friend]

---

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

• BAngularUnit.h

---

GeoTranslate 5.0 From Blue Marble Geographics