VTK  9.0.20200804
Public Types | Public Member Functions | Static 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 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...
 
vtkIdListNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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 ()
 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...
 
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)
 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 ()
 
const vtkIdTypebegin () const
 
const vtkIdTypeend () 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 vtkIdListNew ()
 Standard methods for instantiation, type information, and printing. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkIdListSafeDownCast (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
 
 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 ()
 
- 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
 
- 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

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.

Definition at line 30 of file vtkIdList.h.

Member Typedef Documentation

◆ Superclass

Definition at line 38 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

◆ IsA()

virtual vtkTypeBool vtkIdList::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 vtkObjectBase.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkIdList::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkIdList* vtkIdList::NewInstance ( ) const

◆ PrintSelf()

void vtkIdList::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 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 ( )
inline

Return the number of id's in the list.

Definition at line 57 of file vtkIdList.h.

◆ GetId()

vtkIdType vtkIdList::GetId ( const vtkIdType  i)
inline

Return the id at location i.

Definition at line 62 of file vtkIdList.h.

◆ FindIdLocation()

vtkIdType vtkIdList::FindIdLocation ( const vtkIdType  id)
inline

Find the location i of the provided id.

Definition at line 70 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 89 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 212 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 226 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.

◆ GetPointer()

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

Get a pointer to a particular data index.

Definition at line 120 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 
)

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 139 of file vtkIdList.h.

◆ Squeeze()

void vtkIdList::Squeeze ( )
inline

Free any unused memory.

Definition at line 144 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 239 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 177 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 193 of file vtkIdList.h.

◆ end() [1/2]

vtkIdType* vtkIdList::end ( )
inline

Definition at line 194 of file vtkIdList.h.

◆ begin() [2/2]

const vtkIdType* vtkIdList::begin ( ) const
inline

Definition at line 195 of file vtkIdList.h.

◆ end() [2/2]

const vtkIdType* vtkIdList::end ( ) const
inline

Definition at line 196 of file vtkIdList.h.

Member Data Documentation

◆ NumberOfIds

vtkIdType vtkIdList::NumberOfIds
protected

Definition at line 202 of file vtkIdList.h.

◆ Size

vtkIdType vtkIdList::Size
protected

Definition at line 203 of file vtkIdList.h.

◆ Ids

vtkIdType* vtkIdList::Ids
protected

Definition at line 204 of file vtkIdList.h.


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