IGSTK
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | List of all members
igstk::VideoImagerTool Class Reference

Abstract superclass for concrete IGSTK VideoImagerTool classes. More...

#include <igstkVideoImagerTool.h>

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

Public Types

typedef Transform TransformType
typedef Frame FrameType
- Public Types inherited from igstk::Object
typedef Object Self
 General Typedefs.
typedef ::itk::Object Superclass
typedef ::itk::SmartPointer< SelfPointer
typedef ::itk::SmartPointer
< const Self
ConstPointer
typedef igstk::Logger LoggerType

Public Member Functions

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

Public Attributes

igstkStandardAbstractClassTraitsMacro(VideoImagerTool,
Object) public typedef
VideoImager 
VideoImagerType
 Macro with standard traits declarations.

Protected Member Functions

 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

- Static Public Member Functions inherited from igstk::Object
static Pointer New (void)

Detailed Description

Abstract superclass for concrete IGSTK VideoImagerTool classes.

This class provides a generic implementation of an VideoImager. This may contain hardware specific details of the video-device.

igstkVideoImagerTool.png
VideoImagerTool StateMachineDiagram

Definition at line 73 of file igstkVideoImagerTool.h.

Member Typedef Documentation

Definition at line 85 of file igstkVideoImagerTool.h.

Definition at line 86 of file igstkVideoImagerTool.h.

Constructor & Destructor Documentation

igstk::VideoImagerTool::VideoImagerTool ( void  )
protected
virtual igstk::VideoImagerTool::~VideoImagerTool ( void  )
protectedvirtual

Member Function Documentation

virtual bool igstk::VideoImagerTool::GetUpdated ( )
virtual

Get whether the tool was updated during VideoImager UpdateStatus()

virtual void igstk::VideoImagerTool::RequestConfigure ( void  )
virtual

The "RequestConfigure" method attempts to configure the VideoImager tool.

virtual void igstk::VideoImagerTool::RequestDetachFromVideoImager ( )
virtual

The "RequestDetachFromVideoImager" method detaches the VideoImager tool from the VideoImager.

virtual void igstk::VideoImagerTool::RequestGetFrame ( )
virtual

Request to get the internal frame as an event.

const std::string igstk::VideoImagerTool::GetVideoImagerToolIdentifier ( ) const

Access the unique identifier to the VideoImager tool.

virtual void igstk::VideoImagerTool::RequestAttachToVideoImager ( VideoImagerType )
virtual

The "RequestAttachToVideoImager" method attaches the VideoImager tool to a VideoImager.

FrameType* igstk::VideoImagerTool::GetInternalFrame ( void  )

Get the frame with the current index for this tool.

void igstk::VideoImagerTool::SetInternalFrame ( FrameType )

Set the frame for this tool.

void igstk::VideoImagerTool::SetFrameDimensions ( unsigned int *  )
void igstk::VideoImagerTool::GetFrameDimensions ( unsigned int *  )
virtual void igstk::VideoImagerTool::SetPixelDepth ( unsigned int  _arg)
virtual
virtual unsigned int igstk::VideoImagerTool::GetPixelDepth ( )
virtual
virtual void igstk::VideoImagerTool::SetDelay ( unsigned int  _arg)
virtual
virtual unsigned int igstk::VideoImagerTool::GetDelay ( )
virtual
igstk::Frame* igstk::VideoImagerTool::GetFrameFromBuffer ( const unsigned int  index)
igstk::Frame* igstk::VideoImagerTool::GetTemporalCalibratedFrame ( )
virtual void igstk::VideoImagerTool::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual

Print the object information in a stream.

Reimplemented from igstk::Object.

void igstk::VideoImagerTool::SetVideoImagerToolIdentifier ( const std::string  identifier)
protected

Set a unique identifier to the VideoImager tool.

Member Data Documentation

igstkStandardAbstractClassTraitsMacro ( VideoImagerTool, Object ) public typedef VideoImager igstk::VideoImagerTool::VideoImagerType

Macro with standard traits declarations.

Definition at line 78 of file igstkVideoImagerTool.h.


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