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

A OpenIGTLinkVideoImager-specific VideoImagerTool class. More...

#include <igstkOpenIGTLinkVideoImagerTool.h>

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

Public Member Functions

 igstkStandardClassTraitsMacro (OpenIGTLinkVideoImagerTool, VideoImagerTool) igstkGetStringMacro(VideoImagerToolName)
 Macro with standard traits declarations.
void RequestSetVideoImagerToolName (const std::string &)
 Set tracker tool VideoImagerTool name.
- Public Member Functions inherited from igstk::VideoImagerTool
virtual bool GetUpdated ()
 Get whether the tool was updated during VideoImager UpdateStatus()
virtual void RequestConfigure (void)
 The "RequestConfigure" method attempts to configure the VideoImager tool.
virtual void RequestDetachFromVideoImager ()
 The "RequestDetachFromVideoImager" method detaches the VideoImager tool from the VideoImager.
virtual void RequestGetFrame ()
 Request to get the internal frame as an event.
const std::string GetVideoImagerToolIdentifier () const
 Access the unique identifier to the VideoImager tool.
virtual void RequestAttachToVideoImager (VideoImagerType *)
 The "RequestAttachToVideoImager" method attaches the VideoImager tool to a VideoImager.
FrameTypeGetInternalFrame (void)
 Get the frame with the current index for this tool.
void SetInternalFrame (FrameType *)
 Set the frame for this tool.
void SetFrameDimensions (unsigned int *)
void GetFrameDimensions (unsigned int *)
virtual void SetPixelDepth (unsigned int _arg)
virtual unsigned int GetPixelDepth ()
virtual void SetDelay (unsigned int _arg)
virtual unsigned int GetDelay ()
igstk::FrameGetFrameFromBuffer (const unsigned int index)
igstk::FrameGetTemporalCalibratedFrame ()
- Public Member Functions inherited from igstk::Object
virtual const char * GetNameOfClass () const
void SetLogger (LoggerType *logger)
 Connect the Logger for this class.
void RemoveObserver (unsigned long tag) const

Protected Member Functions

 OpenIGTLinkVideoImagerTool ()
virtual ~OpenIGTLinkVideoImagerTool ()
virtual void PrintSelf (std::ostream &os,::itk::Indent indent) const
 Print object information.
- Protected Member Functions inherited from igstk::VideoImagerTool
 VideoImagerTool (void)
virtual ~VideoImagerTool (void)
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information in a stream.
void SetVideoImagerToolIdentifier (const std::string identifier)
 Set a unique identifier to the VideoImager tool.
- Protected Member Functions inherited from igstk::Object
LoggerTypeGetLogger () const
 Object (void)
 Constructor is protected in order to enforce the use of the New() operator.
virtual ~Object (void)
void RegisterObservedObject (const ::igstk::Object *object, unsigned long tag)
 Register observed objects in an internal array so that they can be disconnected upon destruction.
void RemoveFromObservedObjects ()
 Remove observers that this object may have connected to other objects.

Additional Inherited Members

- Public Types inherited from igstk::VideoImagerTool
typedef Transform TransformType
typedef Frame FrameType
- Static Public Member Functions inherited from igstk::Object
static Pointer New (void)
- Public Attributes inherited from igstk::VideoImagerTool
igstkStandardAbstractClassTraitsMacro(VideoImagerTool,
Object) public typedef
VideoImager 
VideoImagerType
 Macro with standard traits declarations.

Detailed Description

A OpenIGTLinkVideoImager-specific VideoImagerTool class.

This class is a for providing OpenIGTLinkVideoImager-specific functionality for VideoImagerTools, and also to allow compile-time type enforcement for other classes and functions that specifically require an OpenIGTLinkVideoImagerTool.

Definition at line 41 of file igstkOpenIGTLinkVideoImagerTool.h.

Constructor & Destructor Documentation

igstk::OpenIGTLinkVideoImagerTool::OpenIGTLinkVideoImagerTool ( )
protected
virtual igstk::OpenIGTLinkVideoImagerTool::~OpenIGTLinkVideoImagerTool ( )
protectedvirtual

Member Function Documentation

igstk::OpenIGTLinkVideoImagerTool::igstkStandardClassTraitsMacro ( OpenIGTLinkVideoImagerTool  ,
VideoImagerTool   
)

Macro with standard traits declarations.

Get VideoImager tool name

void igstk::OpenIGTLinkVideoImagerTool::RequestSetVideoImagerToolName ( const std::string &  )

Set tracker tool VideoImagerTool name.

virtual void igstk::OpenIGTLinkVideoImagerTool::PrintSelf ( std::ostream &  os,
::itk::Indent  indent 
) const
protectedvirtual

Print object information.


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