IGSTK
Public Member Functions | List of all members
igstk::CoordinateSystemTransformToErrorResult Class Reference

This class is used a result of RequestComputeTransformTo when there is an error. More...

#include <igstkCoordinateSystemTransformToErrorResult.h>

Public Member Functions

 CoordinateSystemTransformToErrorResult ()
 
 CoordinateSystemTransformToErrorResult (const CoordinateSystemTransformToErrorResult &in)
 
CoordinateSystemTransformToErrorResultoperator= (const CoordinateSystemTransformToErrorResult &in)
 
void Initialize (const CoordinateSystem *src, const CoordinateSystem *dst)
 
void Clear ()
 Clears the pointers that the event is holding. More...
 
const CoordinateSystemGetSource () const
 Returns the source coordinate system. More...
 
const CoordinateSystemGetDestination () const
 Returns the destination coordinate system. More...
 

Detailed Description

This class is used a result of RequestComputeTransformTo when there is an error.

It encapsulates information about the source and destination coordinate systems.

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

Definition at line 38 of file igstkCoordinateSystemTransformToErrorResult.h.

Constructor & Destructor Documentation

igstk::CoordinateSystemTransformToErrorResult::CoordinateSystemTransformToErrorResult ( )
igstk::CoordinateSystemTransformToErrorResult::CoordinateSystemTransformToErrorResult ( const CoordinateSystemTransformToErrorResult in)

Member Function Documentation

CoordinateSystemTransformToErrorResult& igstk::CoordinateSystemTransformToErrorResult::operator= ( const CoordinateSystemTransformToErrorResult in)
void igstk::CoordinateSystemTransformToErrorResult::Initialize ( const CoordinateSystem src,
const CoordinateSystem dst 
)
void igstk::CoordinateSystemTransformToErrorResult::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.

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

Returns the source coordinate system.

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

Returns the destination coordinate system.


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