vtkInformationVector Class Reference

#include <vtkInformationVector.h>

Inheritance diagram for vtkInformationVector:

Inheritance graph
[legend]
Collaboration diagram for vtkInformationVector:

Collaboration graph
[legend]

List of all members.


Detailed Description

Store zero or more vtkInformation instances.

vtkInformationVector stores a vector of zero or more vtkInformation objects corresponding to the input or output information for a vtkAlgorithm. An instance of this class is passed to vtkAlgorithm::ProcessRequest calls.

Examples:
vtkInformationVector (Examples)
Tests:
vtkInformationVector (Tests)

Definition at line 39 of file vtkInformationVector.h.


Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void Copy (vtkInformationVector *from, int deep=0)
int GetNumberOfInformationObjects ()
void SetNumberOfInformationObjects (int n)
void SetInformationObject (int index, vtkInformation *info)
vtkInformationGetInformationObject (int index)
void Append (vtkInformation *info)
void Remove (vtkInformation *info)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)

Static Public Member Functions

static vtkInformationVectorNew ()
static int IsTypeOf (const char *type)
static vtkInformationVectorSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkInformationVector ()
 ~vtkInformationVector ()
virtual void ReportReferences (vtkGarbageCollector *)

Protected Attributes

vtkInformationVectorInternals * Internal
int NumberOfInformationObjects

Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 43 of file vtkInformationVector.h.


Constructor & Destructor Documentation

vtkInformationVector::vtkInformationVector (  )  [protected]

vtkInformationVector::~vtkInformationVector (  )  [protected]


Member Function Documentation

static vtkInformationVector* vtkInformationVector::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkInformationVector::GetClassName (  )  [virtual]

Reimplemented from vtkObject.

static int vtkInformationVector::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type 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 vtkObject.

virtual int vtkInformationVector::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 vtkObject.

static vtkInformationVector* vtkInformationVector::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkObject.

void vtkInformationVector::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.

int vtkInformationVector::GetNumberOfInformationObjects (  )  [inline]

Get/Set the number of information objects in the vector. Setting the number to larger than the current number will create empty vtkInformation instances. Setting the number to smaller than the current number will remove entries from higher indices.

Definition at line 51 of file vtkInformationVector.h.

void vtkInformationVector::SetNumberOfInformationObjects ( int  n  ) 

Get/Set the number of information objects in the vector. Setting the number to larger than the current number will create empty vtkInformation instances. Setting the number to smaller than the current number will remove entries from higher indices.

void vtkInformationVector::SetInformationObject ( int  index,
vtkInformation info 
)

Get/Set the vtkInformation instance stored at the given index in the vector. The vector will automatically expand to include the index given if necessary. Missing entries in-between will be filled with empty vtkInformation instances.

vtkInformation* vtkInformationVector::GetInformationObject ( int  index  ) 

Get/Set the vtkInformation instance stored at the given index in the vector. The vector will automatically expand to include the index given if necessary. Missing entries in-between will be filled with empty vtkInformation instances.

void vtkInformationVector::Append ( vtkInformation info  ) 

Append/Remove an information object.

void vtkInformationVector::Remove ( vtkInformation info  ) 

Append/Remove an information object.

virtual void vtkInformationVector::Register ( vtkObjectBase o  )  [virtual]

Initiate garbage collection when a reference is removed.

Reimplemented from vtkObjectBase.

virtual void vtkInformationVector::UnRegister ( vtkObjectBase o  )  [virtual]

Initiate garbage collection when a reference is removed.

Reimplemented from vtkObjectBase.

void vtkInformationVector::Copy ( vtkInformationVector from,
int  deep = 0 
)

Copy all information entries from the given vtkInformation instance. Any previously existing entries are removed. If deep==1, a deep copy of the information structure is performed (new instances of any contained vtkInformation and vtkInformationVector objects are created).

virtual void vtkInformationVector::ReportReferences ( vtkGarbageCollector  )  [protected, virtual]

Reimplemented from vtkObjectBase.


Member Data Documentation

vtkInformationVectorInternals* vtkInformationVector::Internal [protected]

Definition at line 88 of file vtkInformationVector.h.

Definition at line 90 of file vtkInformationVector.h.


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

Generated on Wed Aug 24 11:43:49 2011 for VTK by  doxygen 1.5.6