VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkXMLHyperOctreeWriter Class Reference

Write VTK XML HyperOctree files. More...

#include <vtkXMLHyperOctreeWriter.h>

Inheritance diagram for vtkXMLHyperOctreeWriter:
[legend]
Collaboration diagram for vtkXMLHyperOctreeWriter:
[legend]

List of all members.

Public Types

typedef vtkXMLWriter Superclass
- Public Types inherited from vtkXMLWriter
enum  CompressorType { NONE, ZLIB }
enum  { BigEndian, LittleEndian }
enum  { Ascii, Binary, Appended }
enum  { Int32 = 32, Int64 = 64 }
typedef vtkIdType OffsetType
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
const char * GetDefaultFileExtension ()
vtkHyperOctreeGetInput ()
- Public Member Functions inherited from vtkXMLWriter
int Write ()
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void SetByteOrder (int)
virtual int GetByteOrder ()
void SetByteOrderToBigEndian ()
void SetByteOrderToLittleEndian ()
virtual void SetIdType (int)
virtual int GetIdType ()
void SetIdTypeToInt32 ()
void SetIdTypeToInt64 ()
virtual void SetFileName (const char *)
virtual char * GetFileName ()
virtual void SetCompressor (vtkDataCompressor *)
virtual vtkDataCompressorGetCompressor ()
void SetCompressorType (int compressorType)
void SetCompressorTypeToNone ()
void SetCompressorTypeToZLib ()
virtual void SetBlockSize (unsigned int blockSize)
virtual unsigned int GetBlockSize ()
virtual void SetDataMode (int)
virtual int GetDataMode ()
void SetDataModeToAscii ()
void SetDataModeToBinary ()
void SetDataModeToAppended ()
virtual void SetEncodeAppendedData (int)
virtual int GetEncodeAppendedData ()
virtual void EncodeAppendedDataOn ()
virtual void EncodeAppendedDataOff ()
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
vtkDataObjectGetInput (int port)
virtual void SetTimeStep (int)
virtual int GetTimeStep ()
virtual int * GetTimeStepRange ()
virtual void GetTimeStepRange (int &, int &)
virtual void GetTimeStepRange (int[2])
virtual void SetTimeStepRange (int, int)
void SetTimeStepRange (int[2])
virtual int GetNumberOfTimeSteps ()
virtual void SetNumberOfTimeSteps (int)
void Start ()
void Stop ()
void WriteNextTime (double time)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkXMLHyperOctreeWriterSafeDownCast (vtkObject *o)
static vtkXMLHyperOctreeWriterNew ()

Protected Member Functions

 vtkXMLHyperOctreeWriter ()
 ~vtkXMLHyperOctreeWriter ()
const char * GetDataSetName ()
virtual int FillInputPortInformation (int port, vtkInformation *info)
int WriteData ()
int StartPrimElement (vtkIndent)
void WritePrimaryElementAttributes (ostream &, vtkIndent)
int WriteTopology (vtkIndent)
void SerializeTopology (vtkHyperOctreeCursor *, int)
int WriteAttributeData (vtkIndent)
int FinishPrimElement (vtkIndent)
- Protected Member Functions inherited from vtkXMLWriter
 vtkXMLWriter ()
 ~vtkXMLWriter ()
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void SetDataStream (vtkOutputStream *)
virtual vtkOutputStreamGetDataStream ()
virtual int WriteInternal ()
virtual int GetDataSetMajorVersion ()
virtual int GetDataSetMinorVersion ()
vtkDataSetGetInputAsDataSet ()
int StartFile ()
virtual void WriteFileAttributes ()
int EndFile ()
void DeleteAFile ()
void DeleteAFile (const char *name)
virtual int WritePrimaryElement (ostream &os, vtkIndent indent)
void StartAppendedData ()
void EndAppendedData ()
OffsetType ReserveAttributeSpace (const char *attr, int length=20)
OffsetType GetAppendedDataOffset ()
OffsetType WriteAppendedDataOffset (OffsetType streamPos, OffsetType &lastoffset, const char *attr=0)
OffsetType ForwardAppendedDataOffset (OffsetType streamPos, OffsetType offset, const char *attr=0)
OffsetType ForwardAppendedDataDouble (OffsetType streamPos, double value, const char *attr)
int WriteScalarAttribute (const char *name, int data)
int WriteScalarAttribute (const char *name, float data)
int WriteScalarAttribute (const char *name, double data)
int WriteVectorAttribute (const char *name, int length, int *data)
int WriteVectorAttribute (const char *name, int length, float *data)
int WriteVectorAttribute (const char *name, int length, double *data)
int WriteDataModeAttribute (const char *name)
int WriteWordTypeAttribute (const char *name, int dataType)
int WriteStringAttribute (const char *name, const char *value)
void WriteArrayHeader (vtkAbstractArray *a, vtkIndent indent, const char *alternateName, int writeNumTuples, int timestep)
void WriteArrayFooter (ostream &os, vtkIndent indent, vtkAbstractArray *a, int shortFormat)
void WriteArrayInline (vtkAbstractArray *a, vtkIndent indent, const char *alternateName=0, int writeNumTuples=0)
void WriteInlineData (vtkAbstractArray *a, vtkIndent indent)
void WriteArrayAppended (vtkAbstractArray *a, vtkIndent indent, OffsetsManager &offs, const char *alternateName=0, int writeNumTuples=0, int timestep=0)
int WriteAsciiData (vtkAbstractArray *a, vtkIndent indent)
int WriteBinaryData (vtkAbstractArray *a)
int WriteBinaryDataInternal (vtkAbstractArray *a, OffsetType data_size)
void WriteArrayAppendedData (vtkAbstractArray *a, OffsetType pos, OffsetType &lastoffset)
void WriteFieldData (vtkIndent indent)
void WriteFieldDataInline (vtkFieldData *fd, vtkIndent indent)
void WritePointDataInline (vtkPointData *pd, vtkIndent indent)
void WriteCellDataInline (vtkCellData *cd, vtkIndent indent)
void WriteFieldDataAppended (vtkFieldData *fd, vtkIndent indent, OffsetsManagerGroup *fdManager)
void WriteFieldDataAppendedData (vtkFieldData *fd, int timestep, OffsetsManagerGroup *fdManager)
void WritePointDataAppended (vtkPointData *pd, vtkIndent indent, OffsetsManagerGroup *pdManager)
void WritePointDataAppendedData (vtkPointData *pd, int timestep, OffsetsManagerGroup *pdManager)
void WriteCellDataAppended (vtkCellData *cd, vtkIndent indent, OffsetsManagerGroup *cdManager)
void WriteCellDataAppendedData (vtkCellData *cd, int timestep, OffsetsManagerGroup *cdManager)
void WriteAttributeIndices (vtkDataSetAttributes *dsa, char **names)
void WritePointsAppended (vtkPoints *points, vtkIndent indent, OffsetsManager *manager)
void WritePointsAppendedData (vtkPoints *points, int timestep, OffsetsManager *pdManager)
void WritePointsInline (vtkPoints *points, vtkIndent indent)
void WriteCoordinatesInline (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, vtkIndent indent)
void WriteCoordinatesAppended (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, vtkIndent indent, OffsetsManagerGroup *coordManager)
void WriteCoordinatesAppendedData (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, int timestep, OffsetsManagerGroup *coordManager)
virtual vtkAbstractArrayCreateArrayForPoints (vtkAbstractArray *inArray)
virtual vtkAbstractArrayCreateArrayForCells (vtkAbstractArray *inArray)
virtual vtkDataArrayCreateExactCoordinates (vtkDataArray *inArray, int xyz)
void WritePPointData (vtkPointData *pd, vtkIndent indent)
void WritePCellData (vtkCellData *cd, vtkIndent indent)
void WritePPoints (vtkPoints *points, vtkIndent indent)
void WritePArray (vtkAbstractArray *a, vtkIndent indent, const char *alternateName=0)
void WritePCoordinates (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, vtkIndent indent)
int WriteBinaryDataInternal (void *data, OffsetType numWords, int wordType)
int WriteBinaryDataBlock (unsigned char *in_data, OffsetType numWords, int wordType)
void PerformByteSwap (void *data, OffsetType numWords, int wordSize)
int CreateCompressionHeader (OffsetType size)
int WriteCompressionBlock (unsigned char *data, OffsetType size)
int WriteCompressionHeader ()
OffsetType GetWordTypeSize (int dataType)
const char * GetWordTypeName (int dataType)
OffsetType GetOutputWordTypeSize (int dataType)
char ** CreateStringArray (int numStrings)
void DestroyStringArray (int numStrings, char **strings)
virtual void GetProgressRange (float *range)
virtual void SetProgressRange (float *range, int curStep, int numSteps)
virtual void SetProgressRange (float *range, int curStep, float *fractions)
virtual void SetProgressPartial (float fraction)
virtual void UpdateProgressDiscrete (float progress)
int OpenFile ()
void CloseFile ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkIntArrayTopologyArray
unsigned long TopoOffset
OffsetsManagerGroupTopologyOM
OffsetsManagerGroupPointDataOM
OffsetsManagerGroupCellDataOM
- Protected Attributes inherited from vtkXMLWriter
char * FileName
ostream * Stream
int ByteOrder
int IdType
int DataMode
int EncodeAppendedData
OffsetType AppendedDataPosition
OffsetsManagerGroupFieldDataOM
Int32IdType * Int32IdTypeBuffer
unsigned char * ByteSwapBuffer
vtkDataCompressorCompressor
unsigned int BlockSize
OffsetType CompressionBlockNumber
HeaderType * CompressionHeader
unsigned int CompressionHeaderLength
OffsetType CompressionHeaderPosition
vtkOutputStreamDataStream
float ProgressRange [2]
ofstream * OutFile
int TimeStep
int CurrentTimeIndex
int NumberOfTimeSteps
int TimeStepRange [2]
int UserContinueExecuting
unsigned long * NumberOfTimeValues
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
double Progress
char * ProgressText
unsigned long ErrorCode
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

Detailed Description

Write VTK XML HyperOctree files.

vtkXMLHyperOctreeWriter writes the VTK XML HyperOctree file format. One HyperOctree input can be written into one file in any number of streamed pieces. The standard extension for this writer's file format is "vto". This writer is also used to write a single piece of the parallel file format.

See also:
vtkXMLPHyperOctreeWriter
Tests:
vtkXMLHyperOctreeWriter (Tests)

Definition at line 40 of file vtkXMLHyperOctreeWriter.h.


Member Typedef Documentation

Reimplemented from vtkXMLWriter.

Definition at line 43 of file vtkXMLHyperOctreeWriter.h.


Constructor & Destructor Documentation

vtkXMLHyperOctreeWriter::vtkXMLHyperOctreeWriter ( )
protected
vtkXMLHyperOctreeWriter::~vtkXMLHyperOctreeWriter ( )
protected

Member Function Documentation

virtual const char* vtkXMLHyperOctreeWriter::GetClassName ( )
virtual

Reimplemented from vtkXMLWriter.

static int vtkXMLHyperOctreeWriter::IsTypeOf ( const char *  name)
static

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkXMLWriter.

virtual int vtkXMLHyperOctreeWriter::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkXMLWriter.

static vtkXMLHyperOctreeWriter* vtkXMLHyperOctreeWriter::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkXMLWriter.

void vtkXMLHyperOctreeWriter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkXMLWriter.

static vtkXMLHyperOctreeWriter* vtkXMLHyperOctreeWriter::New ( )
static

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

vtkHyperOctree* vtkXMLHyperOctreeWriter::GetInput ( )

Get/Set the writer's input.

Reimplemented from vtkXMLWriter.

const char* vtkXMLHyperOctreeWriter::GetDefaultFileExtension ( )
virtual

Get the default file extension for files written by this writer.

Implements vtkXMLWriter.

const char* vtkXMLHyperOctreeWriter::GetDataSetName ( )
protectedvirtual

Implements vtkXMLWriter.

virtual int vtkXMLHyperOctreeWriter::FillInputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.

int vtkXMLHyperOctreeWriter::WriteData ( )
protectedvirtual

Reimplemented from vtkXMLWriter.

int vtkXMLHyperOctreeWriter::StartPrimElement ( vtkIndent  )
protected
void vtkXMLHyperOctreeWriter::WritePrimaryElementAttributes ( ostream &  ,
vtkIndent   
)
protectedvirtual

Reimplemented from vtkXMLWriter.

int vtkXMLHyperOctreeWriter::WriteTopology ( vtkIndent  )
protected
void vtkXMLHyperOctreeWriter::SerializeTopology ( vtkHyperOctreeCursor ,
int   
)
protected
int vtkXMLHyperOctreeWriter::WriteAttributeData ( vtkIndent  )
protected
int vtkXMLHyperOctreeWriter::FinishPrimElement ( vtkIndent  )
protected

Member Data Documentation

vtkIntArray* vtkXMLHyperOctreeWriter::TopologyArray
protected

Definition at line 88 of file vtkXMLHyperOctreeWriter.h.

unsigned long vtkXMLHyperOctreeWriter::TopoOffset
protected

Definition at line 89 of file vtkXMLHyperOctreeWriter.h.

OffsetsManagerGroup* vtkXMLHyperOctreeWriter::TopologyOM
protected

Definition at line 90 of file vtkXMLHyperOctreeWriter.h.

OffsetsManagerGroup* vtkXMLHyperOctreeWriter::PointDataOM
protected

Definition at line 91 of file vtkXMLHyperOctreeWriter.h.

OffsetsManagerGroup* vtkXMLHyperOctreeWriter::CellDataOM
protected

Definition at line 92 of file vtkXMLHyperOctreeWriter.h.


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