VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
vtkFieldDataSerializer Class Reference

#include <vtkFieldDataSerializer.h>

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

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkFieldDataSerializerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkFieldDataSerializerNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkFieldDataSerializerSafeDownCast (vtkObjectBase *o)
 
static void SerializeMetaData (vtkFieldData *fieldData, vtkMultiProcessStream &bytestream)
 Serializes the metadata of the given field data instance, i.e., the number of arrays, the name of each array and their dimensions. More...
 
static void DeserializeMetaData (vtkMultiProcessStream &bytestream, vtkStringArray *names, vtkIntArray *datatypes, vtkIntArray *dimensions)
 Given the serialized field metadata in a bytestream, this method extracts the name, datatype and dimensions of each array. More...
 
static void Serialize (vtkFieldData *fieldData, vtkMultiProcessStream &bytestream)
 Serializes the given field data (all the field data) into a bytestream. More...
 
static void SerializeTuples (vtkIdList *tupleIds, vtkFieldData *fieldData, vtkMultiProcessStream &bytestream)
 Serializes the selected tuples from the field data in a byte-stream. More...
 
static void SerializeSubExtent (int subext[6], int gridExtent[6], vtkFieldData *fieldData, vtkMultiProcessStream &bytestream)
 Serializes the given sub-extent of field data of a structured grid in a byte-stream. More...
 
static void DeSerializeToSubExtent (int subext[6], int gridExtent[6], vtkFieldData *fieldData, vtkMultiProcessStream &bytestream)
 Deserializes the field data from a bytestream to a the given sub-extent. More...
 
static void Deserialize (vtkMultiProcessStream &bytestream, vtkFieldData *fieldData)
 Deserializes the field data from a bytestream. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkFieldDataSerializer ()
 
 ~vtkFieldDataSerializer () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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 vtkDataArrayExtractSelectedTuples (vtkIdList *tupleIds, vtkDataArray *inputDataArray)
 Given an input data array and list of tuples, it extracts the selected tuples in to a new array and returns it. More...
 
static vtkDataArrayExtractSubExtentData (int subext[6], int gridExtent[6], vtkDataArray *inputDataArray)
 Given an input data array corresponding to a field on a structured grid, extract the data within the given extent. More...
 
static void SerializeDataArray (vtkDataArray *dataArray, vtkMultiProcessStream &bytestream)
 Serializes the data array into a bytestream. More...
 
static void DeserializeDataArray (vtkMultiProcessStream &bytestream, vtkDataArray *&dataArray)
 Deserializes the data array from a bytestream. More...
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > 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

Definition at line 42 of file vtkFieldDataSerializer.h.

Member Typedef Documentation

◆ Superclass

Definition at line 46 of file vtkFieldDataSerializer.h.

Constructor & Destructor Documentation

◆ vtkFieldDataSerializer()

vtkFieldDataSerializer::vtkFieldDataSerializer ( )
protected

◆ ~vtkFieldDataSerializer()

vtkFieldDataSerializer::~vtkFieldDataSerializer ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkFieldDataSerializer* vtkFieldDataSerializer::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkFieldDataSerializer::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkFieldDataSerializer* vtkFieldDataSerializer::NewInstance ( ) const

◆ PrintSelf()

void vtkFieldDataSerializer::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ SerializeMetaData()

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.

◆ DeserializeMetaData()

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.

◆ Serialize()

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

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

◆ SerializeTuples()

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

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

◆ SerializeSubExtent()

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.

◆ DeSerializeToSubExtent()

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.

◆ Deserialize()

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

Deserializes the field data from a bytestream.

◆ ExtractSelectedTuples()

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.

◆ ExtractSubExtentData()

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.

◆ SerializeDataArray()

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

Serializes the data array into a bytestream.

◆ DeserializeDataArray()

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: