VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkInformationKey Class Referenceabstract

Superclass for vtkInformation keys. More...

#include <vtkInformationKey.h>

Inheritance diagram for vtkInformationKey:
[legend]
Collaboration diagram for vtkInformationKey:
[legend]

Public Types

typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *)
 
virtual void UnRegister (vtkObjectBase *)
 
const char * GetName ()
 
const char * GetLocation ()
 
virtual void ShallowCopy (vtkInformation *from, vtkInformation *to)=0
 
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 void Print (ostream &os, vtkInformation *info)
 
- 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 &os)
 
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 vtkInformationKeySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

void SetAsObjectBase (vtkInformation *info, vtkObjectBase *value)
 
vtkObjectBaseGetAsObjectBase (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 &os)
 
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

const char * Name
 
const char * Location
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Superclass for vtkInformation keys.

vtkInformationKey is the superclass for all keys used to access the map represented by vtkInformation. The vtkInformation::Set and vtkInformation::Get methods of vtkInformation are accessed by information keys. A key is a pointer to an instance of a subclass of vtkInformationKey. The type of the subclass determines the overload of Set/Get that is selected. This ensures that the type of value stored in a vtkInformation instance corresponding to a given key matches the type expected for that key.

Definition at line 36 of file vtkInformationKey.h.

Member Typedef Documentation

Definition at line 39 of file vtkInformationKey.h.

Constructor & Destructor Documentation

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

Key instances are static data that need to be created and destroyed. The constructor and destructor must be public. The name of the static instance and the class in which it is defined should be passed to the constructor. They must be string literals because the strings are not copied.

vtkInformationKey::~vtkInformationKey ( )

Key instances are static data that need to be created and destroyed. The constructor and destructor must be public. The name of the static instance and the class in which it is defined should be passed to the constructor. They must be string literals because the strings are not copied.

Member Function Documentation

virtual const char* vtkInformationKey::GetClassName ( )
virtual
static int vtkInformationKey::IsTypeOf ( const char *  type)
static
virtual int vtkInformationKey::IsA ( const char *  name)
virtual
static vtkInformationKey* vtkInformationKey::SafeDownCast ( vtkObject o)
static
void vtkInformationKey::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 vtkObjectBase.

Reimplemented in vtkInformationQuadratureSchemeDefinitionVectorKey, vtkInformationObjectBaseVectorKey, vtkInformationObjectBaseKey, vtkInformationKeyVectorKey, vtkInformationRequestKey, vtkInformationStringKey, vtkInformationStringVectorKey, and vtkInformationUnsignedLongKey.

virtual void vtkInformationKey::Register ( vtkObjectBase )
virtual

Prevent normal vtkObject reference counting behavior.

Reimplemented from vtkObjectBase.

virtual void vtkInformationKey::UnRegister ( vtkObjectBase )
virtual

Prevent normal vtkObject reference counting behavior.

Reimplemented from vtkObjectBase.

const char* vtkInformationKey::GetName ( )

Get the name of the key. This is not the type of the key, but the name of the key instance.

const char* vtkInformationKey::GetLocation ( )

Get the location of the key. This is the name of the class in which the key is defined.

virtual void vtkInformationKey::ShallowCopy ( vtkInformation from,
vtkInformation to 
)
pure virtual
virtual void vtkInformationKey::DeepCopy ( vtkInformation from,
vtkInformation to 
)
inlinevirtual

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). Default implementation simply calls ShallowCopy().

Reimplemented in vtkInformationQuadratureSchemeDefinitionVectorKey, vtkInformationInformationVectorKey, and vtkInformationInformationKey.

Definition at line 76 of file vtkInformationKey.h.

virtual int vtkInformationKey::Has ( vtkInformation info)
virtual

Check whether this key appears in the given information object.

Reimplemented in vtkInformationRequestKey.

virtual void vtkInformationKey::Remove ( vtkInformation info)
virtual

Remove this key from the given information object.

Reimplemented in vtkInformationRequestKey.

virtual void vtkInformationKey::Report ( vtkInformation info,
vtkGarbageCollector collector 
)
virtual

Report a reference this key has in the given information object.

Reimplemented in vtkInformationInformationVectorKey, vtkInformationDataObjectKey, and vtkInformationObjectBaseKey.

void vtkInformationKey::Print ( vtkInformation info)

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

virtual void vtkInformationKey::Print ( ostream &  os,
vtkInformation info 
)
virtual
void vtkInformationKey::SetAsObjectBase ( vtkInformation info,
vtkObjectBase value 
)
protected
vtkObjectBase* vtkInformationKey::GetAsObjectBase ( vtkInformation info)
protected
void vtkInformationKey::ReportAsObjectBase ( vtkInformation info,
vtkGarbageCollector collector 
)
protected
void vtkInformationKey::ConstructClass ( const char *  )
protected

Member Data Documentation

const char* vtkInformationKey::Name
protected

Definition at line 96 of file vtkInformationKey.h.

const char* vtkInformationKey::Location
protected

Definition at line 97 of file vtkInformationKey.h.


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