Tms::CycleParamEdit Class Reference

Cycle Parameter management class. More...

#include <TmsCycleParam.h>

Inheritance diagram for Tms::CycleParamEdit:

Tms::CycleParam List of all members.

Public Member Functions

 CycleParamEdit ()
 CycleParamEdit (const CycleParam &param)
void clear ()
BString getString ()
 Gets the Cycle Parameters in a string format for writing to a file or display.
BError setString (BString str)
 Sets the Cycle Parameters from a string. For reading from a file.
BError readFromFile (BString fileName)
 Reads the Cycle Parameters from a file.
BError writeToFile (BString fileName)
 Writes the Cycle Parameters to a file.
BError setStates (BList< CycleParamState > cycleStates)
 Sets the Cycle Parameter states given the state information list.
BError getStates (BList< CycleParamState > &cycleStates)
 Returns the state information list describing the Cycle Parameter states. These may not be present.

Static Public Member Functions

static void getDefaultState (CycleParamState &state)
 Get the default settings for a state.
static void getdefaultPickupPositions (BArray< Int32 > &pos)
 Calculates the base pickup phase values for the PS ring.

Private Member Functions

double value (int numSamples, int harmonic, double phase, int sample)
int bunch (int numSamples, int harmonic, double phase, int sample)
BError generateState (int num, Tms::TmsState state, CycleParamState stateParam, int lo1Harmonic, double lo1Phase, int lo2Harmonic, double lo2Phase)

Detailed Description

Cycle Parameter management class.


Constructor & Destructor Documentation

Tms::CycleParamEdit::CycleParamEdit (  ) 

Tms::CycleParamEdit::CycleParamEdit ( const CycleParam param  ) 


Member Function Documentation

void Tms::CycleParamEdit::clear (  ) 

BString Tms::CycleParamEdit::getString (  ) 

Gets the Cycle Parameters in a string format for writing to a file or display.

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

Sets the Cycle Parameters from a string. For reading from a file.

BError Tms::CycleParamEdit::readFromFile ( BString  fileName  ) 

Reads the Cycle Parameters from a file.

BError Tms::CycleParamEdit::writeToFile ( BString  fileName  ) 

Writes the Cycle Parameters to a file.

BError Tms::CycleParamEdit::setStates ( BList< CycleParamState cycleStates  ) 

Sets the Cycle Parameter states given the state information list.

BError Tms::CycleParamEdit::getStates ( BList< CycleParamState > &  cycleStates  ) 

Returns the state information list describing the Cycle Parameter states. These may not be present.

void Tms::CycleParamEdit::getDefaultState ( CycleParamState state  )  [static]

Get the default settings for a state.

void Tms::CycleParamEdit::getdefaultPickupPositions ( BArray< Int32 > &  pos  )  [static]

Calculates the base pickup phase values for the PS ring.

double Tms::CycleParamEdit::value ( int  numSamples,
int  harmonic,
double  phase,
int  sample 
) [private]

int Tms::CycleParamEdit::bunch ( int  numSamples,
int  harmonic,
double  phase,
int  sample 
) [private]

BError Tms::CycleParamEdit::generateState ( int  num,
Tms::TmsState  state,
CycleParamState  stateParam,
int  lo1Harmonic,
double  lo1Phase,
int  lo2Harmonic,
double  lo2Phase 
) [private]

This function will generate the phase tables for a given state. It is passed the parameters for the LO1 reference and the LO2 reference. If lo?Harmonic is 1, then FREF is generated.


The documentation for this class was generated from the following files:
Generated on Fri Sep 18 16:33:20 2009 for LibTmsApi by  doxygen 1.5.1