VTK
|
Store zero or more vtkInformation instances. More...
#include <vtkInformationVector.h>
Public Types | |
typedef vtkObject | 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... | |
vtkInformationVector * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
int | GetNumberOfInformationObjects () |
Get/Set the number of information objects in the vector. More... | |
void | SetNumberOfInformationObjects (int n) |
void | SetInformationObject (int index, vtkInformation *info) |
Get/Set the vtkInformation instance stored at the given index in the vector. More... | |
vtkInformation * | GetInformationObject (int index) |
void | Append (vtkInformation *info) |
Append/Remove an information object. More... | |
void | Remove (vtkInformation *info) |
void | Remove (int idx) |
void | Register (vtkObjectBase *o) override |
Initiate garbage collection when a reference is removed. More... | |
void | UnRegister (vtkObjectBase *o) override |
Decrease the reference count (release by another object). More... | |
void | Copy (vtkInformationVector *from, int deep=0) |
Copy all information entries from the given vtkInformation instance. More... | |
![]() | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. More... | |
virtual void | DebugOff () |
Turn debugging output off. More... | |
bool | GetDebug () |
Get the value of the debug flag. More... | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. More... | |
virtual void | Modified () |
Update the modification time for this object. More... | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. More... | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
vtkCommand * | GetCommand (unsigned long tag) |
void | RemoveObserver (vtkCommand *) |
void | RemoveObservers (unsigned long event, vtkCommand *) |
void | RemoveObservers (const char *event, vtkCommand *) |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
vtkTypeBool | HasObserver (unsigned long event) |
vtkTypeBool | HasObserver (const char *event) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Allow user to set the AbortFlagOn() with the return value of the callback method. More... | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. More... | |
int | InvokeEvent (const char *event, void *callData) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
![]() | |
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 vtkInformationVector * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkInformationVector * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. More... | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOn () |
static void | GlobalWarningDisplayOff () |
static int | GetGlobalWarningDisplay () |
![]() | |
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 |
vtkInformationVector () | |
~vtkInformationVector () override | |
void | ReportReferences (vtkGarbageCollector *) override |
![]() | |
vtkObject () | |
~vtkObject () override | |
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
These methods allow a command to exclusively grab all events. More... | |
void | InternalReleaseFocus () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkInformationVectorInternals * | Internal |
int | NumberOfInformationObjects |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Store zero or more vtkInformation instances.
vtkInformationVector stores a vector of zero or more vtkInformation objects corresponding to the input or output information for a vtkAlgorithm. An instance of this class is passed to vtkAlgorithm::ProcessRequest calls.
Definition at line 41 of file vtkInformationVector.h.
Definition at line 45 of file vtkInformationVector.h.
|
protected |
|
overrideprotected |
|
static |
|
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 |
vtkInformationVector* vtkInformationVector::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 vtkObjectBase.
|
inline |
Get/Set the number of information objects in the vector.
Setting the number to larger than the current number will create empty vtkInformation instances. Setting the number to smaller than the current number will remove entries from higher indices.
Definition at line 55 of file vtkInformationVector.h.
void vtkInformationVector::SetNumberOfInformationObjects | ( | int | n | ) |
void vtkInformationVector::SetInformationObject | ( | int | index, |
vtkInformation * | info | ||
) |
Get/Set the vtkInformation instance stored at the given index in the vector.
The vector will automatically expand to include the index given if necessary. Missing entries in-between will be filled with empty vtkInformation instances.
vtkInformation* vtkInformationVector::GetInformationObject | ( | int | index | ) |
void vtkInformationVector::Append | ( | vtkInformation * | info | ) |
Append/Remove an information object.
void vtkInformationVector::Remove | ( | vtkInformation * | info | ) |
void vtkInformationVector::Remove | ( | int | idx | ) |
|
overridevirtual |
Initiate garbage collection when a reference is removed.
Reimplemented from vtkObjectBase.
|
overridevirtual |
Decrease the reference count (release by another object).
This has the same effect as invoking Delete() (i.e., it reduces the reference count by 1).
Reimplemented from vtkObjectBase.
void vtkInformationVector::Copy | ( | vtkInformationVector * | from, |
int | deep = 0 |
||
) |
Copy all information entries from the given vtkInformation instance.
Any previously existing entries are removed. If deep==1, a deep copy of the information structure is performed (new instances of any contained vtkInformation and vtkInformationVector objects are created).
|
overrideprotectedvirtual |
Reimplemented from vtkObjectBase.
|
protected |
Definition at line 101 of file vtkInformationVector.h.
|
protected |
Definition at line 103 of file vtkInformationVector.h.