phaser-server/v0.0.2/phaseInterface_8h_source.html

 #ifndef PHASE_INTERFACE_H

 #define PHASE_INTERFACE_H

 #include <vector>

 #include <string>

 class Session;

 class PhaseJob;


 class PhaseInterface

 { public:

     virtual void SetJob(Session &, PhaseJob *) = 0;

     virtual void StopJob(Session &) = 0;

     virtual void PauseJob(Session &) = 0;

     virtual void ResumeJob(Session &) = 0;

     virtual void SkipCavity(Session &) = 0;

     virtual void GetState(Session &) = 0;

     virtual std::vector<std::string> GetCavityNames(void) = 0;

     virtual void PostProgress(unsigned, const std::string &) = 0;

     virtual bool Peek(bool = false) = 0;

     typedef std::vector<unsigned> DbIds;

     virtual void ApplyCorrections(Session &, const DbIds *) = 0;

 };


 #endif

PhaseInterface
Abstract interface to RF cavity phasing.
Definition: phaseInterface.h:16

PhaseInterface::PostProgress
virtual void PostProgress(unsigned, const std::string &)=0
Post progress of an activity to clients.

PhaseInterface::GetCavityNames
virtual std::vector< std::string > GetCavityNames(void)=0
Get the names of eligible RF cavities.

PhaseInterface::SkipCavity
virtual void SkipCavity(Session &)=0
Skip the current cavity in the RF phasing job.

PhaseInterface::ResumeJob
virtual void ResumeJob(Session &)=0
Resume execution of the RF phasing job.

PhaseInterface::ApplyCorrections
virtual void ApplyCorrections(Session &, const DbIds *)=0
Request phase corrections be applied.

PhaseInterface::Peek
virtual bool Peek(bool=false)=0
Peek for client commands during phasing.

PhaseInterface::GetState
virtual void GetState(Session &)=0
Get the current state of the server.

PhaseInterface::StopJob
virtual void StopJob(Session &)=0
Destroy any existing RF phasing job.

PhaseInterface::PauseJob
virtual void PauseJob(Session &)=0
Pause execution of the RF phasing job.

PhaseInterface::SetJob
virtual void SetJob(Session &, PhaseJob *)=0
Set a new RF phasing job.

PhaseJob
A job for processing RF cavities.
Definition: phaseJob.h:17

Session
Manage one connection session with a client.
Definition: session.h:23