rGeddei::AbstractDomProcessor Class Reference
[rGeddei's core classes.]

Abstract interface class for handling Geddei DomProcessor objects. More...

#include <abstractdomprocessor.h>

Inheritance diagram for rGeddei::AbstractDomProcessor:

Inheritance graph
[legend]
Collaboration diagram for rGeddei::AbstractDomProcessor:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual const bool spawnWorker (RemoteSession &session)=0
virtual const bool spawnWorker (LocalSession &session)=0

Static Public Member Functions

static RemoteDomProcessorcreate (RemoteSession &session, const QString &type)
static LocalDomProcessorcreate (LocalSession &session, const QString &type)
static LocalDomProcessorcreate (LocalSession &session, SubProcessor *primary)

Detailed Description

Abstract interface class for handling Geddei DomProcessor objects.

Author:
Gav Wood <gav@cs.york.ac.uk>
Note:
This derives from AbstractProcessor, where the type refers to the Geddei Processor-derived subclass. In this object, the type, when used refers instead to the Geddei SubProcessor-derived subclass.


Member Function Documentation

virtual const bool rGeddei::AbstractDomProcessor::spawnWorker ( LocalSession session  )  [pure virtual]

Create and couple a SubProcessor hosted in session session to this, using it as a worker.

Similar concept to Geddei::DomProcessor::createAndAddWorker, but a different name to prevent confusion, since this works with sessions rather than lower level concepts.

Parameters:
session The local session under which to create the SubProcessor worker object.
Returns:
true if the worker was created successfully.

Implemented in rGeddei::LocalDomProcessor, and rGeddei::RemoteDomProcessor.

virtual const bool rGeddei::AbstractDomProcessor::spawnWorker ( RemoteSession session  )  [pure virtual]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Create and couple a SubProcessor hosted in session session to this, using it as a worker.

Similar concept to Geddei::DomProcessor::createAndAddWorker, but a different name to prevent confusion, since this works with sessions rather than lower level concepts.

Parameters:
session The remote session under which to create the SubProcessor worker object.
Returns:
true if the worker was created successfully.

Implemented in rGeddei::LocalDomProcessor, and rGeddei::RemoteDomProcessor.

LocalDomProcessor * rGeddei::AbstractDomProcessor::create ( LocalSession session,
SubProcessor primary 
) [static]

Constructs a new LocalDomProcessor object that internally creates a DomProcessor using primary as its primary SubProcessor object.

Note:
This object will take ownership of primary . You should not attempt to delete it. Typically you will use this constructor with a "new" operator:
 AbstractDomProcessor *a = AbstractDomProcessor::create(
     myLocalSession, new SubProcessorType);

Parameters:
session The LocalSession under which to create the Processor object.
primary The SubProcessor object to be used as the DomProcessor object's primary.

LocalDomProcessor * rGeddei::AbstractDomProcessor::create ( LocalSession session,
const QString &  type 
) [static]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Constructs a new LocalDomProcessor object that represents a DomProcessor object whose primary SubProcessor object is a type class.

 AbstractDomProcessor *a = AbstractDomProcessor::create(
     myLocalSession, "SomePluginType");

Parameters:
session The LocalSession under which to create the Processor object.
type The SubProcessor derived subclass, an instantiation of is to be used as the primary to the DomProcessor object this class represents.

Reimplemented from rGeddei::AbstractProcessor.

RemoteDomProcessor * rGeddei::AbstractDomProcessor::create ( RemoteSession session,
const QString &  type 
) [static]

Constructs a RemoteDomProcessor object together with a DomProcessor object in the RemoteSession (i.e. on that object's host).

Parameters:
session The RemoteSession under which to create the DomProcessor object.
type The SubProcessor-derived subclass to be created as the DomProcessor object's primary. You should check the availability and version with the RemoteSession object before construction.

Reimplemented from rGeddei::AbstractProcessor.


The documentation for this class was generated from the following files:
Generated on Thu Jul 13 06:56:47 2006 for Exscalibar by  doxygen 1.4.7