Itasca C++ Interface
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
itascaxd::IRangeElementUIntPtrList Class Referenceabstract

Interface to to a Range Element that matches an integer to a list of stored integers. More...

#include <irangeelementutil.h>

Public Member Functions

virtual qint64 getNumberOfEntries (bool onOnly=false) const =0
 Returns the total number of entries. If onOnly is true it will return the number of entries whose state is true.
 
virtual QVector< uint64 > getAllEntries (bool onOnly=false) const =0
 Returns a list of all entries. If onOnly is true will return a list of all entries whose state is true.
 
virtual bool getEntryState (const uint64 &entry) const =0
 Returns the state of the entry, or false if the entry does not exist.
 
virtual bool addEntry (const uint64 &entry, bool state=true)=0
 
virtual void setEntryState (const uint64 &entry, bool state)=0
 Sets the state of entry. Ignored if entry has not already been added.
 

Public Attributes

shared::Signal< uint64, bool, uint64 > entryAdded
 
shared::Signal< uint64, bool, uint64 > entryStateChanged
 
shared::Signal allChanged
 

Static Public Attributes

static const TType type_ = 0x4c815ba2
 The type identification number for this class, for use in convert_cast() and convert_getcast().
 

Detailed Description

Interface to to a Range Element that matches an integer to a list of stored integers.

This interface is similar to IFilterElementInt.
Entries with a false state aren't used by the kernel in any way.
They exist to make user interface issues easier (a list of regions with some unselected, for instance).

Member Function Documentation

◆ addEntry()

virtual bool itascaxd::IRangeElementUIntPtrList::addEntry ( const uint64 & entry,
bool state = true )
pure virtual

Adds an entry to the list.
If the entry is already in the list, then the state value is ignored . Use setEntryState() to force a particular entry to a particular state.
If the entry is added to the list, then the state value is used for the new entry.
Returns true if the entry was added, false if the entry alread existed.


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