Raytrix Light Field SDK  5.0
Rx::FileIO::CUVTKDecode Class Reference

Detailed Description

Unstructured grid decoder for a series of xml vtk files.

Inherits Rx::FileIO::IFileDataFramesDecode.

Public Member Functions

 CUVTKDecode ()
 Default constructor. More...
 
 ~CUVTKDecode ()
 Destructor. More...
 
virtual void Close ()
 Closes this object. More...
 
virtual void Destroy ()
 Destroys this object. More...
 
virtual void GetData (size_t nDataId, double &dData)
 Gets the time step for the current open frame as double. Supported data cases are: More...
 
virtual void GetData (size_t nDataId, Interop::Runtime30::IMemory *pTrgMem)
 Not supported for this file type. Will throw an exception if called with any case. More...
 
virtual void GetData (size_t nDataId, Interop::Runtime30::IMemory2D *pTrgMem)
 Gets a CRxMatrix of type double as IMemory2D block from the current frame. The memory block contains either the point or the vector data. Supported data cases are: More...
 
virtual void JumpToFrame (size_t nFrameNbr)
 Opens the specified frame and reads it. Throws an exception when the specified frame does not exist. More...
 
virtual bool NextFrame ()
 When there is a next frame, this function opens and reads it. Because Open() already opens the first frame all following frames need to be processed via do-while. More...
 
virtual void Open (const CRxString &sxFullPath)
 Opens this object. Input folder for the files is the given path. This function will open the first frame. Because of that all following frames need to be processed via do-while. More...
 

Protected Attributes

IFileDataFramesDecodem_pxIFileDataFramesDecode
 The IFileDataFramesDecode interface. More...
 

Constructor & Destructor Documentation

◆ CUVTKDecode()

Rx::FileIO::CUVTKDecode::CUVTKDecode ( )

Default constructor.

◆ ~CUVTKDecode()

Rx::FileIO::CUVTKDecode::~CUVTKDecode ( )

Destructor.

Member Function Documentation

◆ Close()

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

Closes this object.

Implements Rx::FileIO::IFileDataFramesDecode.

◆ Destroy()

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

Destroys this object.

Implements Rx::FileIO::IFileDataFramesDecode.

◆ GetData() [1/3]

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

Gets the time step for the current open frame as double. Supported data cases are:

FileIO::EDataTypeVtk::TimestepData - current time step data

All other cases will throw an exception.

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

Implements Rx::FileIO::IFileDataFramesDecode.

◆ GetData() [2/3]

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

Not supported for this file type. Will throw an exception if called with any case.

Parameters
nDataId[in] Identifier for the data.
pTrgMem[out] Target memory.

Implements Rx::FileIO::IFileDataFramesDecode.

◆ GetData() [3/3]

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

Gets a CRxMatrix of type double as IMemory2D block from the current frame. The memory block contains either the point or the vector data. Supported data cases are:

FileIO::EDataTypeVtk::PointData - 3d point data

FileIO::EDataTypeVtk::VectorData - 3d vector data

All other cases will throw an exception.

Parameters
nDataId[in] Identifier for the data.
pTrgMem[out] Target memory.

Implements Rx::FileIO::IFileDataFramesDecode.

◆ JumpToFrame()

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

Opens the specified frame and reads it. Throws an exception when the specified frame does not exist.

Parameters
nFrameNbr[in] The frame number.

Implements Rx::FileIO::IFileDataFramesDecode.

◆ NextFrame()

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

When there is a next frame, this function opens and reads it. Because Open() already opens the first frame all following frames need to be processed via do-while.

Returns
True if there is a next frame, false otherwise.

Implements Rx::FileIO::IFileDataFramesDecode.

◆ Open()

virtual void Rx::FileIO::CUVTKDecode::Open ( const CRxString sxFullPath)
virtual

Opens this object. Input folder for the files is the given path. This function will open the first frame. Because of that all following frames need to be processed via do-while.

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

Implements Rx::FileIO::IFileDataFramesDecode.

Member Data Documentation

◆ m_pxIFileDataFramesDecode

IFileDataFramesDecode* Rx::FileIO::CUVTKDecode::m_pxIFileDataFramesDecode
protected

The IFileDataFramesDecode interface.