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

Helper class due to PIMPL excess. More...

#include <vtkOffsetsManagerArray.h>

Public Types

typedef vtkIdType OffsetType
 

Public Member Functions

 OffsetsManager ()
 
 ~OffsetsManager ()
 
void Allocate (int numTimeStep)
 
OffsetTypeGetPosition (unsigned int t)
 
OffsetTypeGetRangeMinPosition (unsigned int t)
 
OffsetTypeGetRangeMaxPosition (unsigned int t)
 
OffsetTypeGetOffsetValue (unsigned int t)
 
unsigned long & GetLastMTime ()
 

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 53 of file vtkOffsetsManagerArray.h.

Member Typedef Documentation

Definition at line 60 of file vtkOffsetsManagerArray.h.

Constructor & Destructor Documentation

OffsetsManager::OffsetsManager ( )
inline

Definition at line 63 of file vtkOffsetsManagerArray.h.

OffsetsManager::~OffsetsManager ( )
inline

Definition at line 67 of file vtkOffsetsManagerArray.h.

Member Function Documentation

void OffsetsManager::Allocate ( int  numTimeStep)
inline

Definition at line 70 of file vtkOffsetsManagerArray.h.

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

Definition at line 78 of file vtkOffsetsManagerArray.h.

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

Definition at line 83 of file vtkOffsetsManagerArray.h.

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

Definition at line 88 of file vtkOffsetsManagerArray.h.

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

Definition at line 93 of file vtkOffsetsManagerArray.h.

unsigned long& OffsetsManager::GetLastMTime ( )
inline

Definition at line 98 of file vtkOffsetsManagerArray.h.


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