VTK
|
Key for vtkObjectBase vector values. More...
#include <vtkInformationObjectBaseVectorKey.h>
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. More... | |
vtkInformationObjectBaseVectorKey * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
vtkInformationObjectBaseVectorKey (const char *name, const char *location, const char *requiredClass=nullptr) | |
The name of the static instance and the class in which it is defined(location) should be passed to the constructor. More... | |
~vtkInformationObjectBaseVectorKey () override | |
void | Clear (vtkInformation *info) |
Clear the vector. More... | |
void | Resize (vtkInformation *info, int n) |
Resize (extend) the vector to hold n objects. More... | |
int | Size (vtkInformation *info) |
Get the vector's length. More... | |
int | Length (vtkInformation *info) |
void | Append (vtkInformation *info, vtkObjectBase *value) |
Put the value on the back of the vector, with ref counting. More... | |
void | Set (vtkInformation *info, vtkObjectBase *value, int i) |
Set element i of the vector to value. More... | |
void | Remove (vtkInformation *info, vtkObjectBase *val) |
Remove all instances of val from the list. More... | |
void | Remove (vtkInformation *info, int idx) |
void | SetRange (vtkInformation *info, vtkObjectBase **source, int from, int to, int n) |
Copy n values from the range in source defined by [from from+n-1] into the range in this vector defined by [to to+n-1]. More... | |
void | GetRange (vtkInformation *info, vtkObjectBase **dest, int from, int to, int n) |
Copy n values from the range in this vector defined by [from from+n-1] into the range in the destination vector defined by [to to+n-1]. More... | |
vtkObjectBase * | Get (vtkInformation *info, int idx) |
Get the vtkObjectBase at a specific location in the vector. More... | |
void | ShallowCopy (vtkInformation *from, vtkInformation *to) override |
Copy the entry associated with this key from one information object to another. More... | |
void | Print (ostream &os, vtkInformation *info) override |
Print the key's value in an information object to a stream. More... | |
virtual void | Remove (vtkInformation *info) |
Remove this key from the given information object. More... | |
![]() | |
vtkBaseTypeMacro (vtkInformationKey, vtkObjectBase) | |
void | Register (vtkObjectBase *) override |
Prevent normal vtkObject reference counting behavior. More... | |
void | UnRegister (vtkObjectBase *) override |
Prevent normal vtkObject reference counting behavior. More... | |
const char * | GetName () |
Get the name of the key. More... | |
const char * | GetLocation () |
Get the location of the key. More... | |
vtkInformationKey (const char *name, const char *location) | |
Key instances are static data that need to be created and destroyed. More... | |
~vtkInformationKey () override | |
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). More... | |
virtual int | Has (vtkInformation *info) |
Check whether this key appears in the given information object. More... | |
virtual void | Remove (vtkInformation *info) |
Remove this key from the given information object. More... | |
virtual void | Report (vtkInformation *info, vtkGarbageCollector *collector) |
Report a reference this key has in the given information object. More... | |
void | Print (vtkInformation *info) |
Print the key's value in an information object to a stream. More... | |
virtual bool | NeedToExecute (vtkInformation *vtkNotUsed(pipelineInfo), vtkInformation *vtkNotUsed(dobjInfo)) |
This function is only relevant when the pertaining key is used in a VTK pipeline. More... | |
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. More... | |
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. More... | |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. More... | |
virtual void | Delete () |
Delete a VTK object. More... | |
virtual void | FastDelete () |
Delete a reference to this object. More... | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. More... | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
int | GetReferenceCount () |
Return the current reference count of this object. More... | |
void | SetReferenceCount (int) |
Sets the reference count. More... | |
void | PrintRevisions (ostream &) |
Legacy. More... | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkInformationObjectBaseVectorKey * | SafeDownCast (vtkObjectBase *o) |
static vtkInformationObjectBaseVectorKey * | MakeKey (const char *name, const char *location, const char *requiredClass=nullptr) |
This method simply returns a new vtkInformationObjectBaseVectorKey, given a name, location and optionally a required class (a classname to restrict which class types can be set with this key). More... | |
![]() | |
static vtkTypeBool | IsTypeOf (const char *name) |
Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
![]() | |
vtkInformationKeySetStringMacro (Name) | |
vtkInformationKeySetStringMacro (Location) | |
void | SetAsObjectBase (vtkInformation *info, vtkObjectBase *value) |
const vtkObjectBase * | GetAsObjectBase (vtkInformation *info) const |
vtkObjectBase * | GetAsObjectBase (vtkInformation *info) |
void | ReportAsObjectBase (vtkInformation *info, vtkGarbageCollector *collector) |
void | ConstructClass (const char *) |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &) |
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 | |
const char * | RequiredClass |
![]() | |
char * | Name |
char * | Location |
![]() | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Key for vtkObjectBase vector values.
vtkInformationObjectBaseVectorKey is used to represent keys for double vector values in vtkInformation.h. NOTE the interface in this key differs from that in other similar keys because of our internal use of smart pointers.
Definition at line 34 of file vtkInformationObjectBaseVectorKey.h.
Definition at line 37 of file vtkInformationObjectBaseVectorKey.h.
vtkInformationObjectBaseVectorKey::vtkInformationObjectBaseVectorKey | ( | const char * | name, |
const char * | location, | ||
const char * | requiredClass = nullptr |
||
) |
The name of the static instance and the class in which it is defined(location) should be passed to the constructor.
Providing "requiredClass" name one can insure that only objects of type "requiredClass" are stored in vectors associated with the instance of this key type created. These should be string literals as they are not copied.
|
override |
|
static |
|
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.
|
static |
|
protectedvirtual |
vtkInformationObjectBaseVectorKey* vtkInformationObjectBaseVectorKey::NewInstance | ( | ) | const |
|
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.
|
inlinestatic |
This method simply returns a new vtkInformationObjectBaseVectorKey, given a name, location and optionally a required class (a classname to restrict which class types can be set with this key).
This method is provided for wrappers. Use the constructor directly from C++ instead.
Definition at line 61 of file vtkInformationObjectBaseVectorKey.h.
void vtkInformationObjectBaseVectorKey::Clear | ( | vtkInformation * | info | ) |
Clear the vector.
void vtkInformationObjectBaseVectorKey::Resize | ( | vtkInformation * | info, |
int | n | ||
) |
Resize (extend) the vector to hold n objects.
Any new elements created will be null initialized.
int vtkInformationObjectBaseVectorKey::Size | ( | vtkInformation * | info | ) |
Get the vector's length.
|
inline |
Definition at line 82 of file vtkInformationObjectBaseVectorKey.h.
void vtkInformationObjectBaseVectorKey::Append | ( | vtkInformation * | info, |
vtkObjectBase * | value | ||
) |
Put the value on the back of the vector, with ref counting.
void vtkInformationObjectBaseVectorKey::Set | ( | vtkInformation * | info, |
vtkObjectBase * | value, | ||
int | i | ||
) |
Set element i of the vector to value.
Resizes the vector if needed.
void vtkInformationObjectBaseVectorKey::Remove | ( | vtkInformation * | info, |
vtkObjectBase * | val | ||
) |
Remove all instances of val from the list.
If using the indexed overload, the object at the specified position is removed.
void vtkInformationObjectBaseVectorKey::Remove | ( | vtkInformation * | info, |
int | idx | ||
) |
void vtkInformationObjectBaseVectorKey::SetRange | ( | vtkInformation * | info, |
vtkObjectBase ** | source, | ||
int | from, | ||
int | to, | ||
int | n | ||
) |
Copy n values from the range in source defined by [from from+n-1] into the range in this vector defined by [to to+n-1].
Resizes the vector if needed.
void vtkInformationObjectBaseVectorKey::GetRange | ( | vtkInformation * | info, |
vtkObjectBase ** | dest, | ||
int | from, | ||
int | to, | ||
int | n | ||
) |
Copy n values from the range in this vector defined by [from from+n-1] into the range in the destination vector defined by [to to+n-1].
Up to you to make sure the destination is big enough.
vtkObjectBase* vtkInformationObjectBaseVectorKey::Get | ( | vtkInformation * | info, |
int | idx | ||
) |
Get the vtkObjectBase at a specific location in the vector.
|
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.
|
overridevirtual |
Print the key's value in an information object to a stream.
Reimplemented from vtkInformationKey.
virtual void vtkInformationKey::Remove |
Remove this key from the given information object.
|
protected |
Definition at line 152 of file vtkInformationObjectBaseVectorKey.h.