vtkInformationExecutivePortVectorKey Class Reference

Key for vtkExecutive/Port value pair vectors. More...

#include <vtkInformationExecutivePortVectorKey.h>

Inheritance diagram for vtkInformationExecutivePortVectorKey:

Collaboration diagram for vtkInformationExecutivePortVectorKey:

List of all members.

Public Types
typedef vtkInformationKey	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkInformationExecutivePortVectorKey *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
	vtkInformationExecutivePortVectorKey (const char *name, const char *location)
	~vtkInformationExecutivePortVectorKey ()
virtual void	ShallowCopy (vtkInformation *from, vtkInformation *to)
virtual void	Remove (vtkInformation *info)
virtual void	Report (vtkInformation *info, vtkGarbageCollector *collector)
virtual void	Print (ostream &os, vtkInformation *info)
void	Append (vtkInformation *info, vtkExecutive *executive, int port)
void	Remove (vtkInformation *info, vtkExecutive *executive, int port)
void	Set (vtkInformation *info, vtkExecutive **executives, int *ports, int length)
vtkExecutive **	GetExecutives (vtkInformation *info)
int *	GetPorts (vtkInformation *info)
void	Get (vtkInformation *info, vtkExecutive **executives, int *ports)
int	Length (vtkInformation *info)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkInformationExecutivePortVectorKey *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
vtkExecutive **	GetExecutivesWatchAddress (vtkInformation *info)
int *	GetPortsWatchAddress (vtkInformation *info)

---

Detailed Description

Key for vtkExecutive/Port value pair vectors.

vtkInformationExecutivePortVectorKey is used to represent keys in vtkInformation for values that are vectors of vtkExecutive instances paired with port numbers.

Definition at line 33 of file vtkInformationExecutivePortVectorKey.h.

---

Member Typedef Documentation

typedef vtkInformationKey vtkInformationExecutivePortVectorKey::Superclass

Reimplemented from vtkInformationKey.

Definition at line 36 of file vtkInformationExecutivePortVectorKey.h.

---

Constructor & Destructor Documentation

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

vtkInformationExecutivePortVectorKey::~vtkInformationExecutivePortVectorKey

(

)

---

Member Function Documentation

static int vtkInformationExecutivePortVectorKey::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 vtkInformationKey.

virtual int vtkInformationExecutivePortVectorKey::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 vtkInformationKey.

static vtkInformationExecutivePortVectorKey* vtkInformationExecutivePortVectorKey::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkInformationKey.

virtual vtkObjectBase* vtkInformationExecutivePortVectorKey::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkInformationKey.

vtkInformationExecutivePortVectorKey* vtkInformationExecutivePortVectorKey::NewInstance

(

)

const

Reimplemented from vtkInformationKey.

void vtkInformationExecutivePortVectorKey::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 vtkInformationKey.

void vtkInformationExecutivePortVectorKey::Append	(	vtkInformation *	info,
		vtkExecutive *	executive,
		int	port
	)

Get/Set the value associated with this key in the given information object.

void vtkInformationExecutivePortVectorKey::Remove	(	vtkInformation *	info,
		vtkExecutive *	executive,
		int	port
	)

Get/Set the value associated with this key in the given information object.

void vtkInformationExecutivePortVectorKey::Set	(	vtkInformation *	info,
		vtkExecutive **	executives,
		int *	ports,
		int	length
	)

Get/Set the value associated with this key in the given information object.

vtkExecutive** vtkInformationExecutivePortVectorKey::GetExecutives

(

vtkInformation *

info

)

Get/Set the value associated with this key in the given information object.

int* vtkInformationExecutivePortVectorKey::GetPorts

(

vtkInformation *

info

)

Get/Set the value associated with this key in the given information object.

void vtkInformationExecutivePortVectorKey::Get	(	vtkInformation *	info,
		vtkExecutive **	executives,
		int *	ports
	)

Get/Set the value associated with this key in the given information object.

int vtkInformationExecutivePortVectorKey::Length

(

vtkInformation *

info

)

Get/Set the value associated with this key in the given information object.

virtual void vtkInformationExecutivePortVectorKey::ShallowCopy	(	vtkInformation *	from,
		vtkInformation *	to
	)		[virtual]

Copy the entry associated with this key from one information object to another. If there is no entry in the first information object for this key, the value is removed from the second.

Implements vtkInformationKey.

virtual void vtkInformationExecutivePortVectorKey::Remove

(

vtkInformation *

info

)

[virtual]

Remove this key from the given information object.

Reimplemented from vtkInformationKey.

virtual void vtkInformationExecutivePortVectorKey::Report	(	vtkInformation *	info,
		vtkGarbageCollector *	collector
	)		[virtual]

Report a reference this key has in the given information object.

Reimplemented from vtkInformationKey.

virtual void vtkInformationExecutivePortVectorKey::Print	(	ostream &	os,
		vtkInformation *	info
	)		[virtual]

Print the key's value in an information object to a stream.

Reimplemented from vtkInformationKey.

vtkExecutive** vtkInformationExecutivePortVectorKey::GetExecutivesWatchAddress

(

vtkInformation *

info

)

[protected]

Get the address at which the actual value is stored. This is meant for use from a debugger to add watches and is therefore not a public method.

int* vtkInformationExecutivePortVectorKey::GetPortsWatchAddress

(

vtkInformation *

info

)

[protected]

Get the address at which the actual value is stored. This is meant for use from a debugger to add watches and is therefore not a public method.

---

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

• dox/Common/ExecutionModel/vtkInformationExecutivePortVectorKey.h