key that can used to request integer values from the pipeline vtkInformationIntegerRequestKey is a vtkInformationIntegerKey that can used to request integer values from upstream. A good example of this is UPDATE_NUMBER_OF_PIECES where downstream can request that upstream provides data partitioned into a certain number of pieces. There are several components that make this work. First, the key will copy itself upstream during REQUEST_UPDATE_EXTENT. Second, after a successfull execution, it will stor its value into a data object's information using a specific key defined by its data member DataKey. Third, before execution, it will check if the requested value matched the value in the data object's information. If not, it will ask the pipeline to execute. More...

#include <vtkInformationIntegerRequestKey.h>

Inheritance diagram for vtkInformationIntegerRequestKey:

[legend]

Collaboration diagram for vtkInformationIntegerRequestKey:

[legend]

Public Types
typedef vtkInformationIntegerKey	Superclass

Public Types inherited from vtkInformationIntegerKey
typedef vtkInformationKey	Superclass

Public Types inherited from vtkInformationKey
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkInformationIntegerRequestKey *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

	vtkInformationIntegerRequestKey (const char name, const char location)

	~vtkInformationIntegerRequestKey ()


virtual bool	NeedToExecute (vtkInformation pipelineInfo, vtkInformation dobjInfo)


virtual void	StoreMetaData (vtkInformation request, vtkInformation pipelineInfo, vtkInformation *dobjInfo)


virtual void	CopyDefaultInformation (vtkInformation request, vtkInformation fromInfo, vtkInformation *toInfo)

Public Member Functions inherited from vtkInformationIntegerKey
vtkInformationIntegerKey *	NewInstance () const

	vtkInformationIntegerKey (const char name, const char location)

	~vtkInformationIntegerKey ()

virtual void	ShallowCopy (vtkInformation from, vtkInformation to)

virtual void	Print (ostream &os, vtkInformation *info)

void	Set (vtkInformation *info, int)

int	Get (vtkInformation *info)

Public Member Functions inherited from vtkInformationKey
vtkInformationKey *	NewInstance () const

virtual void	Register (vtkObjectBase *)

virtual void	UnRegister (vtkObjectBase *)

const char *	GetName ()

const char *	GetLocation ()

virtual int	Has (vtkInformation *info)

virtual void	Remove (vtkInformation *info)

virtual void	Report (vtkInformation info, vtkGarbageCollector collector)

	vtkInformationKey (const char name, const char location)

	~vtkInformationKey ()

virtual void	DeepCopy (vtkInformation from, vtkInformation to)

void	Print (vtkInformation *info)

virtual bool	NeedToExecute (vtkInformation vtkNotUsed(pipelineInfo), vtkInformation vtkNotUsed(dobjInfo))

virtual void	StoreMetaData (vtkInformation vtkNotUsed(request), vtkInformation vtkNotUsed(pipelineInfo), vtkInformation *vtkNotUsed(dobjInfo))

virtual void	CopyDefaultInformation (vtkInformation vtkNotUsed(request), vtkInformation vtkNotUsed(fromInfo), vtkInformation *vtkNotUsed(toInfo))

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

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 vtkInformationIntegerRequestKey *	SafeDownCast (vtkObjectBase *o)


static vtkInformationIntegerRequestKey *	MakeKey (const char name, const char location)

Static Public Member Functions inherited from vtkInformationIntegerKey
static int	IsTypeOf (const char *type)

static vtkInformationIntegerKey *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	MakeKey (const char name, const char location)

Static Public Member Functions inherited from vtkInformationKey
static int	IsTypeOf (const char *type)

static vtkInformationKey *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

Protected Member Functions inherited from vtkInformationIntegerKey
int *	GetWatchAddress (vtkInformation *info)

Protected Member Functions inherited from vtkInformationKey
	vtkInformationKeySetStringMacro (Name)

	vtkInformationKeySetStringMacro (Location)

void	SetAsObjectBase (vtkInformation info, vtkObjectBase value)

const vtkObjectBase *	GetAsObjectBase (vtkInformation *info) const

vtkObjectBase *	GetAsObjectBase (vtkInformation *info)

void	ReportAsObjectBase (vtkInformation info, vtkGarbageCollector collector)

void	ConstructClass (const char *)

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkInformationIntegerKey *	DataKey

Protected Attributes inherited from vtkInformationKey
char *	Name

char *	Location

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

key that can used to request integer values from the pipeline vtkInformationIntegerRequestKey is a vtkInformationIntegerKey that can used to request integer values from upstream. A good example of this is UPDATE_NUMBER_OF_PIECES where downstream can request that upstream provides data partitioned into a certain number of pieces. There are several components that make this work. First, the key will copy itself upstream during REQUEST_UPDATE_EXTENT. Second, after a successfull execution, it will stor its value into a data object's information using a specific key defined by its data member DataKey. Third, before execution, it will check if the requested value matched the value in the data object's information. If not, it will ask the pipeline to execute.

The best way to use this class is to subclass it to set the DataKey data member. This is usually done in the subclass' constructor.

Tests:: vtkInformationIntegerRequestKey (Tests)

Definition at line 43 of file vtkInformationIntegerRequestKey.h.

Member Typedef Documentation

typedef vtkInformationIntegerKey vtkInformationIntegerRequestKey::Superclass

Definition at line 46 of file vtkInformationIntegerRequestKey.h.

Constructor & Destructor Documentation

vtkInformationIntegerRequestKey::vtkInformationIntegerRequestKey	(	const char *	name,
		const char *	location
	)

vtkInformationIntegerRequestKey::~vtkInformationIntegerRequestKey ( )

Member Function Documentation

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

static

virtual int vtkInformationIntegerRequestKey::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 vtkInformationIntegerKey.

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

static

virtual vtkObjectBase* vtkInformationIntegerRequestKey::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkInformationIntegerKey.

vtkInformationIntegerRequestKey* vtkInformationIntegerRequestKey::NewInstance ( ) const

void vtkInformationIntegerRequestKey::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 vtkInformationIntegerKey.

static vtkInformationIntegerRequestKey* vtkInformationIntegerRequestKey::MakeKey	(	const char *	name,
		const char *	location
	)

inlinestatic

This method simply returns a new vtkInformationIntegerRequestKey, given a name and a location. This method is provided for wrappers. Use the constructor directly from C++ instead.

Definition at line 56 of file vtkInformationIntegerRequestKey.h.

virtual bool vtkInformationIntegerRequestKey::NeedToExecute	(	vtkInformation *	pipelineInfo,
		vtkInformation *	dobjInfo
	)

virtual

Returns true if a value of type DataKey does not exist in dobjInfo or if it is different that the value stored in pipelineInfo using this key.

virtual void vtkInformationIntegerRequestKey::StoreMetaData	(	vtkInformation *	request,
		vtkInformation *	pipelineInfo,
		vtkInformation *	dobjInfo
	)

virtual

Copies the value stored in pipelineInfo using this key into dobjInfo.

virtual void vtkInformationIntegerRequestKey::CopyDefaultInformation	(	vtkInformation *	request,
		vtkInformation *	fromInfo,
		vtkInformation *	toInfo
	)

virtual

Copies the value stored in fromInfo using this key into toInfo if request has the REQUEST_UPDATE_EXTENT key.

Member Data Documentation

vtkInformationIntegerKey* vtkInformationIntegerRequestKey::DataKey

protected

Definition at line 86 of file vtkInformationIntegerRequestKey.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/ExecutionModel/vtkInformationIntegerRequestKey.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation