ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPVTemporalDataInformation Class Reference

vtkPVTemporalDataInformation is used to gather data information over time. More...

#include <vtkPVTemporalDataInformation.h>

Inheritance diagram for vtkPVTemporalDataInformation:
Inheritance graph
[legend]
Collaboration diagram for vtkPVTemporalDataInformation:
Collaboration graph
[legend]

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)
 
virtual void CopyFromObject (vtkObject *object)
 Transfer information about a single object into this object. More...
 
virtual void AddInformation (vtkPVInformation *info)
 Merge another information object. More...
 
void Initialize ()
 Initializes the information object. More...
 
vtkPVDataSetAttributesInformationGetAttributeInformation (int attr)
 Convenience method to get the attribute information given the attribute type. More...
 
vtkPVArrayInformationGetArrayInformation (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...
 
virtual void SetPortNumber (int)
 Port number controls which output port the information is gathered from. More...
 
virtual void CopyToStream (vtkClientServerStream *)
 Manage a serialized version of the information. More...
 
virtual void CopyFromStream (const vtkClientServerStream *)
 Manage a serialized version of the information. More...
 
virtual void CopyParametersToStream (vtkMultiProcessStream &)
 Serialize/Deserialize the parameters that control how/what information is gathered. More...
 
virtual void CopyParametersFromStream (vtkMultiProcessStream &)
 Serialize/Deserialize the parameters that control how/what information is gathered. More...
 
virtual int GetNumberOfTimeSteps ()
 Returns the number of timesteps this information was gathered from. More...
 
virtual double * GetTimeRange ()
 Returns the time-range this information was gathered from. More...
 
virtual void GetTimeRange (double &, double &)
 Returns the time-range this information was gathered from. More...
 
virtual void GetTimeRange (double [2])
 Returns the time-range this information was gathered from. More...
 
virtual vtkPVDataSetAttributesInformationGetPointDataInformation ()
 Access to information about point/cell/vertex/edge/row data. More...
 
virtual vtkPVDataSetAttributesInformationGetCellDataInformation ()
 Access to information about point/cell/vertex/edge/row data. More...
 
virtual vtkPVDataSetAttributesInformationGetVertexDataInformation ()
 Access to information about point/cell/vertex/edge/row data. More...
 
virtual vtkPVDataSetAttributesInformationGetEdgeDataInformation ()
 Access to information about point/cell/vertex/edge/row data. More...
 
virtual vtkPVDataSetAttributesInformationGetRowDataInformation ()
 Access to information about point/cell/vertex/edge/row data. More...
 
virtual vtkPVDataSetAttributesInformationGetFieldDataInformation ()
 Access to information about field data, if any. More...
 
- Public Member Functions inherited from vtkPVInformation
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int GetRootOnly ()
 Set/get whether to gather information only from the root. More...
 

Static Public Member Functions

static vtkPVTemporalDataInformationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVTemporalDataInformationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVInformation
static int IsTypeOf (const char *type)
 
static vtkPVInformationSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPVTemporalDataInformation ()
 
 ~vtkPVTemporalDataInformation ()
 
- Protected Member Functions inherited from vtkPVInformation
 vtkPVInformation ()
 
 ~vtkPVInformation ()
 
virtual void SetRootOnly (int)
 
 vtkPVInformation (const vtkPVInformation &) VTK_DELETE_FUNCTION
 
void operator= (const vtkPVInformation &) VTK_DELETE_FUNCTION
 

Protected Attributes

vtkPVDataSetAttributesInformationPointDataInformation
 
vtkPVDataSetAttributesInformationCellDataInformation
 
vtkPVDataSetAttributesInformationFieldDataInformation
 
vtkPVDataSetAttributesInformationVertexDataInformation
 
vtkPVDataSetAttributesInformationEdgeDataInformation
 
vtkPVDataSetAttributesInformationRowDataInformation
 
double TimeRange [2]
 
int NumberOfTimeSteps
 
int PortNumber
 
- Protected Attributes inherited from vtkPVInformation
int RootOnly
 

Detailed Description

vtkPVTemporalDataInformation is used to gather data information over time.

This information provided by this class is a sub-set of vtkPVDataInformation and hence this is not directly a subclass of vtkPVDataInformation. It internally uses vtkPVDataInformation to collect information about each timestep.

Definition at line 34 of file vtkPVTemporalDataInformation.h.

Member Typedef Documentation

§ Superclass

Definition at line 38 of file vtkPVTemporalDataInformation.h.

Constructor & Destructor Documentation

§ vtkPVTemporalDataInformation()

vtkPVTemporalDataInformation::vtkPVTemporalDataInformation ( )
protected

§ ~vtkPVTemporalDataInformation()

vtkPVTemporalDataInformation::~vtkPVTemporalDataInformation ( )
protected

Member Function Documentation

§ New()

static vtkPVTemporalDataInformation* vtkPVTemporalDataInformation::New ( )
static

§ GetClassName()

virtual const char* vtkPVTemporalDataInformation::GetClassName ( )
virtual

Reimplemented from vtkPVInformation.

§ IsTypeOf()

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

§ IsA()

virtual int vtkPVTemporalDataInformation::IsA ( const char *  type)
virtual

Reimplemented from vtkPVInformation.

§ SafeDownCast()

static vtkPVTemporalDataInformation* vtkPVTemporalDataInformation::SafeDownCast ( vtkObject *  o)
static

§ PrintSelf()

void vtkPVTemporalDataInformation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

§ SetPortNumber()

virtual void vtkPVTemporalDataInformation::SetPortNumber ( int  )
virtual

Port number controls which output port the information is gathered from.

This is only applicable when the vtkObject from which the information being gathered is a vtkAlgorithm. Set it to -1(default), to return the classname of the vtkAlgorithm itself. This is the only parameter that can be set on the client-side before gathering the information.

§ CopyFromObject()

virtual void vtkPVTemporalDataInformation::CopyFromObject ( vtkObject *  object)
virtual

Transfer information about a single object into this object.

This expects the object to be a vtkAlgorithmOutput.

Reimplemented from vtkPVInformation.

§ AddInformation()

virtual void vtkPVTemporalDataInformation::AddInformation ( vtkPVInformation info)
virtual

Merge another information object.

Calls AddInformation(info, 0).

Reimplemented from vtkPVInformation.

§ CopyToStream()

virtual void vtkPVTemporalDataInformation::CopyToStream ( vtkClientServerStream )
virtual

Manage a serialized version of the information.

Implements vtkPVInformation.

§ CopyFromStream()

virtual void vtkPVTemporalDataInformation::CopyFromStream ( const vtkClientServerStream )
virtual

Manage a serialized version of the information.

Reimplemented from vtkPVInformation.

§ CopyParametersToStream()

virtual void vtkPVTemporalDataInformation::CopyParametersToStream ( vtkMultiProcessStream &  )
virtual

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.

§ CopyParametersFromStream()

virtual void vtkPVTemporalDataInformation::CopyParametersFromStream ( vtkMultiProcessStream &  )
virtual

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.

§ Initialize()

void vtkPVTemporalDataInformation::Initialize ( )

Initializes the information object.

§ GetNumberOfTimeSteps()

virtual int vtkPVTemporalDataInformation::GetNumberOfTimeSteps ( )
virtual

Returns the number of timesteps this information was gathered from.

§ GetTimeRange() [1/3]

virtual double* vtkPVTemporalDataInformation::GetTimeRange ( )
virtual

Returns the time-range this information was gathered from.

§ GetTimeRange() [2/3]

virtual void vtkPVTemporalDataInformation::GetTimeRange ( double &  ,
double &   
)
virtual

Returns the time-range this information was gathered from.

§ GetTimeRange() [3/3]

virtual void vtkPVTemporalDataInformation::GetTimeRange ( double  [2])
virtual

Returns the time-range this information was gathered from.

§ GetPointDataInformation()

virtual vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::GetPointDataInformation ( )
virtual

Access to information about point/cell/vertex/edge/row data.

§ GetCellDataInformation()

virtual vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::GetCellDataInformation ( )
virtual

Access to information about point/cell/vertex/edge/row data.

§ GetVertexDataInformation()

virtual vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::GetVertexDataInformation ( )
virtual

Access to information about point/cell/vertex/edge/row data.

§ GetEdgeDataInformation()

virtual vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::GetEdgeDataInformation ( )
virtual

Access to information about point/cell/vertex/edge/row data.

§ GetRowDataInformation()

virtual vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::GetRowDataInformation ( )
virtual

Access to information about point/cell/vertex/edge/row data.

§ GetAttributeInformation()

vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::GetAttributeInformation ( int  attr)

Convenience method to get the attribute information given the attribute type.

attr can be vtkDataObject::FieldAssociations or vtkDataObject::AttributeTypes (since both are identical).

§ GetFieldDataInformation()

virtual vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::GetFieldDataInformation ( )
virtual

Access to information about field data, if any.

§ GetArrayInformation()

vtkPVArrayInformation* vtkPVTemporalDataInformation::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).

Member Data Documentation

§ PointDataInformation

vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::PointDataInformation
protected

Definition at line 142 of file vtkPVTemporalDataInformation.h.

§ CellDataInformation

vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::CellDataInformation
protected

Definition at line 143 of file vtkPVTemporalDataInformation.h.

§ FieldDataInformation

vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::FieldDataInformation
protected

Definition at line 144 of file vtkPVTemporalDataInformation.h.

§ VertexDataInformation

vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::VertexDataInformation
protected

Definition at line 145 of file vtkPVTemporalDataInformation.h.

§ EdgeDataInformation

vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::EdgeDataInformation
protected

Definition at line 146 of file vtkPVTemporalDataInformation.h.

§ RowDataInformation

vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::RowDataInformation
protected

Definition at line 147 of file vtkPVTemporalDataInformation.h.

§ TimeRange

double vtkPVTemporalDataInformation::TimeRange[2]
protected

Definition at line 149 of file vtkPVTemporalDataInformation.h.

§ NumberOfTimeSteps

int vtkPVTemporalDataInformation::NumberOfTimeSteps
protected

Definition at line 150 of file vtkPVTemporalDataInformation.h.

§ PortNumber

int vtkPVTemporalDataInformation::PortNumber
protected

Definition at line 151 of file vtkPVTemporalDataInformation.h.


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