IGSTK
Protected Types | Protected Member Functions

igstk::OpenIGTLinkVideoImager Class Reference

This imager provides support for socket communication (using the Open IGTLink protocol) to the OpenIGTLink system. More...

#include <igstkOpenIGTLinkVideoImager.h>

Inheritance diagram for igstk::OpenIGTLinkVideoImager:
Inheritance graph
[legend]
Collaboration diagram for igstk::OpenIGTLinkVideoImager:
Collaboration graph
[legend]

List of all members.

Protected Types

typedef VideoImager::ResultType ResultType
 Typedef for internal boolean return type.

Protected Member Functions

 OpenIGTLinkVideoImager (void)
virtual ~OpenIGTLinkVideoImager (void)
virtual ResultType InternalOpen (void)
 Open communication with the tracking device.
virtual ResultType InternalClose (void)
 Close communication with the tracking device.
virtual ResultType InternalStartImaging (void)
 Put the tracking device into tracking mode.
virtual ResultType InternalStopImaging (void)
 Take the tracking device out of tracking mode.
virtual ResultType InternalUpdateStatus (void)
 Update the status and the transforms for all VideoImagerTools.
virtual ResultType InternalThreadedUpdateStatus (void)
 Update the status and the transforms.
virtual ResultType InternalReset (void)
 Reset the tracking device to put it back to its original state.
virtual ResultType VerifyVideoImagerToolInformation (const VideoImagerToolType *)
 Verify imager tool information.
virtual ResultType ValidateSpecifiedFrequency (double frequencyInHz)
 The "ValidateSpecifiedFrequency" method checks if the specified frequency is valid for the tracking device that is being used.
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print object information.
virtual ResultType RemoveVideoImagerToolFromInternalDataContainers (const VideoImagerToolType *imagerTool)
 Remove imager tool entry from internal containers.
virtual ResultType AddVideoImagerToolToInternalDataContainers (const VideoImagerToolType *imagerTool)
 Add imager tool entry from internal containers.

Detailed Description

This imager provides support for socket communication (using the Open IGTLink protocol) to the OpenIGTLink system.

Definition at line 46 of file igstkOpenIGTLinkVideoImager.h.


Member Typedef Documentation

Typedef for internal boolean return type.

Reimplemented from igstk::VideoImager.

Definition at line 66 of file igstkOpenIGTLinkVideoImager.h.


Constructor & Destructor Documentation

igstk::OpenIGTLinkVideoImager::OpenIGTLinkVideoImager ( void  ) [protected]
virtual igstk::OpenIGTLinkVideoImager::~OpenIGTLinkVideoImager ( void  ) [protected, virtual]

Member Function Documentation

virtual ResultType igstk::OpenIGTLinkVideoImager::InternalOpen ( void  ) [protected, virtual]

Open communication with the tracking device.

Implements igstk::VideoImager.

virtual ResultType igstk::OpenIGTLinkVideoImager::InternalClose ( void  ) [protected, virtual]

Close communication with the tracking device.

Implements igstk::VideoImager.

virtual ResultType igstk::OpenIGTLinkVideoImager::InternalStartImaging ( void  ) [protected, virtual]

Put the tracking device into tracking mode.

Implements igstk::VideoImager.

virtual ResultType igstk::OpenIGTLinkVideoImager::InternalStopImaging ( void  ) [protected, virtual]

Take the tracking device out of tracking mode.

Implements igstk::VideoImager.

virtual ResultType igstk::OpenIGTLinkVideoImager::InternalUpdateStatus ( void  ) [protected, virtual]

Update the status and the transforms for all VideoImagerTools.

Implements igstk::VideoImager.

virtual ResultType igstk::OpenIGTLinkVideoImager::InternalThreadedUpdateStatus ( void  ) [protected, virtual]

Update the status and the transforms.

This function is called by a separate thread.

Implements igstk::VideoImager.

virtual ResultType igstk::OpenIGTLinkVideoImager::InternalReset ( void  ) [protected, virtual]

Reset the tracking device to put it back to its original state.

Implements igstk::VideoImager.

virtual ResultType igstk::OpenIGTLinkVideoImager::VerifyVideoImagerToolInformation ( const VideoImagerToolType ) [protected, virtual]

Verify imager tool information.

Implements igstk::VideoImager.

virtual ResultType igstk::OpenIGTLinkVideoImager::ValidateSpecifiedFrequency ( double  frequencyInHz) [protected, virtual]

The "ValidateSpecifiedFrequency" method checks if the specified frequency is valid for the tracking device that is being used.

Reimplemented from igstk::VideoImager.

virtual void igstk::OpenIGTLinkVideoImager::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const [protected, virtual]

Print object information.

Reimplemented from igstk::VideoImager.

virtual ResultType igstk::OpenIGTLinkVideoImager::RemoveVideoImagerToolFromInternalDataContainers ( const VideoImagerToolType imagerTool) [protected, virtual]

Remove imager tool entry from internal containers.

Implements igstk::VideoImager.

virtual ResultType igstk::OpenIGTLinkVideoImager::AddVideoImagerToolToInternalDataContainers ( const VideoImagerToolType imagerTool) [protected, virtual]

Add imager tool entry from internal containers.

Implements igstk::VideoImager.


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