Implementation template for a array iterator. More...
#include <vtkArrayIteratorTemplate.h>
Inheritance diagram for vtkArrayIteratorTemplate< T >:
Collaboration diagram for vtkArrayIteratorTemplate< T >:
Public Types | |
| typedef T | ValueType |
| This is the data type for the value. More... | |
 Public Types inherited from vtkArrayIterator | |
| typedef vtkObject | Superclass |
Public Member Functions | |
| vtkTemplateTypeMacro (vtkArrayIteratorTemplate< T >, vtkArrayIterator) void PrintSelf(ostream &os | |
| void | Initialize (vtkAbstractArray *array) override |
| Set the array this iterator will iterate over. More... | |
| vtkAbstractArray * | GetArray () |
| Get the array. More... | |
| T * | GetTuple (vtkIdType id) |
| Must be called only after Initialize. More... | |
| T & | GetValue (vtkIdType id) |
| Must be called only after Initialize. More... | |
| void | SetValue (vtkIdType id, T value) |
| Sets the value at the index. More... | |
| vtkIdType | GetNumberOfTuples () |
| Must be called only after Initialize. More... | |
| vtkIdType | GetNumberOfValues () |
| Must be called only after Initialize. More... | |
| int | GetNumberOfComponents () |
| Must be called only after Initialize. More... | |
| int | GetDataType () override |
| Get the data type from the underlying array. More... | |
| int | GetDataTypeSize () |
| Get the data type size from the underlying array. More... | |
| Public Member Functions inherited from vtkArrayIterator | |
| virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
| vtkArrayIterator * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
| Public Member Functions inherited from vtkObject | |
| 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... | |
| 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) |
| int | InvokeEvent (unsigned long event) |
| int | InvokeEvent (const char *event) |
| 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) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkCommand * | GetCommand (unsigned long tag) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObserver (vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| 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) |
| 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, 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) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| Public Member Functions inherited from vtkObjectBase | |
| 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 | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object). More... | |
| virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object). More... | |
| int | GetReferenceCount () |
| Return the current reference count of this object. More... | |
| void | SetReferenceCount (int) |
| Sets the reference count. More... | |
| void | PrintRevisions (ostream &) |
| Legacy. More... | |
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
| static vtkArrayIteratorTemplate< T > * | New () |
| Static Public Member Functions inherited from vtkArrayIterator | |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkArrayIterator * | SafeDownCast (vtkObjectBase *o) |
| Static Public Member Functions inherited from vtkObject | |
| 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 () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOff () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static int | GetGlobalWarningDisplay () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| 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. More... | |
| static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Public Attributes | |
| vtkIndent indent | override |
Protected Member Functions | |
| vtkArrayIteratorTemplate () | |
| ~vtkArrayIteratorTemplate () override | |
| Protected Member Functions inherited from vtkArrayIterator | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkArrayIterator () | |
| ~vtkArrayIterator () override | |
| Protected Member Functions inherited from vtkObject | |
| 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 () |
| These methods allow a command to exclusively grab all events. More... | |
| Protected Member Functions inherited from vtkObjectBase | |
| vtkObjectBase () | |
| virtual | ~vtkObjectBase () |
| virtual void | CollectRevisions (ostream &) |
| virtual void | ReportReferences (vtkGarbageCollector *) |
| vtkObjectBase (const vtkObjectBase &) | |
| void | operator= (const vtkObjectBase &) |
Protected Attributes | |
| T * | Pointer |
| Protected Attributes inherited from vtkObject | |
| bool | Debug |
| vtkTimeStamp | MTime |
| vtkSubjectHelper * | SubjectHelper |
| Protected Attributes inherited from vtkObjectBase | |
| vtkAtomicInt32 | ReferenceCount |
| vtkWeakPointerBase ** | WeakPointers |
Detailed Description
template<class T>
class vtkArrayIteratorTemplate< T >
Implementation template for a array iterator.
This is implementation template for a array iterator. It only works with arrays that have a contiguous internal storage of values (as in vtkDataArray, vtkStringArray).
Definition at line 40 of file vtkArrayIteratorTemplate.h.
Member Typedef Documentation
template<class T>
| typedef T vtkArrayIteratorTemplate< T >::ValueType |
This is the data type for the value.
Definition at line 111 of file vtkArrayIteratorTemplate.h.
Constructor & Destructor Documentation
template<class T>
|
protected |
template<class T>
|
overrideprotected |
Member Function Documentation
template<class T>
|
static |
template<class T>
| vtkArrayIteratorTemplate< T >::vtkTemplateTypeMacro | ( | vtkArrayIteratorTemplate< T > | , |
| vtkArrayIterator | |||
| ) |
template<class T>
|
overridevirtual |
Set the array this iterator will iterate over.
After Initialize() has been called, the iterator is valid so long as the Array has not been modified (except using the iterator itself). If the array is modified, the iterator must be re-initialized.
Implements vtkArrayIterator.
template<class T>
|
inline |
Get the array.
Definition at line 59 of file vtkArrayIteratorTemplate.h.
template<class T>
| T* vtkArrayIteratorTemplate< T >::GetTuple | ( | vtkIdType | id | ) |
Must be called only after Initialize.
template<class T>
|
inline |
Must be called only after Initialize.
Definition at line 70 of file vtkArrayIteratorTemplate.h.
template<class T>
|
inline |
Sets the value at the index.
This does not verify if the index is valid. The caller must ensure that id is less than the maximum number of values.
Definition at line 78 of file vtkArrayIteratorTemplate.h.
template<class T>
| vtkIdType vtkArrayIteratorTemplate< T >::GetNumberOfTuples | ( | ) |
Must be called only after Initialize.
template<class T>
| vtkIdType vtkArrayIteratorTemplate< T >::GetNumberOfValues | ( | ) |
Must be called only after Initialize.
template<class T>
| int vtkArrayIteratorTemplate< T >::GetNumberOfComponents | ( | ) |
Must be called only after Initialize.
template<class T>
|
overridevirtual |
Get the data type from the underlying array.
Implements vtkArrayIterator.
template<class T>
| int vtkArrayIteratorTemplate< T >::GetDataTypeSize | ( | ) |
Get the data type size from the underlying array.
Member Data Documentation
template<class T>
| vtkIndent indent vtkArrayIteratorTemplate< T >::override |
Definition at line 45 of file vtkArrayIteratorTemplate.h.
template<class T>
|
protected |
Definition at line 117 of file vtkArrayIteratorTemplate.h.
The documentation for this class was generated from the following file:
- /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Common/Core/vtkArrayIteratorTemplate.h
