VTK  9.1.20211115
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkIdList Class Reference

list of point or cell ids More...

#include <vtkIdList.h>

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

Public Member Functions

void Initialize ()
 Release memory and restore to unallocated state. More...
 
int Allocate (const vtkIdType sz, const int strategy=0)
 Allocate a capacity for sz ids in the list and set the number of stored ids in the list to 0. More...
 
vtkIdType GetNumberOfIds () const noexcept
 Return the number of id's in the list. More...
 
vtkIdType GetId (const vtkIdType i)
 Return the id at location i. More...
 
vtkIdType FindIdLocation (const vtkIdType id)
 Find the location i of the provided id. More...
 
void SetNumberOfIds (const vtkIdType number)
 Specify the number of ids for this object to hold. More...
 
void SetId (const vtkIdType i, const vtkIdType vtkid)
 Set the id at location i. More...
 
void InsertId (const vtkIdType i, const vtkIdType vtkid)
 Set the id at location i. More...
 
vtkIdType InsertNextId (const vtkIdType vtkid)
 Add the id specified to the end of the list. More...
 
vtkIdType InsertUniqueId (const vtkIdType vtkid)
 If id is not already in list, insert it and return location in list. More...
 
void Sort ()
 Sort the ids in the list in ascending id order. More...
 
void Fill (vtkIdType value)
 Fill the ids with the input value. More...
 
vtkIdTypeGetPointer (const vtkIdType i)
 Get a pointer to a particular data index. More...
 
vtkIdTypeWritePointer (const vtkIdType i, const vtkIdType number)
 Get a pointer to a particular data index. More...
 
void SetArray (vtkIdType *array, vtkIdType size, bool save=true)
 Specify an array of vtkIdType to use as the id list. More...
 
void Reset ()
 Reset to an empty state but retain previously allocated memory. More...
 
void Squeeze ()
 Free any unused memory. More...
 
void DeepCopy (vtkIdList *ids)
 Copy an id list by explicitly copying the internal array. More...
 
void DeleteId (vtkIdType vtkid)
 Delete specified id from list. More...
 
vtkIdType IsId (vtkIdType vtkid)
 Return -1 if id specified is not contained in the list; otherwise return the position in the list. More...
 
void IntersectWith (vtkIdList *otherIds)
 Intersect this list with another vtkIdList. More...
 
vtkIdTypeResize (const vtkIdType sz)
 Adjust the size of the id list while maintaining its content (except when being truncated). More...
 
void IntersectWith (vtkIdList &otherIds)
 Intersect one id list with another. More...
 
vtkIdTypeRelease ()
 This releases the ownership of the internal vtkIdType array and returns the pointer to it. More...
 
vtkIdTypebegin ()
 To support range-based for loops. More...
 
vtkIdTypeend ()
 To support range-based for loops. More...
 
const vtkIdTypebegin () const
 To support range-based for loops. More...
 
const vtkIdTypeend () const
 To support range-based for loops. 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...
 
vtkCommandGetCommand (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 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 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...
 
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...
 

Protected Member Functions

 vtkIdList ()
 
 ~vtkIdList () 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 ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkIdType NumberOfIds
 
vtkIdType Size
 
vtkIdTypeIds
 
bool ManageMemory
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkObject Superclass
 Standard methods for instantiation, type information, and printing. More...
 
static vtkIdListNew ()
 Standard methods for instantiation, type information, and printing. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instantiation, type information, and printing. More...
 
static vtkIdListSafeDownCast (vtkObjectBase *o)
 Standard methods for instantiation, type information, and printing. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for instantiation, type information, and printing. More...
 
vtkIdListNewInstance () const
 Standard methods for instantiation, type information, and printing. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instantiation, type information, and printing. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for instantiation, type information, and printing. More...
 

Additional Inherited Members

- 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 ()
 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 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...
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

list of point or cell ids

vtkIdList is used to represent and pass data id's between objects. vtkIdList may represent any type of integer id, but usually represents point and cell ids.

Online Examples:

Definition at line 139 of file vtkIdList.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instantiation, type information, and printing.

Definition at line 147 of file vtkIdList.h.

Constructor & Destructor Documentation

◆ vtkIdList()

vtkIdList::vtkIdList ( )
protected

◆ ~vtkIdList()

vtkIdList::~vtkIdList ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkIdList* vtkIdList::New ( )
static

Standard methods for instantiation, type information, and printing.

◆ IsTypeOf()

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

Standard methods for instantiation, type information, and printing.

◆ IsA()

virtual vtkTypeBool vtkIdList::IsA ( const char *  type)
virtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

Standard methods for instantiation, type information, and printing.

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkIdList::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for instantiation, type information, and printing.

◆ NewInstance()

vtkIdList* vtkIdList::NewInstance ( ) const

Standard methods for instantiation, type information, and printing.

◆ PrintSelf()

void vtkIdList::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkObjectBase.

◆ Initialize()

void vtkIdList::Initialize ( )

Release memory and restore to unallocated state.

◆ Allocate()

int vtkIdList::Allocate ( const vtkIdType  sz,
const int  strategy = 0 
)

Allocate a capacity for sz ids in the list and set the number of stored ids in the list to 0.

strategy is not used.

◆ GetNumberOfIds()

vtkIdType vtkIdList::GetNumberOfIds ( ) const
inlinenoexcept

Return the number of id's in the list.

Definition at line 166 of file vtkIdList.h.

◆ GetId()

vtkIdType vtkIdList::GetId ( const vtkIdType  i)
inline

Return the id at location i.

Definition at line 171 of file vtkIdList.h.

◆ FindIdLocation()

vtkIdType vtkIdList::FindIdLocation ( const vtkIdType  id)
inline

Find the location i of the provided id.

Definition at line 179 of file vtkIdList.h.

◆ SetNumberOfIds()

void vtkIdList::SetNumberOfIds ( const vtkIdType  number)

Specify the number of ids for this object to hold.

Does an allocation as well as setting the number of ids.

◆ SetId()

void vtkIdList::SetId ( const vtkIdType  i,
const vtkIdType  vtkid 
)
inline

Set the id at location i.

Doesn't do range checking so it's a bit faster than InsertId. Make sure you use SetNumberOfIds() to allocate memory prior to using SetId().

Definition at line 198 of file vtkIdList.h.

◆ InsertId()

void vtkIdList::InsertId ( const vtkIdType  i,
const vtkIdType  vtkid 
)
inline

Set the id at location i.

Does range checking and allocates memory as necessary.

Definition at line 328 of file vtkIdList.h.

◆ InsertNextId()

vtkIdType vtkIdList::InsertNextId ( const vtkIdType  vtkid)
inline

Add the id specified to the end of the list.

Range checking is performed.

Definition at line 342 of file vtkIdList.h.

◆ InsertUniqueId()

vtkIdType vtkIdList::InsertUniqueId ( const vtkIdType  vtkid)

If id is not already in list, insert it and return location in list.

Otherwise return just location in list.

◆ Sort()

void vtkIdList::Sort ( )

Sort the ids in the list in ascending id order.

This method uses vtkSMPTools::Sort() so it can be sped up if built properly.

◆ Fill()

void vtkIdList::Fill ( vtkIdType  value)

Fill the ids with the input value.

This method uses vtkSMPTools::Fill() so it can be sped up if built properly.

◆ GetPointer()

vtkIdType* vtkIdList::GetPointer ( const vtkIdType  i)
inline

Get a pointer to a particular data index.

Definition at line 235 of file vtkIdList.h.

◆ WritePointer()

vtkIdType* vtkIdList::WritePointer ( const vtkIdType  i,
const vtkIdType  number 
)

Get a pointer to a particular data index.

Make sure data is allocated for the number of items requested. Set MaxId according to the number of data values requested.

◆ SetArray()

void vtkIdList::SetArray ( vtkIdType array,
vtkIdType  size,
bool  save = true 
)

Specify an array of vtkIdType to use as the id list.

This replaces the underlying array. This instance of vtkIdList takes ownership of the array, meaning that it deletes it on destruction (using delete[]).

◆ Reset()

void vtkIdList::Reset ( )
inline

Reset to an empty state but retain previously allocated memory.

Definition at line 254 of file vtkIdList.h.

◆ Squeeze()

void vtkIdList::Squeeze ( )
inline

Free any unused memory.

Definition at line 259 of file vtkIdList.h.

◆ DeepCopy()

void vtkIdList::DeepCopy ( vtkIdList ids)

Copy an id list by explicitly copying the internal array.

◆ DeleteId()

void vtkIdList::DeleteId ( vtkIdType  vtkid)

Delete specified id from list.

Will remove all occurrences of id in list.

◆ IsId()

vtkIdType vtkIdList::IsId ( vtkIdType  vtkid)
inline

Return -1 if id specified is not contained in the list; otherwise return the position in the list.

Definition at line 355 of file vtkIdList.h.

◆ IntersectWith() [1/2]

void vtkIdList::IntersectWith ( vtkIdList otherIds)

Intersect this list with another vtkIdList.

Updates current list according to result of intersection operation.

◆ Resize()

vtkIdType* vtkIdList::Resize ( const vtkIdType  sz)

Adjust the size of the id list while maintaining its content (except when being truncated).

◆ IntersectWith() [2/2]

void vtkIdList::IntersectWith ( vtkIdList otherIds)
inline

Intersect one id list with another.

This method should become legacy.

Definition at line 292 of file vtkIdList.h.

◆ Release()

vtkIdType* vtkIdList::Release ( )

This releases the ownership of the internal vtkIdType array and returns the pointer to it.

The caller is responsible of calling delete [] on the returned value. This vtkIdList will be set to initialized state after this call.

◆ begin() [1/2]

vtkIdType* vtkIdList::begin ( )
inline

To support range-based for loops.

Definition at line 308 of file vtkIdList.h.

◆ end() [1/2]

vtkIdType* vtkIdList::end ( )
inline

To support range-based for loops.

Definition at line 309 of file vtkIdList.h.

◆ begin() [2/2]

const vtkIdType* vtkIdList::begin ( ) const
inline

To support range-based for loops.

Definition at line 310 of file vtkIdList.h.

◆ end() [2/2]

const vtkIdType* vtkIdList::end ( ) const
inline

To support range-based for loops.

Definition at line 311 of file vtkIdList.h.

Member Data Documentation

◆ NumberOfIds

vtkIdType vtkIdList::NumberOfIds
protected

Definition at line 317 of file vtkIdList.h.

◆ Size

vtkIdType vtkIdList::Size
protected

Definition at line 318 of file vtkIdList.h.

◆ Ids

vtkIdType* vtkIdList::Ids
protected

Definition at line 319 of file vtkIdList.h.

◆ ManageMemory

bool vtkIdList::ManageMemory
protected

Definition at line 320 of file vtkIdList.h.


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