Raytrix Light Field SDK  v3.0
Logo
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events Groups Pages
Rx::FileIO::IFileDataFramesDecode Class Referenceabstract

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, Rx::Interop::Runtime30::IMemory *pTrgMem)=0
 Gets a IMemory block from the current frame. More...
 
virtual void GetData (size_t nDataId, Rx::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 Rx::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

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

Destructor.

Member Function Documentation

virtual void Rx::FileIO::IFileDataFramesDecode::Close ( )
pure virtual
virtual void Rx::FileIO::IFileDataFramesDecode::Destroy ( )
pure virtual
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.

virtual void Rx::FileIO::IFileDataFramesDecode::GetData ( size_t  nDataId,
Rx::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.

virtual void Rx::FileIO::IFileDataFramesDecode::GetData ( size_t  nDataId,
Rx::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.

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.

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.

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

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

Parameters
fullPath[in] Full pathname where all files are located.

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