igstk::CoordinateSystemTransformToResult Class Reference

This class encapsulates the results of asking the coordinate reference system for a transform to another coordinate reference system. More...

#include <igstkCoordinateSystemTransformToResult.h>

Collaboration diagram for igstk::CoordinateSystemTransformToResult:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 CoordinateSystemTransformToResult ()
 Constructor.
 CoordinateSystemTransformToResult (const CoordinateSystemTransformToResult &in)
 Copy constructor.
const
CoordinateSystemTransformToResult
operator= (const CoordinateSystemTransformToResult &in)
 Assignment operator.
void Clear ()
 Clears the pointers that the event is holding.
void Initialize (const Transform &transform, const CoordinateSystem *source, const CoordinateSystem *destination)
 Sets the transform, source, and destination coordinate systems.
template<class TSource , class TDestination >
void Initialize (const Transform &transform, const TSource *sourceObject, const TDestination *destinationObject)
 Sets the transform, source, and destination coordinate systems from two given objects that respectively own coordinate systems.
const TransformGetTransform () const
 Returns the computed transform.
const CoordinateSystemGetSource () const
 Returns the source coordinate system.
const CoordinateSystemGetDestination () const
 Returns the destination coordinate system.


Detailed Description

This class encapsulates the results of asking the coordinate reference system for a transform to another coordinate reference system.

It is meant to be used as payload in an event that is created after a successful call to RequestTransformTo().

Definition at line 38 of file igstkCoordinateSystemTransformToResult.h.


Constructor & Destructor Documentation

igstk::CoordinateSystemTransformToResult::CoordinateSystemTransformToResult (  ) 

Constructor.

igstk::CoordinateSystemTransformToResult::CoordinateSystemTransformToResult ( const CoordinateSystemTransformToResult in  ) 

Copy constructor.


Member Function Documentation

const CoordinateSystemTransformToResult& igstk::CoordinateSystemTransformToResult::operator= ( const CoordinateSystemTransformToResult in  ) 

Assignment operator.

void igstk::CoordinateSystemTransformToResult::Clear (  ) 

Clears the pointers that the event is holding.

This should be called after the event is received to remove unnecessary smart pointer references to coordinate systems.

void igstk::CoordinateSystemTransformToResult::Initialize ( const Transform transform,
const CoordinateSystem source,
const CoordinateSystem destination 
)

Sets the transform, source, and destination coordinate systems.

template<class TSource , class TDestination >
void igstk::CoordinateSystemTransformToResult::Initialize ( const Transform transform,
const TSource *  sourceObject,
const TDestination *  destinationObject 
) [inline]

Sets the transform, source, and destination coordinate systems from two given objects that respectively own coordinate systems.

Definition at line 68 of file igstkCoordinateSystemTransformToResult.h.

const Transform& igstk::CoordinateSystemTransformToResult::GetTransform (  )  const

Returns the computed transform.

const CoordinateSystem* igstk::CoordinateSystemTransformToResult::GetSource (  )  const

Returns the source coordinate system.

const CoordinateSystem* igstk::CoordinateSystemTransformToResult::GetDestination (  )  const

Returns the destination coordinate system.


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

Generated on Thu Feb 12 09:45:56 2009 for IGSTK by  doxygen 1.5.8