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

Composite dataset that holds multiple times. More...

#include <vtkTemporalDataSet.h>

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

Public Types

typedef vtkCompositeDataSet Superclass
 
- Public Types inherited from vtkCompositeDataSet
typedef vtkDataObject Superclass
 
- Public Types inherited from vtkDataObject
typedef vtkObject Superclass
 
enum  FieldAssociations {
  FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE, FIELD_ASSOCIATION_POINTS_THEN_CELLS,
  FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, FIELD_ASSOCIATION_ROWS, NUMBER_OF_ASSOCIATIONS
}
 
enum  AttributeTypes {
  POINT, CELL, FIELD, POINT_THEN_CELL,
  VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES
}
 
enum  FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int GetDataObjectType ()
 
void SetTimeStep (unsigned int timestep, vtkDataObject *dobj)
 
virtual int GetExtentType ()
 
void SetNumberOfTimeSteps (unsigned int numLevels)
 
unsigned int GetNumberOfTimeSteps ()
 
vtkDataObject * GetTimeStep (unsigned int timestep)
 
vtkInformation * GetMetaData (unsigned int timestep)
 
int HasMetaData (unsigned int timestep)
 
virtual vtkInformation * GetMetaData (vtkCompositeDataIterator *iter)
 
virtual int HasMetaData (vtkCompositeDataIterator *iter)
 
- Public Member Functions inherited from vtkCompositeDataSet
virtual vtkCompositeDataIterator * NewIterator ()
 
virtual vtkAlgorithmOutput * GetProducerPort ()
 
virtual void CopyStructure (vtkCompositeDataSet *input)
 
virtual void SetDataSet (vtkCompositeDataIterator *iter, vtkDataObject *dataObj)
 
virtual vtkDataObject * GetDataSet (vtkCompositeDataIterator *iter)
 
virtual unsigned long GetActualMemorySize ()
 
virtual void Initialize ()
 
virtual vtkIdType GetNumberOfPoints ()
 
virtual void ShallowCopy (vtkDataObject *src)
 
virtual void DeepCopy (vtkDataObject *src)
 
- Public Member Functions inherited from vtkDataObject
unsigned long int GetMTime ()
 
void ReleaseData ()
 
int ShouldIReleaseData ()
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
virtual void Update ()
 
virtual void UpdateInformation ()
 
virtual void PropagateUpdateExtent ()
 
virtual void TriggerAsynchronousUpdate ()
 
virtual void UpdateData ()
 
virtual unsigned long GetEstimatedMemorySize ()
 
unsigned long GetUpdateTime ()
 
void SetUpdateExtentToWholeExtent ()
 
unsigned long GetPipelineMTime ()
 
void CopyInformation (vtkDataObject *data)
 
virtual void CopyInformationFromPipeline (vtkInformation *request)
 
void DataHasBeenGenerated ()
 
virtual void PrepareForNewData ()
 
virtual void Crop ()
 
virtual vtkDataSetAttributes * GetAttributes (int type)
 
virtual vtkFieldData * GetAttributesAsFieldData (int type)
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 
virtual vtkIdType GetNumberOfElements (int type)
 
virtual vtkSource * GetSource ()
 
void SetSource (vtkSource *s)
 
virtual vtkInformation * GetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual vtkInformation * GetPipelineInformation ()
 
virtual void SetPipelineInformation (vtkInformation *)
 
virtual int GetDataReleased ()
 
void SetReleaseDataFlag (int)
 
int GetReleaseDataFlag ()
 
virtual void ReleaseDataFlagOn ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void SetFieldData (vtkFieldData *)
 
virtual vtkFieldData * GetFieldData ()
 
virtual void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int piece, int numPieces)
 
virtual void SetUpdateExtent (int x0, int x1, int y0, int y1, int z0, int z1)
 
virtual void SetUpdateExtent (int extent[6])
 
virtual int * GetUpdateExtent ()
 
virtual void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
virtual void GetUpdateExtent (int extent[6])
 
virtual void CopyTypeSpecificInformation (vtkDataObject *data)
 
void SetUpdatePiece (int piece)
 
void SetUpdateNumberOfPieces (int num)
 
virtual int GetUpdatePiece ()
 
virtual int GetUpdateNumberOfPieces ()
 
void SetUpdateGhostLevel (int level)
 
virtual int GetUpdateGhostLevel ()
 
virtual void SetRequestExactExtent (int flag)
 
virtual int GetRequestExactExtent ()
 
virtual void RequestExactExtentOn ()
 
virtual void RequestExactExtentOff ()
 
virtual void SetWholeExtent (int x0, int x1, int y0, int y1, int z0, int z1)
 
virtual void SetWholeExtent (int extent[6])
 
virtual int * GetWholeExtent ()
 
virtual void GetWholeExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
virtual void GetWholeExtent (int extent[6])
 
virtual void SetWholeBoundingBox (double x0, double x1, double y0, double y1, double z0, double z1)
 
virtual void SetWholeBoundingBox (double bb[6])
 
virtual double * GetWholeBoundingBox ()
 
virtual void GetWholeBoundingBox (double &x0, double &x1, double &y0, double &y1, double &z0, double &z1)
 
virtual void GetWholeBoundingBox (double extent[6])
 
virtual void SetMaximumNumberOfPieces (int)
 
virtual int GetMaximumNumberOfPieces ()
 
virtual void CopyInformationToPipeline (vtkInformation *request, vtkInformation *input, vtkInformation *output, int forceCopy)
 
void CopyInformationToPipeline (vtkInformation *request, vtkInformation *input)
 
void SetExtentTranslator (vtkExtentTranslator *translator)
 
vtkExtentTranslator * GetExtentTranslator ()
 
void GlobalReleaseDataFlagOn ()
 
void GlobalReleaseDataFlagOff ()
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
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)
 
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)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkTemporalDataSet * New ()
 
static int IsTypeOf (const char *type)
 
static vtkTemporalDataSet * SafeDownCast (vtkObject *o)
 
static vtkTemporalDataSet * GetData (vtkInformation *info)
 
static vtkTemporalDataSet * GetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkCompositeDataSet
static int IsTypeOf (const char *type)
 
static vtkCompositeDataSet * SafeDownCast (vtkObject *o)
 
static vtkInformationStringKey * NAME ()
 
static vtkCompositeDataSet * GetData (vtkInformation *info)
 
static vtkCompositeDataSet * GetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObject * New ()
 
static int IsTypeOf (const char *type)
 
static vtkDataObject * SafeDownCast (vtkObject *o)
 
static const char * GetAssociationTypeAsString (int associationType)
 
static vtkInformationStringKey * DATA_TYPE_NAME ()
 
static
vtkInformationDataObjectKey * 
DATA_OBJECT ()
 
static vtkInformationIntegerKey * DATA_EXTENT_TYPE ()
 
static
vtkInformationIntegerPointerKey * 
DATA_EXTENT ()
 
static vtkInformationIntegerKey * DATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKey * DATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKey * DATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKey * DATA_RESOLUTION ()
 
static
vtkInformationDoubleVectorKey * 
DATA_TIME_STEPS ()
 
static
vtkInformationInformationVectorKey * 
POINT_DATA_VECTOR ()
 
static
vtkInformationInformationVectorKey * 
CELL_DATA_VECTOR ()
 
static
vtkInformationInformationVectorKey * 
VERTEX_DATA_VECTOR ()
 
static
vtkInformationInformationVectorKey * 
EDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKey * FIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKey * FIELD_ASSOCIATION ()
 
static vtkInformationIntegerKey * FIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKey * FIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKey * FIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKey * FIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKey * FIELD_OPERATION ()
 
static
vtkInformationDoubleVectorKey * 
FIELD_RANGE ()
 
static
vtkInformationDoubleVectorKey * 
PIECE_FIELD_RANGE ()
 
static vtkInformationStringKey * FIELD_ARRAY_NAME ()
 
static
vtkInformationIntegerVectorKey * 
PIECE_EXTENT ()
 
static vtkInformationStringKey * FIELD_NAME ()
 
static
vtkInformationDoubleVectorKey * 
ORIGIN ()
 
static
vtkInformationDoubleVectorKey * 
SPACING ()
 
static vtkInformationIntegerKey * DATA_GEOMETRY_UNMODIFIED ()
 
static
vtkInformationDataObjectKey * 
SIL ()
 
static vtkInformation * GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
 
static vtkInformation * GetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static vtkInformation * SetActiveAttribute (vtkInformation *info, int fieldAssociation, const char *attributeName, int attributeType)
 
static void SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples)
 
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
 
static vtkDataObject * GetData (vtkInformation *info)
 
static vtkDataObject * GetData (vtkInformationVector *v, int i=0)
 
static void SetGlobalReleaseDataFlag (int val)
 
static int GetGlobalReleaseDataFlag ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObject * SafeDownCast (vtkObject *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

 vtkTemporalDataSet ()
 
 ~vtkTemporalDataSet ()
 
- Protected Member Functions inherited from vtkCompositeDataSet
 vtkCompositeDataSet ()
 
 ~vtkCompositeDataSet ()
 
void SetNumberOfChildren (unsigned int num)
 
unsigned int GetNumberOfChildren ()
 
void SetChild (unsigned int index, vtkDataObject *)
 
void RemoveChild (unsigned int index)
 
vtkDataObject * GetChild (unsigned int num)
 
vtkInformation * GetChildMetaData (unsigned int index)
 
void SetChildMetaData (unsigned int index, vtkInformation *info)
 
int HasChildMetaData (unsigned int index)
 
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 
 ~vtkDataObject ()
 
vtkExecutive * GetExecutive ()
 
int GetPortNumber ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
vtkStreamingDemandDrivenPipeline * TrySDDP (const char *method)
 
- 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 &os)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Types inherited from vtkDataObject
typedef
vtkStreamingDemandDrivenPipeline 
SDDP
 
- Protected Attributes inherited from vtkCompositeDataSet
vtkCompositeDataSetInternals * Internals
 
- Protected Attributes inherited from vtkDataObject
vtkFieldData * FieldData
 
vtkSource * Source
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformation * Information
 
vtkInformation * PipelineInformation
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
- Static Protected Attributes inherited from vtkDataObject
static const char AssociationNames [NUMBER_OF_ASSOCIATIONS][55]
 

Detailed Description

Composite dataset that holds multiple times.

vtkTemporalDataSet is a vtkCompositeDataSet that stores multiple time steps of data.

See Also
vtkCompositeDataSet

Definition at line 31 of file vtkTemporalDataSet.h.

Member Typedef Documentation

Definition at line 36 of file vtkTemporalDataSet.h.

Constructor & Destructor Documentation

vtkTemporalDataSet::vtkTemporalDataSet ( )
protected
vtkTemporalDataSet::~vtkTemporalDataSet ( )
protected

Member Function Documentation

static vtkTemporalDataSet* vtkTemporalDataSet::New ( )
static
virtual const char* vtkTemporalDataSet::GetClassName ( )
virtual

Reimplemented from vtkCompositeDataSet.

static int vtkTemporalDataSet::IsTypeOf ( const char *  type)
static
virtual int vtkTemporalDataSet::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 vtkCompositeDataSet.

static vtkTemporalDataSet* vtkTemporalDataSet::SafeDownCast ( vtkObject *  o)
static
virtual void vtkTemporalDataSet::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 vtkCompositeDataSet.

virtual int vtkTemporalDataSet::GetDataObjectType ( )
inlinevirtual

Return class name of data type (see vtkType.h for definitions).

Reimplemented from vtkCompositeDataSet.

Definition at line 40 of file vtkTemporalDataSet.h.

void vtkTemporalDataSet::SetNumberOfTimeSteps ( unsigned int  numLevels)
inline

Set the number of time steps in theis dataset

Definition at line 44 of file vtkTemporalDataSet.h.

unsigned int vtkTemporalDataSet::GetNumberOfTimeSteps ( )
inline

Returns the number of time steps.

Definition at line 52 of file vtkTemporalDataSet.h.

void vtkTemporalDataSet::SetTimeStep ( unsigned int  timestep,
vtkDataObject *  dobj 
)

Set a data object as a timestep. Cannot be vtkTemporalDataSet.

vtkDataObject* vtkTemporalDataSet::GetTimeStep ( unsigned int  timestep)
inline

Get a timestep.

Definition at line 63 of file vtkTemporalDataSet.h.

vtkInformation* vtkTemporalDataSet::GetMetaData ( unsigned int  timestep)
inline

Get timestep meta-data.

Definition at line 69 of file vtkTemporalDataSet.h.

int vtkTemporalDataSet::HasMetaData ( unsigned int  timestep)
inline

Returns if timestep meta-data is present.

Definition at line 75 of file vtkTemporalDataSet.h.

static vtkTemporalDataSet* vtkTemporalDataSet::GetData ( vtkInformation *  info)
static

Retrieve an instance of this class from an information object.

static vtkTemporalDataSet* vtkTemporalDataSet::GetData ( vtkInformationVector *  v,
int  i = 0 
)
static

Retrieve an instance of this class from an information object.

virtual int vtkTemporalDataSet::GetExtentType ( )
inlinevirtual

The extent type is a 3D extent

Reimplemented from vtkDataObject.

Definition at line 88 of file vtkTemporalDataSet.h.

virtual vtkInformation* vtkTemporalDataSet::GetMetaData ( vtkCompositeDataIterator *  iter)
inlinevirtual

Unhiding superclass method.

Reimplemented from vtkCompositeDataSet.

Definition at line 92 of file vtkTemporalDataSet.h.

virtual int vtkTemporalDataSet::HasMetaData ( vtkCompositeDataIterator *  iter)
inlinevirtual

Unhiding superclass method.

Reimplemented from vtkCompositeDataSet.

Definition at line 99 of file vtkTemporalDataSet.h.


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