Interface to to a Range Element that matches string to a list of stored strings. More...

#include <irangeelementutil.h>

Public Member Functions
virtual int64	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 StringList	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 string &entry) const =0
	Returns the state of the entry, or false if the entry does not exist.

virtual bool	addEntry (const string &entry, bool state=true)=0
	Adds an entry to the list. .

virtual void	setEntryState (const string &entry, bool state)=0
	Sets the state of entry. Ignored if entry has not already been added.

virtual bool	removeEntryIfOff (const string &entry)=0
	Removes entry from list if it is present and off. Returns TRUE if it does so, false if not.

virtual void	removeAllOffEntries ()=0
	Removes all OFF entries from the list.

virtual bool	removeEntry (const string &entry)=0
	Remove entry regardless.

Public Attributes
shared::Signal< const string &, bool, uint64 >	entryAdded

shared::Signal< const string &, uint64 >	entryRemoved

shared::Signal< const string &, bool, uint64 >	entryStateChanged

shared::Signal	allChanged

Static Public Attributes
static const TType	type_ = 0x04c815ba5
	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 string to a list of stored strings.

This interface is similar to IRangeElementUIntPtrList.
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).

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

C:/Source/itasca-suite/common/module/interface/irangeelementutil.h

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description