Key for String vector values. More...

#include <vtkInformationStringVectorKey.h>

Inheritance diagram for vtkInformationStringVectorKey:

Collaboration diagram for vtkInformationStringVectorKey:

Public Types
typedef vtkInformationKey	Superclass

Public Types inherited from vtkInformationKey
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkInformationStringVectorKey *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

	vtkInformationStringVectorKey (const char name, const char location, int length=-1)

	~vtkInformationStringVectorKey ()

virtual void	ShallowCopy (vtkInformation from, vtkInformation to)

virtual void	Print (ostream &os, vtkInformation *info)


void	Append (vtkInformation info, const char value)

void	Set (vtkInformation info, const char value, int idx=0)

const char *	Get (vtkInformation *info, int idx=0)

int	Length (vtkInformation *info)

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)

virtual void	Report (vtkInformation info, vtkGarbageCollector collector)

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


static vtkInformationStringVectorKey *	MakeKey (const char name, const char location, int length=-1)

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 &)

Protected Attributes
int	RequiredLength

Protected Attributes inherited from vtkInformationKey
char *	Name

char *	Location

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Key for String vector values.

vtkInformationStringVectorKey is used to represent keys for String vector values in vtkInformation.h

Tests:: vtkInformationStringVectorKey (Tests)

Definition at line 33 of file vtkInformationStringVectorKey.h.

Member Typedef Documentation

typedef vtkInformationKey vtkInformationStringVectorKey::Superclass

Definition at line 36 of file vtkInformationStringVectorKey.h.

Constructor & Destructor Documentation

vtkInformationStringVectorKey::vtkInformationStringVectorKey	(	const char *	name,
		const char *	location,
		int	length = `-1`
	)

vtkInformationStringVectorKey::~vtkInformationStringVectorKey ( )

Member Function Documentation

static int vtkInformationStringVectorKey::IsTypeOf ( const char * type )

static

virtual int vtkInformationStringVectorKey::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 vtkInformationStringVectorKey* vtkInformationStringVectorKey::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkInformationStringVectorKey::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkInformationKey.

vtkInformationStringVectorKey* vtkInformationStringVectorKey::NewInstance ( ) const

void vtkInformationStringVectorKey::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 vtkInformationStringVectorKey* vtkInformationStringVectorKey::MakeKey	(	const char *	name,
		const char *	location,
		int	length = `-1`
	)

inlinestatic

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

Definition at line 47 of file vtkInformationStringVectorKey.h.

void vtkInformationStringVectorKey::Append	(	vtkInformation *	info,
		const char *	value
	)

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

void vtkInformationStringVectorKey::Set	(	vtkInformation *	info,
		const char *	value,
		int	idx = `0`
	)

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

const char* vtkInformationStringVectorKey::Get	(	vtkInformation *	info,
		int	idx = `0`
	)

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

int vtkInformationStringVectorKey::Length ( vtkInformation * info )

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

virtual void vtkInformationStringVectorKey::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 vtkInformationStringVectorKey::Print	(	ostream &	os,
		vtkInformation *	info
	)

virtual

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

Reimplemented from vtkInformationKey.

Member Data Documentation

int vtkInformationStringVectorKey::RequiredLength

protected

Definition at line 73 of file vtkInformationStringVectorKey.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation