Main Page | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members

srm::SRF_Celestiocentric Class Reference

SRF_Celestiocentric class declaration. More...

#include <Celestiocentric.h>

Inheritance diagram for srm::SRF_Celestiocentric:

Inheritance graph
[legend]
Collaboration diagram for srm::SRF_Celestiocentric:

Collaboration graph
[legend]
List of all members.

Public Member Functions

Coord3DcreateCoordinate3D (SRM_Long_Float coord_comp1, SRM_Long_Float coord_comp2, SRM_Long_Float coord_comp3)
 Returns a 3D coordinate object.

virtual bool isA (SRF_ClassType type) const
 Returns true if this SRF is of the given class type.

virtual SRF_ClassType getClassType () const
 Returns the class type of this SRF instance.

bool isEqual (const SRF_Celestiocentric &srf) const
 Returns true if the SRF parameters are equal.

bool operator== (const SRF_Celestiocentric &rhs) const
 The equality operator.

SRF_CelestiocentricmakeCopy () const
 Returns a copy of this SRF object.

virtual SRM_Coordinate_Valid_Region changeCoordinate3DSRF (const Coord3D &src_coord, Coord3D &des_coord)
 Changes a coordinate's values to this SRF (optimized implementation).

const char * toString ()
 Returns char* of parameter names and their values.


Static Public Member Functions

SRF_Celestiocentriccreate (SRM_ORM_Code orm, SRM_RT_Code rt)
 SRF_Celestiocentric only constructor by ORM code.

SRF_Celestiocentriccreate (SRM_SRF_Parameters_Info srf_params)
 SRF_Celestiocentric constructor by ORM parameters.


Protected Member Functions

 SRF_Celestiocentric (void *impl)
 No stack allocation.

SRF_Celestiocentricoperator= (const SRF_Celestiocentric &)
 No copy constructor.

virtual ~SRF_Celestiocentric ()
 Use release().


Friends

class BaseSRF

Detailed Description

SRF_Celestiocentric class declaration.

SRFs are allocated by the API, and when no longer needed they should be released by calling the release() method.

Author:
David Shen
See also:
BaseSRF_3D

Definition at line 91 of file Celestiocentric.h.


Member Function Documentation

virtual SRM_Coordinate_Valid_Region srm::SRF_Celestiocentric::changeCoordinate3DSRF const Coord3D src_coord,
Coord3D des_coord
[virtual]
 

Changes a coordinate's values to this SRF (optimized implementation).

Note:
The destination coordinate must have been created using this SRF.
Parameters:
src_coord in: the source coordinate in some other SRF
des_coord in/out: the destination coordinate in this SRF
Returns:
validity code for the destination coordinate
Exceptions:
This method throws srm::Exception

Reimplemented from srm::BaseSRF_3D.

SRF_Celestiocentric* srm::SRF_Celestiocentric::create SRM_SRF_Parameters_Info  srf_params  )  [inline, static]
 

SRF_Celestiocentric constructor by ORM parameters.

Exceptions:
This method throws srm::Exception

Definition at line 103 of file Celestiocentric.h.

SRF_Celestiocentric* srm::SRF_Celestiocentric::create SRM_ORM_Code  orm,
SRM_RT_Code  rt
[static]
 

SRF_Celestiocentric only constructor by ORM code.

Exceptions:
This method throws srm::Exception

bool srm::SRF_Celestiocentric::isEqual const SRF_Celestiocentric srf  )  const
 

Returns true if the SRF parameters are equal.

Note:
This method is deprecated. Use the equality operator instead.

SRF_Celestiocentric* srm::SRF_Celestiocentric::makeCopy  )  const
 

Returns a copy of this SRF object.

Exceptions:
This method throws srm::Exception

bool srm::SRF_Celestiocentric::operator== const SRF_Celestiocentric rhs  )  const
 

The equality operator.

Note:
This operator returns true if the SRFs have identical parameter values.

const char* srm::SRF_Celestiocentric::toString  )  [virtual]
 

Returns char* of parameter names and their values.

Exceptions:
This method throws srm::Exception

Implements srm::BaseSRF.


The documentation for this class was generated from the following file:
Spatial Reference Model C++ API Version 4.4 - December 7, 2009
Copyright © 2009 SEDRIS Docs by Doxygen 1.3.2