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

Iterator for vtkBitArray. This iterator iterates over a vtkBitArray. It uses the double interface to get/set bit values. More...

#include <vtkBitArrayIterator.h>

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

Public Types

typedef vtkArrayIterator Superclass
 
typedef int ValueType
 Data type of a value. More...
 
- Public Types inherited from vtkArrayIterator
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...
 
vtkBitArrayIteratorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Initialize (vtkAbstractArray *array) override
 Set the array this iterator will iterate over. More...
 
vtkAbstractArrayGetArray ()
 Get the array. More...
 
int * GetTuple (vtkIdType id)
 Must be called only after Initialize. More...
 
int GetValue (vtkIdType id)
 Must be called only after Initialize. 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 () const override
 Get the data type from the underlying array. More...
 
int GetDataTypeSize () const
 Get the data type size from the underlying array. More...
 
void SetValue (vtkIdType id, int value)
 Sets the value at the index. More...
 
- Public Member Functions inherited from vtkArrayIterator
vtkArrayIteratorNewInstance () const
 
- 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...
 
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)
 
vtkCommandGetCommand (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)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). 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)
 
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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkBitArrayIteratorNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkBitArrayIteratorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkArrayIterator
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkArrayIteratorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkBitArrayIterator ()
 
 ~vtkBitArrayIterator () override
 
void SetArray (vtkBitArray *b)
 
- Protected Member Functions inherited from vtkArrayIterator
 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int * Tuple
 
int TupleSize
 
vtkBitArrayArray
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- 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

Iterator for vtkBitArray. This iterator iterates over a vtkBitArray. It uses the double interface to get/set bit values.

Definition at line 29 of file vtkBitArrayIterator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 33 of file vtkBitArrayIterator.h.

◆ ValueType

Data type of a value.

Definition at line 94 of file vtkBitArrayIterator.h.

Constructor & Destructor Documentation

◆ vtkBitArrayIterator()

vtkBitArrayIterator::vtkBitArrayIterator ( )
protected

◆ ~vtkBitArrayIterator()

vtkBitArrayIterator::~vtkBitArrayIterator ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkBitArrayIterator* vtkBitArrayIterator::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkBitArrayIterator::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 vtkArrayIterator.

◆ SafeDownCast()

static vtkBitArrayIterator* vtkBitArrayIterator::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkBitArrayIterator::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkArrayIterator.

◆ NewInstance()

vtkBitArrayIterator* vtkBitArrayIterator::NewInstance ( ) const

◆ PrintSelf()

void vtkBitArrayIterator::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 vtkArrayIterator.

◆ Initialize()

void vtkBitArrayIterator::Initialize ( vtkAbstractArray array)
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.

◆ GetArray()

vtkAbstractArray* vtkBitArrayIterator::GetArray ( )

Get the array.

◆ GetTuple()

int* vtkBitArrayIterator::GetTuple ( vtkIdType  id)

Must be called only after Initialize.

◆ GetValue()

int vtkBitArrayIterator::GetValue ( vtkIdType  id)

Must be called only after Initialize.

◆ GetNumberOfTuples()

vtkIdType vtkBitArrayIterator::GetNumberOfTuples ( )

Must be called only after Initialize.

◆ GetNumberOfValues()

vtkIdType vtkBitArrayIterator::GetNumberOfValues ( )

Must be called only after Initialize.

◆ GetNumberOfComponents()

int vtkBitArrayIterator::GetNumberOfComponents ( )

Must be called only after Initialize.

◆ GetDataType()

int vtkBitArrayIterator::GetDataType ( ) const
overridevirtual

Get the data type from the underlying array.

Implements vtkArrayIterator.

◆ GetDataTypeSize()

int vtkBitArrayIterator::GetDataTypeSize ( ) const

Get the data type size from the underlying array.

◆ SetValue()

void vtkBitArrayIterator::SetValue ( vtkIdType  id,
int  value 
)

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.

◆ SetArray()

void vtkBitArrayIterator::SetArray ( vtkBitArray b)
protected

Member Data Documentation

◆ Tuple

int* vtkBitArrayIterator::Tuple
protected

Definition at line 100 of file vtkBitArrayIterator.h.

◆ TupleSize

int vtkBitArrayIterator::TupleSize
protected

Definition at line 101 of file vtkBitArrayIterator.h.

◆ Array

vtkBitArray* vtkBitArrayIterator::Array
protected

Definition at line 103 of file vtkBitArrayIterator.h.


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