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

srm::SRF_LococentricEuclidean3D Class Reference

SRF_LococentricEuclidean3D class declaration. More...

#include <LococentricEuclidean3D.h>

Inheritance diagram for srm::SRF_LococentricEuclidean3D:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

Coord3D * createCoordinate3D (SRM_Long_Float coord_comp1, SRM_Long_Float coord_comp2, SRM_Long_Float coord_comp3)
 Returns a 3D coordinate object.

const SRM_LCE_3D_Parameters & getSRFParameters () const
 Returns a reference to the SRF parameter structure.

void get_lococentre (SRM_Vector_3D &lococentre)
 Returns the lococentre SRF parameter value.

void get_primary_axis (SRM_Vector_3D &primary_axis)
 Returns the primary_axis SRF parameter value.

void get_secondary_axis (SRM_Vector_3D &secondary_axis)
 Returns the secondary_axis SRF parameter value.

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_LococentricEuclidean3D &srf) const
 Returns true if the SRF parameters are equal.

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

SRF_LococentricEuclidean3D * makeCopy () 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_LococentricEuclidean3D * create (SRM_ORM_Code orm, SRM_RT_Code rt, const SRM_LCE_3D_Parameters &params)
 Constructor by SRF parameter structure.

SRF_LococentricEuclidean3D * create (SRM_ORM_Code orm, SRM_RT_Code rt, const SRM_Vector_3D &lococentre, const SRM_Vector_3D &primary_axis, const SRM_Vector_3D &secondary_axis)
 Constructor by individual SRF parameters.

SRF_LococentricEuclidean3D * create (SRM_SRF_Parameters_Info srf_params)
 SRF_LococentricEuclidean3D constructor by SRF parameter structure.


Protected Member Functions

 SRF_LococentricEuclidean3D (void *impl)
 No stack allocation.

SRF_LococentricEuclidean3D & operator= (const SRF_LococentricEuclidean3D &)
 No copy constructor.

virtual ~SRF_LococentricEuclidean3D ()
 Use release().

Detailed Description

SRF_LococentricEuclidean3D 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 LococentricEuclidean3D.h.

Member Function Documentation

virtual SRM_Coordinate_Valid_Region srm::SRF_LococentricEuclidean3D::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_LococentricEuclidean3D* srm::SRF_LococentricEuclidean3D::create (  SRM_SRF_Parameters_Info  srf_params  )  [inline, static]
 

SRF_LococentricEuclidean3D constructor by SRF parameter structure.

Exceptions:
This method throws srm::Exception

Definition at line 115 of file LococentricEuclidean3D.h.

SRF_LococentricEuclidean3D* srm::SRF_LococentricEuclidean3D::create (  SRM_ORM_Code  orm,
SRM_RT_Code  rt,
const SRM_Vector_3D &  lococentre,
const SRM_Vector_3D &  primary_axis,
const SRM_Vector_3D &  secondary_axis
)  [static]
 

Constructor by individual SRF parameters.

Exceptions:
This method throws srm::Exception

SRF_LococentricEuclidean3D* srm::SRF_LococentricEuclidean3D::create (  SRM_ORM_Code  orm,
SRM_RT_Code  rt,
const SRM_LCE_3D_Parameters &  params
)  [static]
 

Constructor by SRF parameter structure.

Exceptions:
This method throws srm::Exception

void srm::SRF_LococentricEuclidean3D::get_lococentre (  SRM_Vector_3D &  lococentre  ) 
 

Returns the lococentre SRF parameter value.

Exceptions:
This method throws srm::Exception

void srm::SRF_LococentricEuclidean3D::get_primary_axis (  SRM_Vector_3D &  primary_axis  ) 
 

Returns the primary_axis SRF parameter value.

Exceptions:
This method throws srm::Exception

void srm::SRF_LococentricEuclidean3D::get_secondary_axis (  SRM_Vector_3D &  secondary_axis  ) 
 

Returns the secondary_axis SRF parameter value.

Exceptions:
This method throws srm::Exception

const SRM_LCE_3D_Parameters& srm::SRF_LococentricEuclidean3D::getSRFParameters (   )  const
 

Returns a reference to the SRF parameter structure.

Exceptions:
This method throws srm::Exception

bool srm::SRF_LococentricEuclidean3D::isEqual (  const SRF_LococentricEuclidean3D &  srf  )  const
 

Returns true if the SRF parameters are equal.

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

SRF_LococentricEuclidean3D* srm::SRF_LococentricEuclidean3D::makeCopy (   )  const
 

Returns a copy of this SRF object.

Exceptions:
This method throws srm::Exception

bool srm::SRF_LococentricEuclidean3D::operator== (  const SRF_LococentricEuclidean3D &  rhs  )  const
 

The equality operator.

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

const char* srm::SRF_LococentricEuclidean3D::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