VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkCompositeDataSet Class Referenceabstract

abstract superclass for composite (multi-block or AMR) datasets More...

#include <vtkCompositeDataSet.h>

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

Public Types

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 int IsA (const char *type)
 
vtkCompositeDataSetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkCompositeDataIteratorNewIterator ()=0
 
virtual int GetDataObjectType ()
 
virtual void CopyStructure (vtkCompositeDataSet *input)=0
 
virtual void SetDataSet (vtkCompositeDataIterator *iter, vtkDataObject *dataObj)=0
 
virtual vtkDataObjectGetDataSet (vtkCompositeDataIterator *iter)=0
 
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
vtkDataObjectNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
unsigned long int GetMTime ()
 
void ReleaseData ()
 
unsigned long GetUpdateTime ()
 
void DataHasBeenGenerated ()
 
virtual void PrepareForNewData ()
 
virtual int GetExtentType ()
 
virtual void Crop (const int *updateExtent)
 
virtual vtkDataSetAttributesGetAttributes (int type)
 
virtual vtkFieldDataGetAttributesAsFieldData (int type)
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 
virtual vtkIdType GetNumberOfElements (int type)
 
virtual vtkInformationGetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual int GetDataReleased ()
 
virtual void SetFieldData (vtkFieldData *)
 
virtual vtkFieldDataGetFieldData ()
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 
void GlobalReleaseDataFlagOn ()
 
void GlobalReleaseDataFlagOff ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
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)
 
vtkCommandGetCommand (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)
 
template<class U , class T >
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)
 
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)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkCompositeDataSetSafeDownCast (vtkObjectBase *o)
 
static vtkInformationStringKeyNAME ()
 
static vtkCompositeDataSetGetData (vtkInformation *info)
 
static vtkCompositeDataSetGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static const char * GetAssociationTypeAsString (int associationType)
 
static int GetAssociationTypeFromString (const char *associationType)
 
static vtkInformationStringKeyDATA_TYPE_NAME ()
 
static
vtkInformationDataObjectKey
DATA_OBJECT ()
 
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
 
static
vtkInformationIntegerPointerKey
DATA_EXTENT ()
 
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKeyDATA_RESOLUTION ()
 
static vtkInformationDoubleKeyDATA_TIME_STEP ()
 
static
vtkInformationInformationVectorKey
POINT_DATA_VECTOR ()
 
static
vtkInformationInformationVectorKey
CELL_DATA_VECTOR ()
 
static
vtkInformationInformationVectorKey
VERTEX_DATA_VECTOR ()
 
static
vtkInformationInformationVectorKey
EDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKeyFIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ASSOCIATION ()
 
static vtkInformationIntegerKeyFIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKeyFIELD_OPERATION ()
 
static
vtkInformationDoubleVectorKey
FIELD_RANGE ()
 
static
vtkInformationDoubleVectorKey
PIECE_FIELD_RANGE ()
 
static vtkInformationStringKeyFIELD_ARRAY_NAME ()
 
static
vtkInformationIntegerVectorKey
PIECE_EXTENT ()
 
static vtkInformationStringKeyFIELD_NAME ()
 
static
vtkInformationDoubleVectorKey
ORIGIN ()
 
static
vtkInformationDoubleVectorKey
SPACING ()
 
static vtkInformationIntegerKeyDATA_GEOMETRY_UNMODIFIED ()
 
static
vtkInformationDoubleVectorKey
BOUNDING_BOX ()
 
static
vtkInformationDataObjectKey
SIL ()
 
static vtkInformationGetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
 
static vtkInformationGetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static vtkInformationSetActiveAttribute (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 vtkDataObjectGetData (vtkInformation *info)
 
static vtkDataObjectGetData (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 vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCompositeDataSet ()
 
virtual ~vtkCompositeDataSet ()
 
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 
 ~vtkDataObject ()
 
- 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 &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkDataObject
vtkFieldDataFieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformationInformation
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt< vtkTypeInt32 > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

abstract superclass for composite (multi-block or AMR) datasets

vtkCompositeDataSet is an abstract class that represents a collection of datasets (including other composite datasets). It provides an interface to access the datasets through iterators. vtkCompositeDataSet provides methods that are used by subclasses to store the datasets. vtkCompositeDataSet provides the datastructure for a full tree representation. Subclasses provide the semantics for it and control how this tree is built.

See also
vtkCompositeDataIterator
Examples:
vtkCompositeDataSet (Examples)
Tests:
vtkCompositeDataSet (Tests)

Definition at line 49 of file vtkCompositeDataSet.h.

Member Typedef Documentation

Definition at line 52 of file vtkCompositeDataSet.h.

Constructor & Destructor Documentation

vtkCompositeDataSet::vtkCompositeDataSet ( )
protected
virtual vtkCompositeDataSet::~vtkCompositeDataSet ( )
protectedvirtual

Member Function Documentation

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

Reimplemented in vtkMultiBlockDataSet, vtkOverlappingAMR, vtkDataObjectTree, vtkMultiPieceDataSet, vtkHierarchicalBoxDataSet, vtkNonOverlappingAMR, and vtkUniformGridAMR.

static vtkCompositeDataSet* vtkCompositeDataSet::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkCompositeDataSet::NewInstanceInternal ( ) const
protectedvirtual
vtkCompositeDataSet* vtkCompositeDataSet::NewInstance ( ) const
void vtkCompositeDataSet::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.

Reimplemented in vtkMultiBlockDataSet, vtkOverlappingAMR, vtkDataObjectTree, vtkUniformGridAMR, vtkMultiPieceDataSet, vtkHierarchicalBoxDataSet, and vtkNonOverlappingAMR.

virtual vtkCompositeDataIterator* vtkCompositeDataSet::NewIterator ( )
pure virtual

Return a new iterator (the iterator has to be deleted by user).

Implemented in vtkDataObjectTree, vtkOverlappingAMR, vtkHierarchicalBoxDataSet, and vtkUniformGridAMR.

virtual int vtkCompositeDataSet::GetDataObjectType ( )
inlinevirtual

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

Reimplemented from vtkDataObject.

Reimplemented in vtkMultiBlockDataSet, vtkOverlappingAMR, vtkMultiPieceDataSet, vtkHierarchicalBoxDataSet, vtkUniformGridAMR, and vtkNonOverlappingAMR.

Definition at line 59 of file vtkCompositeDataSet.h.

virtual void vtkCompositeDataSet::CopyStructure ( vtkCompositeDataSet input)
pure virtual

Copies the tree structure from the input. All pointers to non-composite data objects are intialized to NULL. This also shallow copies the meta data associated with all the nodes.

Implemented in vtkUniformGridAMR, and vtkDataObjectTree.

virtual void vtkCompositeDataSet::SetDataSet ( vtkCompositeDataIterator iter,
vtkDataObject dataObj 
)
pure virtual

Sets the data set at the location pointed by the iterator. The iterator does not need to be iterating over this dataset itself. It can be any composite datasite with similar structure (achieved by using CopyStructure).

Implemented in vtkUniformGridAMR, and vtkDataObjectTree.

virtual vtkDataObject* vtkCompositeDataSet::GetDataSet ( vtkCompositeDataIterator iter)
pure virtual

Returns the dataset located at the positiong pointed by the iterator. The iterator does not need to be iterating over this dataset itself. It can be an iterator for composite dataset with similar structure (achieved by using CopyStructure).

Implemented in vtkUniformGridAMR, and vtkDataObjectTree.

virtual unsigned long vtkCompositeDataSet::GetActualMemorySize ( )
virtual

Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated.

Reimplemented from vtkDataObject.

Reimplemented in vtkDataObjectTree.

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

Retrieve an instance of this class from an information object.

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

Retrieve an instance of this class from an information object.

virtual void vtkCompositeDataSet::Initialize ( )
virtual

Restore data object to initial state,

Reimplemented from vtkDataObject.

Reimplemented in vtkDataObjectTree, and vtkUniformGridAMR.

virtual void vtkCompositeDataSet::ShallowCopy ( vtkDataObject src)
virtual

Shallow and Deep copy.

Reimplemented from vtkDataObject.

Reimplemented in vtkUniformGridAMR, and vtkDataObjectTree.

virtual void vtkCompositeDataSet::DeepCopy ( vtkDataObject src)
virtual

Shallow and Deep copy.

Reimplemented from vtkDataObject.

Reimplemented in vtkUniformGridAMR, and vtkDataObjectTree.

virtual vtkIdType vtkCompositeDataSet::GetNumberOfPoints ( )
virtual

Returns the total number of points of all blocks. This will iterate over all blocks and call GetNumberOfPoints() so it might be expansive.

Reimplemented in vtkDataObjectTree.

static vtkInformationStringKey* vtkCompositeDataSet::NAME ( )
static

Key used to put node name in the meta-data associated with a node.


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