Tms::CycleParam Class Reference

This class defines the parameters for a PS processing cycle. More...

#include <TmsD.h>

Inheritance diagram for Tms::CycleParam:

Public Member Functions
	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 >())

Public Attributes
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

This class defines the parameters for a PS processing cycle.

Constructor & Destructor Documentation

CycleParam()

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

Member Data Documentation

channel

BUInt32 Tms::CycleParam::channel

The channel number this configuration is for, 0 defines all channels.

cycleType

BString Tms::CycleParam::cycleType

The Cycle Type Name of this parameter set, normally the BEAM type the set of parameters is designed to measure.

frefPhaseDelay

BArray<BInt32 > Tms::CycleParam::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.

info

BString Tms::CycleParam::info

Information on this parameter set.

name

BString Tms::CycleParam::name

The name of this set of parameters.

pllCycleStartFrequency

BUInt32 Tms::CycleParam::pllCycleStartFrequency

This defines the initial PLL frequency. This is loaded on START_CYCLE.

pllDdsMaximum

BUInt32 Tms::CycleParam::pllDdsMaximum

PLL DDS maximum frequency. If this and pllDdsMinimum is set to 0, this feature is disabled.

pllDdsMinimum

BUInt32 Tms::CycleParam::pllDdsMinimum

PLL DDS minimum frequency. If this and pllDdsMaximum is set to 0, this feature is disabled.

pllFrefGain

BUInt32 Tms::CycleParam::pllFrefGain

The gain the FREF signal. This is a value in the range +-8191. A normal value would be around 4096.

pllGain

BUInt32 Tms::CycleParam::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.

pllInitialFrequency

BUInt32 Tms::CycleParam::pllInitialFrequency

This defines the initial PLL frequency. This is loaded after the delay given in pllInitialFrequencyDelay.

pllInitialFrequencyDelay

BUInt32 Tms::CycleParam::pllInitialFrequencyDelay

This defines the delay in milliseconds from START_CYCLE when the pllInitialFrequency is loaded.

ring

BUInt32 Tms::CycleParam::ring

The ring this configuration is for, 0 defines all rings.

settings

BArray<BString > Tms::CycleParam::settings

A string array defining the settings for the states. Used for CycleParam editors.

stateDelay

BUInt32 Tms::CycleParam::stateDelay

The delay in FREF periods when in the delay state.

stateTable

BArray<PuStateTable > Tms::CycleParam::stateTable

The array of State Table entries for the processing run.

---

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

• TmsD.h
• TmsD.cc