kpilot

ConduitState Class Reference

This class defines the current state of the vcal-conduitbase. More...

#include <conduitstate.h>

Inheritance diagram for ConduitState:

List of all members.


Public Types

enum  state_t {
  eTest, eInit, ePCToHH, eHHToPC,
  eDeleteUnsyncedHH, eDeleteUnsyncedPC, eCleanUp
}

Public Member Functions

 ConduitState ()
virtual void finishSync (ConduitAction *)=0
virtual void handleRecord (ConduitAction *)=0
bool started ()
virtual void startSync (ConduitAction *)=0
state_t state ()
virtual ~ConduitState ()

Protected Attributes

bool fStarted
state_t fState

Detailed Description

This class defines the current state of the vcal-conduitbase.

Subclasses of this class can do the things that are needed, in methods defined here, for the state that they define.

Definition at line 38 of file conduitstate.h.


Member Enumeration Documentation

Enumerator:
eTest 
eInit 
ePCToHH 
eHHToPC 
eDeleteUnsyncedHH 
eDeleteUnsyncedPC 
eCleanUp 

Definition at line 41 of file conduitstate.h.


Constructor & Destructor Documentation

ConduitState::ConduitState (  )  [inline]

Definition at line 56 of file conduitstate.h.

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

Definition at line 57 of file conduitstate.h.


Member Function Documentation

virtual void ConduitState::finishSync ( ConduitAction  )  [pure virtual]

Clean up after all records are synced and enter next state.

Implemented in CleanUpState, DeleteUnsyncedHHState, DeleteUnsyncedPCState, HHToPCState, InitState, PCToHHState, and TestState.

virtual void ConduitState::handleRecord ( ConduitAction  )  [pure virtual]

Sync the next record in row.

Implemented in CleanUpState, DeleteUnsyncedHHState, DeleteUnsyncedPCState, HHToPCState, InitState, PCToHHState, and TestState.

bool ConduitState::started (  )  [inline]

Returns wether or not this state has started.

Definition at line 83 of file conduitstate.h.

virtual void ConduitState::startSync ( ConduitAction  )  [pure virtual]

Prepare for a sync in the current state.

Don't forget to set fState to true in this method. Otherwise the state won't handle records.

Implemented in CleanUpState, DeleteUnsyncedHHState, DeleteUnsyncedPCState, HHToPCState, InitState, PCToHHState, and TestState.

state_t ConduitState::state (  )  [inline]

Returns the state type.

Definition at line 78 of file conduitstate.h.


Member Data Documentation

bool ConduitState::fStarted [protected]

Definition at line 53 of file conduitstate.h.

Definition at line 52 of file conduitstate.h.


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