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

#include <vtkInformationExecutivePortKey.h>

Inheritance diagram for vtkInformationExecutivePortKey:

Collaboration diagram for vtkInformationExecutivePortKey:

Public Types
typedef vtkInformationKey	Superclass

Public Types inherited from vtkInformationKey
typedef vtkObjectBase	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)

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)

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


static vtkInformationExecutivePortKey *	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 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 &)

Additional Inherited Members
Protected Attributes inherited from vtkInformationKey
char *	Name

char *	Location

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

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 * type )

static

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

virtual vtkObjectBase* vtkInformationExecutivePortKey::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkInformationKey.

vtkInformationExecutivePortKey* vtkInformationExecutivePortKey::NewInstance ( ) const

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.

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

inlinestatic

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

Definition at line 46 of file vtkInformationExecutivePortKey.h.

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:

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation