Cern
LibTmsApi 2.3.0
Tms::CycleParamState Class Reference

#include <TmsCycleParam.h>

Public Member Functions

 CycleParamState ()
 
void clear ()
 Clear the entry.
 
void setNext (int nextNum, BUInt32 nextPeriod, bool f1RefSigma, bool f1LoMsb, bool f2RefSigma, bool f2LoMsb, bool pllF2, bool acquire)
 
BString getString ()
 Returns the CycleParamState in string form.
 
BError setString (BString str)
 Sets the CycleParamState from a string.
 

Public Attributes

BUInt32 num
 The state number

 
BUInt32 period
 The cycle period.
 
TmsState state
 The TMS State.
 
BUInt32 bunchMask
 The set of bunches to capture bit mask.
 
BUInt32 mean1Mask
 The set of bunches to pass through meanFilter1.
 
BUInt32 mean2Mask
 The set of bunches to pass through meanFilter2.
 
BUInt32 lo1Harmonic
 The LO harmonic number used in this state.
 
double lo1Phase
 The phase offset of the LO as a fraction of FREF (+-1.0)
 
BUInt32 lo2Harmonic
 The LO harmonic number used in this state.
 
double lo2Phase
 The phase offset of the LO as a fraction of FREF (+-1.0)
 
double gateWidth
 The gate pulse width as a fraction of LO (0 - 1.0)
 
double gatePhase
 The gate phase offset as a fraction of LO (0 - 1.0)
 
double blrWidth
 The gate pulse width as a fraction of LO (0 - 1.0)
 
double blrPhase
 The gate phase offset as a fraction of LO (0 - 1.0)
 

Constructor & Destructor Documentation

◆ CycleParamState()

Tms::CycleParamState::CycleParamState ( )

Member Function Documentation

◆ clear()

void Tms::CycleParamState::clear ( )

Clear the entry.

◆ getString()

BString Tms::CycleParamState::getString ( )

Returns the CycleParamState in string form.

◆ setNext()

void Tms::CycleParamState::setNext ( int  nextNum,
BUInt32  nextPeriod,
bool  f1RefSigma,
bool  f1LoMsb,
bool  f2RefSigma,
bool  f2LoMsb,
bool  pllF2,
bool  acquire 
)

◆ setString()

BError Tms::CycleParamState::setString ( BString  str)

Sets the CycleParamState from a string.

Member Data Documentation

◆ blrPhase

double Tms::CycleParamState::blrPhase

The gate phase offset as a fraction of LO (0 - 1.0)

◆ blrWidth

double Tms::CycleParamState::blrWidth

The gate pulse width as a fraction of LO (0 - 1.0)

◆ bunchMask

BUInt32 Tms::CycleParamState::bunchMask

The set of bunches to capture bit mask.

◆ gatePhase

double Tms::CycleParamState::gatePhase

The gate phase offset as a fraction of LO (0 - 1.0)

◆ gateWidth

double Tms::CycleParamState::gateWidth

The gate pulse width as a fraction of LO (0 - 1.0)

◆ lo1Harmonic

BUInt32 Tms::CycleParamState::lo1Harmonic

The LO harmonic number used in this state.

◆ lo1Phase

double Tms::CycleParamState::lo1Phase

The phase offset of the LO as a fraction of FREF (+-1.0)

◆ lo2Harmonic

BUInt32 Tms::CycleParamState::lo2Harmonic

The LO harmonic number used in this state.

◆ lo2Phase

double Tms::CycleParamState::lo2Phase

The phase offset of the LO as a fraction of FREF (+-1.0)

◆ mean1Mask

BUInt32 Tms::CycleParamState::mean1Mask

The set of bunches to pass through meanFilter1.

◆ mean2Mask

BUInt32 Tms::CycleParamState::mean2Mask

The set of bunches to pass through meanFilter2.

◆ num

BUInt32 Tms::CycleParamState::num

The state number

◆ period

BUInt32 Tms::CycleParamState::period

The cycle period.

◆ state

TmsState Tms::CycleParamState::state

The TMS State.


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