vtkDataObjectTree Class Reference

provides implementation for most abstract methods in the superclass vtkCompositeDataSet More...

#include <vtkDataObjectTree.h>

Inheritance diagram for vtkDataObjectTree:

Collaboration diagram for vtkDataObjectTree:

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 Member Functions
virtual int	IsA (const char *type)
vtkDataObjectTree *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkDataObjectTreeIterator *	NewTreeIterator ()
virtual vtkCompositeDataIterator *	NewIterator ()
virtual void	CopyStructure (vtkCompositeDataSet *input)
virtual void	SetDataSet (vtkCompositeDataIterator *iter, vtkDataObject *dataObj)
void	SetDataSetFrom (vtkDataObjectTreeIterator *iter, vtkDataObject *dataObj)
virtual vtkDataObject *	GetDataSet (vtkCompositeDataIterator *iter)
virtual vtkInformation *	GetMetaData (vtkCompositeDataIterator *iter)
virtual int	HasMetaData (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 vtkCompositeDataSet
vtkCompositeDataSet *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	GetDataObjectType ()
Public Member Functions inherited from vtkDataObject
vtkDataObject *	NewInstance () 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 vtkDataSetAttributes *	GetAttributes (int type)
virtual vtkFieldData *	GetAttributesAsFieldData (int type)
virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)
virtual vtkIdType	GetNumberOfElements (int type)
virtual vtkInformation *	GetInformation ()
virtual void	SetInformation (vtkInformation *)
virtual int	GetDataReleased ()
virtual void	SetFieldData (vtkFieldData *)
virtual vtkFieldData *	GetFieldData ()
virtual void	CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
void	GlobalReleaseDataFlagOn ()
void	GlobalReleaseDataFlagOff ()

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkDataObjectTree *	SafeDownCast (vtkObjectBase *o)
static vtkDataObjectTree *	GetData (vtkInformation *info)
static vtkDataObjectTree *	GetData (vtkInformationVector *v, int i=0)
Static Public Member Functions inherited from vtkCompositeDataSet
static int	IsTypeOf (const char *type)
static vtkCompositeDataSet *	SafeDownCast (vtkObjectBase *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 (vtkObjectBase *o)
static const char *	GetAssociationTypeAsString (int associationType)
static int	GetAssociationTypeFromString (const char *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 vtkInformationDoubleKey *	DATA_TIME_STEP ()
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 vtkInformationDoubleVectorKey *	BOUNDING_BOX ()
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 ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkDataObjectTree ()
	~vtkDataObjectTree ()
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 vtkCompositeDataSet
	vtkCompositeDataSet ()
virtual	~vtkCompositeDataSet ()
Protected Member Functions inherited from vtkDataObject
	vtkDataObject ()
	~vtkDataObject ()

Protected Attributes
vtkDataObjectTreeInternals *	Internals
Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData
int	DataReleased
vtkTimeStamp	UpdateTime
vtkInformation *	Information

Friends
class	vtkDataObjectTreeIterator

Detailed Description

provides implementation for most abstract methods in the superclass vtkCompositeDataSet

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

See Also

vtkDataObjectTreeIterator

Definition at line 45 of file vtkDataObjectTree.h.

Member Typedef Documentation

typedef vtkCompositeDataSet vtkDataObjectTree::Superclass

Definition at line 48 of file vtkDataObjectTree.h.

Constructor & Destructor Documentation

vtkDataObjectTree::vtkDataObjectTree ( )

protected

vtkDataObjectTree::~vtkDataObjectTree ( )

protected

Member Function Documentation

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

static

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

virtual

Reimplemented from vtkCompositeDataSet.

Reimplemented in vtkMultiBlockDataSet, and vtkMultiPieceDataSet.

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

static

virtual vtkObjectBase* vtkDataObjectTree::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCompositeDataSet.

Reimplemented in vtkMultiBlockDataSet, and vtkMultiPieceDataSet.

vtkDataObjectTree* vtkDataObjectTree::NewInstance

(

)

const

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

virtual vtkDataObjectTreeIterator* vtkDataObjectTree::NewTreeIterator ( )

virtual

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

virtual vtkCompositeDataIterator* vtkDataObjectTree::NewIterator ( )

virtual

Return a new iterator (the iterator has to be deleted by user). Use NewTreeIterator when you have a pointer to a vtkDataObjectTree and NewIterator when you have a pointer to a vtkCompositeDataSet; NewIterator is inherited and calls NewTreeIterator internally.

Implements vtkCompositeDataSet.

virtual void vtkDataObjectTree::CopyStructure ( vtkCompositeDataSet *  input )

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.

Implements vtkCompositeDataSet.

virtual void vtkDataObjectTree::SetDataSet ( vtkCompositeDataIterator *  iter, vtkDataObject *  dataObj  )

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).

Implements vtkCompositeDataSet.

void vtkDataObjectTree::SetDataSetFrom	(	vtkDataObjectTreeIterator *	iter,
		vtkDataObject *	dataObj
	)

Sets the data at the location provided by a vtkDataObjectTreeIterator

virtual vtkDataObject* vtkDataObjectTree::GetDataSet ( vtkCompositeDataIterator *  iter )

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).

Implements vtkCompositeDataSet.

virtual vtkInformation* vtkDataObjectTree::GetMetaData ( vtkCompositeDataIterator *  iter )

virtual

Returns the meta-data associated with the position pointed by the iterator. This will create a new vtkInformation object if none already exists. Use HasMetaData to avoid creating the vtkInformation object unnecessarily. 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).

Reimplemented in vtkMultiBlockDataSet, and vtkMultiPieceDataSet.

virtual int vtkDataObjectTree::HasMetaData ( vtkCompositeDataIterator *  iter )

virtual

Returns if any meta-data associated with the position 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).

Reimplemented in vtkMultiBlockDataSet, and vtkMultiPieceDataSet.

virtual unsigned long vtkDataObjectTree::GetActualMemorySize ( )

virtual

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

Reimplemented from vtkCompositeDataSet.

virtual void vtkDataObjectTree::Initialize ( )

virtual

Restore data object to initial state,

Reimplemented from vtkCompositeDataSet.

virtual void vtkDataObjectTree::ShallowCopy ( vtkDataObject *  src )

virtual

Shallow and Deep copy.

Reimplemented from vtkCompositeDataSet.

virtual void vtkDataObjectTree::DeepCopy ( vtkDataObject *  src )

virtual

Shallow and Deep copy.

Reimplemented from vtkCompositeDataSet.

virtual vtkIdType vtkDataObjectTree::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 from vtkCompositeDataSet.

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

static

Retrieve an instance of this class from an information object.

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

static

Retrieve an instance of this class from an information object.

void vtkDataObjectTree::SetNumberOfChildren ( unsigned int  num )

protected

Set the number of children.

unsigned int vtkDataObjectTree::GetNumberOfChildren ( )

protected

Get the number of children.

void vtkDataObjectTree::SetChild ( unsigned int  index, vtkDataObject *    )

protected

Set child dataset at a given index. The number of children is adjusted to to be greater than the index specified.

void vtkDataObjectTree::RemoveChild ( unsigned int  index )

protected

Remove the child at a given index.

vtkDataObject* vtkDataObjectTree::GetChild ( unsigned int  num )

protected

Returns a child dataset at a given index.

vtkInformation* vtkDataObjectTree::GetChildMetaData ( unsigned int  index )

protected

Returns the meta-data at a given index. If the index is valid, however, no information object is set, then a new one will created and returned. To avoid unnecessary creation, use HasMetaData().

void vtkDataObjectTree::SetChildMetaData ( unsigned int  index, vtkInformation *  info  )

protected

Sets the meta-data at a given index.

int vtkDataObjectTree::HasChildMetaData ( unsigned int  index )

protected

Returns if meta-data information is available for the given child index. Returns 1 is present, 0 otherwise.

Friends And Related Function Documentation

friend class vtkDataObjectTreeIterator

friend

Definition at line 156 of file vtkDataObjectTree.h.

Member Data Documentation

vtkDataObjectTreeInternals* vtkDataObjectTree::Internals

protected

Definition at line 154 of file vtkDataObjectTree.h.

---

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

• dox/Common/DataModel/vtkDataObjectTree.h