VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
vtkInformationObjectBaseKey Class Reference

Key for vtkObjectBase values. More...

#include <vtkInformationObjectBaseKey.h>

Inheritance diagram for vtkInformationObjectBaseKey:
[legend]
Collaboration diagram for vtkInformationObjectBaseKey:
[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)
 
 vtkInformationObjectBaseKey (const char *name, const char *location, const char *requiredClass=0)
 
 ~vtkInformationObjectBaseKey ()
 
virtual void ShallowCopy (vtkInformation *from, vtkInformation *to)
 
virtual void Report (vtkInformation *info, vtkGarbageCollector *collector)
 
void Set (vtkInformation *info, vtkObjectBase *)
 
vtkObjectBaseGet (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)
 
 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
vtkInformationObjectBaseKey
SafeDownCast (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 ()
 

Protected Attributes

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

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

Detailed Description

Key for vtkObjectBase values.

vtkInformationObjectBaseKey is used to represent keys in vtkInformation for values that are vtkObjectBase instances.

Definition at line 31 of file vtkInformationObjectBaseKey.h.

Member Typedef Documentation

Definition at line 34 of file vtkInformationObjectBaseKey.h.

Constructor & Destructor Documentation

vtkInformationObjectBaseKey::vtkInformationObjectBaseKey ( const char *  name,
const char *  location,
const char *  requiredClass = 0 
)
vtkInformationObjectBaseKey::~vtkInformationObjectBaseKey ( )

Member Function Documentation

virtual const char* vtkInformationObjectBaseKey::GetClassName ( )
virtual

Reimplemented from vtkInformationKey.

static int vtkInformationObjectBaseKey::IsTypeOf ( const char *  type)
static
virtual int vtkInformationObjectBaseKey::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 vtkInformationObjectBaseKey* vtkInformationObjectBaseKey::SafeDownCast ( vtkObject o)
static
void vtkInformationObjectBaseKey::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 vtkInformationObjectBaseKey::Set ( vtkInformation info,
vtkObjectBase  
)

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

vtkObjectBase* vtkInformationObjectBaseKey::Get ( vtkInformation info)

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

virtual void vtkInformationObjectBaseKey::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 vtkInformationObjectBaseKey::Report ( vtkInformation info,
vtkGarbageCollector collector 
)
virtual

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

Reimplemented from vtkInformationKey.

Member Data Documentation

const char* vtkInformationObjectBaseKey::RequiredClass
protected

Definition at line 58 of file vtkInformationObjectBaseKey.h.


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