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

Key for unsigned long values in vtkInformation. More...

#include <vtkInformationUnsignedLongKey.h>

Inheritance diagram for vtkInformationUnsignedLongKey:
[legend]
Collaboration diagram for vtkInformationUnsignedLongKey:
[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)
 
 vtkInformationUnsignedLongKey (const char *name, const char *location)
 
 ~vtkInformationUnsignedLongKey ()
 
virtual void ShallowCopy (vtkInformation *from, vtkInformation *to)
 
virtual void Print (ostream &os, vtkInformation *info)
 
void Set (vtkInformation *info, unsigned long)
 
unsigned long 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
vtkInformationUnsignedLongKey
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 Member Functions

unsigned long * GetWatchAddress (vtkInformation *info)
 
- 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 &)
 

Additional Inherited Members

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

Detailed Description

Key for unsigned long values in vtkInformation.

vtkInformationUnsignedLongKey is used to represent keys for unsigned long values in vtkInformation.

Definition at line 29 of file vtkInformationUnsignedLongKey.h.

Member Typedef Documentation

Definition at line 32 of file vtkInformationUnsignedLongKey.h.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual const char* vtkInformationUnsignedLongKey::GetClassName ( )
virtual

Reimplemented from vtkInformationKey.

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

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

unsigned long vtkInformationUnsignedLongKey::Get ( vtkInformation info)

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

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

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

Reimplemented from vtkInformationKey.

unsigned long* vtkInformationUnsignedLongKey::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: