Key for string values in vtkInformation. More...

#include <vtkInformationStringKey.h>

Inheritance diagram for vtkInformationStringKey:

Collaboration diagram for vtkInformationStringKey:

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.

vtkInformationStringKey *	NewInstance () const

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

	vtkInformationStringKey (const char name, const char location)

	~vtkInformationStringKey () override

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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.

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

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

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

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

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

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

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

void	InitializeObjectBase ()

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

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

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

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

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

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

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

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

static vtkInformationStringKey *	SafeDownCast (vtkObjectBase *o)

static vtkInformationStringKey *	MakeKey (const char name, const char location)
	This method simply returns a new vtkInformationStringKey, given a name and a location.

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.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

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

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

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

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkInformationKey
char *	Name

char *	Location

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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 25 of file vtkInformationStringKey.h.

Member Typedef Documentation

◆ Superclass

typedef vtkInformationKey vtkInformationStringKey::Superclass

Definition at line 28 of file vtkInformationStringKey.h.

Constructor & Destructor Documentation

◆ vtkInformationStringKey()

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

◆ ~vtkInformationStringKey()

vtkInformationStringKey::~vtkInformationStringKey ( )

override

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkInformationStringKey::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkInformationStringKey * vtkInformationStringKey::NewInstance ( ) const

◆ PrintSelf()

void vtkInformationStringKey::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.

◆ MakeKey()

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

inlinestatic

This method simply returns a new vtkInformationStringKey, given a name and a location.

This method is provided for wrappers. Use the constructor directly from C++ instead.

Definition at line 39 of file vtkInformationStringKey.h.

◆ Set() [1/2]

void vtkInformationStringKey::Set	(	vtkInformation *	info,
		const char *
	)

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

◆ Set() [2/2]

void vtkInformationStringKey::Set	(	vtkInformation *	info,
		const std::string &	str
	)

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

◆ Get()

const char * vtkInformationStringKey::Get ( vtkInformation * info )

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

◆ ShallowCopy()

void vtkInformationStringKey::ShallowCopy	(	vtkInformation *	from,
		vtkInformation *	to
	)

overridevirtual

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.

◆ Print()

void vtkInformationStringKey::Print	(	ostream &	os,
		vtkInformation *	info
	)

overridevirtual

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:

Common/Core/vtkInformationStringKey.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkInformationStringKey()

◆ ~vtkInformationStringKey()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ MakeKey()

◆ Set() [1/2]

◆ Set() [2/2]

◆ Get()

◆ ShallowCopy()

◆ Print()