#include <src/PlusDataCollection/PlusStreamBufferItem.h>

Public Member Functions
PlusStatus	DeepCopy (StreamBufferItem *dataItem)

PlusStatus	DeleteFrameField (const char *fieldName)

PlusStatus	DeleteFrameField (const std::string &fieldName)

double	GetFilteredTimestamp (double localTimeOffsetSec)

igsioVideoFrame &	GetFrame ()

std::string	GetFrameField (const std::string &fieldName) const

igsioFieldMapType	GetFrameFieldMap ()

unsigned long	GetIndex ()

PlusStatus	GetMatrix (vtkMatrix4x4 *outputMatrix)

ToolStatus	GetStatus () const

double	GetTimestamp (double localTimeOffsetSec)

BufferItemUidType	GetUid ()

double	GetUnfilteredTimestamp (double localTimeOffsetSec)

bool	HasValidFieldData () const

bool	HasValidTransformData () const

bool	HasValidVideoData () const

StreamBufferItem &	operator= (StreamBufferItem const &dataItem)

void	SetFilteredTimestamp (double filteredTimestamp)

void	SetFrameField (std::string fieldName, std::string fieldValue, igsioFrameFieldFlags flags=FRAMEFIELD_NONE)

void	SetIndex (unsigned long index)

PlusStatus	SetMatrix (vtkMatrix4x4 *matrix)

void	SetStatus (ToolStatus status)

void	SetUid (BufferItemUidType uid)

void	SetUnfilteredTimestamp (double unfilteredTimestamp)

void	SetValidTransformData (bool aValid)

	StreamBufferItem ()

	StreamBufferItem (const StreamBufferItem &dataItem)

virtual	~StreamBufferItem ()

Protected Attributes
double	FilteredTimeStamp

igsioVideoFrame	Frame

igsioFieldMapType	FrameFields

unsigned long	Index

vtkSmartPointer< vtkMatrix4x4 >	Matrix

ToolStatus	Status

BufferItemUidType	Uid

double	UnfilteredTimeStamp

bool	ValidTransformData

Detailed Description

Definition at line 38 of file PlusStreamBufferItem.h.

Constructor & Destructor Documentation

◆ StreamBufferItem() [1/2]

StreamBufferItem::StreamBufferItem ( )

Definition at line 14 of file PlusStreamBufferItem.cxx.

◆ ~StreamBufferItem()

StreamBufferItem::~StreamBufferItem ( )

virtual

Definition at line 26 of file PlusStreamBufferItem.cxx.

◆ StreamBufferItem() [2/2]

StreamBufferItem::StreamBufferItem ( const StreamBufferItem & dataItem )

Definition at line 31 of file PlusStreamBufferItem.cxx.

Member Function Documentation

◆ DeepCopy()

PlusStatus StreamBufferItem::DeepCopy ( StreamBufferItem * dataItem )

Copy stream buffer item

Definition at line 111 of file PlusStreamBufferItem.cxx.

◆ DeleteFrameField() [1/2]

PlusStatus StreamBufferItem::DeleteFrameField ( const char * fieldName )

Delete frame field

Definition at line 86 of file PlusStreamBufferItem.cxx.

◆ DeleteFrameField() [2/2]

PlusStatus StreamBufferItem::DeleteFrameField ( const std::string & fieldName )

Definition at line 105 of file PlusStreamBufferItem.cxx.

◆ GetFilteredTimestamp()

double StreamBufferItem::GetFilteredTimestamp ( double localTimeOffsetSec )

inline

Get filtered timestamp in global time (global = local + offset)

Definition at line 51 of file PlusStreamBufferItem.h.

◆ GetFrame()

igsioVideoFrame& StreamBufferItem::GetFrame ( )

inline

Definition at line 88 of file PlusStreamBufferItem.h.

◆ GetFrameField()

std::string StreamBufferItem::GetFrameField ( const std::string & fieldName ) const

Get frame field value

Definition at line 68 of file PlusStreamBufferItem.cxx.

◆ GetFrameFieldMap()

igsioFieldMapType StreamBufferItem::GetFrameFieldMap ( )

inline

Get frame field map

Definition at line 80 of file PlusStreamBufferItem.h.

◆ GetIndex()

unsigned long StreamBufferItem::GetIndex ( )

inline

Set/get index assigned by the data acquisition system (usually a counter) If frames are skipped then the counter should be increased by the number of skipped frames, therefore the index difference between subsequent frames be more than 1.

Definition at line 67 of file PlusStreamBufferItem.h.

◆ GetMatrix()

PlusStatus StreamBufferItem::GetMatrix ( vtkMatrix4x4 * outputMatrix )

Get tracker matrix

Definition at line 141 of file PlusStreamBufferItem.cxx.

◆ GetStatus()

ToolStatus StreamBufferItem::GetStatus ( ) const

Get tracker item status

Definition at line 161 of file PlusStreamBufferItem.cxx.

◆ GetTimestamp()

double StreamBufferItem::GetTimestamp ( double localTimeOffsetSec )

inline

Get timestamp for the current buffer item in global time (global = local + offset)

Definition at line 48 of file PlusStreamBufferItem.h.

◆ GetUid()

BufferItemUidType StreamBufferItem::GetUid ( )

inline

Set/get unique identifier assigned by the storage buffer

Definition at line 71 of file PlusStreamBufferItem.h.

◆ GetUnfilteredTimestamp()

double StreamBufferItem::GetUnfilteredTimestamp ( double localTimeOffsetSec )

inline

Get unfiltered timestamp in global time (global = local + offset)

Definition at line 57 of file PlusStreamBufferItem.h.

◆ HasValidFieldData()

bool StreamBufferItem::HasValidFieldData ( ) const

Definition at line 167 of file PlusStreamBufferItem.cxx.

◆ HasValidTransformData()

bool StreamBufferItem::HasValidTransformData ( ) const

inline

Definition at line 101 of file PlusStreamBufferItem.h.

◆ HasValidVideoData()

bool StreamBufferItem::HasValidVideoData ( ) const

inline

Definition at line 103 of file PlusStreamBufferItem.h.

◆ operator=()

StreamBufferItem & StreamBufferItem::operator= ( StreamBufferItem const & dataItem )

Definition at line 39 of file PlusStreamBufferItem.cxx.

◆ SetFilteredTimestamp()

void StreamBufferItem::SetFilteredTimestamp ( double filteredTimestamp )

inline

Set filtered timestamp

Definition at line 54 of file PlusStreamBufferItem.h.

◆ SetFrameField()

void StreamBufferItem::SetFrameField	(	std::string	fieldName,
		std::string	fieldValue,
		igsioFrameFieldFlags	flags = `FRAMEFIELD_NONE`
	)

Set frame field

Definition at line 61 of file PlusStreamBufferItem.cxx.

◆ SetIndex()

void StreamBufferItem::SetIndex ( unsigned long index )

inline

Definition at line 68 of file PlusStreamBufferItem.h.

◆ SetMatrix()

PlusStatus StreamBufferItem::SetMatrix ( vtkMatrix4x4 * matrix )

Set tracker matrix

Definition at line 125 of file PlusStreamBufferItem.cxx.

◆ SetStatus()

void StreamBufferItem::SetStatus ( ToolStatus status )

Set tracker item status

Definition at line 155 of file PlusStreamBufferItem.cxx.

◆ SetUid()

void StreamBufferItem::SetUid ( BufferItemUidType uid )

inline

Definition at line 72 of file PlusStreamBufferItem.h.

◆ SetUnfilteredTimestamp()

void StreamBufferItem::SetUnfilteredTimestamp ( double unfilteredTimestamp )

inline

Set unfiltered timestamp

Definition at line 60 of file PlusStreamBufferItem.h.

◆ SetValidTransformData()

void StreamBufferItem::SetValidTransformData ( bool aValid )

inline

Definition at line 100 of file PlusStreamBufferItem.h.

Member Data Documentation

◆ FilteredTimeStamp

double StreamBufferItem::FilteredTimeStamp

protected

Definition at line 109 of file PlusStreamBufferItem.h.

◆ Frame

igsioVideoFrame StreamBufferItem::Frame

protected

Definition at line 122 of file PlusStreamBufferItem.h.

◆ FrameFields

igsioFieldMapType StreamBufferItem::FrameFields

protected

Custom frame fields

Definition at line 119 of file PlusStreamBufferItem.h.

◆ Index

unsigned long StreamBufferItem::Index

protected

index assigned by the data acquisition system (usually a counter)

Definition at line 113 of file PlusStreamBufferItem.h.

◆ Matrix

vtkSmartPointer<vtkMatrix4x4> StreamBufferItem::Matrix

protected

Definition at line 123 of file PlusStreamBufferItem.h.

◆ Status

ToolStatus StreamBufferItem::Status

protected

Definition at line 124 of file PlusStreamBufferItem.h.

◆ Uid

BufferItemUidType StreamBufferItem::Uid

protected

unique identifier assigned by the storage buffer, it is guaranteed to increase monotonously, by one for each frame that is added to the buffer

Definition at line 116 of file PlusStreamBufferItem.h.

◆ UnfilteredTimeStamp

double StreamBufferItem::UnfilteredTimeStamp

protected

Definition at line 110 of file PlusStreamBufferItem.h.

◆ ValidTransformData

bool StreamBufferItem::ValidTransformData

protected

Definition at line 121 of file PlusStreamBufferItem.h.

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

src/PlusDataCollection/PlusStreamBufferItem.h
src/PlusDataCollection/PlusStreamBufferItem.cxx

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ StreamBufferItem() [1/2]

◆ ~StreamBufferItem()

◆ StreamBufferItem() [2/2]

Member Function Documentation

◆ DeepCopy()

◆ DeleteFrameField() [1/2]

◆ DeleteFrameField() [2/2]

◆ GetFilteredTimestamp()

◆ GetFrame()

◆ GetFrameField()

◆ GetFrameFieldMap()

◆ GetIndex()

◆ GetMatrix()

◆ GetStatus()

◆ GetTimestamp()

◆ GetUid()

◆ GetUnfilteredTimestamp()

◆ HasValidFieldData()

◆ HasValidTransformData()

◆ HasValidVideoData()

◆ operator=()

◆ SetFilteredTimestamp()

◆ SetFrameField()

◆ SetIndex()

◆ SetMatrix()

◆ SetStatus()

◆ SetUid()

◆ SetUnfilteredTimestamp()

◆ SetValidTransformData()

Member Data Documentation

◆ FilteredTimeStamp

◆ Frame

◆ FrameFields

◆ Index

◆ Matrix

◆ Status

◆ Uid

◆ UnfilteredTimeStamp

◆ ValidTransformData