VTK  9.1.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkInformationStringVectorKey Class Reference

Key for String vector values. More...

#include <vtkInformationStringVectorKey.h>

Inheritance diagram for vtkInformationStringVectorKey:
[legend]
Collaboration diagram for vtkInformationStringVectorKey:
[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.
 
vtkInformationStringVectorKeyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
 vtkInformationStringVectorKey (const char *name, const char *location, int length=-1)
 
 ~vtkInformationStringVectorKey () 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 Append (vtkInformation *info, const char *value)
 Get/Set the value associated with this key in the given information object.
 
void Set (vtkInformation *info, const char *value, int index=0)
 Get/Set the value associated with this key in the given information object.
 
void Append (vtkInformation *info, const std::string &value)
 Get/Set the value associated with this key in the given information object.
 
void Set (vtkInformation *info, const std::string &value, int idx=0)
 Get/Set the value associated with this key in the given information object.
 
const char * Get (vtkInformation *info, int idx=0)
 Get/Set the value associated with this key in the given information object.
 
int Length (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.
 
void Register (vtkObjectBase *) override
 Prevent normal vtkObject reference counting behavior.
 
void UnRegister (vtkObjectBase *) override
 Prevent normal vtkObject reference counting behavior.
 
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.
 
 ~vtkInformationKey () override
 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 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.
 
virtual 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.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkInformationStringVectorKeySafeDownCast (vtkObjectBase *o)
 
static vtkInformationStringVectorKeyMakeKey (const char *name, const char *location, int length=-1)
 This method simply returns a new vtkInformationStringVectorKey, given a name, a location and a required length.
 
- 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
 
- 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 *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int RequiredLength
 
- Protected Attributes inherited from vtkInformationKey
char * Name
 
char * Location
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

Key for String vector values.

vtkInformationStringVectorKey is used to represent keys for String vector values in vtkInformation.h

Definition at line 33 of file vtkInformationStringVectorKey.h.

Member Typedef Documentation

◆ Superclass

Definition at line 36 of file vtkInformationStringVectorKey.h.

Constructor & Destructor Documentation

◆ vtkInformationStringVectorKey()

vtkInformationStringVectorKey::vtkInformationStringVectorKey ( const char *  name,
const char *  location,
int  length = -1 
)

◆ ~vtkInformationStringVectorKey()

vtkInformationStringVectorKey::~vtkInformationStringVectorKey ( )
override

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkInformationStringVectorKey::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 vtkInformationStringVectorKey * vtkInformationStringVectorKey::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkInformationStringVectorKey::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkInformationStringVectorKey * vtkInformationStringVectorKey::NewInstance ( ) const

◆ PrintSelf()

void vtkInformationStringVectorKey::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 vtkInformationStringVectorKey * vtkInformationStringVectorKey::MakeKey ( const char *  name,
const char *  location,
int  length = -1 
)
inlinestatic

This method simply returns a new vtkInformationStringVectorKey, given a name, a location and a required length.

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

Definition at line 47 of file vtkInformationStringVectorKey.h.

◆ Append() [1/2]

void vtkInformationStringVectorKey::Append ( vtkInformation info,
const char *  value 
)

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

◆ Set() [1/2]

void vtkInformationStringVectorKey::Set ( vtkInformation info,
const char *  value,
int  index = 0 
)

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

◆ Append() [2/2]

void vtkInformationStringVectorKey::Append ( vtkInformation info,
const std::string &  value 
)

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

◆ Set() [2/2]

void vtkInformationStringVectorKey::Set ( vtkInformation info,
const std::string &  value,
int  idx = 0 
)

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

◆ Get()

const char * vtkInformationStringVectorKey::Get ( vtkInformation info,
int  idx = 0 
)

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

◆ Length()

int vtkInformationStringVectorKey::Length ( vtkInformation info)

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

◆ ShallowCopy()

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

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

Reimplemented from vtkInformationKey.

Member Data Documentation

◆ RequiredLength

int vtkInformationStringVectorKey::RequiredLength
protected

Definition at line 80 of file vtkInformationStringVectorKey.h.


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