Rx::FileIO::IFileDataFramesDecode Class Reference

Detailed Description

Interface for decoding multiple data frames.

Inherited by Rx::FileIO::CUVTKDecode, and Rx::FileIO::CUVTKDecode_Impl.

Public Member Functions
virtual void	Close ()=0
	Closes this IFileDataFramesDecode. More...
virtual void	Destroy ()=0
	Destroys this IFileDataFramesDecode. More...
virtual void	GetData (size_t nDataId, double &dData)=0
	Gets a double value from the current frame. More...
virtual void	GetData (size_t nDataId, Interop::Runtime30::IMemory *pTrgMem)=0
	Gets a IMemory block from the current frame. More...
virtual void	GetData (size_t nDataId, Interop::Runtime30::IMemory2D *pTrgMem)=0
	Gets a IMemory2D block from the current frame. More...
virtual void	JumpToFrame (size_t nFrameNbr)=0
	Opens specified frame and reads it. More...
virtual bool	NextFrame ()=0
	Opens a new frame and reads it. More...
virtual void	Open (const CRxString &sxFullPath)=0
	Opens the IFileDataFramesDecode. Input folder for the files is the given path. More...

Protected Member Functions
virtual	~IFileDataFramesDecode ()
	Destructor. More...

Constructor & Destructor Documentation

~IFileDataFramesDecode()

virtual Rx::FileIO::IFileDataFramesDecode::~IFileDataFramesDecode ( )

inlineprotectedvirtual

Destructor.

Member Function Documentation

Close()

virtual void Rx::FileIO::IFileDataFramesDecode::Close ( )

pure virtual

Closes this IFileDataFramesDecode.

Implemented in Rx::FileIO::CUVTKDecode, and Rx::FileIO::CUVTKDecode_Impl.

Destroy()

virtual void Rx::FileIO::IFileDataFramesDecode::Destroy ( )

pure virtual

Destroys this IFileDataFramesDecode.

Implemented in Rx::FileIO::CUVTKDecode, and Rx::FileIO::CUVTKDecode_Impl.

GetData() [1/3]

virtual void Rx::FileIO::IFileDataFramesDecode::GetData ( size_t  nDataId, double &  dData  )

pure virtual

Gets a double value from the current frame.

Parameters

nDataId	[in] Identifier for the data.
dData	[out] The data.

Implemented in Rx::FileIO::CUVTKDecode, and Rx::FileIO::CUVTKDecode_Impl.

GetData() [2/3]

virtual void Rx::FileIO::IFileDataFramesDecode::GetData ( size_t  nDataId, Interop::Runtime30::IMemory *  pTrgMem  )

pure virtual

Gets a IMemory block from the current frame.

Parameters

nDataId	[in] Identifier for the data.
pTrgMem	[out] If non-null, the target memory.

Implemented in Rx::FileIO::CUVTKDecode, and Rx::FileIO::CUVTKDecode_Impl.

GetData() [3/3]

virtual void Rx::FileIO::IFileDataFramesDecode::GetData ( size_t  nDataId, Interop::Runtime30::IMemory2D *  pTrgMem  )

pure virtual

Gets a IMemory2D block from the current frame.

Parameters

nDataId	[in] Identifier for the data.
pTrgMem	[out] If non-null, the target memory.

Implemented in Rx::FileIO::CUVTKDecode, and Rx::FileIO::CUVTKDecode_Impl.

JumpToFrame()

virtual void Rx::FileIO::IFileDataFramesDecode::JumpToFrame ( size_t  nFrameNbr )

pure virtual

Opens specified frame and reads it.

Parameters

nFrameNbr

[in] The frame number.

Implemented in Rx::FileIO::CUVTKDecode, and Rx::FileIO::CUVTKDecode_Impl.

NextFrame()

virtual bool Rx::FileIO::IFileDataFramesDecode::NextFrame ( )

pure virtual

Opens a new frame and reads it.

Returns

True if there is a next frame and the frame has been read, false if there is no next frame.

Implemented in Rx::FileIO::CUVTKDecode, and Rx::FileIO::CUVTKDecode_Impl.

Open()

virtual void Rx::FileIO::IFileDataFramesDecode::Open ( const CRxString &  sxFullPath )

pure virtual

Opens the IFileDataFramesDecode. Input folder for the files is the given path.

Parameters

sxFullPath

[in] Full pathname where all files are located.

Implemented in Rx::FileIO::CUVTKDecode, and Rx::FileIO::CUVTKDecode_Impl.