SPATREF::COORDAXIS Class Reference

Coordinate axis definition. More...

#include <mi32/spatref.h>

List of all members.

Public Types
enum	IDNUM {   IDNUM_Undefined = -1, IDNUM_None = 0, IDNUM_GeodeticLatitude = 1101, IDNUM_GeodeticLongitude = 1102,   IDNUM_EllipsoidalHeight = 1103, IDNUM_Easting = 1104, IDNUM_Northing = 1105, IDNUM_Westing = 1106,   IDNUM_Southing = 1107, IDNUM_GravityRelatedHeight = 1108, IDNUM_GravityRelatedDepth = 1109, IDNUM_GeocentricX = 1110,   IDNUM_GeocentricY = 1111, IDNUM_GeocentricZ = 1112, IDNUM_SphericalLatitude = 1113, IDNUM_SphericalLongitude = 1114,   IDNUM_GeocentricRadius = 1115, IDNUM_LocalX = 1116, IDNUM_LocalY = 1117, IDNUM_LocalZ = 1118,   IDNUM_ImageColumn = 1119, IDNUM_ImageRow = 1120, IDNUM_RightAscension = 1121, IDNUM_Declination = 1122 }
enum	SYMBOLUSAGE { SYMBOLUSAGE_Unspecified = 0, SYMBOLUSAGE_Positive = 1, SYMBOLUSAGE_Negative = 2 }
Public Member Functions
	COORDAXIS (const COORDAXIS &rhs)
	COORDAXIS ()
	~COORDAXIS ()
ERRVALUE	Assign (const XMLNODE *xmlnode)
ERRVALUE	Assign (IDNUM IdNum)
ERRVALUE	Assign (const IDENTIFIER &Id)
ERRVALUE	Create (const UOM::UNIT &unit, const MISTRING &name, const MISTRING &SymbolPositive, const MISTRING &SymbolNegative)
const MISTRING &	GetAbbr () const
void	GetDisplay (MISTRING &string, int indent, GETDISPLAY flags=GETDISPLAY_None) const
const IDENTIFIERLIST &	GetIdList () const
IDNUM	GetIdNum () const
const MISTRING &	GetName () const
MISTRING	GetNameFitted (int maxchars, bool IncludeUnitSymbol) const
const MISTRING &	GetSymbol (SYMBOLUSAGE usage=SYMBOLUSAGE_Unspecified) const
const UOM::UNIT &	GetUnit () const
const DOUBLE_RANGE &	GetValidRange () const
XMLNODE *	GetXML (XMLNODE *parentnode, const char *nodename="CoordAxis") const
bool	HasSymbolNegative () const
COORDAXIS &	operator= (const COORDAXIS &rhs)
void	SetName (const MISTRING &textitem)
void	SetSymbolNegative (const MISTRING &symbol)
void	SetSymbolPositive (const MISTRING &symbol)
void	SetUnit (const UOM::UNIT &unit)
void	SetValidRange (const DOUBLE_RANGE &ValidRange)

---

Detailed Description

Coordinate axis definition.

---

Member Enumeration Documentation

enum SPATREF::COORDAXIS::IDNUM

Coordinate Axis ID numbers.

Enumerator:

IDNUM_Undefined
IDNUM_None
IDNUM_GeodeticLatitude
IDNUM_GeodeticLongitude
IDNUM_EllipsoidalHeight
IDNUM_Easting
IDNUM_Northing
IDNUM_Westing
IDNUM_Southing
IDNUM_GravityRelatedHeight
IDNUM_GravityRelatedDepth
IDNUM_GeocentricX
IDNUM_GeocentricY
IDNUM_GeocentricZ
IDNUM_SphericalLatitude
IDNUM_SphericalLongitude
IDNUM_GeocentricRadius
IDNUM_LocalX
IDNUM_LocalY
IDNUM_LocalZ
IDNUM_ImageColumn
IDNUM_ImageRow
IDNUM_RightAscension
IDNUM_Declination

enum SPATREF::COORDAXIS::SYMBOLUSAGE

Enumerator:

SYMBOLUSAGE_Unspecified
SYMBOLUSAGE_Positive
SYMBOLUSAGE_Negative

---

Constructor & Destructor Documentation

SPATREF::COORDAXIS::COORDAXIS

(

)

Default constructor.

SPATREF::COORDAXIS::COORDAXIS

(

const COORDAXIS &

rhs

)

Copy constructor.

SPATREF::COORDAXIS::~COORDAXIS

(

)

Destructor.

---

Member Function Documentation

ERRVALUE SPATREF::COORDAXIS::Assign

(

const XMLNODE *

xmlnode

)

Assign from XMLNODE.

ERRVALUE SPATREF::COORDAXIS::Assign

(

IDNUM

IdNum

)

Assign by MicroImages ID number.

ERRVALUE SPATREF::COORDAXIS::Assign

(

const IDENTIFIER &

Id

)

Assign by IDENTIFIER.

ERRVALUE SPATREF::COORDAXIS::Create	(	const UOM::UNIT &	unit,
		const MISTRING &	name,
		const MISTRING &	SymbolPositive,
		const MISTRING &	SymbolNegative
	)

Create coordinate axis.

Parameters:

	unit	Coordinate unit
	name	Axis name
	SymbolPositive	Symbol for coordinate
	SymbolNegative	Symbol for negative coordinate, blank if same as for positive

const MISTRING& SPATREF::COORDAXIS::GetAbbr

(

)

const

Get abbreviation.

void SPATREF::COORDAXIS::GetDisplay	(	MISTRING &	string,
		int	indent,
		GETDISPLAY	flags = GETDISPLAY_None
	)			const

Get multiline string suitable for display.

Parameters:

	string	String returned, will be initially cleared if indent is 0
	indent	Indent level
	flags	Flags for extra items to display

const IDENTIFIERLIST& SPATREF::COORDAXIS::GetIdList

(

)

const

Get identifer list.

IDNUM SPATREF::COORDAXIS::GetIdNum

(

)

const

Get MicroImages identification number.

const MISTRING& SPATREF::COORDAXIS::GetName

(

)

const

Get name.

MISTRING SPATREF::COORDAXIS::GetNameFitted	(	int	maxchars,
		bool	IncludeUnitSymbol
	)			const

Get name fitted to limited space.

Used where name is displayed in limited space such as a table column heading or field name. Returned name may contain spaces, and may contain symbol for axis if no other availble name will fit. If unit symbol is included, returned string will be in the form of "name (unitsym)".

Parameters:

	maxchars	Maximum string length returned
	IncludeUnitSymbol	Include unit symbol in name

const MISTRING& SPATREF::COORDAXIS::GetSymbol

(

SYMBOLUSAGE

usage = SYMBOLUSAGE_Unspecified

)

const

Get symbol for specified usage.

const UOM::UNIT& SPATREF::COORDAXIS::GetUnit

(

)

const

Get axis measurement unit.

const DOUBLE_RANGE& SPATREF::COORDAXIS::GetValidRange

(

)

const

Get valid range for ordinates on this axis.

Returns:

Valid range, will be arbitrarily large if no valid range defined.

XMLNODE* SPATREF::COORDAXIS::GetXML	(	XMLNODE *	parentnode,
		const char *	nodename = "CoordAxis"
	)			const

Get XMLNODE representation.

Parameters:

nodename

Parent for contain node to be created

bool SPATREF::COORDAXIS::HasSymbolNegative

(

)

const

Determine if has different symbol for negative values than for positive.

COORDAXIS& SPATREF::COORDAXIS::operator=

(

const COORDAXIS &

rhs

)

Assignment.

void SPATREF::COORDAXIS::SetName

(

const MISTRING &

textitem

)

Set name for axis.

void SPATREF::COORDAXIS::SetSymbolNegative

(

const MISTRING &

symbol

)

Set symbol for reporting 'negative' values.

void SPATREF::COORDAXIS::SetSymbolPositive

(

const MISTRING &

symbol

)

Set symbol for reporting 'positive' values.

Will use for all values if no 'negative' symbol specified.

void SPATREF::COORDAXIS::SetUnit

(

const UOM::UNIT &

unit

)

Set new measurement unit for axis.

Does not alter valid range if any.

void SPATREF::COORDAXIS::SetValidRange

(

const DOUBLE_RANGE &

ValidRange

)

Set valid range for axis values.

Parameters:

ValidRange

Range to set

---

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

• mi32/spatref.h