#include <localprocessor.h>
Inheritance diagram for rGeddei::LocalProcessor:
Public Member Functions | |
virtual const bool | connect (const uint sourceIndex, const LocalProcessor *sink, const uint sinkIndex, const uint bufferSize=1) |
virtual const bool | connect (const uint sourceIndex, const RemoteProcessor *sink, const uint sinkIndex, const uint bufferSize=1) |
virtual void | disconnect (const uint sourceIndex) |
virtual void | disconnectAll () |
virtual const bool | go () |
virtual const QString | name () const |
virtual void | reset () |
virtual void | share (const uint sourceIndex) |
virtual void | split (const uint sourceIndex) |
virtual void | stop () |
virtual void | waitUntilDone () |
virtual const Processor::ErrorType | waitUntilGoing (int *errorData=0) |
virtual | ~LocalProcessor () |
Protected Attributes | |
bool | theAdopted |
Processor * | theProcessor |
LocalSession * | theSession |
Friends | |
class | AbstractProcessor |
class | LocalDomProcessor |
class | LocalSession |
class | RemoteDomProcessor |
class | RemoteProcessor |
Because of this, rGeddei allows locally created Geddei Processor objects to be introduced directly into rGeddei with no Factory/plugin middleman.
rGeddei::LocalProcessor::~LocalProcessor | ( | ) | [virtual] |
Default destructor.
virtual const bool rGeddei::LocalProcessor::go | ( | ) | [inline, virtual] |
Sends a message to the Processor object that this represents, telling it to start.
Implements rGeddei::AbstractProcessor.
virtual const Processor::ErrorType rGeddei::LocalProcessor::waitUntilGoing | ( | int * | errorData = 0 |
) | [inline, virtual] |
Sends a message to the Processor object that this represents, telling it to wait until the start() operation has completed.
errorData | Pointer to an integer, which if non-zero will be filled with some data pertaining to the error (if any) that occured in starting the Processor object. |
Implements rGeddei::AbstractProcessor.
virtual void rGeddei::LocalProcessor::waitUntilDone | ( | ) | [inline, virtual] |
Sends a message to the Processor object that this represents, telling it to wait until the processor() operation has completed.
Implements rGeddei::AbstractProcessor.
virtual void rGeddei::LocalProcessor::stop | ( | ) | [inline, virtual] |
Sends a message to the Processor object that this represents, telling it to stop.
Implements rGeddei::AbstractProcessor.
virtual void rGeddei::LocalProcessor::reset | ( | ) | [inline, virtual] |
Sends a message to the Processor object that this represents, telling it to reset.
Implements rGeddei::AbstractProcessor.
virtual void rGeddei::LocalProcessor::share | ( | const uint | sourceIndex | ) | [inline, virtual] |
Sends a message to the Processor object that this represents, telling it to share the output port sourceIndex.
sourceIndex | The output port index to be share. |
Implements rGeddei::AbstractProcessor.
virtual void rGeddei::LocalProcessor::split | ( | const uint | sourceIndex | ) | [inline, virtual] |
Sends a message to the Processor object that this represents, telling it to split the output port sourceIndex.
sourceIndex | The output port index to be split. |
Implements rGeddei::AbstractProcessor.
const bool rGeddei::LocalProcessor::connect | ( | const uint | sourceIndex, | |
const RemoteProcessor * | sink, | |||
const uint | sinkIndex, | |||
const uint | bufferSize = 1 | |||
) | [virtual] |
Attempts to create a connection between the Processor object this represents and another RemoteProcessor object.
The connection will be formed between the output port of index sourceIndex of the Processor object this represents and the input port sinkIndex of the Processor represented by the RemoteProcessor sink.
sourceIndex | The index of the output port on this side of the connection. | |
sink | The RemoteProcessor object to whose Processor object we wish to connect. | |
sinkIndex | The index of the input port on the opposite side of the connection. | |
bufferSize | A minimum size of Buffer. Leave this at 1 unless you have a good reason not to. |
Implements rGeddei::AbstractProcessor.
const bool rGeddei::LocalProcessor::connect | ( | const uint | sourceIndex, | |
const LocalProcessor * | sink, | |||
const uint | sinkIndex, | |||
const uint | bufferSize = 1 | |||
) | [virtual] |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Attempts to create a connection between the Processor object this represents and another LocalProcessor object.
The connection will be formed between the output port of index sourceIndex of the Processor object this represents and the input port sinkIndex of the Processor represented by the LocalProcessor sink.
sourceIndex | The index of the output port on this side of the connection. | |
sink | The LocalProcessor object to whose Processor object we wish to connect. | |
sinkIndex | The index of the input port on the opposite side of the connection. | |
bufferSize | A minimum size of Buffer. Leave this at 1 unless you have a good reason not to. |
Implements rGeddei::AbstractProcessor.
void rGeddei::LocalProcessor::disconnect | ( | const uint | sourceIndex | ) | [virtual] |
Disguard all connections going from a given port (generally only one, unless the port has a split() or share() operation carried out on it).
sourceIndex | The output port from whom all connection are to be destroyed. |
Implements rGeddei::AbstractProcessor.
void rGeddei::LocalProcessor::disconnectAll | ( | ) | [virtual] |
Disguard all connections going from this object.
Implements rGeddei::AbstractProcessor.
virtual const QString rGeddei::LocalProcessor::name | ( | ) | const [inline, virtual] |
Retreive the unique identifier of this object.
Implements rGeddei::AbstractProcessor.