vtkInformationStringKey Class Reference

Key for string values in vtkInformation. More...

#include <vtkInformationStringKey.h>

Inheritance diagram for vtkInformationStringKey:

Collaboration diagram for vtkInformationStringKey:

List of all members.

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

---

Detailed Description

Key for string values in vtkInformation.

vtkInformationStringKey is used to represent keys for string values in vtkInformation.

Tests:

vtkInformationStringKey (Tests)

Definition at line 33 of file vtkInformationStringKey.h.

---

Member Typedef Documentation

typedef vtkInformationKey vtkInformationStringKey::Superclass

Reimplemented from vtkInformationKey.

Definition at line 36 of file vtkInformationStringKey.h.

---

Constructor & Destructor Documentation

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

vtkInformationStringKey::~vtkInformationStringKey

(

)

---

Member Function Documentation

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

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkInformationKey.

virtual vtkObjectBase* vtkInformationStringKey::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkInformationKey.

vtkInformationStringKey* vtkInformationStringKey::NewInstance

(

)

const

Reimplemented from vtkInformationKey.

void vtkInformationStringKey::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 vtkInformationStringKey::Set	(	vtkInformation *	info,
		const char *
	)

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

const char* vtkInformationStringKey::Get

(

vtkInformation *

info

)

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

virtual void vtkInformationStringKey::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 vtkInformationStringKey::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/Core/vtkInformationStringKey.h