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

key used to define meta-data of type vtkDataObject vtkInformationDataObjectMetaDataKey is a vtkInformationDataObjectKey that (shallow) copies itself downstream during the REQUEST_INFORMATION pass. Hence it can be used to provide meta-data of type vtkDataObject or any subclass. More...

#include <vtkInformationDataObjectMetaDataKey.h>

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

Public Types

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

Public Member Functions

virtual int IsA (const char *type)
 
vtkInformationDataObjectMetaDataKeyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
 vtkInformationDataObjectMetaDataKey (const char *name, const char *location)
 
 ~vtkInformationDataObjectMetaDataKey ()
 
virtual void CopyDefaultInformation (vtkInformation *request, vtkInformation *fromInfo, vtkInformation *toInfo)
 
- Public Member Functions inherited from vtkInformationDataObjectKey
vtkInformationDataObjectKeyNewInstance () const
 
 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
 
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 vtkInformationDataObjectMetaDataKeySafeDownCast (vtkObjectBase *o)
 
static vtkInformationDataObjectMetaDataKeyMakeKey (const char *name, const char *location)
 
- Static Public Member Functions inherited from vtkInformationDataObjectKey
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 used to define meta-data of type vtkDataObject vtkInformationDataObjectMetaDataKey is a vtkInformationDataObjectKey that (shallow) copies itself downstream during the REQUEST_INFORMATION pass. Hence it can be used to provide meta-data of type vtkDataObject or any subclass.

Tests:
vtkInformationDataObjectMetaDataKey (Tests)

Definition at line 33 of file vtkInformationDataObjectMetaDataKey.h.

Member Typedef Documentation

Definition at line 36 of file vtkInformationDataObjectMetaDataKey.h.

Constructor & Destructor Documentation

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

Member Function Documentation

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

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

Reimplemented from vtkInformationDataObjectKey.

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

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

This method simply returns a new vtkInformationDataObjectMetaDataKey, given a name and a location. This method is provided for wrappers. Use the constructor directly from C++ instead.

Definition at line 46 of file vtkInformationDataObjectMetaDataKey.h.

virtual void vtkInformationDataObjectMetaDataKey::CopyDefaultInformation ( vtkInformation request,
vtkInformation fromInfo,
vtkInformation toInfo 
)
virtual

Simply shallow copies the key from fromInfo to toInfo if request has the REQUEST_INFORMATION() key. This is used by the pipeline to propagate this key downstream.


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