VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkCompositeDataSet Class Reference

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 Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkCompositeDataIteratorNewIterator ()
 
virtual int GetDataObjectType ()
 
virtual vtkAlgorithmOutputGetProducerPort ()
 
virtual void CopyStructure (vtkCompositeDataSet *input)
 
virtual void SetDataSet (vtkCompositeDataIterator *iter, vtkDataObject *dataObj)
 
virtual vtkDataObjectGetDataSet (vtkCompositeDataIterator *iter)
 
virtual vtkInformationGetMetaData (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)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkCompositeDataSetSafeDownCast (vtkObject *o)
 
static vtkInformationStringKeyNAME ()
 
static vtkCompositeDataSetGetData (vtkInformation *info)
 
static vtkCompositeDataSetGetData (vtkInformationVector *v, int i=0)
 

Protected Member Functions

 vtkCompositeDataSet ()
 
 ~vtkCompositeDataSet ()
 
void SetNumberOfChildren (unsigned int num)
 
unsigned int GetNumberOfChildren ()
 
void SetChild (unsigned int index, vtkDataObject *)
 
void RemoveChild (unsigned int index)
 
vtkDataObjectGetChild (unsigned int num)
 
vtkInformationGetChildMetaData (unsigned int index)
 
void SetChildMetaData (unsigned int index, vtkInformation *info)
 
int HasChildMetaData (unsigned int index)
 

Protected Attributes

vtkCompositeDataSetInternalsInternals
 

Friends

class vtkCompositeDataIterator
 

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

Definition at line 42 of file vtkCompositeDataSet.h.

Member Typedef Documentation

Definition at line 45 of file vtkCompositeDataSet.h.

Constructor & Destructor Documentation

vtkCompositeDataSet::vtkCompositeDataSet ( )
protected
vtkCompositeDataSet::~vtkCompositeDataSet ( )
protected

Member Function Documentation

virtual const char* vtkCompositeDataSet::GetClassName ( )
virtual
static int vtkCompositeDataSet::IsTypeOf ( const char *  type)
static
virtual int vtkCompositeDataSet::IsA ( const char *  type)
virtual
static vtkCompositeDataSet* vtkCompositeDataSet::SafeDownCast ( vtkObject o)
static
void vtkCompositeDataSet::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual vtkCompositeDataIterator* vtkCompositeDataSet::NewIterator ( )
virtual

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

virtual int vtkCompositeDataSet::GetDataObjectType ( )
inlinevirtual

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

Definition at line 52 of file vtkCompositeDataSet.h.

virtual vtkAlgorithmOutput* vtkCompositeDataSet::GetProducerPort ( )
virtual

Get the port currently producing this object.

virtual void vtkCompositeDataSet::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.

virtual void vtkCompositeDataSet::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).

virtual vtkDataObject* vtkCompositeDataSet::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).

virtual vtkInformation* vtkCompositeDataSet::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).

virtual int vtkCompositeDataSet::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).

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.

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,

virtual void vtkCompositeDataSet::ShallowCopy ( vtkDataObject src)
virtual

Shallow and Deep copy.

virtual void vtkCompositeDataSet::DeepCopy ( vtkDataObject src)
virtual

Shallow and Deep copy.

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.

static vtkInformationStringKey* vtkCompositeDataSet::NAME ( )
static

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

void vtkCompositeDataSet::SetNumberOfChildren ( unsigned int  num)
protected

Set the number of children.

unsigned int vtkCompositeDataSet::GetNumberOfChildren ( )
protected

Get the number of children.

void vtkCompositeDataSet::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 vtkCompositeDataSet::RemoveChild ( unsigned int  index)
protected

Remove the child at a given index.

vtkDataObject* vtkCompositeDataSet::GetChild ( unsigned int  num)
protected

Returns a child dataset at a given index.

vtkInformation* vtkCompositeDataSet::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 vtkCompositeDataSet::SetChildMetaData ( unsigned int  index,
vtkInformation info 
)
protected

Sets the meta-data at a given index.

int vtkCompositeDataSet::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 vtkCompositeDataIterator
friend

Definition at line 153 of file vtkCompositeDataSet.h.

Member Data Documentation

vtkCompositeDataSetInternals* vtkCompositeDataSet::Internals
protected

Definition at line 151 of file vtkCompositeDataSet.h.


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