phaser-server  0.0.3
Public Member Functions | Static Public Member Functions | List of all members
RfCavity Class Reference

One RF cavity for phase error measurement. More...

#include <rfCavity.h>

Public Member Functions

 RfCavity (const std::string &)
 Construct an instance. More...
 
void KickPhase (double)
 Kick the cavity phase. More...
 
const std::string & Name (void) const
 Get the cavity name.
 
double GetEnergy (void) const
 Get the cavity energy setting (MeV).
 
Type::Region GetRegion (void) const
 Get the cavity's associated region.
 
double GetRegionEnergy (void) const
 Get the target energy (MeV) for cavity's region.
 
double GetPhase (void) const
 Get the cavity phase setting.
 
const std::string & GetPhasePv (void) const
 Get the cavity phase PV name.
 

Static Public Member Functions

static dbr_double_t InRange (dbr_double_t)
 Adjust the passed angle so that it falls within [-180, 180). More...
 

Detailed Description

One RF cavity for phase error measurement.

Constructor & Destructor Documentation

◆ RfCavity()

RfCavity::RfCavity ( const std::string &  cavity)

Construct an instance.

Initialize information about the passed RF cavity. Both the CED and EPICS are used as sources of information.

Parameters
cavity- Name of cavity.
Exceptions
cpplib::Exceptionif an invalid RF cavity name is passed.

Member Function Documentation

◆ InRange()

dbr_double_t RfCavity::InRange ( dbr_double_t  angle)
static

Adjust the passed angle so that it falls within [-180, 180).

Parameters
angle- Angle to be adjusted.

◆ KickPhase()

void RfCavity::KickPhase ( double  kick)

Kick the cavity phase.

Adjust phase to the desired value; which is the cavity phase setting plus the kick. Limit to 10 degree steps.

Parameters
kick- Phase perturbation (deg).

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