VTK
Public Member Functions | List of all members
OffsetsManager Class Reference

Helper class due to PIMPL excess. More...

#include <vtkXMLOffsetsManager.h>

Public Member Functions

 OffsetsManager ()
 
void Allocate (int numTimeStep)
 
vtkTypeInt64 & GetPosition (unsigned int t)
 
vtkTypeInt64 & GetRangeMinPosition (unsigned int t)
 
vtkTypeInt64 & GetRangeMaxPosition (unsigned int t)
 
vtkTypeInt64 & GetOffsetValue (unsigned int t)
 
vtkMTimeTypeGetLastMTime ()
 

Detailed Description

Helper class due to PIMPL excess.

This class is deisgned to work within vtkXMLWriter. It store a position in a file (unsigned long) and associate a offset in the file. This is useful when writing TimeStep XML file when you want to forward the same offset from the AppendData section on every entry in let say <Points> definition Example:

* <Points>
*   <DataArray type="Float32" TimeStep="0" format="appended" offset="268" />
*   <DataArray type="Float32" TimeStep="1" format="appended" offset="268" />
*   ...
* </Points>
* 

Therefore data is only stored once in the XML file. At read time the offset value is stored to determine whenever we need to read data (ie when offset different from previously stored offset)

See also
vtkXMLWriter
Warning
Do not include this file in a header file, it will break PIMPL convention

Definition at line 54 of file vtkXMLOffsetsManager.h.

Constructor & Destructor Documentation

◆ OffsetsManager()

OffsetsManager::OffsetsManager ( )
inline

Definition at line 58 of file vtkXMLOffsetsManager.h.

Member Function Documentation

◆ Allocate()

void OffsetsManager::Allocate ( int  numTimeStep)
inline

Definition at line 62 of file vtkXMLOffsetsManager.h.

◆ GetPosition()

vtkTypeInt64& OffsetsManager::GetPosition ( unsigned int  t)
inline

Definition at line 70 of file vtkXMLOffsetsManager.h.

◆ GetRangeMinPosition()

vtkTypeInt64& OffsetsManager::GetRangeMinPosition ( unsigned int  t)
inline

Definition at line 75 of file vtkXMLOffsetsManager.h.

◆ GetRangeMaxPosition()

vtkTypeInt64& OffsetsManager::GetRangeMaxPosition ( unsigned int  t)
inline

Definition at line 80 of file vtkXMLOffsetsManager.h.

◆ GetOffsetValue()

vtkTypeInt64& OffsetsManager::GetOffsetValue ( unsigned int  t)
inline

Definition at line 85 of file vtkXMLOffsetsManager.h.

◆ GetLastMTime()

vtkMTimeType& OffsetsManager::GetLastMTime ( )
inline

Definition at line 90 of file vtkXMLOffsetsManager.h.


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