SPATREF::COORDOPPARM Class Reference

Coordinate operation parameter definition. More...

#include <mi32/spatref.h>

List of all members.

Public Types

enum  ANGLETYPE {
  ANGLETYPE_Invalid = 0, ANGLETYPE_General = 1, ANGLETYPE_Longitude = 2, ANGLETYPE_Latitude = 3,
  ANGLETYPE_RightAscension = 4, ANGLETYPE_Declination = 5
}
enum  IDNUM {
  IDNUM_Undefined = -1, IDNUM_LatitudeOffset = 1501, IDNUM_LongitudeOffset = 1502, IDNUM_VerticalOffset = 1503,
  IDNUM_GeoidUndulation = 1504, IDNUM_X_AxisTranslation = 1505, IDNUM_Y_AxisTranslation = 1506, IDNUM_Z_AxisTranslation = 1507,
  IDNUM_X_AxisRotation = 1508, IDNUM_Y_AxisRotation = 1509, IDNUM_Z_AxisRotation = 1510, IDNUM_ScaleDifference = 1511,
  IDNUM_ScaleFactorForSourceCRSFirstAxis = 1512, IDNUM_ScaleFactorForSourceCRSSecondAxis = 1513, IDNUM_RotationAngleOfSourceCRSAxes = 1514, IDNUM_RotationAngleOfSourceCRSFirstAxis = 1515,
  IDNUM_RotationAngleOfSourceCRSSecondAxis = 1516, IDNUM_Ordinate1OfEvaluationPoint = 1517, IDNUM_Ordinate2OfEvaluationPoint = 1518, IDNUM_Ordinate3OfEvaluationPoint = 1519,
  IDNUM_Ordinate1OfEvaluationPointInSourceCRS = 1520, IDNUM_Ordinate2OfEvaluationPointInSourceCRS = 1521, IDNUM_Ordinate1OfEvaluationPointInTargetCRS = 1522, IDNUM_Ordinate2OfEvaluationPointInTargetCRS = 1523,
  IDNUM_SemiMajorAxisLengthDifference = 1526, IDNUM_FlatteningDifference = 1527, IDNUM_LatitudeAndLongitudeDifferenceFile = 1528, IDNUM_LatitudeDifferenceFile = 1529,
  IDNUM_LongitudeDifferenceFile = 1530, IDNUM_PointScaleFactor = 1531, IDNUM_EastingAndNorthingDifferenceFile = 1532, IDNUM_MaritimeProvinceResidualFile = 1533,
  IDNUM_GeoideModelFile = 1534, IDNUM_ScalingFactorForSourceCRSCoordDifferences = 1535, IDNUM_ScalingFactorForTargetCRSCoordDifferences = 1536, IDNUM_ScalingFactorForCoordDifferences = 1537,
  IDNUM_LatitudeOfNaturalOrigin = 1538, IDNUM_LongitudeOfNaturalOrigin = 1539, IDNUM_ScaleFactorAtNaturalOrigin = 1540, IDNUM_FalseEasting = 1541,
  IDNUM_FalseNorthing = 1542, IDNUM_LatitudeOfProjectionCenter = 1543, IDNUM_LongitudeOfProjectionCenter = 1544, IDNUM_AzimuthOfInitialLine = 1545,
  IDNUM_AngleFromRectifiedToSkewGrid = 1546, IDNUM_ScaleFactorOnInitialLine = 1547, IDNUM_EastingAtProjectionCenter = 1548, IDNUM_NorthingAtProjectionCenter = 1549,
  IDNUM_LatitudeOfPseudoStandardParallel = 1550, IDNUM_ScaleFactorOnPseudoStandardParallel = 1551, IDNUM_LatitudeOfFalseOrigin = 1552, IDNUM_LongitudeOfFalseOrigin = 1553,
  IDNUM_LatitudeOf1stStandardParallel = 1554, IDNUM_LatitudeOf2ndStandardParallel = 1555, IDNUM_EastingAtFalseOrigin = 1556, IDNUM_NorthingAtFalseOrigin = 1557,
  IDNUM_SphericalLatitudeOfOrigin = 1558, IDNUM_SphericalLongitudeOfOrigin = 1559, IDNUM_InitialLongitude = 1560, IDNUM_ZoneWidth = 1561,
  IDNUM_HeightAboveEllipsoid = 1563, IDNUM_IsSkewed = 1564, IDNUM_LandsatNumber = 1565, IDNUM_SatellitePath = 1566,
  IDNUM_X_AxisTranslationRev = 1567, IDNUM_Y_AxisTranslationRev = 1568, IDNUM_Z_AxisTranslationRev = 1569, IDNUM_X_AxisRotationRev = 1570,
  IDNUM_Y_AxisRotationRev = 1571, IDNUM_Z_AxisRotationRev = 1572, IDNUM_ScaleDifferenceRev = 1573, IDNUM_LatitudeOfStandardParallel = 1576,
  IDNUM_RightAscensionOfProjectionCenter = 1578, IDNUM_DeclinationOfProjectionCenter = 1579, IDNUM_LatitudeOfPoint1 = 1580, IDNUM_LongitudeOfPoint1 = 1581,
  IDNUM_LatitudeOfPoint2 = 1582, IDNUM_LongitudeOfPoint2 = 1583, IDNUM_CoefficientA0 = 1600, IDNUM_CoefficientB0 = 1700
}
enum  TYPE { TYPE_Invalid = 0, TYPE_Boolean = 1, TYPE_Number = 2, TYPE_String = 3 }

Public Member Functions

 COORDOPPARM (const COORDOPPARM &rhs)
 COORDOPPARM ()
 ~COORDOPPARM ()
ERRVALUE Assign (const XMLNODE *xmlnode)
ANGLETYPE GetAngleType () const
const MISTRING & GetDescription () const
void GetDisplay (MISTRING &string, int indent, GETDISPLAY flags=GETDISPLAY_None) const
bool GetDisplayStrs (MISTRING &valstr, MISTRING &unitstr, bool Strip0=false) const
const IDENTIFIERLIST & GetIdList () const
IDNUM GetIdNum () const
const MISTRING & GetName () const
TYPE GetType () const
const UOM::UNIT & GetUnit () const
bool GetValue (MISTRING &value) const
bool GetValue (STRUTF8 &value) const
bool GetValue (bool &value) const
bool GetValue (double &value) const
XMLNODE * GetXML (XMLNODE *parentnode, const char *nodename="CoordOpParm") const
bool HasValue () const
bool IsOptional () const
COORDOPPARM & operator= (const COORDOPPARM &rhs)
ERRVALUE Set (IDNUM IdNum, const STRUTF8 &string)
ERRVALUE Set (IDNUM IdNum, const MISTRING &string)
ERRVALUE Set (IDNUM IdNum, double value, const UOM::UNIT &unit)
ERRVALUE Set (IDNUM IdNum, double value, UOM::IDNUM UnitIdNum=UOM::IDNUM_Unspecified)
ERRVALUE Set (IDNUM IdNum, int value)
ERRVALUE Set (IDNUM IdNum, bool value)

Static Public Member Functions

static ANGLETYPE IdNumToAngleType (IDNUM idnum)
static IDNUM LookupIdNum (const IDENTIFIER &Id)

Detailed Description

Coordinate operation parameter definition.

Member Enumeration Documentation

enum SPATREF::COORDOPPARM::ANGLETYPE
Enumerator:
ANGLETYPE_Invalid 
ANGLETYPE_General 
ANGLETYPE_Longitude 
ANGLETYPE_Latitude 
ANGLETYPE_RightAscension 
ANGLETYPE_Declination 
enum SPATREF::COORDOPPARM::IDNUM

Coordinate Operation Parameter ID numbers.

Enumerator:
IDNUM_Undefined 
IDNUM_LatitudeOffset 
IDNUM_LongitudeOffset 
IDNUM_VerticalOffset 
IDNUM_GeoidUndulation 
IDNUM_X_AxisTranslation 
IDNUM_Y_AxisTranslation 
IDNUM_Z_AxisTranslation 
IDNUM_X_AxisRotation 
IDNUM_Y_AxisRotation 
IDNUM_Z_AxisRotation 
IDNUM_ScaleDifference 
IDNUM_ScaleFactorForSourceCRSFirstAxis 
IDNUM_ScaleFactorForSourceCRSSecondAxis 
IDNUM_RotationAngleOfSourceCRSAxes 
IDNUM_RotationAngleOfSourceCRSFirstAxis 
IDNUM_RotationAngleOfSourceCRSSecondAxis 
IDNUM_Ordinate1OfEvaluationPoint 
IDNUM_Ordinate2OfEvaluationPoint 
IDNUM_Ordinate3OfEvaluationPoint 
IDNUM_Ordinate1OfEvaluationPointInSourceCRS 
IDNUM_Ordinate2OfEvaluationPointInSourceCRS 
IDNUM_Ordinate1OfEvaluationPointInTargetCRS 
IDNUM_Ordinate2OfEvaluationPointInTargetCRS 
IDNUM_SemiMajorAxisLengthDifference 
IDNUM_FlatteningDifference 
IDNUM_LatitudeAndLongitudeDifferenceFile 
IDNUM_LatitudeDifferenceFile 
IDNUM_LongitudeDifferenceFile 
IDNUM_PointScaleFactor 
IDNUM_EastingAndNorthingDifferenceFile 
IDNUM_MaritimeProvinceResidualFile 
IDNUM_GeoideModelFile 
IDNUM_ScalingFactorForSourceCRSCoordDifferences 
IDNUM_ScalingFactorForTargetCRSCoordDifferences 
IDNUM_ScalingFactorForCoordDifferences 
IDNUM_LatitudeOfNaturalOrigin 
IDNUM_LongitudeOfNaturalOrigin 
IDNUM_ScaleFactorAtNaturalOrigin 
IDNUM_FalseEasting 
IDNUM_FalseNorthing 
IDNUM_LatitudeOfProjectionCenter 
IDNUM_LongitudeOfProjectionCenter 
IDNUM_AzimuthOfInitialLine 
IDNUM_AngleFromRectifiedToSkewGrid 
IDNUM_ScaleFactorOnInitialLine 
IDNUM_EastingAtProjectionCenter 
IDNUM_NorthingAtProjectionCenter 
IDNUM_LatitudeOfPseudoStandardParallel 
IDNUM_ScaleFactorOnPseudoStandardParallel 
IDNUM_LatitudeOfFalseOrigin 
IDNUM_LongitudeOfFalseOrigin 
IDNUM_LatitudeOf1stStandardParallel 
IDNUM_LatitudeOf2ndStandardParallel 
IDNUM_EastingAtFalseOrigin 
IDNUM_NorthingAtFalseOrigin 
IDNUM_SphericalLatitudeOfOrigin 
IDNUM_SphericalLongitudeOfOrigin 
IDNUM_InitialLongitude 
IDNUM_ZoneWidth 
IDNUM_HeightAboveEllipsoid 
IDNUM_IsSkewed 
IDNUM_LandsatNumber 
IDNUM_SatellitePath 
IDNUM_X_AxisTranslationRev 
IDNUM_Y_AxisTranslationRev 
IDNUM_Z_AxisTranslationRev 
IDNUM_X_AxisRotationRev 
IDNUM_Y_AxisRotationRev 
IDNUM_Z_AxisRotationRev 
IDNUM_ScaleDifferenceRev 
IDNUM_LatitudeOfStandardParallel 
IDNUM_RightAscensionOfProjectionCenter 
IDNUM_DeclinationOfProjectionCenter 
IDNUM_LatitudeOfPoint1 
IDNUM_LongitudeOfPoint1 
IDNUM_LatitudeOfPoint2 
IDNUM_LongitudeOfPoint2 
IDNUM_CoefficientA0 
IDNUM_CoefficientB0 
enum SPATREF::COORDOPPARM::TYPE

CoordOpParm type enumeration.

Enumerator:
TYPE_Invalid 
TYPE_Boolean 
TYPE_Number 
TYPE_String 

Constructor & Destructor Documentation

SPATREF::COORDOPPARM::COORDOPPARM (  ) 

Default constructor.

SPATREF::COORDOPPARM::COORDOPPARM ( const COORDOPPARM &  rhs  ) 

Copy constructor.

SPATREF::COORDOPPARM::~COORDOPPARM (  ) 

Destructor.

Member Function Documentation

ERRVALUE SPATREF::COORDOPPARM::Assign ( const XMLNODE *  xmlnode  ) 

Assign from XMLNODE.

ANGLETYPE SPATREF::COORDOPPARM::GetAngleType (  )  const

Get 'angle type'.

const MISTRING& SPATREF::COORDOPPARM::GetDescription (  )  const

Get description.

void SPATREF::COORDOPPARM::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
bool SPATREF::COORDOPPARM::GetDisplayStrs ( MISTRING &  valstr,
MISTRING &  unitstr,
bool  Strip0 = false 
) const

Get formatted value and unit strings for display based on type.

Returns:
true if has value, false if not
Parameters:
valstr Value string returned
unitstr Unit string returned
Strip0 Strip trailing zeros from value
const IDENTIFIERLIST& SPATREF::COORDOPPARM::GetIdList (  )  const

Get identifer list.

IDNUM SPATREF::COORDOPPARM::GetIdNum (  )  const

Get MicroImages identification number.

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

Get name.

TYPE SPATREF::COORDOPPARM::GetType (  )  const

Get parameter type.

const UOM::UNIT& SPATREF::COORDOPPARM::GetUnit (  )  const [inline]

Get measurement unit.

bool SPATREF::COORDOPPARM::GetValue ( MISTRING &  value  )  const

Get string, filename or URL value as MISTRING.

Returns:
true if successful, false if value not set.
Parameters:
value Value returned if available
bool SPATREF::COORDOPPARM::GetValue ( STRUTF8 &  value  )  const

Get string, filename or URL value as STRUTF8.

Returns:
true if successful, false if value not set.
Parameters:
value Value returned if available
bool SPATREF::COORDOPPARM::GetValue ( bool &  value  )  const

Get boolean value.

Returns:
true if successful, false if value not boolean or not set.
Parameters:
value Value returned if available
bool SPATREF::COORDOPPARM::GetValue ( double &  value  )  const

Get numeric value.

Returns:
true if successful, false if value not numeric or not set.
Parameters:
value Value returned if available
XMLNODE* SPATREF::COORDOPPARM::GetXML ( XMLNODE *  parentnode,
const char *  nodename = "CoordOpParm" 
) const

Get XMLNODE representation.

Parameters:
nodename Parent for contain node to be created
bool SPATREF::COORDOPPARM::HasValue (  )  const [inline]

Determine if has value set.

static ANGLETYPE SPATREF::COORDOPPARM::IdNumToAngleType ( IDNUM  idnum  )  [static]

Convert IDNUM to AngleType.

bool SPATREF::COORDOPPARM::IsOptional (  )  const [inline]

Determine if parameter is optional.

Only useful when accessing method parameter list.

static IDNUM SPATREF::COORDOPPARM::LookupIdNum ( const IDENTIFIER &  Id  )  [static]

Lookup IDNUM given IDENTIFIER.

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

Assignment.

ERRVALUE SPATREF::COORDOPPARM::Set ( IDNUM  IdNum,
const STRUTF8 &  string 
)

Set IDNUM and value from STRUTF8.

ERRVALUE SPATREF::COORDOPPARM::Set ( IDNUM  IdNum,
const MISTRING &  string 
)

Set IDNUM and value from MISTRING.

ERRVALUE SPATREF::COORDOPPARM::Set ( IDNUM  IdNum,
double  value,
const UOM::UNIT &  unit 
)

Set IDNUM, numeric value and UNIT.

ERRVALUE SPATREF::COORDOPPARM::Set ( IDNUM  IdNum,
double  value,
UOM::IDNUM  UnitIdNum = UOM::IDNUM_Unspecified 
)

Set IDNUM, numeric value and unit if applicable.

ERRVALUE SPATREF::COORDOPPARM::Set ( IDNUM  IdNum,
int  value 
)

Set IDNUM and unitless integer value.

ERRVALUE SPATREF::COORDOPPARM::Set ( IDNUM  IdNum,
bool  value 
)

Set IDNUM and boolean value.

The documentation for this class was generated from the following file:
Generated on Sun Oct 7 21:40:28 2012 for TNTsdk 2012 by  doxygen 1.6.1