#include <abstractprocessorgroup.h>
Public Member Functions | |
AbstractProcessorGroup () | |
void | deleteAll () |
void | disconnectAll () |
AbstractDomProcessor & | dom (const QString &name) |
const bool | exists (const QString &name) |
AbstractProcessor & | get (const QString &name) |
const bool | go (const bool waitUntilGoing=true) const |
void | init () const |
AbstractProcessor & | operator[] (const QString &name) |
void | reset () const |
void | stop (const bool resetToo=true) const |
const Processor::ErrorType | waitUntilGoing (AbstractProcessor **errorProc=0, int *errorData=0) const |
~AbstractProcessorGroup () | |
Friends | |
class | AbstractProcessor |
You may also treat it like an array using the array subscript operator ([]) to retrieve a particular AbstractProcessor object reference through its name.
rGeddei::AbstractProcessorGroup::AbstractProcessorGroup | ( | ) |
Basic constructor.
rGeddei::AbstractProcessorGroup::~AbstractProcessorGroup | ( | ) |
Default destructor.
void rGeddei::AbstractProcessorGroup::init | ( | ) | const |
Call AbstractProcessor::init() on all AbstractProcessor objects in the group with only the default arguments.
All properties will be default, and all names unique but unknown.
const bool rGeddei::AbstractProcessorGroup::go | ( | const bool | waitUntilGoing = true |
) | const |
Start all represented Processor objects processing. See Geddei::Processor::go() and AbstractProcessor::go() for more information.
waitUntilGoing | If true, this call should block until all involved Processor objects are either running or have failed to start. |
const Processor::ErrorType rGeddei::AbstractProcessorGroup::waitUntilGoing | ( | AbstractProcessor ** | errorProc = 0 , |
|
int * | errorData = 0 | |||
) | const |
Block until all represented Processor objects are started or have failed to start.
errorProc | If non-zero, specifies a location at which a pointer to the offending AbstractProcessor object, if existant, will be stored. | |
errorData | If non-zero, specifies a location at which an integer coded description of the error, if existant, will be stored. |
void rGeddei::AbstractProcessorGroup::stop | ( | const bool | resetToo = true |
) | const |
Stop all represented Processor objects immediately. See Geddei::Processor::stop() and AbstractProcessor::stop() for more information.
resetToo | Conduct a reset of all processors as well. Leave as true unless you know what you're doing. |
void rGeddei::AbstractProcessorGroup::reset | ( | ) | const |
Resets all Processor objects in the group. They must already be stop()ed. See Geddei::Processor::reset() and AbstractProcessor::reset() for more information.
void rGeddei::AbstractProcessorGroup::disconnectAll | ( | ) |
Disconnect all represented Processor objects immediately. See Geddei::Processor::disconnectAll() for more information.
void rGeddei::AbstractProcessorGroup::deleteAll | ( | ) |
Delete all AbstractProcessor objects in this group.
const bool rGeddei::AbstractProcessorGroup::exists | ( | const QString & | name | ) |
Check whether an AbstractProcessor object of name name exists in this group.
name | The name to be checked for. |
AbstractProcessor & rGeddei::AbstractProcessorGroup::get | ( | const QString & | name | ) |
Retreive the AbstractProcessor object of name name.
name | The name of the AbstractProcessor to be retrieved. |
AbstractDomProcessor & rGeddei::AbstractProcessorGroup::dom | ( | const QString & | name | ) |
Retreive the AbstractDomProcessor object of name name.
name | The name of the AbstractDomProcessor to be retrieved. |
AbstractProcessor& rGeddei::AbstractProcessorGroup::operator[] | ( | const QString & | name | ) | [inline] |
Array subscript operator. Semantically equivalent to get().
name | The name of the AbstractProcessor to be retrieved. |