VTK
Public Types | Public Member Functions | Static Public Member Functions | List of all members
vtkInformationStringKey Class Reference

Key for string values in vtkInformation. More...

#include <vtkInformationStringKey.h>

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

Public Types

typedef vtkInformationKey Superclass
 
- Public Types inherited from vtkInformationKey
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
 vtkInformationStringKey (const char *name, const char *location)
 
 ~vtkInformationStringKey ()
 
virtual void ShallowCopy (vtkInformation *from, vtkInformation *to)
 
virtual void Print (ostream &os, vtkInformation *info)
 
void Set (vtkInformation *info, const char *)
 
const char * Get (vtkInformation *info)
 
- Public Member Functions inherited from vtkInformationKey
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)
 
- 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 vtkInformationStringKeySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkInformationKey
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 ()
 

Additional Inherited Members

- Protected Member Functions inherited from vtkInformationKey
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 inherited from vtkInformationKey
const char * Name
 
const char * Location
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Key for string values in vtkInformation.

vtkInformationStringKey is used to represent keys for string values in vtkInformation.

Definition at line 29 of file vtkInformationStringKey.h.

Member Typedef Documentation

Definition at line 32 of file vtkInformationStringKey.h.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual const char* vtkInformationStringKey::GetClassName ( )
virtual

Reimplemented from vtkInformationKey.

static int vtkInformationStringKey::IsTypeOf ( const char *  type)
static
virtual int 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 vtkInformationKey.

static vtkInformationStringKey* vtkInformationStringKey::SafeDownCast ( vtkObject o)
static
void vtkInformationStringKey::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.

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

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

const char* vtkInformationStringKey::Get ( vtkInformation info)

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

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

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: