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

srm::Direction Class Reference

The Direction abstract contains a vector and a reference location. More...

#include <Direction.h>

Collaboration diagram for srm::Direction:

Collaboration graph
[legend]
List of all members.

Public Member Functions

BaseSRF * getSRF () const
 Returns the SRF this Direction belongs to.

void getRefCoord (Coord3D &coord) const
 Gets the reference coordinate.

void getDir (Vector3 vec) const
 Gets the direction vector.

SRM_Long_Float getVectorComp1 () const
 Gets the first component value of the vector.

SRM_Long_Float getVectorComp2 () const
 Gets the second component value of the vector.

SRM_Long_Float getVectorComp3 () const
 Gets the third component value of the vector.

SRM_Long_Float getVectorComp (SRM_Integer index) const
 Gets the nth component value of the vector.

void setVectorComp (const SRM_Long_Float comp1, const SRM_Long_Float comp2, const SRM_Long_Float comp3)
 Sets the direction vector values.

void setVectorComp (const SRM_Integer index, const SRM_Long_Float comp)
 Sets the direction vector values.

void setVector (const Vector3 vec)
 Sets the direction vector values.

bool isEqual (const Direction &dir) const
 Returns true if this has the same ref_coord and vector.

Direction * makeCopy () const
 Makes a shallow copy of this Direction object.


Protected Member Functions

 Direction (BaseSRF *srf, const Vector3 ref_coord, const Vector3 vec)
 Constructor, requires an SRF, 3 reference coordinate values, and 3 direction values.

virtual ~Direction ()
 Destructor, releases the SRF.

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


Protected Attributes

BaseSRF * _srf
 The SRF this Direction belongs to.

Vector3 _ref_coord
 The reference coordinate values.

Vector3 _vec
 The direction values.


Friends

class BaseSRF_3D
class Orientation

Detailed Description

The Direction abstract contains a vector and a reference location.

Author:
Warren Macchi, David Shen
See also:
BaseSRF_3D

Definition at line 29 of file Direction.h.

Member Function Documentation

void srm::Direction::getRefCoord (  Coord3D &  coord  )  const
 

Gets the reference coordinate.

Exceptions:
This method throws srm::Exception

BaseSRF* srm::Direction::getSRF (   )  const [inline]
 

Returns the SRF this Direction belongs to.

Exceptions:
This method throws srm::Exception

Definition at line 36 of file Direction.h.

SRM_Long_Float srm::Direction::getVectorComp (  SRM_Integer  index  )  const
 

Gets the nth component value of the vector.

Exceptions:
This method throws srm::Exception
Note:
the index is [ 1, 2, 3 ]

void srm::Direction::setVectorComp (  const SRM_Integer  index,
const SRM_Long_Float  comp
) 
 

Sets the direction vector values.

Exceptions:
This method throws srm::Exception
Note:
the index is [ 1, 2, 3 ]

The documentation for this class was generated from the following file:
Spatial Reference Model C++ API Version 4.1 - 26 Jun 2006
Copyright © 2006 SEDRIS™ Docs by Doxygen 1.3.2