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

Interface to the global list of all named filters. More...

#include <irangelist.h>

Public Member Functions

virtual const IRangegetFirst () const =0
 
virtual const IRangefindRangeWithName (const QString &name) const =0
 
virtual IRangefindRangeWithName (const QString &name)=0
 
virtual IRangecreateRange (const IRange *prev)=0
 
virtual void parse (IRange *rng, const IParse &par, const QString &keywords=QString(), IParse::IMark *p=0, bool includeFish=true)=0
 
virtual IContainergetIContainer ()=0
 Returns the IContainer interface const pointer representing the list of filters.
 
virtual const IContainergetIContainer () const =0
 Returns the IContainer interface pointer representing the list of filters.
 
virtual QStringList getAllNames (bool includeFish=true) const =0
 Returns a list of all named filters (not sorted).
 
virtual IRangeadd (const IRange &rng)=0
 

Static Public Attributes

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

Detailed Description

Interface to the global list of all named filters.

Member Function Documentation

◆ add()

virtual IRange * itascaxd::IRangeList::add ( const IRange & rng)
pure virtual

Adds a copy of rng to the named filter list
NOTE: may throw exception if recursion is detected.

◆ createRange()

virtual IRange * itascaxd::IRangeList::createRange ( const IRange * prev)
pure virtual

Creates a new Range object (but does not add it to the list).
If prev#0 a copy of prev is created, otherwise a new empty filter is created.

◆ findRangeWithName() [1/2]

virtual const IRange * itascaxd::IRangeList::findRangeWithName ( const QString & name) const
pure virtual

Attempts to find a named filter matching name. Returns 0 if not found.
CaseSensitivity is determined by the Settings object.

◆ findRangeWithName() [2/2]

virtual IRange * itascaxd::IRangeList::findRangeWithName ( const QString & name)
pure virtual

◆ getFirst()

virtual const IRange * itascaxd::IRangeList::getFirst ( ) const
pure virtual

Return a pointer to the first named Range stored.
IRange::getNext() can be used to iterate.

◆ parse()

virtual void itascaxd::IRangeList::parse ( IRange * rng,
const IParse & par,
const QString & keywords = QString(),
IParse::IMark * p = 0,
bool includeFish = true )
pure virtual

Attemps to parse the tokens starting at p into a filter.
Does not check for a RANGE keyword first - assumes one has already been found.
Will not throw error if tokens left on list that are not parsed.
Checks tokens against keywords, if find a match then ends, you can use this to protect against filter name conflicts in subsequent keywords.
If this filter is given a name a copy of it will automatically be added to the named filter list.
rng will be cleared (and name removed) at start.


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