Light object for holding data information. More...
#include <vtkPVDataInformation.h>
Public Types | |
typedef vtkPVInformation | Superclass |
Public Types inherited from vtkPVInformation | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
void | PrintSelf (ostream &os, vtkIndent indent) override |
vtkPVArrayInformation * | GetArrayInformation (const char *arrayname, int fieldAssociation) |
Method to find and return attribute array information for a particular array for the given attribute type if one exists. More... | |
void | CopyFromObject (vtkObject *) override |
Transfer information about a single object into this object. More... | |
void | AddInformation (vtkPVInformation *info) override |
Merge another information object. More... | |
virtual void | AddInformation (vtkPVInformation *, int addingParts) |
Merge another information object. More... | |
void | Initialize () |
Remove all information. More... | |
vtkTypeInt64 | GetNumberOfElements (int type) |
Returns the number of elements of the given type where type can vtkDataObject::POINT, vtkDataObject::CELL, ... More... | |
const char * | GetPrettyDataTypeString () |
Returns a string describing the datatype that can be directly shown in a user interface. More... | |
vtkPVDataSetAttributesInformation * | GetAttributeInformation (int fieldAssociation) |
Method to access vtkPVDataSetAttributesInformation using field association type. More... | |
vtkPVDataInformation * | GetDataInformationForCompositeIndex (int index) |
Given the flat-index for a node in a composite dataset, this method returns the data information for the node, it available. More... | |
unsigned int | GetNumberOfBlockLeafs (bool skipEmpty) |
Compute the number of block leaf from this information multipieces are counted as single block. More... | |
vtkPVDataInformation * | GetDataInformationForCompositeIndex (int *index) |
This is same as GetDataInformationForCompositeIndex() however note that the index will get modified in this method. More... | |
virtual double * | GetTimeSpan () |
virtual void | GetTimeSpan (double &, double &) |
virtual void | GetTimeSpan (double [2]) |
bool | IsDataStructured () |
Returns if the data type is structured. More... | |
bool | IsAttributeValid (int fieldAssociation) |
Returns true if provided fieldAssociation is valid for this dataset, false otherwise. More... | |
virtual void | SetPortNumber (int) |
Port number controls which output port the information is gathered from. More... | |
virtual int | GetPortNumber () |
Port number controls which output port the information is gathered from. More... | |
void | CopyToStream (vtkClientServerStream *) override |
Manage a serialized version of the information. More... | |
void | CopyFromStream (const vtkClientServerStream *) override |
Manage a serialized version of the information. More... | |
void | CopyParametersToStream (vtkMultiProcessStream &) override |
Serialize/Deserialize the parameters that control how/what information is gathered. More... | |
void | CopyParametersFromStream (vtkMultiProcessStream &) override |
Serialize/Deserialize the parameters that control how/what information is gathered. More... | |
virtual int | GetDataSetType () |
Access to information. More... | |
virtual int | GetCompositeDataSetType () |
Access to information. More... | |
const char * | GetDataSetTypeAsString () |
Access to information. More... | |
bool | DataSetTypeIsA (const char *type) |
Access to information. More... | |
virtual vtkTypeInt64 | GetNumberOfPoints () |
Access to information. More... | |
virtual vtkTypeInt64 | GetNumberOfCells () |
Access to information. More... | |
virtual vtkTypeInt64 | GetNumberOfRows () |
Access to information. More... | |
virtual vtkTypeInt64 | GetNumberOfTrees () |
Access to information. More... | |
virtual vtkTypeInt64 | GetNumberOfVertices () |
Access to information. More... | |
virtual vtkTypeInt64 | GetNumberOfEdges () |
Access to information. More... | |
virtual vtkTypeInt64 | GetNumberOfLeaves () |
Access to information. More... | |
virtual int | GetMemorySize () |
Access to information. More... | |
virtual vtkIdType | GetPolygonCount () |
Access to information. More... | |
virtual int | GetNumberOfDataSets () |
Access to information. More... | |
virtual double * | GetBounds () |
Access to information. More... | |
virtual void | GetBounds (double &, double &, double &, double &, double &, double &) |
Access to information. More... | |
virtual void | GetBounds (double [6]) |
Access to information. More... | |
virtual int * | GetExtent () |
Of course Extent is only valid for structured data sets. More... | |
virtual void | GetExtent (int &, int &, int &, int &, int &, int &) |
Of course Extent is only valid for structured data sets. More... | |
virtual void | GetExtent (int [6]) |
Of course Extent is only valid for structured data sets. More... | |
virtual vtkPVArrayInformation * | GetPointArrayInformation () |
Access to information about points. More... | |
virtual vtkPVDataSetAttributesInformation * | GetPointDataInformation () |
Access to information about point/cell/vertex/edge/row data. More... | |
virtual vtkPVDataSetAttributesInformation * | GetCellDataInformation () |
Access to information about point/cell/vertex/edge/row data. More... | |
virtual vtkPVDataSetAttributesInformation * | GetVertexDataInformation () |
Access to information about point/cell/vertex/edge/row data. More... | |
virtual vtkPVDataSetAttributesInformation * | GetEdgeDataInformation () |
Access to information about point/cell/vertex/edge/row data. More... | |
virtual vtkPVDataSetAttributesInformation * | GetRowDataInformation () |
Access to information about point/cell/vertex/edge/row data. More... | |
virtual vtkPVDataSetAttributesInformation * | GetFieldDataInformation () |
Accesse to information about field data, if any. More... | |
virtual vtkPVCompositeDataInformation * | GetCompositeDataInformation () |
If data is composite, this provides information specific to composite datasets. More... | |
virtual char * | GetDataClassName () |
ClassName of the data represented by information object. More... | |
virtual char * | GetCompositeDataClassName () |
The least common class name of composite dataset blocks. More... | |
virtual int | GetHasTime () |
Returns if the Time is set. More... | |
virtual double | GetTime () |
Returns the data time if, GetHasTime() return true. More... | |
virtual int | GetNumberOfTimeSteps () |
Returns the number of time steps. More... | |
virtual char * | GetTimeLabel () |
Returns the label that should be used instead of "Time" if any. More... | |
virtual char * | GetCompositeDataSetName () |
If this instance of vtkPVDataInformation summarizes a node in a composite-dataset, and if that node has been given a label in that composite dataset (using vtkCompositeDataSet::NAME meta-data), then this will return that name. More... | |
Public Member Functions inherited from vtkPVInformation | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
virtual int | GetRootOnly () |
Set/get whether to gather information only from the root. More... | |
Public Member Functions inherited from vtkObject | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
virtual void | DebugOff () |
bool | GetDebug () |
void | SetDebug (bool debugFlag) |
virtual void | Modified () |
virtual vtkMTimeType | GetMTime () |
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) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
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 *) |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
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) |
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 *) |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
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) |
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) |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
int | GetReferenceCount () |
void | PrintRevisions (ostream &) |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
int | GetReferenceCount () |
void | PrintRevisions (ostream &) |
Static Public Member Functions | |
static vtkPVDataInformation * | New () |
static int | IsTypeOf (const char *type) |
static vtkPVDataInformation * | SafeDownCast (vtkObject *o) |
static void | RegisterHelper (const char *classname, const char *helperclassname) |
Allows run time addition of information getters for new classes. More... | |
Static Public Member Functions inherited from vtkPVInformation | |
static int | IsTypeOf (const char *type) |
static vtkPVInformation * | SafeDownCast (vtkObject *o) |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
static void | BreakOnError () |
static void | SetGlobalWarningDisplay (int val) |
static void | GlobalWarningDisplayOn () |
static void | GlobalWarningDisplayOff () |
static int | GetGlobalWarningDisplay () |
static void | SetGlobalWarningDisplay (int val) |
static void | GlobalWarningDisplayOn () |
static void | GlobalWarningDisplayOff () |
static int | GetGlobalWarningDisplay () |
Static Public Member Functions inherited from vtkObjectBase | |
static vtkTypeBool | IsTypeOf (const char *name) |
static vtkObjectBase * | New () |
static vtkObjectBase * | New () |
Static Protected Member Functions | |
static vtkPVDataInformationHelper * | FindHelper (const char *classname) |
Friends | |
class | vtkPVDataInformationHelper |
class | vtkPVCompositeDataInformation |
Light object for holding data information.
This object is a light weight object. It has no user interface and does not necessarily last a long time. It is meant to help collect information about data object and collections of data objects. It has a PV in the class name because it should never be moved into VTK.
Definition at line 51 of file vtkPVDataInformation.h.
Definition at line 55 of file vtkPVDataInformation.h.
|
protected |
|
overrideprotected |
|
static |
|
virtual |
Reimplemented from vtkPVInformation.
Reimplemented in vtkPVRepresentedDataInformation.
|
static |
|
virtual |
Reimplemented from vtkPVInformation.
Reimplemented in vtkPVRepresentedDataInformation.
|
static |
|
overridevirtual |
Reimplemented from vtkObject.
Reimplemented in vtkPVRepresentedDataInformation.
vtkPVArrayInformation* vtkPVDataInformation::GetArrayInformation | ( | const char * | arrayname, |
int | fieldAssociation | ||
) |
Method to find and return attribute array information for a particular array for the given attribute type if one exists.
Returns NULL if none is found. fieldAssociation
can be vtkDataObject::FIELD_ASSOCIATION_POINTS, vtkDataObject::FIELD_ASSOCIATION_CELLS etc. (use vtkDataObject::FIELD_ASSOCIATION_NONE for field data) (or vtkDataObject::POINT, vtkDataObject::CELL, vtkDataObject::FIELD).
|
virtual |
Port number controls which output port the information is gathered from.
This is the only parameter that can be set on the client-side before gathering the information.
|
virtual |
Port number controls which output port the information is gathered from.
This is the only parameter that can be set on the client-side before gathering the information.
|
overridevirtual |
Transfer information about a single object into this object.
Reimplemented from vtkPVInformation.
Reimplemented in vtkPVRepresentedDataInformation.
|
overridevirtual |
Merge another information object.
Calls AddInformation(info, 0).
Reimplemented from vtkPVInformation.
|
virtual |
Merge another information object.
If adding information of 1 part across processors, set addingParts to false. If adding information of parts, set addingParts to true.
|
overridevirtual |
Manage a serialized version of the information.
Implements vtkPVInformation.
|
overridevirtual |
Manage a serialized version of the information.
Reimplemented from vtkPVInformation.
|
overridevirtual |
Serialize/Deserialize the parameters that control how/what information is gathered.
This are different from the ivars that constitute the gathered information itself. For example, PortNumber on vtkPVDataInformation controls what output port the data-information is gathered from.
Reimplemented from vtkPVInformation.
|
overridevirtual |
Serialize/Deserialize the parameters that control how/what information is gathered.
This are different from the ivars that constitute the gathered information itself. For example, PortNumber on vtkPVDataInformation controls what output port the data-information is gathered from.
Reimplemented from vtkPVInformation.
void vtkPVDataInformation::Initialize | ( | ) |
Remove all information.
The next add will be like a copy. I might want to put this in the PVInformation superclass.
|
virtual |
Access to information.
|
virtual |
Access to information.
const char* vtkPVDataInformation::GetDataSetTypeAsString | ( | ) |
Access to information.
bool vtkPVDataInformation::DataSetTypeIsA | ( | const char * | type | ) |
Access to information.
|
virtual |
Access to information.
|
virtual |
Access to information.
|
virtual |
Access to information.
|
virtual |
Access to information.
|
virtual |
Access to information.
|
virtual |
Access to information.
|
virtual |
Access to information.
|
virtual |
Access to information.
|
virtual |
Access to information.
|
virtual |
Access to information.
|
virtual |
Access to information.
|
virtual |
Access to information.
|
virtual |
Access to information.
vtkTypeInt64 vtkPVDataInformation::GetNumberOfElements | ( | int | type | ) |
Returns the number of elements of the given type where type can vtkDataObject::POINT, vtkDataObject::CELL, ...
etc.
const char* vtkPVDataInformation::GetPrettyDataTypeString | ( | ) |
Returns a string describing the datatype that can be directly shown in a user interface.
|
virtual |
Of course Extent is only valid for structured data sets.
Extent is the largest extent that contains all the parts.
|
virtual |
Of course Extent is only valid for structured data sets.
Extent is the largest extent that contains all the parts.
|
virtual |
Of course Extent is only valid for structured data sets.
Extent is the largest extent that contains all the parts.
|
virtual |
Access to information about points.
Only valid for subclasses of vtkPointSet.
|
virtual |
Access to information about point/cell/vertex/edge/row data.
|
virtual |
Access to information about point/cell/vertex/edge/row data.
|
virtual |
Access to information about point/cell/vertex/edge/row data.
|
virtual |
Access to information about point/cell/vertex/edge/row data.
|
virtual |
Access to information about point/cell/vertex/edge/row data.
|
virtual |
Accesse to information about field data, if any.
vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetAttributeInformation | ( | int | fieldAssociation | ) |
Method to access vtkPVDataSetAttributesInformation using field association type.
fieldAssociation
can be vtkDataObject::FIELD_ASSOCIATION_POINTS, vtkDataObject::FIELD_ASSOCIATION_CELLS etc. (use vtkDataObject::FIELD_ASSOCIATION_NONE for field data).
|
virtual |
If data is composite, this provides information specific to composite datasets.
vtkPVDataInformation* vtkPVDataInformation::GetDataInformationForCompositeIndex | ( | int | index | ) |
Given the flat-index for a node in a composite dataset, this method returns the data information for the node, it available.
unsigned int vtkPVDataInformation::GetNumberOfBlockLeafs | ( | bool | skipEmpty | ) |
Compute the number of block leaf from this information multipieces are counted as single block.
The boolean skipEmpty parameter allows to choose to count empty dataset are not Calling this method with skipEmpty to false will correspond to the vtkBlockColors array in a multiblock.
vtkPVDataInformation* vtkPVDataInformation::GetDataInformationForCompositeIndex | ( | int * | index | ) |
This is same as GetDataInformationForCompositeIndex() however note that the index will get modified in this method.
|
virtual |
ClassName of the data represented by information object.
|
virtual |
The least common class name of composite dataset blocks.
|
virtual |
|
virtual |
|
virtual |
Returns if the Time is set.
|
virtual |
Returns the data time if, GetHasTime() return true.
|
virtual |
Returns the number of time steps.
|
virtual |
Returns the label that should be used instead of "Time" if any.
bool vtkPVDataInformation::IsDataStructured | ( | ) |
Returns if the data type is structured.
bool vtkPVDataInformation::IsAttributeValid | ( | int | fieldAssociation | ) |
Returns true if provided fieldAssociation is valid for this dataset, false otherwise.
Always returns true for composite datasets. eg, FIELD_ASSOCIATION_EDGES will return false for a vtkPolyData, true for a vtkGraph.
|
virtual |
If this instance of vtkPVDataInformation summarizes a node in a composite-dataset, and if that node has been given a label in that composite dataset (using vtkCompositeDataSet::NAME meta-data), then this will return that name.
Returns NULL if this instance doesn't represent a node in a composite dataset or doesn't have a label/name associated with it.
|
static |
Allows run time addition of information getters for new classes.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protectedvirtual |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
staticprotected |
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
|
friend |
Definition at line 364 of file vtkPVDataInformation.h.
|
friend |
Definition at line 365 of file vtkPVDataInformation.h.
|
protected |
Definition at line 320 of file vtkPVDataInformation.h.
|
protected |
Definition at line 321 of file vtkPVDataInformation.h.
|
protected |
Definition at line 322 of file vtkPVDataInformation.h.
|
protected |
Definition at line 323 of file vtkPVDataInformation.h.
|
protected |
Definition at line 324 of file vtkPVDataInformation.h.
|
protected |
Definition at line 325 of file vtkPVDataInformation.h.
|
protected |
Definition at line 326 of file vtkPVDataInformation.h.
|
protected |
Definition at line 327 of file vtkPVDataInformation.h.
|
protected |
Definition at line 328 of file vtkPVDataInformation.h.
|
protected |
Definition at line 329 of file vtkPVDataInformation.h.
|
protected |
Definition at line 330 of file vtkPVDataInformation.h.
|
protected |
Definition at line 331 of file vtkPVDataInformation.h.
|
protected |
Definition at line 332 of file vtkPVDataInformation.h.
|
protected |
Definition at line 334 of file vtkPVDataInformation.h.
|
protected |
Definition at line 336 of file vtkPVDataInformation.h.
|
protected |
Definition at line 337 of file vtkPVDataInformation.h.
|
protected |
Definition at line 338 of file vtkPVDataInformation.h.
|
protected |
Definition at line 339 of file vtkPVDataInformation.h.
|
protected |
Definition at line 341 of file vtkPVDataInformation.h.
|
protected |
Definition at line 344 of file vtkPVDataInformation.h.
|
protected |
Definition at line 347 of file vtkPVDataInformation.h.
|
protected |
Definition at line 350 of file vtkPVDataInformation.h.
|
protected |
Definition at line 351 of file vtkPVDataInformation.h.
|
protected |
Definition at line 354 of file vtkPVDataInformation.h.
|
protected |
Definition at line 355 of file vtkPVDataInformation.h.
|
protected |
Definition at line 356 of file vtkPVDataInformation.h.
|
protected |
Definition at line 357 of file vtkPVDataInformation.h.
|
protected |
Definition at line 358 of file vtkPVDataInformation.h.
|
protected |
Definition at line 360 of file vtkPVDataInformation.h.
|
protected |
Definition at line 362 of file vtkPVDataInformation.h.