Writer for multi-group datasets. More...

#include <vtkXMLCompositeDataWriter.h>

Inheritance diagram for vtkXMLCompositeDataWriter:

Collaboration diagram for vtkXMLCompositeDataWriter:

Public Types
typedef vtkXMLWriter	Superclass

Public Types inherited from vtkXMLWriter
enum	{ Int32 =32, Int64 =64 }

enum	CompressorType { NONE, ZLIB }

typedef vtkAlgorithm	Superclass

enum	{ BigEndian, LittleEndian }

enum	{ Ascii, Binary, Appended }

enum	{ UInt32 =32, UInt64 =64 }

Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass

enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkXMLCompositeDataWriter *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual const char *	GetDefaultFileExtension ()


virtual int	GetGhostLevel ()

virtual void	SetGhostLevel (int)


virtual int	GetWriteMetaFile ()

virtual void	SetWriteMetaFile (int flag)


int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector )

Public Member Functions inherited from vtkXMLWriter
vtkXMLWriter *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

int	Write ()

virtual void	SetByteOrder (int)

virtual int	GetByteOrder ()

void	SetByteOrderToBigEndian ()

void	SetByteOrderToLittleEndian ()

virtual void	SetHeaderType (int)

virtual int	GetHeaderType ()

void	SetHeaderTypeToUInt32 ()

void	SetHeaderTypeToUInt64 ()

virtual void	SetIdType (int)

virtual int	GetIdType ()

void	SetIdTypeToInt32 ()

void	SetIdTypeToInt64 ()

virtual void	SetFileName (const char *)

virtual char *	GetFileName ()

virtual void	SetWriteToOutputString (int)

virtual int	GetWriteToOutputString ()

virtual void	WriteToOutputStringOn ()

virtual void	WriteToOutputStringOff ()

std::string	GetOutputString ()

virtual void	SetCompressor (vtkDataCompressor *)

virtual vtkDataCompressor *	GetCompressor ()

void	SetCompressorType (int compressorType)

void	SetCompressorTypeToNone ()

void	SetCompressorTypeToZLib ()

virtual void	SetBlockSize (size_t blockSize)

virtual size_t	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	SetInputData (vtkDataObject *)

void	SetInputData (int, vtkDataObject *)

vtkDataObject *	GetInput (int port)

vtkDataObject *	GetInput ()

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
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

void	SetUpdateExtent (int port, int extent[6])

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, unsigned long *mtime)

virtual vtkInformation *	GetInformation ()

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)

vtkDataObject *	GetInputDataObject (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)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int extent[6])

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool 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)

vtkCommand *	GetCommand (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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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 &)

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 vtkXMLCompositeDataWriter *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkXMLWriter
static int	IsTypeOf (const char *type)

static vtkXMLWriter *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkXMLCompositeDataWriter ()

	~vtkXMLCompositeDataWriter ()

vtkStdString	CreatePieceFileName (int Piece)

virtual int	FillInputPortInformation (int port, vtkInformation *info)

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )

int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual int	WriteData ()

virtual const char *	GetDataSetName ()

virtual vtkExecutive *	CreateDefaultExecutive ()

virtual void	FillDataTypes (vtkCompositeDataSet *)

unsigned int	GetNumberOfDataTypes ()

int *	GetDataTypesPointer ()

void	CreateWriters (vtkCompositeDataSet *)

vtkXMLWriter *	GetWriter (int index)

void	SplitFileName ()

const char *	GetFilePrefix ()

const char *	GetFilePath ()

int	WriteMetaFileIfRequested ()

void	MakeDirectory (const char *name)

void	RemoveADirectory (const char *name)

virtual void	ProgressCallback (vtkAlgorithm *w)

virtual void	RemoveWrittenFiles (const char *SubDirectory)


virtual int	GetDataSetMajorVersion ()

virtual int	GetDataSetMinorVersion ()


virtual int	WriteComposite (vtkCompositeDataSet compositeData, vtkXMLDataElement element, int &writerIdx)=0


virtual int	WriteNonCompositeData (vtkDataObject dObj, vtkXMLDataElement element, int &writerIdx, const char *FileName)

Protected Member Functions inherited from vtkXMLWriter
	vtkXMLWriter ()

	~vtkXMLWriter ()

virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual void	SetDataStream (vtkOutputStream *)

virtual vtkOutputStream *	GetDataStream ()

virtual int	WriteInternal ()

vtkDataSet *	GetInputAsDataSet ()

virtual int	StartFile ()

virtual void	WriteFileAttributes ()

virtual int	EndFile ()

void	DeleteAFile ()

void	DeleteAFile (const char *name)

virtual int	WritePrimaryElement (ostream &os, vtkIndent indent)

virtual void	WritePrimaryElementAttributes (ostream &os, vtkIndent indent)

void	StartAppendedData ()

void	EndAppendedData ()

vtkTypeInt64	ReserveAttributeSpace (const char *attr, size_t length=20)

vtkTypeInt64	GetAppendedDataOffset ()

void	WriteAppendedDataOffset (vtkTypeInt64 streamPos, vtkTypeInt64 &lastoffset, const char *attr=0)

void	ForwardAppendedDataOffset (vtkTypeInt64 streamPos, vtkTypeInt64 offset, const char *attr=0)

void	ForwardAppendedDataDouble (vtkTypeInt64 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)

void	WriteArrayAppendedData (vtkAbstractArray *a, vtkTypeInt64 pos, vtkTypeInt64 &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)

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	WriteBinaryDataBlock (unsigned char *in_data, size_t numWords, int wordType)

void	PerformByteSwap (void *data, size_t numWords, size_t wordSize)

int	CreateCompressionHeader (size_t size)

int	WriteCompressionBlock (unsigned char *data, size_t size)

int	WriteCompressionHeader ()

size_t	GetWordTypeSize (int dataType)

const char *	GetWordTypeName (int dataType)

size_t	GetOutputWordTypeSize (int dataType)

char **	CreateStringArray (int numStrings)

void	DestroyStringArray (int numStrings, char **strings)

virtual void	GetProgressRange (float range[2])

virtual void	SetProgressRange (const float range[2], int curStep, int numSteps)

virtual void	SetProgressRange (const float range[2], int curStep, const float *fractions)

virtual void	SetProgressPartial (float fraction)

virtual void	UpdateProgressDiscrete (float progress)

int	OpenStream ()

int	OpenFile ()

int	OpenString ()

void	CloseStream ()

void	CloseFile ()

void	CloseString ()

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 void	ReportReferences (vtkGarbageCollector *)

virtual void	SetNumberOfInputConnections (int port, int n)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *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 &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static void	ProgressCallbackFunction (vtkObject , unsigned long, void , void *)

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Protected Attributes
vtkInformation *	InputInformation

vtkXMLCompositeDataWriterInternals *	Internal

int	GhostLevel

int	WriteMetaFile

vtkCallbackCommand *	ProgressObserver

Protected Attributes inherited from vtkXMLWriter
char *	FileName

ostream *	Stream

int	WriteToOutputString

std::string	OutputString

int	ByteOrder

int	HeaderType

int	IdType

int	DataMode

int	EncodeAppendedData

vtkTypeInt64	AppendedDataPosition

OffsetsManagerGroup *	FieldDataOM

Int32IdType *	Int32IdTypeBuffer

unsigned char *	ByteSwapBuffer

vtkDataCompressor *	Compressor

size_t	BlockSize

size_t	CompressionBlockNumber

vtkXMLDataHeader *	CompressionHeader

vtkTypeInt64	CompressionHeaderPosition

vtkOutputStream *	DataStream

float	ProgressRange [2]

ofstream *	OutFile

vtksys_ios::ostringstream *	OutStringStream

int	TimeStep

int	CurrentTimeIndex

int	NumberOfTimeSteps

int	TimeStepRange [2]

int	UserContinueExecuting

bool	UsePreviousVersion

vtkTypeInt64 *	NumberOfTimeValues

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Writer for multi-group datasets.

vtkXMLCompositeDataWriter writes (serially) the VTK XML multi-group, multi-block hierarchical and hierarchical box files. XML multi-group data files are meta-files that point to a list of serial VTK XML files.

See also: vtkXMLPCompositeDataWriter

Definition at line 37 of file vtkXMLCompositeDataWriter.h.

Member Typedef Documentation

typedef vtkXMLWriter vtkXMLCompositeDataWriter::Superclass

Definition at line 40 of file vtkXMLCompositeDataWriter.h.

Constructor & Destructor Documentation

vtkXMLCompositeDataWriter::vtkXMLCompositeDataWriter ( )

protected

vtkXMLCompositeDataWriter::~vtkXMLCompositeDataWriter ( )

protected

Member Function Documentation

static int vtkXMLCompositeDataWriter::IsTypeOf ( const char * type )

static

virtual int vtkXMLCompositeDataWriter::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.

Reimplemented in vtkXMLPMultiBlockDataWriter, vtkXMLPUniformGridAMRWriter, vtkXMLUniformGridAMRWriter, vtkXMLMultiBlockDataWriter, vtkXMLPHierarchicalBoxDataWriter, and vtkXMLHierarchicalBoxDataWriter.

static vtkXMLCompositeDataWriter* vtkXMLCompositeDataWriter::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkXMLCompositeDataWriter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkXMLWriter.

Reimplemented in vtkXMLPMultiBlockDataWriter, vtkXMLPUniformGridAMRWriter, vtkXMLUniformGridAMRWriter, vtkXMLMultiBlockDataWriter, vtkXMLPHierarchicalBoxDataWriter, and vtkXMLHierarchicalBoxDataWriter.

vtkXMLCompositeDataWriter* vtkXMLCompositeDataWriter::NewInstance ( ) const

void vtkXMLCompositeDataWriter::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 vtkAlgorithm.

Reimplemented in vtkXMLUniformGridAMRWriter, vtkXMLMultiBlockDataWriter, and vtkXMLHierarchicalBoxDataWriter.

virtual const char* vtkXMLCompositeDataWriter::GetDefaultFileExtension ( )

virtual

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

Implements vtkXMLWriter.

Reimplemented in vtkXMLUniformGridAMRWriter, vtkXMLMultiBlockDataWriter, and vtkXMLHierarchicalBoxDataWriter.

virtual int vtkXMLCompositeDataWriter::GetGhostLevel ( )

virtual

Get/Set the number of pieces into which the inputs are split.

Get/Set the number of ghost levels to be written.

virtual void vtkXMLCompositeDataWriter::SetGhostLevel ( int )

virtual

Get/Set the number of pieces into which the inputs are split.

Get/Set the number of ghost levels to be written.

virtual int vtkXMLCompositeDataWriter::GetWriteMetaFile ( )

virtual

Get/Set whether this instance will write the meta-file.

virtual void vtkXMLCompositeDataWriter::SetWriteMetaFile ( int flag )

virtual

Get/Set whether this instance will write the meta-file.

Reimplemented in vtkXMLPMultiBlockDataWriter, and vtkXMLPUniformGridAMRWriter.

int vtkXMLCompositeDataWriter::ProcessRequest	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

virtual

See the vtkAlgorithm for a desciption of what these do

Reimplemented from vtkXMLWriter.

virtual int vtkXMLCompositeDataWriter::GetDataSetMajorVersion ( )

inlineprotectedvirtual

Methods to define the file's major and minor version numbers. Major version incremented since v0.1 composite data readers cannot read the files written by this new reader.

Reimplemented from vtkXMLWriter.

Reimplemented in vtkXMLUniformGridAMRWriter.

Definition at line 75 of file vtkXMLCompositeDataWriter.h.

virtual int vtkXMLCompositeDataWriter::GetDataSetMinorVersion ( )

inlineprotectedvirtual

Methods to define the file's major and minor version numbers. Major version incremented since v0.1 composite data readers cannot read the files written by this new reader.

Reimplemented from vtkXMLWriter.

Reimplemented in vtkXMLUniformGridAMRWriter.

Definition at line 76 of file vtkXMLCompositeDataWriter.h.

vtkStdString vtkXMLCompositeDataWriter::CreatePieceFileName ( int Piece )

protected

Create a filename for the given index.

virtual int vtkXMLCompositeDataWriter::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.

Reimplemented in vtkXMLUniformGridAMRWriter, and vtkXMLMultiBlockDataWriter.

int vtkXMLCompositeDataWriter::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

protectedvirtual

Reimplemented from vtkXMLWriter.

int vtkXMLCompositeDataWriter::RequestUpdateExtent	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

protected

virtual int vtkXMLCompositeDataWriter::WriteData ( )

protectedvirtual

Reimplemented from vtkXMLWriter.

virtual const char* vtkXMLCompositeDataWriter::GetDataSetName ( )

protectedvirtual

Implements vtkXMLWriter.

virtual vtkExecutive* vtkXMLCompositeDataWriter::CreateDefaultExecutive ( )

protectedvirtual

Create a default executive. If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). Otherwise, vtkStreamingDemandDrivenPipeline is created.

Reimplemented from vtkAlgorithm.

virtual void vtkXMLCompositeDataWriter::FillDataTypes ( vtkCompositeDataSet * )

protectedvirtual

Determine the data types for each of the leaf nodes.

Reimplemented in vtkXMLPMultiBlockDataWriter, and vtkXMLPUniformGridAMRWriter.

unsigned int vtkXMLCompositeDataWriter::GetNumberOfDataTypes ( )

protected

Returns the number of leaf nodes (also includes empty leaf nodes).

int* vtkXMLCompositeDataWriter::GetDataTypesPointer ( )

protected

Returns the array pointer to the array of leaf nodes.

void vtkXMLCompositeDataWriter::CreateWriters ( vtkCompositeDataSet * )

protected

vtkXMLWriter* vtkXMLCompositeDataWriter::GetWriter ( int index )

protected

void vtkXMLCompositeDataWriter::SplitFileName ( )

protected

const char* vtkXMLCompositeDataWriter::GetFilePrefix ( )

protected

const char* vtkXMLCompositeDataWriter::GetFilePath ( )

protected

int vtkXMLCompositeDataWriter::WriteMetaFileIfRequested ( )

protected

Write the collection file if it is requested. This is overridden in parallel writers to communicate the hierarchy to the root which then write the meta file.

void vtkXMLCompositeDataWriter::MakeDirectory ( const char * name )

protected

void vtkXMLCompositeDataWriter::RemoveADirectory ( const char * name )

protected

static void vtkXMLCompositeDataWriter::ProgressCallbackFunction	(	vtkObject *	,
		unsigned	long,
		void *	,
		void *
	)

staticprotected

virtual void vtkXMLCompositeDataWriter::ProgressCallback ( vtkAlgorithm * w )

protectedvirtual

virtual int vtkXMLCompositeDataWriter::WriteComposite	(	vtkCompositeDataSet *	compositeData,
		vtkXMLDataElement *	element,
		int &	writerIdx
	)

protectedpure virtual

Internal method called recursively to create the xml tree for the children of compositeData as well as write the actual data set files. element will only have added nested information. writerIdx is the global piece index used to create unique filenames for each file written. This function returns 0 if no files were written from compositeData.

Implemented in vtkXMLPMultiBlockDataWriter, vtkXMLUniformGridAMRWriter, and vtkXMLMultiBlockDataWriter.

virtual int vtkXMLCompositeDataWriter::WriteNonCompositeData	(	vtkDataObject *	dObj,
		vtkXMLDataElement *	element,
		int &	writerIdx,
		const char *	FileName
	)

protectedvirtual

Internal method to write a non vtkCompositeDataSet subclass as well as add in the file name to the metadata file. Element is the containing XML metadata element that may have data overwritten and added to (the index XML attribute should not be touched though). writerIdx is the piece index that gets incremented for the globally numbered piece. This function returns 0 if no file was written (not necessarily an error). this->ErrorCode is set on error.

virtual void vtkXMLCompositeDataWriter::RemoveWrittenFiles ( const char * SubDirectory )

protectedvirtual

Utility function to remove any already written files in case writer failed.

Reimplemented in vtkXMLPMultiBlockDataWriter.

Member Data Documentation

vtkInformation* vtkXMLCompositeDataWriter::InputInformation

protected

Definition at line 96 of file vtkXMLCompositeDataWriter.h.

vtkXMLCompositeDataWriterInternals* vtkXMLCompositeDataWriter::Internal

protected

Definition at line 128 of file vtkXMLCompositeDataWriter.h.

int vtkXMLCompositeDataWriter::GhostLevel

protected

Definition at line 131 of file vtkXMLCompositeDataWriter.h.

int vtkXMLCompositeDataWriter::WriteMetaFile

protected

Whether to write the collection file on this node. This could potentially be set to 0 (i.e. do not write) for optimization if the file structured does not change but the data does.

Definition at line 136 of file vtkXMLCompositeDataWriter.h.

vtkCallbackCommand* vtkXMLCompositeDataWriter::ProgressObserver

protected

Definition at line 145 of file vtkXMLCompositeDataWriter.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/IO/XML/vtkXMLCompositeDataWriter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation