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

Key for variant vector values. More...

#include <vtkInformationVariantVectorKey.h>

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

Public Types

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

Public Member Functions

virtual int IsA (const char *type)
 
vtkInformationVariantVectorKeyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
 vtkInformationVariantVectorKey (const char *name, const char *location, int length=-1)
 
 ~vtkInformationVariantVectorKey ()
 
virtual void ShallowCopy (vtkInformation *from, vtkInformation *to)
 
virtual void Print (ostream &os, vtkInformation *info)
 
void Append (vtkInformation *info, const vtkVariant &value)
 
void Set (vtkInformation *info, const vtkVariant *value, int length)
 
const vtkVariantGet (vtkInformation *info) const
 
const vtkVariantGet (vtkInformation *info, int idx) const
 
void Get (vtkInformation *info, vtkVariant *value) const
 
int Length (vtkInformation *info) const
 
- 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)
 
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 vtkInformationVariantVectorKeySafeDownCast (vtkObjectBase *o)
 
static vtkInformationVariantVectorKeyMakeKey (const char *name, const char *location, int length=-1)
 
- 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 &)
 

Protected Attributes

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

Detailed Description

Key for variant vector values.

vtkInformationVariantVectorKey is used to represent keys for variant vector values in vtkInformation.h

Tests:
vtkInformationVariantVectorKey (Tests)

Definition at line 35 of file vtkInformationVariantVectorKey.h.

Member Typedef Documentation

Definition at line 38 of file vtkInformationVariantVectorKey.h.

Constructor & Destructor Documentation

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

Member Function Documentation

static int vtkInformationVariantVectorKey::IsTypeOf ( const char *  type)
static
virtual int vtkInformationVariantVectorKey::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 vtkInformationVariantVectorKey* vtkInformationVariantVectorKey::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkInformationVariantVectorKey::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkInformationKey.

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

static vtkInformationVariantVectorKey* vtkInformationVariantVectorKey::MakeKey ( const char *  name,
const char *  location,
int  length = -1 
)
inlinestatic

This method simply returns a new vtkInformationVariantVectorKey, 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 49 of file vtkInformationVariantVectorKey.h.

void vtkInformationVariantVectorKey::Append ( vtkInformation info,
const vtkVariant value 
)

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

void vtkInformationVariantVectorKey::Set ( vtkInformation info,
const vtkVariant value,
int  length 
)

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

const vtkVariant* vtkInformationVariantVectorKey::Get ( vtkInformation info) const

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

const vtkVariant& vtkInformationVariantVectorKey::Get ( vtkInformation info,
int  idx 
) const

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

void vtkInformationVariantVectorKey::Get ( vtkInformation info,
vtkVariant value 
) const

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

int vtkInformationVariantVectorKey::Length ( vtkInformation info) const

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

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

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

Reimplemented from vtkInformationKey.

Member Data Documentation

int vtkInformationVariantVectorKey::RequiredLength
protected

Definition at line 77 of file vtkInformationVariantVectorKey.h.


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