Tms::CycleParamEdit Class Reference

Cycle Parameter management class. More...

#include <TmsCycleParam.h>

Inheritance diagram for Tms::CycleParamEdit:

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.
Public Member Functions inherited from Tms::CycleParam
	CycleParam (BString pcycleType=BString(), BString pname=BString(), BString pinfo=BString(), BUInt32 pring=BUInt32(), BUInt32 pchannel=BUInt32(), BUInt32 ppllCycleStartFrequency=BUInt32(), BUInt32 ppllInitialFrequency=BUInt32(), BUInt32 ppllInitialFrequencyDelay=BUInt32(), BUInt32 ppllFrefGain=BUInt32(), BUInt32 ppllGain=BUInt32(), BUInt32 ppllDdsMinimum=BUInt32(), BUInt32 ppllDdsMaximum=BUInt32(), BUInt32 pstateDelay=BUInt32(), BArray< BInt32 > pfrefPhaseDelay=BArray< BInt32 >(), BArray< PuStateTable > pstateTable=BArray< PuStateTable >(), BArray< BString > psettings=BArray< BString >())

Static Public Member Functions
static void	getDefaultState (CycleParamState &state)
	Get the default settings for a state.
static void	getdefaultPickupPositions (BArray< BInt32 > &pos)
	Get the default pickup positions.

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 (CycleParamState stateParam)

Additional Inherited Members
Public Attributes inherited from Tms::CycleParam
BString	cycleType
	The Cycle Type Name of this parameter set, normally the BEAM type the set of parameters is designed to measure.
BString	name
	The name of this set of parameters.
BString	info
	Information on this parameter set.
BUInt32	ring
	The ring this configuration is for, 0 defines all rings.
BUInt32	channel
	The channel number this configuration is for, 0 defines all channels.
BUInt32	pllCycleStartFrequency
	This defines the initial PLL frequency. This is loaded on START_CYCLE.
BUInt32	pllInitialFrequency
	This defines the initial PLL frequency. This is loaded after the delay given in pllInitialFrequencyDelay.
BUInt32	pllInitialFrequencyDelay
	This defines the delay in milliseconds from START_CYCLE when the pllInitialFrequency is loaded.
BUInt32	pllFrefGain
	The gain the FREF signal. This is a value in the range +-8191. A normal value would be around 4096.
BUInt32	pllGain
	The gain of the PLL feedback system. This is the gain reduction of the PLL in terms of right bit shifts. A bit shift of 7 is about unity gain.
BUInt32	pllDdsMinimum
	PLL DDS minimum frequency. If this and pllDdsMaximum is set to 0, this feature is disabled.
BUInt32	pllDdsMaximum
	PLL DDS maximum frequency. If this and pllDdsMinimum is set to 0, this feature is disabled.
BUInt32	stateDelay
	The delay in FREF periods when in the delay state.
BArray< BInt32 >	frefPhaseDelay
	The phase delay parameters for the Fref timing signal for each of the Pick-Up channels. This is set based on the position of the Pick-Up's in the PS ring. Its value is based of Fref / 512.
BArray< PuStateTable >	stateTable
	The array of State Table entries for the processing run.
BArray< BString >	settings
	A string array defining the settings for the states. Used for CycleParam editors.

Detailed Description

Cycle Parameter management class.

Constructor & Destructor Documentation

CycleParamEdit() [1/2]

Tms::CycleParamEdit::CycleParamEdit

(

)

CycleParamEdit() [2/2]

Tms::CycleParamEdit::CycleParamEdit

(

const CycleParam &

param

)

Member Function Documentation

bunch()

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

private

clear()

void Tms::CycleParamEdit::clear

(

)

generateState()

BError Tms::CycleParamEdit::generateState ( CycleParamState  stateParam )

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.

getdefaultPickupPositions()

void Tms::CycleParamEdit::getdefaultPickupPositions ( BArray< BInt32 > &  pos )

static

Get the default pickup positions.

Calculates the base pickup phase values for the PS ring.

getDefaultState()

void Tms::CycleParamEdit::getDefaultState ( CycleParamState &  state )

static

Get the default settings for a state.

getStates()

BError Tms::CycleParamEdit::getStates

(

BList< CycleParamState > &

cycleStates

)

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

getString()

BString Tms::CycleParamEdit::getString

(

)

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

readFromFile()

BError Tms::CycleParamEdit::readFromFile

(

BString

fileName

)

Reads the Cycle Parameters from a file.

setStates()

BError Tms::CycleParamEdit::setStates

(

BList< CycleParamState >

cycleStates

)

Sets the Cycle Parameter states given the state information list.

setString()

BError Tms::CycleParamEdit::setString

(

BString

str

)

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

value()

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

private

writeToFile()

BError Tms::CycleParamEdit::writeToFile

(

BString

fileName

)

Writes the Cycle Parameters to a file.

---

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

• TmsCycleParam.h
• TmsCycleParam.cc