vtkInformationInformationKey Class Reference

Key for vtkInformation values. More...

#include <vtkInformationInformationKey.h>

Inheritance diagram for vtkInformationInformationKey:

Collaboration diagram for vtkInformationInformationKey:

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.
vtkInformationInformationKey *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
	vtkInformationInformationKey (const char *name, const char *location)
	~vtkInformationInformationKey () override
void	ShallowCopy (vtkInformation *from, vtkInformation *to) override
	Copy the entry associated with this key from one information object to another.
void	DeepCopy (vtkInformation *from, vtkInformation *to) override
	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).
void	Set (vtkInformation *info, vtkInformation *)
	Get/Set the value associated with this key in the given information object.
vtkInformation *	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.
void	Register (vtkObjectBase *) override
	Prevent normal vtkObject reference counting behavior.
void	UnRegister (vtkObjectBase *) override
	Prevent normal vtkObject reference counting behavior.
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.
	~vtkInformationKey () override
	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.
virtual void	Print (ostream &os, 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 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.
virtual 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.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkInformationInformationKey *	SafeDownCast (vtkObjectBase *o)
static vtkInformationInformationKey *	MakeKey (const char *name, const char *location)
	This method simply returns a new vtkInformationInformationKey, 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 *)
	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 vtkInformation values.

vtkInformationInformationKey is used to represent keys in vtkInformation for other information objects.

Definition at line 31 of file vtkInformationInformationKey.h.

Member Typedef Documentation

Superclass

typedef vtkInformationKey vtkInformationInformationKey::Superclass

Definition at line 34 of file vtkInformationInformationKey.h.

Constructor & Destructor Documentation

vtkInformationInformationKey()

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

~vtkInformationInformationKey()

vtkInformationInformationKey::~vtkInformationInformationKey ( )

override

Member Function Documentation

IsTypeOf()

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

static

IsA()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkInformationInformationKey::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkInformationInformationKey * vtkInformationInformationKey::NewInstance

(

)

const

PrintSelf()

void vtkInformationInformationKey::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 vtkObjectBase.

MakeKey()

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

inlinestatic

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

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

Definition at line 45 of file vtkInformationInformationKey.h.

Set()

void vtkInformationInformationKey::Set	(	vtkInformation *	info,
		vtkInformation *
	)

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

Get()

vtkInformation * vtkInformationInformationKey::Get

(

vtkInformation *

info

)

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

ShallowCopy()

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

DeepCopy()

void vtkInformationInformationKey::DeepCopy ( vtkInformation *  from, vtkInformation *  to  )

overridevirtual

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

Reimplemented from vtkInformationKey.

---

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

• Common/Core/vtkInformationInformationKey.h