kpilot/lib

RecordConduitBase Class Reference

An intermediate class that introduces the slots we need for our sync implementation. More...

#include <recordConduit.h>

Inheritance diagram for RecordConduitBase:

ConduitAction

List of all members.


Public Types

enum  SyncProgress { NotDone = 0, Done = 1, Error = 2 }
enum  States { Initialize, PalmToPC, PCToPalm, Cleanup }

Public Member Functions

 RecordConduitBase (KPilotDeviceLink *o, const char *n, const QStringList a=QStringList())
virtual ~RecordConduitBase ()

Static Public Member Functions

static QString name (SyncProgress s)
static QString name (States s)

Protected Slots

void process ()

Protected Member Functions

virtual SyncProgress loadPC ()=0
virtual SyncProgress palmRecToPC ()=0
virtual SyncProgress pcRecToPalm ()=0
virtual SyncProgress cleanup ()=0
virtual bool exec ()

Detailed Description

An intermediate class that introduces the slots we need for our sync implementation.

This is here _only_ because mixing moc with template classes sounds really scary.

Definition at line 56 of file recordConduit.h.


Member Enumeration Documentation

State of the conduit's sync.

This is changed by process().

Definition at line 86 of file recordConduit.h.

Return values for the processing functions.

Each should return NotDone if it needs to be called again (e.g. to process another record), Done if it is finished and something else should be done, and Error if the sync cannot be completed.

Definition at line 80 of file recordConduit.h.


Constructor & Destructor Documentation

RecordConduitBase::RecordConduitBase ( KPilotDeviceLink o,
const char *  n,
const QStringList  a = QStringList() 
) [inline]

Constructor.

The QStringList a sets flags for the ConduitAction.

Definition at line 62 of file recordConduit.h.

virtual RecordConduitBase::~RecordConduitBase (  )  [inline, virtual]

Destructor.

Definition at line 70 of file recordConduit.h.


Member Function Documentation

virtual SyncProgress RecordConduitBase::cleanup (  )  [protected, pure virtual]

Function called at the end of this conduit's sync, which should reset DB flags and write changed config data out to disk.

Returns:
Done when the cleanup is complete.
See also:
process()

virtual SyncProgress RecordConduitBase::loadPC (  )  [protected, pure virtual]

Function called at the beginning of a sync to load data from the PC.

Returns:
Done when the load has finished.
See also:
process

QString RecordConduitBase::name ( RecordConduitBase::SyncProgress  s  )  [static]

Returns a human-readable name for the progress indicator s.

Definition at line 173 of file recordConduit.cc.

virtual SyncProgress RecordConduitBase::palmRecToPC (  )  [protected, pure virtual]

Function called repeatedly to fetch the next modified entry from the Palm and sync it with the PC by looking up the record, and calling the syncer for it.

Returns:
Dome when there are no more modified records on the Palm
See also:
process()

virtual SyncProgress RecordConduitBase::pcRecToPalm (  )  [protected, pure virtual]

Function called repeatedly to fetch the next modified entry from the PC and sync it with the Palm by looking up the record and calling the syncer for it.

Returns:
Done when there are no more modified records on the PC
See also:
process()

void RecordConduitBase::process (  )  [protected, slot]

Slot used for the implementation of a state machine: calls each of the relevant other slots (above) as needed until they return true.

Definition at line 84 of file recordConduit.cc.


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