vtkInformationExecutivePortKey Class Reference

Key for vtkExecutive/Port value pairs. More...

#include <vtkInformationExecutivePortKey.h>

Inheritance diagram for vtkInformationExecutivePortKey:

Collaboration diagram for vtkInformationExecutivePortKey:

List of all members.

Public Types
typedef vtkInformationKey	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkInformationExecutivePortKey *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
	vtkInformationExecutivePortKey (const char *name, const char *location)
	~vtkInformationExecutivePortKey ()
virtual void	ShallowCopy (vtkInformation *from, vtkInformation *to)
virtual void	Report (vtkInformation *info, vtkGarbageCollector *collector)
virtual void	Print (ostream &os, vtkInformation *info)
void	Set (vtkInformation *info, vtkExecutive *, int)
vtkExecutive *	GetExecutive (vtkInformation *info)
int	GetPort (vtkInformation *info)
void	Get (vtkInformation *info, vtkExecutive *&executive, int &port)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkInformationExecutivePortKey *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

---

Detailed Description

Key for vtkExecutive/Port value pairs.

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

Definition at line 33 of file vtkInformationExecutivePortKey.h.

---

Member Typedef Documentation

typedef vtkInformationKey vtkInformationExecutivePortKey::Superclass

Reimplemented from vtkInformationKey.

Definition at line 36 of file vtkInformationExecutivePortKey.h.

---

Constructor & Destructor Documentation

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

vtkInformationExecutivePortKey::~vtkInformationExecutivePortKey

(

)

---

Member Function Documentation

static int vtkInformationExecutivePortKey::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 vtkInformationExecutivePortKey::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 vtkInformationExecutivePortKey* vtkInformationExecutivePortKey::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkInformationKey.

virtual vtkObjectBase* vtkInformationExecutivePortKey::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkInformationKey.

vtkInformationExecutivePortKey* vtkInformationExecutivePortKey::NewInstance

(

)

const

Reimplemented from vtkInformationKey.

void vtkInformationExecutivePortKey::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 vtkInformationExecutivePortKey::Set	(	vtkInformation *	info,
		vtkExecutive *	,
		int
	)

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

vtkExecutive* vtkInformationExecutivePortKey::GetExecutive

(

vtkInformation *

info

)

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

int vtkInformationExecutivePortKey::GetPort

(

vtkInformation *

info

)

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

void vtkInformationExecutivePortKey::Get	(	vtkInformation *	info,
		vtkExecutive *&	executive,
		int &	port
	)

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

virtual void vtkInformationExecutivePortKey::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 vtkInformationExecutivePortKey::Report	(	vtkInformation *	info,
		vtkGarbageCollector *	collector
	)		[virtual]

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

Reimplemented from vtkInformationKey.

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

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

Reimplemented from vtkInformationKey.

---

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

• dox/Common/ExecutionModel/vtkInformationExecutivePortKey.h