vtkArrayWriter Class Reference

Serialize sparse and dense arrays to a file or stream. More...

#include <vtkArrayWriter.h>

Inheritance diagram for vtkArrayWriter:

Collaboration diagram for vtkArrayWriter:

Public Types
typedef vtkWriter	Superclass
Public Types inherited from vtkWriter
typedef vtkAlgorithm	Superclass
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)
vtkArrayWriter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	Write ()
bool	Write (const vtkStdString &FileName, bool WriteBinary=false)
bool	Write (ostream &stream, bool WriteBinary=false)
vtkStdString	Write (bool WriteBinary)
virtual void	SetFileName (const char *)
virtual char *	GetFileName ()
virtual void	SetBinary (int)
virtual int	GetBinary ()
virtual void	BinaryOn ()
virtual void	BinaryOff ()
virtual vtkStdString	GetOutputString ()
virtual void	SetWriteToOutputString (bool)
virtual bool	GetWriteToOutputString ()
virtual void	WriteToOutputStringOn ()
virtual void	WriteToOutputStringOff ()
Public Member Functions inherited from vtkWriter
vtkWriter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	EncodeString (char *resname, const char *name, bool doublePercent)
void	EncodeWriteString (ostream *out, const char *name, bool doublePercent)
void	SetInputData (vtkDataObject *input)
void	SetInputData (int index, vtkDataObject *input)
vtkDataObject *	GetInput ()
vtkDataObject *	GetInput (int port)
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 vtkArrayWriter *	New ()
static int	IsTypeOf (const char *type)
static vtkArrayWriter *	SafeDownCast (vtkObjectBase *o)
static bool	Write (vtkArray *array, const vtkStdString &file_name, bool WriteBinary=false)
static vtkStdString	Write (vtkArray *array, bool WriteBinary=false)
static bool	Write (vtkArray *array, ostream &stream, bool WriteBinary=false)
Static Public Member Functions inherited from vtkWriter
static int	IsTypeOf (const char *type)
static vtkWriter *	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
	vtkArrayWriter ()
	~vtkArrayWriter ()
virtual int	FillInputPortInformation (int port, vtkInformation *info)
virtual void	WriteData ()
Protected Member Functions inherited from vtkWriter
	vtkWriter ()
	~vtkWriter ()
virtual int	ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
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 vtkExecutive *	CreateDefaultExecutive ()
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 &)

Protected Attributes
char *	FileName
int	Binary
bool	WriteToOutputString
vtkStdString	OutputString
Protected Attributes inherited from vtkWriter
vtkTimeStamp	WriteTime
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 Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Serialize sparse and dense arrays to a file or stream.

vtkArrayWriter serializes sparse and dense array data using a text-based format that is human-readable and easily parsed (default option). The WriteBinary array option can be used to serialize the sparse and dense array data using a binary format that is optimized for rapid throughput.

vtkArrayWriter can be used in two distinct ways: first, it can be used as a normal pipeline filter, which writes its inputs to a file. Alternatively, static methods are provided for writing vtkArray instances to files or arbitrary c++ streams.

Inputs: Input port 0: (required) vtkArrayData object containing a single sparse or dense array.

Output Format: See http://www.kitware.com/InfovisWiki/index.php/N-Way_Array_File_Formats for details on how vtkArrayWriter encodes data.

See also

vtkArrayReader

Thanks:

Developed by Timothy M. Shead (tshea.nosp@m.d@sa.nosp@m.ndia..nosp@m.gov) at Sandia National Laboratories.

Tests:

vtkArrayWriter (Tests)

Definition at line 63 of file vtkArrayWriter.h.

Member Typedef Documentation

typedef vtkWriter vtkArrayWriter::Superclass

Definition at line 68 of file vtkArrayWriter.h.

Constructor & Destructor Documentation

vtkArrayWriter::vtkArrayWriter ( )

protected

vtkArrayWriter::~vtkArrayWriter ( )

protected

Member Function Documentation

static vtkArrayWriter* vtkArrayWriter::New ( )

static

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

static

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

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

static

virtual vtkObjectBase* vtkArrayWriter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkWriter.

vtkArrayWriter* vtkArrayWriter::NewInstance

(

)

const

void vtkArrayWriter::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.

virtual void vtkArrayWriter::SetFileName ( const char *  )

virtual

Get / set the filename where data will be stored (when used as a filter).

virtual char* vtkArrayWriter::GetFileName ( )

virtual

Get / set the filename where data will be stored (when used as a filter).

virtual void vtkArrayWriter::SetBinary ( int  )

virtual

Get / set whether data will be written in binary format (when used as a filter).

virtual int vtkArrayWriter::GetBinary ( )

virtual

Get / set whether data will be written in binary format (when used as a filter).

virtual void vtkArrayWriter::BinaryOn ( )

virtual

Get / set whether data will be written in binary format (when used as a filter).

virtual void vtkArrayWriter::BinaryOff ( )

virtual

Get / set whether data will be written in binary format (when used as a filter).

virtual vtkStdString vtkArrayWriter::GetOutputString ( )

inlinevirtual

The output string. This is only set when WriteToOutputString is set.

Definition at line 88 of file vtkArrayWriter.h.

virtual void vtkArrayWriter::SetWriteToOutputString ( bool  )

virtual

Whether to output to a string instead of to a file, which is the default.

virtual bool vtkArrayWriter::GetWriteToOutputString ( )

virtual

Whether to output to a string instead of to a file, which is the default.

virtual void vtkArrayWriter::WriteToOutputStringOn ( )

virtual

Whether to output to a string instead of to a file, which is the default.

virtual void vtkArrayWriter::WriteToOutputStringOff ( )

virtual

Whether to output to a string instead of to a file, which is the default.

virtual int vtkArrayWriter::Write ( )

virtual

Write data to output. Method executes subclasses WriteData() method, as well as StartMethod() and EndMethod() methods. Returns 1 on success and 0 on failure.

Reimplemented from vtkWriter.

bool vtkArrayWriter::Write	(	const vtkStdString &	FileName,
		bool	WriteBinary = false
	)

Writes input port 0 data to a file, using an arbitrary filename and binary flag.

static bool vtkArrayWriter::Write ( vtkArray *  array, const vtkStdString &  file_name, bool  WriteBinary = false  )

static

Write an arbitrary array to a file, without using the pipeline.

bool vtkArrayWriter::Write	(	ostream &	stream,
		bool	WriteBinary = false
	)

Write input port 0 data to an arbitrary stream. Note: streams should always be opened in binary mode, to prevent problems reading files on Windows.

static bool vtkArrayWriter::Write ( vtkArray *  array, ostream &  stream, bool  WriteBinary = false  )

static

Write arbitrary data to a stream without using the pipeline. Note: streams should always be opened in binary mode, to prevent problems reading files on Windows.

vtkStdString vtkArrayWriter::Write

(

bool

WriteBinary

)

Write input port 0 data to a string. Note that the WriteBinary argument is not optional in order to not clash with the inherited Write() method.

static vtkStdString vtkArrayWriter::Write ( vtkArray *  array, bool  WriteBinary = false  )

static

Write arbitrary data to a string without using the pipeline.

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

virtual void vtkArrayWriter::WriteData ( )

protectedvirtual

Implements vtkWriter.

Member Data Documentation

char* vtkArrayWriter::FileName

protected

Definition at line 138 of file vtkArrayWriter.h.

int vtkArrayWriter::Binary

protected

Definition at line 139 of file vtkArrayWriter.h.

bool vtkArrayWriter::WriteToOutputString

protected

Definition at line 140 of file vtkArrayWriter.h.

vtkStdString vtkArrayWriter::OutputString

protected

Definition at line 141 of file vtkArrayWriter.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/Core/vtkArrayWriter.h