VTK  9.4.20241203
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 Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkInformationUnsignedLongKeyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
 vtkInformationUnsignedLongKey (const char *name, const char *location)
 
 ~vtkInformationUnsignedLongKey () override
 
void ShallowCopy (vtkInformation *from, vtkInformation *to) override
 Copy the entry associated with this key from one information object to another.
 
void Print (ostream &os, vtkInformation *info) override
 Print the key's value in an information object to a stream.
 
void Set (vtkInformation *info, unsigned long)
 Get/Set the value associated with this key in the given information object.
 
unsigned long Get (vtkInformation *info)
 Get/Set the value associated with this key in the given information object.
 
- Public Member Functions inherited from vtkInformationKey
 vtkBaseTypeMacro (vtkInformationKey, vtkObjectBase)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
const char * GetName ()
 Get the name of the key.
 
const char * GetLocation ()
 Get the location of the key.
 
virtual void ShallowCopy (vtkInformation *from, vtkInformation *to)=0
 Copy the entry associated with this key from one information object to another.
 
virtual void DeepCopy (vtkInformation *from, vtkInformation *to)
 Duplicate (new instance created) the entry associated with this key from one information object to another (new instances of any contained vtkInformation and vtkInformationVector objects are created).
 
virtual int Has (vtkInformation *info)
 Check whether this key appears in the given information object.
 
virtual void Remove (vtkInformation *info)
 Remove this key from the given information object.
 
virtual void Report (vtkInformation *info, vtkGarbageCollector *collector)
 Report a reference this key has in the given information object.
 
virtual bool NeedToExecute (vtkInformation *vtkNotUsed(pipelineInfo), vtkInformation *vtkNotUsed(dobjInfo))
 This function is only relevant when the pertaining key is used in a VTK pipeline.
 
virtual void StoreMetaData (vtkInformation *vtkNotUsed(request), vtkInformation *vtkNotUsed(pipelineInfo), vtkInformation *vtkNotUsed(dobjInfo))
 This function is only relevant when the pertaining key is used in a VTK pipeline.
 
virtual void CopyDefaultInformation (vtkInformation *vtkNotUsed(request), vtkInformation *vtkNotUsed(fromInfo), vtkInformation *vtkNotUsed(toInfo))
 This function is only relevant when the pertaining key is used in a VTK pipeline.
 
 vtkInformationKey (const char *name, const char *location)
 Key instances are static data that need to be created and destroyed.
 
void Print (vtkInformation *info)
 Print the key's value in an information object to a stream.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkInformationUnsignedLongKeySafeDownCast (vtkObjectBase *o)
 
static vtkInformationUnsignedLongKeyMakeKey (const char *name, const char *location)
 This method simply returns a new vtkInformationUnsignedLongKey, given a name and a location.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
unsigned long * GetWatchAddress (vtkInformation *info)
 Get the address at which the actual value is stored.
 
- 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 RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Protected Attributes inherited from vtkInformationKey
char * Name
 
char * Location
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Key for unsigned long values in vtkInformation.

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

Tests:
vtkInformationUnsignedLongKey (Tests)

Definition at line 23 of file vtkInformationUnsignedLongKey.h.

Member Typedef Documentation

◆ Superclass

Definition at line 26 of file vtkInformationUnsignedLongKey.h.

Constructor & Destructor Documentation

◆ vtkInformationUnsignedLongKey()

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

◆ ~vtkInformationUnsignedLongKey()

vtkInformationUnsignedLongKey::~vtkInformationUnsignedLongKey ( )
override

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkInformationUnsignedLongKey::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

◆ SafeDownCast()

static vtkInformationUnsignedLongKey * vtkInformationUnsignedLongKey::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkInformationUnsignedLongKey::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkInformationUnsignedLongKey * vtkInformationUnsignedLongKey::NewInstance ( ) const

◆ PrintSelf()

void vtkInformationUnsignedLongKey::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ MakeKey()

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

This method simply returns a new vtkInformationUnsignedLongKey, given a name and a location.

This method is provided for wrappers. Use the constructor directly from C++ instead.

Definition at line 37 of file vtkInformationUnsignedLongKey.h.

◆ Set()

void vtkInformationUnsignedLongKey::Set ( vtkInformation info,
unsigned long   
)

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

◆ Get()

unsigned long vtkInformationUnsignedLongKey::Get ( vtkInformation info)

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

◆ ShallowCopy()

void vtkInformationUnsignedLongKey::ShallowCopy ( vtkInformation from,
vtkInformation to 
)
overridevirtual

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.

◆ Print()

void vtkInformationUnsignedLongKey::Print ( ostream &  os,
vtkInformation info 
)
overridevirtual

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

Reimplemented from vtkInformationKey.

◆ GetWatchAddress()

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: