Tms::CycleParam Class Reference

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

#include <TmsD.h>

Inheritance diagram for Tms::CycleParam:

Tms::CycleParamEdit List of all members.

Public Member Functions

 CycleParam ()
 CycleParam (BString pcycleType, BString pinfo, UInt32 pchannel, UInt32 ppllInitialFrequency, UInt32 ppllInitialFrequencyDelay, UInt32 ppllFrefGain, UInt32 ppllGain, UInt32 ppllDdsMinimum, UInt32 ppllDdsMaximum, BArray< Int32 > pfrefPhaseDelay, BArray< PuStateTable > pstateTable, BArray< BString > psettings)

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 info
 Information on this parameter set.
UInt32 channel
 The channel number this configuration is for, 0 defines all channels.
UInt32 pllInitialFrequency
 This defines the initial PLL frequency. This is loaded on START_CYCLE and after the delay given in pllInitialFrequencyDelay.
UInt32 pllInitialFrequencyDelay
 This defines the delay in milliseconds from START_CYCLE when the pllInitialFrequency is loaded.
UInt32 pllFrefGain
 The gain the FREF signal. This is a value in the range +-8191. A normal value would be around 4096.
UInt32 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.
UInt32 pllDdsMinimum
 PLL DDS minimum frequency. If this and pllDdsMaximum is set to 0, this feature is disabled.
UInt32 pllDdsMaximum
 PLL DDS maximum frequency. If this and pllDdsMinimum is set to 0, this feature is disabled.
BArray< Int32frefPhaseDelay
 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< PuStateTablestateTable
 The array of State Table entries for the processing run.
BArray< BStringsettings
 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

Tms::CycleParam::CycleParam (  ) 

Tms::CycleParam::CycleParam ( BString  pcycleType,
BString  pinfo,
UInt32  pchannel,
UInt32  ppllInitialFrequency,
UInt32  ppllInitialFrequencyDelay,
UInt32  ppllFrefGain,
UInt32  ppllGain,
UInt32  ppllDdsMinimum,
UInt32  ppllDdsMaximum,
BArray< Int32 pfrefPhaseDelay,
BArray< PuStateTable pstateTable,
BArray< BString psettings 
)


Member Data Documentation

BString Tms::CycleParam::cycleType

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

BString Tms::CycleParam::info

Information on this parameter set.

UInt32 Tms::CycleParam::channel

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

UInt32 Tms::CycleParam::pllInitialFrequency

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

UInt32 Tms::CycleParam::pllInitialFrequencyDelay

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

UInt32 Tms::CycleParam::pllFrefGain

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

UInt32 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.

UInt32 Tms::CycleParam::pllDdsMinimum

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

UInt32 Tms::CycleParam::pllDdsMaximum

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

BArray<Int32> 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.

BArray<PuStateTable> Tms::CycleParam::stateTable

The array of State Table entries for the processing run.

BArray<BString> Tms::CycleParam::settings

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


The documentation for this class was generated from the following files:
Generated on Tue Oct 9 16:16:04 2007 for LibTmsApi by  doxygen 1.5.1