VTK
|
a list of ids arranged in priority order More...
#include <vtkPriorityQueue.h>
Classes | |
class | Item |
Public Types | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual int | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkPriorityQueue * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
void | Allocate (const vtkIdType sz, const vtkIdType ext=1000) |
Allocate initial space for priority queue. More... | |
void | Insert (double priority, vtkIdType id) |
Insert id with priority specified. More... | |
vtkIdType | Pop (vtkIdType location, double &priority) |
Removes item at specified location from tree; then reorders and balances tree. More... | |
vtkIdType | Pop (vtkIdType location=0) |
Same as above but simplified for easier wrapping into interpreted languages. More... | |
vtkIdType | Peek (vtkIdType location, double &priority) |
Peek into the queue without actually removing anything. More... | |
vtkIdType | Peek (vtkIdType location=0) |
Peek into the queue without actually removing anything. More... | |
double | DeleteId (vtkIdType id) |
Delete entry in queue with specified id. More... | |
double | GetPriority (vtkIdType id) |
Get the priority of an entry in the queue with specified id. More... | |
vtkIdType | GetNumberOfItems () |
Return the number of items in this queue. More... | |
void | Reset () |
Empty the queue but without releasing memory. 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 | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
int | HasObserver (unsigned long event) |
int | 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... | |
int | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
int | 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 vtkPriorityQueue * | New () |
Instantiate priority queue with default size and extension size of 1000. More... | |
static int | IsTypeOf (const char *type) |
static vtkPriorityQueue * | 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... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkPriorityQueue () | |
~vtkPriorityQueue () override | |
Item * | Resize (const vtkIdType sz) |
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=NULL) |
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 | |
vtkIdTypeArray * | ItemLocation |
Item * | Array |
vtkIdType | Size |
vtkIdType | MaxId |
vtkIdType | Extend |
Protected Attributes inherited from vtkObject | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
Protected Attributes inherited from vtkObjectBase | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
a list of ids arranged in priority order
vtkPriorityQueue is a general object for creating and manipulating lists of object ids (e.g., point or cell ids). Object ids are sorted according to a user-specified priority, where entries at the top of the queue have the smallest values.
This implementation provides a feature beyond the usual ability to insert and retrieve (or pop) values from the queue. It is also possible to pop any item in the queue given its id number. This allows you to delete entries in the queue which can useful for reinserting an item into the queue.
Definition at line 46 of file vtkPriorityQueue.h.
Definition at line 62 of file vtkPriorityQueue.h.
|
protected |
|
overrideprotected |
|
static |
Instantiate priority queue with default size and extension size of 1000.
|
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 |
vtkPriorityQueue* vtkPriorityQueue::NewInstance | ( | ) | const |
|
overridevirtual |
Allocate initial space for priority queue.
Insert id with priority specified.
The id is generally an index like a point id or cell id.
Removes item at specified location from tree; then reorders and balances tree.
The location == 0 is the root of the tree. If queue is exhausted, then a value < 0 is returned. (Note: the location is not the same as deleting an id; id is mapped to location.)
Same as above but simplified for easier wrapping into interpreted languages.
Peek into the queue without actually removing anything.
Returns the id and the priority.
Definition at line 166 of file vtkPriorityQueue.h.
Peek into the queue without actually removing anything.
Returns the id.
Definition at line 179 of file vtkPriorityQueue.h.
Delete entry in queue with specified id.
Returns priority value associated with that id; or VTK_DOUBLE_MAX if not in queue.
Definition at line 141 of file vtkPriorityQueue.h.
Get the priority of an entry in the queue with specified id.
Returns priority value of that id or VTK_DOUBLE_MAX if not in queue.
Definition at line 154 of file vtkPriorityQueue.h.
|
inline |
Return the number of items in this queue.
Definition at line 117 of file vtkPriorityQueue.h.
void vtkPriorityQueue::Reset | ( | ) |
Empty the queue but without releasing memory.
This avoids the overhead of memory allocation/deletion.
|
protected |
Definition at line 131 of file vtkPriorityQueue.h.
|
protected |
Definition at line 132 of file vtkPriorityQueue.h.
|
protected |
Definition at line 133 of file vtkPriorityQueue.h.
|
protected |
Definition at line 134 of file vtkPriorityQueue.h.
|
protected |
Definition at line 135 of file vtkPriorityQueue.h.