vtkFieldDataSerializer Class Reference

#include <vtkFieldDataSerializer.h>

Inheritance diagram for vtkFieldDataSerializer:

Collaboration diagram for vtkFieldDataSerializer:

List of all members.

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkFieldDataSerializer *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
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	Deserialize (vtkMultiProcessStream &bytestream, vtkFieldData *fieldData)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkFieldDataSerializer ()
virtual	~vtkFieldDataSerializer ()
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)

---

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

Reimplemented from vtkObject.

Definition at line 48 of file vtkFieldDataSerializer.h.

---

Constructor & Destructor Documentation

vtkFieldDataSerializer::vtkFieldDataSerializer

(

)

[protected]

virtual vtkFieldDataSerializer::~vtkFieldDataSerializer

(

)

[protected, virtual]

---

Member Function Documentation

static vtkFieldDataSerializer* vtkFieldDataSerializer::New

(

)

[static]

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

Reimplemented from vtkObject.

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

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]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkFieldDataSerializer::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkObject.

vtkFieldDataSerializer* vtkFieldDataSerializer::NewInstance

(

)

const

Reimplemented from vtkObject.

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::Deserialize	(	vtkMultiProcessStream &	bytestream,
		vtkFieldData *	fieldData
	)		[static]

Deserializes the field data from a bytestream.

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

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
	)		[static, protected]

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
	)		[static, protected]

Serializes the data array into a bytestream.

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

Deserializes the data array from a bytestream

---

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

• dox/Parallel/Core/vtkFieldDataSerializer.h