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

Key for vtkDataObject values. More...

#include <vtkInformationDataObjectKey.h>

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

Public Types

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

Public Member Functions

virtual int IsA (const char *type)
 
vtkInformationDataObjectKeyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
 vtkInformationDataObjectKey (const char *name, const char *location)
 
 ~vtkInformationDataObjectKey ()
 
virtual void ShallowCopy (vtkInformation *from, vtkInformation *to)
 
virtual void Report (vtkInformation *info, vtkGarbageCollector *collector)
 
void Set (vtkInformation *info, vtkDataObject *)
 
vtkDataObjectGet (vtkInformation *info)
 
- Public Member Functions inherited from vtkInformationKey
vtkInformationKeyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
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)
 
virtual bool NeedToExecute (vtkInformation *vtkNotUsed(pipelineInfo), vtkInformation *vtkNotUsed(dobjInfo))
 
virtual void StoreMetaData (vtkInformation *vtkNotUsed(request), vtkInformation *vtkNotUsed(pipelineInfo), vtkInformation *vtkNotUsed(dobjInfo))
 
virtual void CopyDefaultInformation (vtkInformation *vtkNotUsed(request), vtkInformation *vtkNotUsed(fromInfo), vtkInformation *vtkNotUsed(toInfo))
 
- 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 &)
 
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 vtkInformationDataObjectKeySafeDownCast (vtkObjectBase *o)
 
static vtkInformationDataObjectKeyMakeKey (const char *name, const char *location)
 
- Static Public Member Functions inherited from vtkInformationKey
static int IsTypeOf (const char *type)
 
static vtkInformationKeySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
- Protected Member Functions inherited from vtkInformationKey
 vtkInformationKeySetStringMacro (Name)
 
 vtkInformationKeySetStringMacro (Location)
 
void SetAsObjectBase (vtkInformation *info, vtkObjectBase *value)
 
const vtkObjectBaseGetAsObjectBase (vtkInformation *info) const
 
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 &)
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkInformationKey
char * Name
 
char * Location
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Key for vtkDataObject values.

vtkInformationDataObjectKey is used to represent keys in vtkInformation for values that are vtkDataObject instances.

Definition at line 32 of file vtkInformationDataObjectKey.h.

Member Typedef Documentation

Definition at line 35 of file vtkInformationDataObjectKey.h.

Constructor & Destructor Documentation

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

Member Function Documentation

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

Reimplemented in vtkInformationDataObjectMetaDataKey.

static vtkInformationDataObjectKey* vtkInformationDataObjectKey::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkInformationDataObjectKey::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkInformationKey.

Reimplemented in vtkInformationDataObjectMetaDataKey.

vtkInformationDataObjectKey* vtkInformationDataObjectKey::NewInstance ( ) const
void vtkInformationDataObjectKey::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 vtkInformationDataObjectMetaDataKey.

static vtkInformationDataObjectKey* vtkInformationDataObjectKey::MakeKey ( const char *  name,
const char *  location 
)
inlinestatic

This method simply returns a new vtkInformationDataObjectKey, 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 vtkInformationDataObjectKey.h.

void vtkInformationDataObjectKey::Set ( vtkInformation info,
vtkDataObject  
)

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

vtkDataObject* vtkInformationDataObjectKey::Get ( vtkInformation info)

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

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

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

Reimplemented from vtkInformationKey.


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