NifTK  16.4.1 - 0798f20
CMIC's Translational Medical Imaging Platform
Public Types | Public Member Functions | Protected Member Functions | List of all members
niftk::IGIDataType Class Reference

Abstract base class for IGI Data, such as objects containing tracking data, video frames or ultrasound frames. More...

Inheritance diagram for niftk::IGIDataType:
Inheritance graph
[legend]
Collaboration diagram for niftk::IGIDataType:
Collaboration graph
[legend]

Public Types

typedef
SystemTimeServiceI::TimeType 
IGITimeType
 
typedef unsigned long int IGIIndexType
 

Public Member Functions

 mitkClassMacroItkParent (IGIDataType, itk::Object) static Pointer New()
 
IGITimeType GetTimeStampInNanoSeconds () const
 
void SetTimeStampInNanoSeconds (const IGITimeType &time)
 
virtual void SetDuration (IGITimeType _arg)
 
virtual IGITimeType GetDuration ()
 
virtual void SetFrameId (IGIIndexType _arg)
 
virtual IGIIndexType GetFrameId ()
 
virtual void SetIsSaved (bool _arg)
 
virtual bool GetIsSaved ()
 
virtual void SetShouldBeSaved (bool _arg)
 
virtual bool GetShouldBeSaved ()
 
virtual void SetFileName (std::string _arg)
 
virtual std::string GetFileName ()
 
virtual voidGetData () const
 This object can contain any data, and derived classes should override this. More...
 

Protected Member Functions

 IGIDataType ()
 
virtual ~IGIDataType ()
 
 IGIDataType (const IGIDataType &)
 
IGIDataTypeoperator= (const IGIDataType &)
 

Detailed Description

Abstract base class for IGI Data, such as objects containing tracking data, video frames or ultrasound frames.

Note: All errors should thrown as mitk::Exception or sub-classes thereof.

Member Typedef Documentation

typedef unsigned long int niftk::IGIDataType::IGIIndexType

Constructor & Destructor Documentation

niftk::IGIDataType::IGIDataType ( )
protected
niftk::IGIDataType::~IGIDataType ( )
protectedvirtual
niftk::IGIDataType::IGIDataType ( const IGIDataType )
protected

Member Function Documentation

virtual void* niftk::IGIDataType::GetData ( ) const
inlinevirtual

This object can contain any data, and derived classes should override this.

Reimplemented in niftk::NiftyLinkDataType.

virtual IGITimeType niftk::IGIDataType::GetDuration ( )
virtual
virtual std::string niftk::IGIDataType::GetFileName ( )
virtual
virtual IGIIndexType niftk::IGIDataType::GetFrameId ( )
virtual
virtual bool niftk::IGIDataType::GetIsSaved ( )
virtual
virtual bool niftk::IGIDataType::GetShouldBeSaved ( )
virtual
IGIDataType::IGITimeType niftk::IGIDataType::GetTimeStampInNanoSeconds ( ) const
niftk::IGIDataType::mitkClassMacroItkParent ( IGIDataType  ,
itk::Object   
)
IGIDataType& niftk::IGIDataType::operator= ( const IGIDataType )
protected
virtual void niftk::IGIDataType::SetDuration ( IGITimeType  _arg)
virtual
virtual void niftk::IGIDataType::SetFileName ( std::string  _arg)
virtual
virtual void niftk::IGIDataType::SetFrameId ( IGIIndexType  _arg)
virtual
virtual void niftk::IGIDataType::SetIsSaved ( bool  _arg)
virtual
virtual void niftk::IGIDataType::SetShouldBeSaved ( bool  _arg)
virtual
void niftk::IGIDataType::SetTimeStampInNanoSeconds ( const IGITimeType time)

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