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

Key for integer values in vtkInformation. More...

#include <vtkInformationIntegerKey.h>

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

Public Types

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

Public Member Functions

virtual int IsA (const char *type)
 
vtkInformationIntegerKeyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
 vtkInformationIntegerKey (const char *name, const char *location)
 
 ~vtkInformationIntegerKey ()
 
virtual void ShallowCopy (vtkInformation *from, vtkInformation *to)
 
virtual void Print (ostream &os, vtkInformation *info)
 
void Set (vtkInformation *info, int)
 
int Get (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)
 
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 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 vtkInformationIntegerKeySafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyMakeKey (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
 
intGetWatchAddress (vtkInformation *info)
 
- 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 integer values in vtkInformation.

vtkInformationIntegerKey is used to represent keys for integer values in vtkInformation.

Tests:
vtkInformationIntegerKey (Tests)

Definition at line 33 of file vtkInformationIntegerKey.h.

Member Typedef Documentation

Definition at line 36 of file vtkInformationIntegerKey.h.

Constructor & Destructor Documentation

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

Member Function Documentation

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

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

Reimplemented from vtkInformationKey.

Reimplemented in vtkInformationIntegerRequestKey.

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

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

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

void vtkInformationIntegerKey::Set ( vtkInformation info,
int   
)

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

int vtkInformationIntegerKey::Get ( vtkInformation info)

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

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

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

Reimplemented from vtkInformationKey.

int* vtkInformationIntegerKey::GetWatchAddress ( vtkInformation info)
protected

Get the address at which the actual value is stored. This is meant for use from a debugger to add watches and is therefore not a public method.


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