vtkInformation Class Reference

#include <vtkInformation.h>

Inheritance diagram for vtkInformation:

[legend]Collaboration diagram for vtkInformation:

[legend]List of all members.

Detailed Description

Store vtkAlgorithm input/output information.

vtkInformation represents information and/or data for one input or one output of a vtkAlgorithm. It maps from keys to values of several data types. Instances of this class are collected in vtkInformationVector instances and passed to vtkAlgorithm::ProcessRequest calls. The information and data referenced by the instance on a particular input or output define the request made to the vtkAlgorithm instance.

Created by:

Bertel, Francois

CVS contributions (if > 5%):

Bertel, Francois (69%)
Martin, Ken (30%)

CVS logs (CVSweb):

.h (/Filtering/vtkInformation.h)
.cxx (/Filtering/vtkInformation.cxx)

Member Typedef Documentation

typedef vtkObject vtkInformation::Superclass

Reimplemented from vtkObject.
Definition at line 64 of file vtkInformation.h.

Constructor & Destructor Documentation

vtkInformation::vtkInformation ( ) [protected]

vtkInformation::~vtkInformation ( ) [protected]

Member Function Documentation

vtkInformation* vtkInformation::New ( ) [static]

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

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

Reimplemented from vtkObject.

int vtkInformation::IsTypeOf ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject.

virtual int vtkInformation::IsA ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

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

void vtkInformation::Clear ( )

Clear all information entries.

void vtkInformation::Copy ( vtkInformation * from )

Copy all information entries from the given vtkInformation instance. Any previously existing entries are removed.

void vtkInformation::CopyEntry ( vtkInformation * from,

vtkInformationKey * key

)

Copy the key/value pair associated with the given key in the given information object.

void vtkInformation::CopyEntry ( vtkInformation * from,

vtkInformationDataObjectKey * key

)

Copy the key/value pair associated with the given key in the given information object.

void vtkInformation::CopyEntry ( vtkInformation * from,

vtkInformationDoubleVectorKey * key

)

Copy the key/value pair associated with the given key in the given information object.

void vtkInformation::CopyEntry ( vtkInformation * from,

vtkInformationExecutiveKey * key

)

Copy the key/value pair associated with the given key in the given information object.

void vtkInformation::CopyEntry ( vtkInformation * from,

vtkInformationInformationKey * key

)

Copy the key/value pair associated with the given key in the given information object.

void vtkInformation::CopyEntry ( vtkInformation * from,

vtkInformationInformationVectorKey * key

)

Copy the key/value pair associated with the given key in the given information object.

void vtkInformation::CopyEntry ( vtkInformation * from,

vtkInformationIntegerKey * key

)

Copy the key/value pair associated with the given key in the given information object.

void vtkInformation::CopyEntry ( vtkInformation * from,

vtkInformationIntegerVectorKey * key

)

Copy the key/value pair associated with the given key in the given information object.

void vtkInformation::CopyEntry ( vtkInformation * from,

vtkInformationStringKey * key

)

Copy the key/value pair associated with the given key in the given information object.

void vtkInformation::CopyEntries ( vtkInformation * from,

vtkInformationKeyVectorKey * key

)

Use the given key to lookup a list of other keys in the given information object. The key/value pairs associated with these other keys will be copied.

void vtkInformation::Set ( vtkInformationIntegerKey * key,

int value

)

Get/Set an integer-valued entry.

int vtkInformation::Get ( vtkInformationIntegerKey * key )

Get/Set an integer-valued entry.

void vtkInformation::Remove ( vtkInformationIntegerKey * key )

Get/Set an integer-valued entry.

int vtkInformation::Has ( vtkInformationIntegerKey * key )

Get/Set an integer-valued entry.

void vtkInformation::Append ( vtkInformationIntegerVectorKey * key,

int value

)

Get/Set an integer-vector-valued entry.

void vtkInformation::Set ( vtkInformationIntegerVectorKey * key,

int * value,

int length

)

Get/Set an integer-vector-valued entry.

int* vtkInformation::Get ( vtkInformationIntegerVectorKey * key )

Get/Set an integer-vector-valued entry.

void vtkInformation::Get ( vtkInformationIntegerVectorKey * key,

int * value

)

Get/Set an integer-vector-valued entry.

int vtkInformation::Length ( vtkInformationIntegerVectorKey * key )

Get/Set an integer-vector-valued entry.

void vtkInformation::Remove ( vtkInformationIntegerVectorKey * key )

Get/Set an integer-vector-valued entry.

int vtkInformation::Has ( vtkInformationIntegerVectorKey * key )

Get/Set an integer-vector-valued entry.

void vtkInformation::Append ( vtkInformationDoubleVectorKey * key,

double value

)

Get/Set an double-vector-valued entry.

void vtkInformation::Set ( vtkInformationDoubleVectorKey * key,

double * value,

int length

)

Get/Set an double-vector-valued entry.

double* vtkInformation::Get ( vtkInformationDoubleVectorKey * key )

Get/Set an double-vector-valued entry.

void vtkInformation::Get ( vtkInformationDoubleVectorKey * key,

double * value

)

Get/Set an double-vector-valued entry.

int vtkInformation::Length ( vtkInformationDoubleVectorKey * key )

Get/Set an double-vector-valued entry.

void vtkInformation::Remove ( vtkInformationDoubleVectorKey * key )

Get/Set an double-vector-valued entry.

int vtkInformation::Has ( vtkInformationDoubleVectorKey * key )

Get/Set an double-vector-valued entry.

void vtkInformation::Append ( vtkInformationKeyVectorKey * key,

vtkInformationKey * value

)

Get/Set an InformationKey-vector-valued entry.

void vtkInformation::Set ( vtkInformationKeyVectorKey * key,

vtkInformationKey ** value,

int length

)

Get/Set an InformationKey-vector-valued entry.

vtkInformationKey** vtkInformation::Get ( vtkInformationKeyVectorKey * key )

Get/Set an InformationKey-vector-valued entry.

void vtkInformation::Get ( vtkInformationKeyVectorKey * key,

vtkInformationKey ** value

)

Get/Set an InformationKey-vector-valued entry.

int vtkInformation::Length ( vtkInformationKeyVectorKey * key )

Get/Set an InformationKey-vector-valued entry.

void vtkInformation::Remove ( vtkInformationKeyVectorKey * key )

Get/Set an InformationKey-vector-valued entry.

int vtkInformation::Has ( vtkInformationKeyVectorKey * key )

Get/Set an InformationKey-vector-valued entry.

void vtkInformation::Set ( vtkInformationStringKey * key,

const char *

)

Get/Set a string-valued entry.

const char* vtkInformation::Get ( vtkInformationStringKey * key )

Get/Set a string-valued entry.

void vtkInformation::Remove ( vtkInformationStringKey * key )

Get/Set a string-valued entry.

int vtkInformation::Has ( vtkInformationStringKey * key )

Get/Set a string-valued entry.

void vtkInformation::Set ( vtkInformationInformationKey * key,

vtkInformation *

)

Get/Set an entry storing another vtkInformation instance.

vtkInformation* vtkInformation::Get ( vtkInformationInformationKey * key )

Get/Set an entry storing another vtkInformation instance.

void vtkInformation::Remove ( vtkInformationInformationKey * key )

Get/Set an entry storing another vtkInformation instance.

int vtkInformation::Has ( vtkInformationInformationKey * key )

Get/Set an entry storing another vtkInformation instance.

void vtkInformation::Set ( vtkInformationInformationVectorKey * key,

vtkInformationVector *

)

Get/Set an entry storing a vtkInformationVector instance.

vtkInformationVector* vtkInformation::Get ( vtkInformationInformationVectorKey * key )

Get/Set an entry storing a vtkInformationVector instance.

void vtkInformation::Remove ( vtkInformationInformationVectorKey * key )

Get/Set an entry storing a vtkInformationVector instance.

int vtkInformation::Has ( vtkInformationInformationVectorKey * key )

Get/Set an entry storing a vtkInformationVector instance.

void vtkInformation::Set ( vtkInformationObjectBaseKey * key,

vtkObjectBase *

)

Get/Set an entry storing a vtkObjectBase instance.

vtkObjectBase* vtkInformation::Get ( vtkInformationObjectBaseKey * key )

Get/Set an entry storing a vtkObjectBase instance.

void vtkInformation::Remove ( vtkInformationObjectBaseKey * key )

Get/Set an entry storing a vtkObjectBase instance.

int vtkInformation::Has ( vtkInformationObjectBaseKey * key )

Get/Set an entry storing a vtkObjectBase instance.

void vtkInformation::Set ( vtkInformationDataObjectKey * key,

vtkDataObject *

)

Get/Set an entry storing a vtkDataObject instance.

vtkDataObject* vtkInformation::Get ( vtkInformationDataObjectKey * key )

Get/Set an entry storing a vtkDataObject instance.

void vtkInformation::Remove ( vtkInformationDataObjectKey * key )

Get/Set an entry storing a vtkDataObject instance.

int vtkInformation::Has ( vtkInformationDataObjectKey * key )

Get/Set an entry storing a vtkDataObject instance.

void vtkInformation::Set ( vtkInformationExecutiveKey * key,

vtkExecutive *

)

Get/Set an entry storing a vtkExecutive instance.

vtkExecutive* vtkInformation::Get ( vtkInformationExecutiveKey * key )

Get/Set an entry storing a vtkExecutive instance.

void vtkInformation::Remove ( vtkInformationExecutiveKey * key )

Get/Set an entry storing a vtkExecutive instance.

int vtkInformation::Has ( vtkInformationExecutiveKey * key )

Get/Set an entry storing a vtkExecutive instance.

vtkInformationKey* vtkInformation::GetKey ( vtkInformationDataObjectKey * key ) [static]

Upcast the given key instance.

vtkInformationKey* vtkInformation::GetKey ( vtkInformationDoubleVectorKey * key ) [static]

Upcast the given key instance.

vtkInformationKey* vtkInformation::GetKey ( vtkInformationExecutiveKey * key ) [static]

Upcast the given key instance.

vtkInformationKey* vtkInformation::GetKey ( vtkInformationInformationKey * key ) [static]

Upcast the given key instance.

vtkInformationKey* vtkInformation::GetKey ( vtkInformationInformationVectorKey * key ) [static]

Upcast the given key instance.

vtkInformationKey* vtkInformation::GetKey ( vtkInformationIntegerKey * key ) [static]

Upcast the given key instance.

vtkInformationKey* vtkInformation::GetKey ( vtkInformationIntegerVectorKey * key ) [static]

Upcast the given key instance.

vtkInformationKey* vtkInformation::GetKey ( vtkInformationStringKey * key ) [static]

Upcast the given key instance.

vtkInformationKey* vtkInformation::GetKey ( vtkInformationKey * key ) [static]

Upcast the given key instance.

virtual void vtkInformation::UnRegister ( vtkObjectBase * o ) [virtual]

Initiate garbage collection when a reference is removed.
Reimplemented from vtkObject.

void vtkInformation::SetAsObjectBase ( vtkInformationKey * key,

vtkObjectBase * value

) [protected]

vtkObjectBase* vtkInformation::GetAsObjectBase ( vtkInformationKey * key ) [protected]

virtual void vtkInformation::ReportReferences ( vtkGarbageCollector * ) [protected, virtual]

Reimplemented from vtkObjectBase.

virtual void vtkInformation::RemoveReferences ( ) [protected, virtual]

Reimplemented from vtkObjectBase.

virtual void vtkInformation::GarbageCollectionStarting ( ) [protected, virtual]

Reimplemented from vtkObjectBase.

Member Data Documentation

vtkInformationInternals* vtkInformation::Internal [protected]

Definition at line 208 of file vtkInformation.h.

int vtkInformation::GarbageCollecting [protected]

Definition at line 214 of file vtkInformation.h.

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

dox/Filtering/vtkInformation.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	Clear ()
void	Copy (vtkInformation *from)
void	CopyEntries (vtkInformation from, vtkInformationKeyVectorKey key)
virtual void	UnRegister (vtkObjectBase *o)

void	CopyEntry (vtkInformation from, vtkInformationKey key)
void	CopyEntry (vtkInformation from, vtkInformationDataObjectKey key)
void	CopyEntry (vtkInformation from, vtkInformationDoubleVectorKey key)
void	CopyEntry (vtkInformation from, vtkInformationExecutiveKey key)
void	CopyEntry (vtkInformation from, vtkInformationInformationKey key)
void	CopyEntry (vtkInformation from, vtkInformationInformationVectorKey key)
void	CopyEntry (vtkInformation from, vtkInformationIntegerKey key)
void	CopyEntry (vtkInformation from, vtkInformationIntegerVectorKey key)
void	CopyEntry (vtkInformation from, vtkInformationStringKey key)

void	Set (vtkInformationIntegerKey *key, int value)
int	Get (vtkInformationIntegerKey *key)
void	Remove (vtkInformationIntegerKey *key)
int	Has (vtkInformationIntegerKey *key)

void	Append (vtkInformationIntegerVectorKey *key, int value)
void	Set (vtkInformationIntegerVectorKey key, int value, int length)
int *	Get (vtkInformationIntegerVectorKey *key)
void	Get (vtkInformationIntegerVectorKey key, int value)
int	Length (vtkInformationIntegerVectorKey *key)
void	Remove (vtkInformationIntegerVectorKey *key)
int	Has (vtkInformationIntegerVectorKey *key)

void	Append (vtkInformationDoubleVectorKey *key, double value)
void	Set (vtkInformationDoubleVectorKey key, double value, int length)
double *	Get (vtkInformationDoubleVectorKey *key)
void	Get (vtkInformationDoubleVectorKey key, double value)
int	Length (vtkInformationDoubleVectorKey *key)
void	Remove (vtkInformationDoubleVectorKey *key)
int	Has (vtkInformationDoubleVectorKey *key)

void	Append (vtkInformationKeyVectorKey key, vtkInformationKey value)
void	Set (vtkInformationKeyVectorKey key, vtkInformationKey *value, int length)
vtkInformationKey **	Get (vtkInformationKeyVectorKey *key)
void	Get (vtkInformationKeyVectorKey key, vtkInformationKey *value)
int	Length (vtkInformationKeyVectorKey *key)
void	Remove (vtkInformationKeyVectorKey *key)
int	Has (vtkInformationKeyVectorKey *key)

void	Set (vtkInformationStringKey key, const char )
const char *	Get (vtkInformationStringKey *key)
void	Remove (vtkInformationStringKey *key)
int	Has (vtkInformationStringKey *key)

void	Set (vtkInformationInformationKey key, vtkInformation )
vtkInformation *	Get (vtkInformationInformationKey *key)
void	Remove (vtkInformationInformationKey *key)
int	Has (vtkInformationInformationKey *key)

void	Set (vtkInformationInformationVectorKey key, vtkInformationVector )
vtkInformationVector *	Get (vtkInformationInformationVectorKey *key)
void	Remove (vtkInformationInformationVectorKey *key)
int	Has (vtkInformationInformationVectorKey *key)

void	Set (vtkInformationObjectBaseKey key, vtkObjectBase )
vtkObjectBase *	Get (vtkInformationObjectBaseKey *key)
void	Remove (vtkInformationObjectBaseKey *key)
int	Has (vtkInformationObjectBaseKey *key)

void	Set (vtkInformationDataObjectKey key, vtkDataObject )
vtkDataObject *	Get (vtkInformationDataObjectKey *key)
void	Remove (vtkInformationDataObjectKey *key)
int	Has (vtkInformationDataObjectKey *key)

void	Set (vtkInformationExecutiveKey key, vtkExecutive )
vtkExecutive *	Get (vtkInformationExecutiveKey *key)
void	Remove (vtkInformationExecutiveKey *key)
int	Has (vtkInformationExecutiveKey *key)
Static Public Member Functions
vtkInformation *	New ()
int	IsTypeOf (const char *type)
vtkInformation *	SafeDownCast (vtkObject *o)

vtkInformationKey *	GetKey (vtkInformationDataObjectKey *key)
vtkInformationKey *	GetKey (vtkInformationDoubleVectorKey *key)
vtkInformationKey *	GetKey (vtkInformationExecutiveKey *key)
vtkInformationKey *	GetKey (vtkInformationInformationKey *key)
vtkInformationKey *	GetKey (vtkInformationInformationVectorKey *key)
vtkInformationKey *	GetKey (vtkInformationIntegerKey *key)
vtkInformationKey *	GetKey (vtkInformationIntegerVectorKey *key)
vtkInformationKey *	GetKey (vtkInformationStringKey *key)
vtkInformationKey *	GetKey (vtkInformationKey *key)
Protected Member Functions
	vtkInformation ()
	~vtkInformation ()
void	SetAsObjectBase (vtkInformationKey key, vtkObjectBase value)
vtkObjectBase *	GetAsObjectBase (vtkInformationKey *key)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	RemoveReferences ()
virtual void	GarbageCollectionStarting ()
Protected Attributes
vtkInformationInternals *	Internal
int	GarbageCollecting

vtkInformation Class Reference

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation