Key for String vector values. More...

#include <vtkInformationStringVectorKey.h>

Inheritance diagram for vtkInformationStringVectorKey:

Collaboration diagram for vtkInformationStringVectorKey:

Public Types
typedef vtkInformationKey	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkInformationStringVectorKey *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

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

	~vtkInformationStringVectorKey () override

void	ShallowCopy (vtkInformation from, vtkInformation to) override
	Copy the entry associated with this key from one information object to another. More...

void	Print (ostream &os, vtkInformation *info) override
	Print the key's value in an information object to a stream. More...


void	Append (vtkInformation info, const char value)
	Get/Set the value associated with this key in the given information object. More...

void	Set (vtkInformation info, const char value, int idx=0)
	Get/Set the value associated with this key in the given information object. More...

void	Append (vtkInformation *info, const std::string &value)
	Get/Set the value associated with this key in the given information object. More...

void	Set (vtkInformation *info, const std::string &value, int idx=0)
	Get/Set the value associated with this key in the given information object. More...

const char *	Get (vtkInformation *info, int idx=0)
	Get/Set the value associated with this key in the given information object. More...

int	Length (vtkInformation *info)
	Get/Set the value associated with this key in the given information object. More...

Public Member Functions inherited from vtkInformationKey
	vtkBaseTypeMacro (vtkInformationKey, vtkObjectBase)

void	Register (vtkObjectBase *) override
	Prevent normal vtkObject reference counting behavior. More...

void	UnRegister (vtkObjectBase *) override
	Prevent normal vtkObject reference counting behavior. More...

const char *	GetName ()
	Get the name of the key. More...

const char *	GetLocation ()
	Get the location of the key. More...

virtual void	DeepCopy (vtkInformation from, vtkInformation to)
	Duplicate (new instance created) the entry associated with this key from one information object to another (new instances of any contained vtkInformation and vtkInformationVector objects are created). More...

virtual int	Has (vtkInformation *info)
	Check whether this key appears in the given information object. More...

virtual void	Remove (vtkInformation *info)
	Remove this key from the given information object. More...

virtual void	Report (vtkInformation info, vtkGarbageCollector collector)
	Report a reference this key has in the given information object. More...

virtual bool	NeedToExecute (vtkInformation vtkNotUsed(pipelineInfo), vtkInformation vtkNotUsed(dobjInfo))
	This function is only relevant when the pertaining key is used in a VTK pipeline. More...

virtual void	StoreMetaData (vtkInformation vtkNotUsed(request), vtkInformation vtkNotUsed(pipelineInfo), vtkInformation *vtkNotUsed(dobjInfo))
	This function is only relevant when the pertaining key is used in a VTK pipeline. More...

virtual void	CopyDefaultInformation (vtkInformation vtkNotUsed(request), vtkInformation vtkNotUsed(fromInfo), vtkInformation *vtkNotUsed(toInfo))
	This function is only relevant when the pertaining key is used in a VTK pipeline. More...

	vtkInformationKey (const char name, const char location)
	Key instances are static data that need to be created and destroyed. More...

	~vtkInformationKey () override
	Key instances are static data that need to be created and destroyed. More...

void	Print (vtkInformation *info)
	Print the key's value in an information object to a stream. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkInformationStringVectorKey *	SafeDownCast (vtkObjectBase *o)

static vtkInformationStringVectorKey *	MakeKey (const char name, const char location, int length=-1)
	This method simply returns a new vtkInformationStringVectorKey, given a name, a location and a required length. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

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 *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool 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 36 of file vtkInformationStringVectorKey.h.

Member Typedef Documentation

typedef vtkInformationKey vtkInformationStringVectorKey::Superclass

Definition at line 39 of file vtkInformationStringVectorKey.h.

Constructor & Destructor Documentation

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

vtkInformationStringVectorKey::~vtkInformationStringVectorKey ( )

override

Member Function Documentation

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

static

virtual vtkTypeBool 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 vtkObjectBase.

static vtkInformationStringVectorKey* vtkInformationStringVectorKey::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkInformationStringVectorKey::NewInstanceInternal ( ) const

protectedvirtual

vtkInformationStringVectorKey* vtkInformationStringVectorKey::NewInstance ( ) const

void vtkInformationStringVectorKey::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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 51 of file vtkInformationStringVectorKey.h.

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