#include <vtkInformationObjectBaseKey.h>

Inheritance diagram for vtkInformationObjectBaseKey:

Collaboration diagram for vtkInformationObjectBaseKey:

Public Types
typedef vtkInformationKey	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkInformationObjectBaseKey *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
	vtkInformationObjectBaseKey (const char name, const char location, const char *requiredClass=0)
	~vtkInformationObjectBaseKey ()
virtual void	ShallowCopy (vtkInformation from, vtkInformation to)
virtual void	Report (vtkInformation info, vtkGarbageCollector collector)

void	Set (vtkInformation info, vtkObjectBase )
vtkObjectBase *	Get (vtkInformation *info)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkInformationObjectBaseKey *	SafeDownCast (vtkObjectBase *o)

static vtkInformationObjectBaseKey *	MakeKey (const char name, const char location, const char *requiredClass=0)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkInformationKeySetStringMacro (RequiredClass)
Protected Attributes
const char *	RequiredClass

Detailed Description

Key for vtkObjectBase values.

vtkInformationObjectBaseKey is used to represent keys in vtkInformation for values that are vtkObjectBase instances.

Definition at line 32 of file vtkInformationObjectBaseKey.h.

Member Typedef Documentation

typedef vtkInformationKey vtkInformationObjectBaseKey::Superclass

Reimplemented from vtkInformationKey.

Definition at line 35 of file vtkInformationObjectBaseKey.h.

Constructor & Destructor Documentation

vtkInformationObjectBaseKey::vtkInformationObjectBaseKey	(	const char *	name,
		const char *	location,
		const char *	requiredClass = `0`
	)

vtkInformationObjectBaseKey::~vtkInformationObjectBaseKey ( )

Member Function Documentation

static int vtkInformationObjectBaseKey::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 vtkInformationObjectBaseKey::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 vtkInformationObjectBaseKey* vtkInformationObjectBaseKey::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkInformationKey.

virtual vtkObjectBase* vtkInformationObjectBaseKey::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkInformationKey.

vtkInformationObjectBaseKey* vtkInformationObjectBaseKey::NewInstance ( ) const

Reimplemented from vtkInformationKey.

void vtkInformationObjectBaseKey::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 vtkInformationObjectBaseKey* vtkInformationObjectBaseKey::MakeKey	(	const char *	name,
		const char *	location,
		const char *	requiredClass = `0`
	)		`[inline, static]`

This method simply returns a new vtkInformationObjectBaseKey, given a name, location and optionally a required class (a classname to restrict which class types can be set with this key). This method is provided for wrappers. Use the constructor directly from C++ instead.

Definition at line 47 of file vtkInformationObjectBaseKey.h.

void vtkInformationObjectBaseKey::Set	(	vtkInformation *	info,
		vtkObjectBase *
	)

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

vtkObjectBase* vtkInformationObjectBaseKey::Get ( vtkInformation * info )

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

virtual void vtkInformationObjectBaseKey::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.