SPATREF::DATUM Class Reference

Datum specification. More...

#include <mi32/spatref.h>

List of all members.

Public Types

enum  IDNUM {
  IDNUM_Undefined = -1, IDNUM_Local = 2000, IDNUM_WGS_1984 = 2800, IDNUM_WGS_1972 = 2802,
  IDNUM_AustralianGeodetic_1966 = 2219, IDNUM_AustralianGeodetic_1984 = 2220, IDNUM_CampoInchauspe = 2233, IDNUM_CorregoAlegre = 2245,
  IDNUM_European_1950 = 2260, IDNUM_JGD2000 = 2304, IDNUM_NorthAmerican_1927 = 2346, IDNUM_NorthAmerican_1983 = 2347,
  IDNUM_NorthAmerican_1983_HARN = 2418, IDNUM_SouthAmerican_1969 = 2386, IDNUM_Tokyo = 2393, IDNUM_Astronomical_Unspecified = 2700,
  IDNUM_MeanSeaLevel = 2900
}
enum  TYPE {
  TYPE_Undefined = 0x0000, TYPE_Geodetic = 0x0002, TYPE_Vertical = 0x0004, TYPE_Engineering = 0x0008,
  TYPE_Temporal = 0x0010, TYPE_Image = 0x0020, TYPE_Astronomical = 0x0040, TYPES_GeorefObject = (TYPE_Geodetic | TYPE_Engineering | TYPE_Astronomical)
}

Public Member Functions

 DATUM (IDNUM idnum)
 DATUM (const DATUM &rhs)
 DATUM ()
 ~DATUM ()
ERRVALUE Assign (const XMLNODE *xmlnode)
ERRVALUE Assign (IDNUM IdNum)
ERRVALUE Assign (const IDENTIFIER &Id)
const MISTRINGGetAbbr () const
bool GetDftTransOp (const DATUM &datum, COORDOPDEF &CoordOpDef) const
const MILIST< COORDOPDEF > & GetDftTransOpList () const
void GetDisplay (MISTRING &string, int indent, GETDISPLAY flags=GETDISPLAY_None) const
const ELLIPSOIDGetEllipsoid () const
const IDENTIFIERLISTGetIdList () const
IDNUM GetIdNum () const
const MISTRINGGetName () const
const PRIMEMERIDIANGetPrimeMeridian () const
TYPE GetType () const
const TEXTRESITEMLISTGetValidAreaList () const
XMLNODEGetXML (XMLNODE *parentnode, const char *nodename="Datum") const
bool IsAllowedLegacy () const
bool IsConvertible () const
DATUMoperator= (const DATUM &rhs)

Static Public Member Functions

static TEXTID TypeToTextID (TYPE type)

Detailed Description

Datum specification.


Member Enumeration Documentation

Datum ID numbers.

Note, not all IDs in database are listed.

Enumerator:
IDNUM_Undefined 
IDNUM_Local 
IDNUM_WGS_1984 
IDNUM_WGS_1972 
IDNUM_AustralianGeodetic_1966 
IDNUM_AustralianGeodetic_1984 
IDNUM_CampoInchauspe 
IDNUM_CorregoAlegre 
IDNUM_European_1950 
IDNUM_JGD2000 
IDNUM_NorthAmerican_1927 
IDNUM_NorthAmerican_1983 
IDNUM_NorthAmerican_1983_HARN 
IDNUM_SouthAmerican_1969 
IDNUM_Tokyo 
IDNUM_Astronomical_Unspecified 
IDNUM_MeanSeaLevel 

Datum type enumeration.

Enumerator:
TYPE_Undefined 
TYPE_Geodetic 

Geodetic datum with ellipsoid and prime meridian.

TYPE_Vertical 

Vertical (gravity-based) datum.

TYPE_Engineering 

Engineering/Local datum.

TYPE_Temporal 

Temporal (time-based) datum.

TYPE_Image 

Image (pixel-based) datum.

TYPE_Astronomical 

Astronomical datum.

TYPES_GeorefObject 

Constructor & Destructor Documentation

SPATREF::DATUM::DATUM (  ) 

Default constructor.

SPATREF::DATUM::DATUM ( const DATUM rhs  ) 

Copy constructor.

SPATREF::DATUM::DATUM ( IDNUM  idnum  ) 

Construct using IDNUM.

If IDNUM is not valid then will be undefined.

SPATREF::DATUM::~DATUM (  ) 

Destructor.


Member Function Documentation

ERRVALUE SPATREF::DATUM::Assign ( const XMLNODE xmlnode  ) 

Assign from XMLNODE.

ERRVALUE SPATREF::DATUM::Assign ( IDNUM  IdNum  ) 

Assign by MicroImages ID number.

ERRVALUE SPATREF::DATUM::Assign ( const IDENTIFIER Id  ) 

Assign by IDENTIFIER.

const MISTRING& SPATREF::DATUM::GetAbbr (  )  const

Get abbreviation.

bool SPATREF::DATUM::GetDftTransOp ( const DATUM datum,
COORDOPDEF CoordOpDef 
) const

Get default COORDOPDEF for datum transformation.

Returns:
true if transformation available, false if not.
Parameters:
datum Datum to transform to
CoordOpDef Coordinate operation definition returned
const MILIST<COORDOPDEF>& SPATREF::DATUM::GetDftTransOpList (  )  const

Get default transformation operation definition list.

void SPATREF::DATUM::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 ELLIPSOID& SPATREF::DATUM::GetEllipsoid (  )  const

Get ellipsoid reference for geodetic datum.

Returns:
Ellipsoid reference.
const IDENTIFIERLIST& SPATREF::DATUM::GetIdList (  )  const

Get identifer list.

IDNUM SPATREF::DATUM::GetIdNum (  )  const

Get MicroImages identification number.

const MISTRING& SPATREF::DATUM::GetName (  )  const

Get name.

const PRIMEMERIDIAN& SPATREF::DATUM::GetPrimeMeridian (  )  const

Get prime meridian reference for geodetic datum.

TYPE SPATREF::DATUM::GetType (  )  const

Get datum type.

const TEXTRESITEMLIST& SPATREF::DATUM::GetValidAreaList (  )  const

Get list of valid area names.

XMLNODE* SPATREF::DATUM::GetXML ( XMLNODE parentnode,
const char *  nodename = "Datum" 
) const

Get XMLNODE representation.

Parameters:
nodename Parent for contain node to be created
bool SPATREF::DATUM::IsAllowedLegacy (  )  const

Determine if allowed in legacy (pre 7.0) structure.

bool SPATREF::DATUM::IsConvertible (  )  const

Determine if datum can be converted to other datums.

DATUM& SPATREF::DATUM::operator= ( const DATUM rhs  ) 

Assignment.

static TEXTID SPATREF::DATUM::TypeToTextID ( TYPE  type  )  [static]

Convert DATUM::TYPE to TEXTID.


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

Generated on Sun Oct 7 21:40:29 2012 for TNTsdk 2012 by  doxygen 1.6.1