igstk::Frame Class Reference

Frame from an external input device. More...

#include <igstkFrame.h>

Collaboration diagram for igstk::Frame:

Collaboration graph
[legend]

List of all members.

Public Types

typedef TimeStamp::TimePeriodType TimePeriodType

Public Member Functions

void SetLogger (LoggerType *logger)
virtual void SetWidth (unsigned int _arg)
virtual unsigned int GetWidth ()
virtual void SetHeight (unsigned int _arg)
virtual unsigned int GetHeight ()
virtual void SetNumberOfChannels (unsigned int _arg)
virtual unsigned int GetNumberOfChannels ()
 Frame ()
 Constructor and destructor.
 Frame (unsigned int width, unsigned int height, unsigned int channels)
 Frame (const Frame &t)
virtual ~Frame ()
void * GetImagePtr ()
TimePeriodType GetStartTime () const
 Returns the time at which the validity of this information starts.
TimePeriodType GetExpirationTime () const
 Returns the time at which the validity of this information expires.
void SetTimeToExpiration (TimePeriodType millisecondsToExpiration)
bool IsValidAtTime (TimePeriodType timeToTestInMilliseconds) const
 Returns the validity status of the frame at the time passed as argument.
bool IsValidNow () const
 Returns the validity status of the frame when it is called.
void Print (std::ostream &os, itk::Indent indent) const
 Method for printing the member variables of this class to an ostream.

Protected Member Functions

LoggerType * GetLogger () const
void PrintHeader (std::ostream &os, itk::Indent indent) const
void PrintTrailer (std::ostream &itkNotUsed(os), itk::Indent itkNotUsed(indent)) const
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information in a stream.

Friends

class VideoImager
class VideoImagerTool


Detailed Description

Frame from an external input device.

It is intended to be used as a communication vehicle between imagers and spatial objects. The class contains a TimeStamp defining the validity period for the information in the frame.

All the set methods require an argument that defines the number of milliseconds for which the stored information is considered to be valid. The validity period will be counted from the moment the Set method was invoked.

See also:
TimeStamp

Definition at line 49 of file igstkFrame.h.


Member Typedef Documentation

Definition at line 56 of file igstkFrame.h.


Constructor & Destructor Documentation

igstk::Frame::Frame (  ) 

Constructor and destructor.

igstk::Frame::Frame ( unsigned int  width,
unsigned int  height,
unsigned int  channels 
)

igstk::Frame::Frame ( const Frame t  ) 

virtual igstk::Frame::~Frame (  )  [virtual]


Member Function Documentation

LoggerType* igstk::Frame::GetLogger (  )  const [protected]

void igstk::Frame::SetLogger ( LoggerType *  logger  ) 

virtual void igstk::Frame::SetWidth ( unsigned int  _arg  )  [virtual]

virtual unsigned int igstk::Frame::GetWidth (  )  [virtual]

virtual void igstk::Frame::SetHeight ( unsigned int  _arg  )  [virtual]

virtual unsigned int igstk::Frame::GetHeight (  )  [virtual]

virtual void igstk::Frame::SetNumberOfChannels ( unsigned int  _arg  )  [virtual]

virtual unsigned int igstk::Frame::GetNumberOfChannels (  )  [virtual]

void* igstk::Frame::GetImagePtr (  ) 

TimePeriodType igstk::Frame::GetStartTime (  )  const

Returns the time at which the validity of this information starts.

The data in this frame should not be used for scenes to be rendered before that validity time. The time is returned in milliseconds.

See also:
TimeStamp

TimePeriodType igstk::Frame::GetExpirationTime (  )  const

Returns the time at which the validity of this information expires.

The data in this frame should not be used for scenes to be rendered after that validity time. The time is returned in milliseconds.

See also:
TimeStamp

void igstk::Frame::SetTimeToExpiration ( TimePeriodType  millisecondsToExpiration  ) 

bool igstk::Frame::IsValidAtTime ( TimePeriodType  timeToTestInMilliseconds  )  const

Returns the validity status of the frame at the time passed as argument.

The frame values should not be used in a scene if the time when the scene is to be rendered returned 'false' when passed to this IsValid() function. The time is passed in milliseconds.

See also:
TimeStamp

bool igstk::Frame::IsValidNow (  )  const

Returns the validity status of the frame when it is called.

See also:
TimeStamp

void igstk::Frame::Print ( std::ostream &  os,
itk::Indent  indent 
) const

Method for printing the member variables of this class to an ostream.

void igstk::Frame::PrintHeader ( std::ostream &  os,
itk::Indent  indent 
) const [protected]

void igstk::Frame::PrintTrailer ( std::ostream &  itkNotUsedos,
itk::Indent   itkNotUsedindent 
) const [protected]

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

Print the object information in a stream.


Friends And Related Function Documentation

friend class VideoImager [friend]

Definition at line 53 of file igstkFrame.h.

friend class VideoImagerTool [friend]

Definition at line 54 of file igstkFrame.h.


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

Generated on Thu Apr 9 21:38:51 2015 for IGSTK by  doxygen 1.5.6