#include <vtkFieldDataSerializer.h>

Inheritance diagram for vtkFieldDataSerializer:

Collaboration diagram for vtkFieldDataSerializer:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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

vtkFieldDataSerializer *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

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)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

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 vtkFieldDataSerializer *	New ()

static int	IsTypeOf (const char *type)

static vtkFieldDataSerializer *	SafeDownCast (vtkObjectBase *o)


static void	SerializeMetaData (vtkFieldData *fieldData, vtkMultiProcessStream &bytestream)


static void	DeserializeMetaData (vtkMultiProcessStream &bytestream, vtkStringArray names, vtkIntArray datatypes, vtkIntArray *dimensions)


static void	Serialize (vtkFieldData *fieldData, vtkMultiProcessStream &bytestream)


static void	SerializeTuples (vtkIdList tupleIds, vtkFieldData fieldData, vtkMultiProcessStream &bytestream)


static void	SerializeSubExtent (int subext[6], int gridExtent[6], vtkFieldData *fieldData, vtkMultiProcessStream &bytestream)


static void	DeSerializeToSubExtent (int subext[6], int gridExtent[6], vtkFieldData *fieldData, vtkMultiProcessStream &bytestream)


static void	Deserialize (vtkMultiProcessStream &bytestream, vtkFieldData *fieldData)

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

	vtkFieldDataSerializer ()

virtual	~vtkFieldDataSerializer ()

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 &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions

static vtkDataArray *	ExtractSelectedTuples (vtkIdList tupleIds, vtkDataArray inputDataArray)


static vtkDataArray *	ExtractSubExtentData (int subext[6], int gridExtent[6], vtkDataArray *inputDataArray)


static void	SerializeDataArray (vtkDataArray *dataArray, vtkMultiProcessStream &bytestream)


static void	DeserializeDataArray (vtkMultiProcessStream &bytestream, vtkDataArray *&dataArray)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

A concrete instance of vtkObject which provides functionality for serializing and de-serializing field data, primarily used for the purpose of preparing the data for transfer over MPI or other communication mechanism.

See also: vtkFieldData vtkPointData vtkCellData vtkMultiProcessStream

Tests:: vtkFieldDataSerializer (Tests)

Definition at line 44 of file vtkFieldDataSerializer.h.

Member Typedef Documentation

typedef vtkObject vtkFieldDataSerializer::Superclass

Definition at line 48 of file vtkFieldDataSerializer.h.

Constructor & Destructor Documentation

vtkFieldDataSerializer::vtkFieldDataSerializer ( )

protected

virtual vtkFieldDataSerializer::~vtkFieldDataSerializer ( )

protectedvirtual

Member Function Documentation

static vtkFieldDataSerializer* vtkFieldDataSerializer::New ( )

static

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

static

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

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

static

virtual vtkObjectBase* vtkFieldDataSerializer::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkFieldDataSerializer* vtkFieldDataSerializer::NewInstance ( ) const

void vtkFieldDataSerializer::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 vtkObject.

static void vtkFieldDataSerializer::SerializeMetaData	(	vtkFieldData *	fieldData,
		vtkMultiProcessStream &	bytestream
	)

static

Serializes the metadata of the given field data instance, i.e., the number of arrays, the name of each array and their dimensions.

static void vtkFieldDataSerializer::DeserializeMetaData	(	vtkMultiProcessStream &	bytestream,
		vtkStringArray *	names,
		vtkIntArray *	datatypes,
		vtkIntArray *	dimensions
	)

static

Given the serialized field metadata in a bytestream, this method extracts the name, datatype and dimensions of each array. The metadata is deserialized on user-supplied, pre-allocated data structures. (1) names – an array of strings wherein, each element, names[i], corresponds to the name of array i. (2) datatypes – an array of ints where each element corresponds to the actual primitive type of each array, e.g.,VTK_DOUBLE,VTK_INT, etc. (3) dimensions – a 2-component array of integers where the first component corresponds to the number of tuples of and the second component corresponds to the number components of array i.

static void vtkFieldDataSerializer::Serialize	(	vtkFieldData *	fieldData,
		vtkMultiProcessStream &	bytestream
	)

static

Serializes the given field data (all the field data) into a bytestream.

static void vtkFieldDataSerializer::SerializeTuples	(	vtkIdList *	tupleIds,
		vtkFieldData *	fieldData,
		vtkMultiProcessStream &	bytestream
	)

static

Serializes the selected tuples from the the field data in a byte-stream.

static void vtkFieldDataSerializer::SerializeSubExtent	(	int	subext[6],
		int	gridExtent[6],
		vtkFieldData *	fieldData,
		vtkMultiProcessStream &	bytestream
	)

static

Serializes the given sub-extent of field data of a structured grid in a byte-stream. The field data can be either cell-centered or node-centered depending on what subext and gridExtent actually represents.

static void vtkFieldDataSerializer::DeSerializeToSubExtent	(	int	subext[6],
		int	gridExtent[6],
		vtkFieldData *	fieldData,
		vtkMultiProcessStream &	bytestream
	)

static

Deserializes the field data from a bytestream to a the given sub-extent. The field data can be either cell-centered or node-centered depending on what subext and gridExtent actually represent.

static void vtkFieldDataSerializer::Deserialize	(	vtkMultiProcessStream &	bytestream,
		vtkFieldData *	fieldData
	)

static

Deserializes the field data from a bytestream.

static vtkDataArray* vtkFieldDataSerializer::ExtractSelectedTuples	(	vtkIdList *	tupleIds,
		vtkDataArray *	inputDataArray
	)

staticprotected

Given an input data array and list of tuples, it extracts the selected tuples in to a new array and returns it.

static vtkDataArray* vtkFieldDataSerializer::ExtractSubExtentData	(	int	subext[6],
		int	gridExtent[6],
		vtkDataArray *	inputDataArray
	)

staticprotected

Given an input data array corresponding to a field on a structured grid, extract the data within the given extent.

static void vtkFieldDataSerializer::SerializeDataArray	(	vtkDataArray *	dataArray,
		vtkMultiProcessStream &	bytestream
	)

staticprotected

Serializes the data array into a bytestream.

static void vtkFieldDataSerializer::DeserializeDataArray	(	vtkMultiProcessStream &	bytestream,
		vtkDataArray *&	dataArray
	)

staticprotected

Deserializes the data array from a bytestream

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Parallel/Core/vtkFieldDataSerializer.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation