vtkInformationObjectBaseKey Class Reference

#include <vtkInformationObjectBaseKey.h>

Inheritance diagram for vtkInformationObjectBaseKey:

[legend]Collaboration diagram for vtkInformationObjectBaseKey:

[legend]List of all members.

---

Detailed Description

Key for vtkObjectBase values.

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

Definition at line 31 of file vtkInformationObjectBaseKey.h.

Public Types
typedef vtkInformationKey	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
	vtkInformationObjectBaseKey (const char *name, const char *location, const char *requiredClass=0)
virtual void	ShallowCopy (vtkInformation *from, vtkInformation *to)
virtual void	Report (vtkInformation *info, vtkGarbageCollector *collector)
	~vtkInformationObjectBaseKey ()
void	Set (vtkInformation *info, vtkObjectBase *)
vtkObjectBase *	Get (vtkInformation *info)
int	Has (vtkInformation *info)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkInformationObjectBaseKey *	SafeDownCast (vtkObject *o)
Protected Attributes
const char *	RequiredClass

---

Member Typedef Documentation

typedef vtkInformationKey vtkInformationObjectBaseKey::Superclass

Reimplemented from vtkInformationKey. Definition at line 34 of file vtkInformationObjectBaseKey.h.

---

Constructor & Destructor Documentation

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

vtkInformationObjectBaseKey::~vtkInformationObjectBaseKey (   )

---

Member Function Documentation

virtual const char* vtkInformationObjectBaseKey::GetClassName (   )  [virtual]

Reimplemented from vtkInformationKey.

static int vtkInformationObjectBaseKey::IsTypeOf (  const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkInformationKey.

virtual int vtkInformationObjectBaseKey::IsA (  const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkInformationKey.

static vtkInformationObjectBaseKey* vtkInformationObjectBaseKey::SafeDownCast (  vtkObject *  o  )  [static]

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.

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

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

vtkObjectBase* vtkInformationObjectBaseKey::Get (  vtkInformation *  info  )

int vtkInformationObjectBaseKey::Has (  vtkInformation *  info  )

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.

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

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

---

Member Data Documentation

const char* vtkInformationObjectBaseKey::RequiredClass [protected]

Definition at line 59 of file vtkInformationObjectBaseKey.h.

---

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

• dox/Filtering/vtkInformationObjectBaseKey.h

---