PowerSupply

version 1.19.4 class documentation

kain ( ACO )

Generated on 2015-12-17T15:28:17+01:00

Introduction

Explain the purpose of this class

HTML part of introduction

---

---

Interface

   [Back to top]

Device Interface

   [Back to top]

Setting Properties

   [Back to top]

Init

   [Back to top]

Control property, used to initialize the device with default values from the device instantiation file.

Attributes	Value
multiplexed	false
partial-setting	true
type	setting
visibility	operational

Reset

   [Back to top]

Control property, used to reset the device while keeping the persistent data.

Attributes	Value
multiplexed	false
partial-setting	true
type	setting
visibility	operational

Setting

   [Back to top]

Used for setting hardware parameters for controlling the device.

Attributes	Value
multiplexed	true
partial-setting	true
type	setting
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
armFg	INOUT	bool	scalar
enabled	INOUT	bool	scalar
voltage	INOUT	double	scalar
voltage_units	OUT	char	array
voltage_min	OUT	double	scalar
voltage_max	OUT	double	scalar
current	INOUT	double	scalar
current_units	OUT	char	array
current_min	OUT	double	scalar
current_max	OUT	double	scalar
frequency	INOUT	double	scalar
frequency_units	OUT	char	array
frequency_min	OUT	double	scalar
frequency_max	OUT	double	scalar
coeffArrCurr	INOUT	double	array2D
coeffArrCurr_min	OUT	double	scalar
coeffArrCurr_max	OUT	double	scalar
coeffArrCurr_units	OUT	char	array
coeffArrVolt	INOUT	double	array2D
coeffArrVolt_min	OUT	double	scalar
coeffArrVolt_max	OUT	double	scalar
coeffArrVolt_units	OUT	char	array
coeffArrFreq	INOUT	double	array2D
coeffArrFreq_min	OUT	double	scalar
coeffArrFreq_max	OUT	double	scalar
coeffArrFreq_units	OUT	char	array
coeffArrPhase	INOUT	double	array2D
coeffArrPhase_min	OUT	double	scalar
coeffArrPhase_max	OUT	double	scalar
coeffArrPhase_units	OUT	char	array
coeffArrResFreq	INOUT	double	array2D
coeffArrResFreq_min	OUT	double	scalar
coeffArrResFreq_max	OUT	double	scalar
coeffArrResFreq_units	OUT	char	array
coeffArrDetunePhase	INOUT	double	array2D
coeffArrDetunePhase_min	OUT	double	scalar
coeffArrDetunePhase_max	OUT	double	scalar
coeffArrDetunePhase_units	OUT	char	array
harmonic	INOUT	double	array2D
harmonic_min	OUT	double	scalar
harmonic_max	OUT	double	scalar
harmonic_units	OUT	char	array
freqControl	INOUT	bool	array
amplControl	INOUT	bool	array
phaseSynchronisation	INOUT	bool	array
presetPhase	INOUT	double	array2D
presetPhase_min	OUT	double	scalar
presetPhase_max	OUT	double	scalar
presetPhase_units	OUT	char	array
beamPhaseControl	INOUT	bool	array
koQFraction	INOUT	double	scalar
koQFraction_min	OUT	double	scalar
koQFraction_max	OUT	double	scalar
koQFraction_units	OUT	char	array
koQSpread	INOUT	double	scalar
koQSpread_min	OUT	double	scalar
koQSpread_max	OUT	double	scalar
koQSpread_units	OUT	char	array
koFrequency	INOUT	double	scalar
koFrequency_min	OUT	double	scalar
koFrequency_max	OUT	double	scalar
koFrequency_units	OUT	char	array
koHarmonic	INOUT	double	scalar
koHarmonic_min	OUT	double	scalar
koHarmonic_max	OUT	double	scalar
koHarmonic_units	OUT	char	array

Min-Value-Items	Direction	Type	Scalarity	Description
voltage_min	OUT	double	scalar
current_min	OUT	double	scalar
frequency_min	OUT	double	scalar
coeffArrCurr_min	OUT	double	scalar
coeffArrVolt_min	OUT	double	scalar
coeffArrFreq_min	OUT	double	scalar
coeffArrPhase_min	OUT	double	scalar
coeffArrResFreq_min	OUT	double	scalar
coeffArrDetunePhase_min	OUT	double	scalar
harmonic_min	OUT	double	scalar
presetPhase_min	OUT	double	scalar
koQFraction_min	OUT	double	scalar
koQSpread_min	OUT	double	scalar
koFrequency_min	OUT	double	scalar
koHarmonic_min	OUT	double	scalar

Max-Value-Items	Direction	Type	Scalarity	Description
voltage_max	OUT	double	scalar
current_max	OUT	double	scalar
frequency_max	OUT	double	scalar
coeffArrCurr_max	OUT	double	scalar
coeffArrVolt_max	OUT	double	scalar
coeffArrFreq_max	OUT	double	scalar
coeffArrPhase_max	OUT	double	scalar
coeffArrResFreq_max	OUT	double	scalar
coeffArrDetunePhase_max	OUT	double	scalar
harmonic_max	OUT	double	scalar
presetPhase_max	OUT	double	scalar
koQFraction_max	OUT	double	scalar
koQSpread_max	OUT	double	scalar
koFrequency_max	OUT	double	scalar
koHarmonic_max	OUT	double	scalar

Inverter

   [Back to top]

Attributes	Value
multiplexed	false
partial-setting	true
type	setting
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
invert	INOUT	INVERTER_POSITION	custom-type-scalar	set inverter (-1: negative, 0: no_invert, 1: positive)

RawRampData

   [Back to top]

Get or Set the ramp value data formatted for direct use in FG

Attributes	Value
multiplexed	true
partial-setting	true
type	setting
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
rawCoeffArrCurr	INOUT	int32_t	array2D
rawCoeffArrVolt	INOUT	int32_t	array2D
rawCoeffArrFreq	INOUT	int32_t	array2D
rawCoeffArrPhase	INOUT	int32_t	array2D
rawCoeffArrResFreq	INOUT	int32_t	array2D
rawCoeffArrDetunePhase	INOUT	int32_t	array2D

DCValue

   [Back to top]

Attributes	Value
multiplexed	false
partial-setting	true
type	setting
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
enabled	INOUT	bool	scalar
current	INOUT	double	scalar
current_units	OUT	char	array
current_min	OUT	double	scalar
current_max	OUT	double	scalar
voltage	INOUT	double	scalar
voltage_units	OUT	char	array
voltage_min	OUT	double	scalar
voltage_max	OUT	double	scalar
frequency	INOUT	double	scalar
frequency_units	OUT	char	array
frequency_min	OUT	double	scalar
frequency_max	OUT	double	scalar
phase	INOUT	double	scalar
phase_min	OUT	double	scalar
phase_max	OUT	double	scalar
phase_units	OUT	char	array
resonanceFreq	INOUT	double	scalar
resonanceFreq_min	OUT	double	scalar
resonanceFreq_max	OUT	double	scalar
resonanceFreq_units	OUT	char	array
detunePhase	INOUT	double	scalar
detunePhase_min	OUT	double	scalar
detunePhase_max	OUT	double	scalar
detunePhase_units	OUT	char	array
harmonic	INOUT	double	array
harmonic_min	OUT	double	scalar
harmonic_max	OUT	double	scalar
harmonic_units	OUT	char	array
presetPhase	INOUT	double	array
presetPhase_min	OUT	double	scalar
presetPhase_max	OUT	double	scalar
presetPhase_units	OUT	char	array
amplControl	INOUT	bool	scalar
beamPhaseControl	INOUT	bool	scalar
freqControl	INOUT	bool	scalar
koQFraction	INOUT	double	scalar
koQFraction_min	OUT	double	scalar
koQFraction_max	OUT	double	scalar
koQFraction_units	OUT	char	array
koQSpread	INOUT	double	scalar
koQSpread_min	OUT	double	scalar
koQSpread_max	OUT	double	scalar
koQSpread_units	OUT	char	array
koFrequency	INOUT	double	scalar
koFrequency_min	OUT	double	scalar
koFrequency_max	OUT	double	scalar
koFrequency_units	OUT	char	array
koHarmonic	INOUT	double	scalar
koHarmonic_min	OUT	double	scalar
koHarmonic_max	OUT	double	scalar
koHarmonic_units	OUT	char	array
processIndex	INOUT	double	scalar	when in DC-Mode use reference values of this beamprocess; if device is ramped, prepare and execute the rampdata
processIndex_min	OUT	double	scalar
processIndex_max	OUT	double	scalar
processIndex_units	OUT	char	array

Min-Value-Items	Direction	Type	Scalarity	Description
current_min	OUT	double	scalar
voltage_min	OUT	double	scalar
frequency_min	OUT	double	scalar
phase_min	OUT	double	scalar
resonanceFreq_min	OUT	double	scalar
detunePhase_min	OUT	double	scalar
harmonic_min	OUT	double	scalar
presetPhase_min	OUT	double	scalar
koQFraction_min	OUT	double	scalar
koQSpread_min	OUT	double	scalar
koFrequency_min	OUT	double	scalar
koHarmonic_min	OUT	double	scalar
processIndex_min	OUT	double	scalar

Max-Value-Items	Direction	Type	Scalarity	Description
current_max	OUT	double	scalar
voltage_max	OUT	double	scalar
frequency_max	OUT	double	scalar
phase_max	OUT	double	scalar
resonanceFreq_max	OUT	double	scalar
detunePhase_max	OUT	double	scalar
harmonic_max	OUT	double	scalar
presetPhase_max	OUT	double	scalar
koQFraction_max	OUT	double	scalar
koQSpread_max	OUT	double	scalar
koFrequency_max	OUT	double	scalar
koHarmonic_max	OUT	double	scalar
processIndex_max	OUT	double	scalar

DCMode

   [Back to top]

Attributes	Value
multiplexed	false
partial-setting	true
type	setting
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
mode	INOUT	bool	scalar	switch device between event-triggered- and DC-mode (onDemand)

Connect

   [Back to top]

Attributes	Value
multiplexed	false
partial-setting	true
type	setting
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
connect	INOUT	bool	scalar	connect or disconnect from load (only for Powersupplies with more than 1 load (magnet))

Power

   [Back to top]

Returns the current software and hardware versions of a piece of equipment.Used to turn the power of a device on or off.

Attributes	Value
multiplexed	false
partial-setting	true
type	setting
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
power	INOUT	DEVICE_POWER	custom-type-scalar

Acquisition Properties

   [Back to top]

Status

   [Back to top]

Used to display the (cycle independent) overall status of the device. Detailed status information may be additionally added to this property.

Attributes	Value
cycle-bound	false
partial-setting	false
type	acquisition
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
dcMode	OUT	bool	scalar
runtimeEnvironmentOk	OUT	bool	array
runtimeEnvironmentOk_labels	OUT	char	array2D
status	OUT	DEVICE_STATUS	custom-type-scalar
detailedStatus	OUT	bool	array	Detailed status should consist of an array of boolean values considered as detailed status information as well as a corresponding string array containing keys to illustrate the meaning of the detailed status information.
detailedStatus_labels	OUT	char	array2D	Labels of detailed status bits.
detailedStatus_severity	OUT	DETAILED_STATUS_SEVERITY	custom-type-array	Severities of the detailed status bits.
powerState	OUT	DEVICE_POWER_STATE	custom-type-scalar	Power state of the device (ON, OFF).
control	OUT	DEVICE_CONTROL	custom-type-scalar
interlock	OUT	bool	scalar	Interlock state of the device.
opReady	OUT	bool	scalar	Contains the devices state regarding operation.
modulesReady	OUT	bool	scalar	Contains the devices module state.
error_codes	OUT	int32_t	array
error_messages	OUT	char	array2D
error_timestamps	OUT	int64_t	array
error_cycle_names	OUT	char	array2D

ModuleStatus

   [Back to top]

Gives detailed information on the state of 3rd party hardware and software components which are required to operate the device.

Attributes	Value
cycle-bound	false
partial-setting	false
type	acquisition
visibility	development

Value-Items	Direction	Type	Scalarity	Description
moduleStatus	OUT	MODULE_STATUS	custom-type-array
moduleStatus_labels	OUT	char	array2D

AcquisitionDAQ

   [Back to top]

Attributes	Value
cycle-bound	true
partial-setting	false
type	acquisition
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
refTriggerName	OUT	char	array
refTriggerStamp	OUT	int64_t	scalar	TAI, ns since UNIX epoch, -1 invalid
channelTimeSinceRefTrigger	OUT	float	array
channelUserDelay	OUT	float	scalar
channelActualDelay	OUT	float	scalar
channelName	OUT	char	array
channelValue	OUT	float	array
channelError	OUT	float	array
channelUnit	OUT	char	array
status	OUT	ACQUISITION_STATUS_BITENUM	custom-type-scalar	B1 - Overvoltage has occurred on the channel. B2 - Not enough pre- or post-trigger samples available to perform realignment or/and user delay. B3 - Insufficient buffer size passed to the time-domain sink to extract all samples.
temperature	OUT	float	scalar
processIndex	OUT	int32_t	scalar
sequenceIndex	OUT	int32_t	scalar
chainIndex	OUT	int32_t	scalar
eventNumber	OUT	int32_t	scalar
timingGroupID	OUT	int32_t	scalar
acquisitionStamp	OUT	int64_t	scalar
eventStamp	OUT	int64_t	scalar
processStartStamp	OUT	int64_t	scalar
sequenceStartStamp	OUT	int64_t	scalar
chainStartStamp	OUT	int64_t	scalar

Filter-Items	Direction	Type	Scalarity	Description
channelNameFilter	IN	char	array
triggerNameFilter	IN	char	array	Applicable in TRIGGERED acquisition mode only.
acquisitionModeFilter	IN	ACQUISITION_MODE	custom-type-scalar
maxClientUpdateFrequencyFilter	IN	STREAMING_CLIENT_UPDATE_FREQUENCY	custom-type-scalar

DAQChannelConfig

   [Back to top]

Attributes	Value
cycle-bound	false
partial-setting	false
type	acquisition
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
channelNames	OUT	char	array2D
channelTypes	OUT	char	array2D
processIndex	OUT	int32_t	scalar
sequenceIndex	OUT	int32_t	scalar
chainIndex	OUT	int32_t	scalar
eventNumber	OUT	int32_t	scalar
timingGroupID	OUT	int32_t	scalar
acquisitionStamp	OUT	int64_t	scalar
eventStamp	OUT	int64_t	scalar
processStartStamp	OUT	int64_t	scalar
sequenceStartStamp	OUT	int64_t	scalar
chainStartStamp	OUT	int64_t	scalar

Acquisition

   [Back to top]

Used for returning acquisition data which is retrieved from the hardware.

Attributes	Value
cycle-bound	true
partial-setting	false
type	acquisition
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
voltageSet	OUT	double	scalar
voltageSet_units	OUT	char	array
voltage	OUT	double	scalar
voltage_units	OUT	char	array
voltage_min	OUT	double	scalar
voltage_max	OUT	double	scalar
currentSet	OUT	double	scalar
currentSet_units	OUT	char	array
current	OUT	double	scalar
current_units	OUT	char	array
current_min	OUT	double	scalar
current_max	OUT	double	scalar
frequencySet	OUT	double	scalar
frequencySet_units	OUT	char	array
frequency	OUT	double	scalar
frequency_units	OUT	char	array
frequency_min	OUT	double	scalar
frequency_max	OUT	double	scalar
processIndex	OUT	int32_t	scalar
sequenceIndex	OUT	int32_t	scalar
chainIndex	OUT	int32_t	scalar
eventNumber	OUT	int32_t	scalar
timingGroupID	OUT	int32_t	scalar
acquisitionStamp	OUT	int64_t	scalar
eventStamp	OUT	int64_t	scalar
processStartStamp	OUT	int64_t	scalar
sequenceStartStamp	OUT	int64_t	scalar
chainStartStamp	OUT	int64_t	scalar

Min-Value-Items	Direction	Type	Scalarity	Description
voltage_min	OUT	double	scalar
current_min	OUT	double	scalar
frequency_min	OUT	double	scalar

Max-Value-Items	Direction	Type	Scalarity	Description
voltage_max	OUT	double	scalar
current_max	OUT	double	scalar
frequency_max	OUT	double	scalar

Configuration

   [Back to top]

Used for checking of hardware configuration and libVersions.

Attributes	Value
cycle-bound	false
partial-setting	false
type	acquisition
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
slaveConfig	OUT	char	array2D
processIndex	OUT	int32_t	scalar
sequenceIndex	OUT	int32_t	scalar
chainIndex	OUT	int32_t	scalar
eventNumber	OUT	int32_t	scalar
timingGroupID	OUT	int32_t	scalar
acquisitionStamp	OUT	int64_t	scalar
eventStamp	OUT	int64_t	scalar
processStartStamp	OUT	int64_t	scalar
sequenceStartStamp	OUT	int64_t	scalar
chainStartStamp	OUT	int64_t	scalar

DCValueAcq

   [Back to top]

get device actual value when in DC-mode

Attributes	Value
cycle-bound	false
partial-setting	false
type	acquisition
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
currentSet	OUT	double	scalar
currentSet_units	OUT	char	array
current	OUT	double	scalar
current_units	OUT	char	array
current_min	OUT	double	scalar
current_max	OUT	double	scalar
voltageSet	OUT	double	scalar
voltageSet_units	OUT	char	array
voltage	OUT	double	scalar
voltage_units	OUT	char	array
voltage_min	OUT	double	scalar
voltage_max	OUT	double	scalar
frequencySet	OUT	double	scalar
frequencySet_units	OUT	char	array
frequency	OUT	double	scalar
frequency_units	OUT	char	array
frequency_min	OUT	double	scalar
frequency_max	OUT	double	scalar
processIndex	OUT	int32_t	scalar
sequenceIndex	OUT	int32_t	scalar
chainIndex	OUT	int32_t	scalar
eventNumber	OUT	int32_t	scalar
timingGroupID	OUT	int32_t	scalar
acquisitionStamp	OUT	int64_t	scalar
eventStamp	OUT	int64_t	scalar
processStartStamp	OUT	int64_t	scalar
sequenceStartStamp	OUT	int64_t	scalar
chainStartStamp	OUT	int64_t	scalar

Min-Value-Items	Direction	Type	Scalarity	Description
current_min	OUT	double	scalar
voltage_min	OUT	double	scalar
frequency_min	OUT	double	scalar

Max-Value-Items	Direction	Type	Scalarity	Description
current_max	OUT	double	scalar
voltage_max	OUT	double	scalar
frequency_max	OUT	double	scalar

Version

   [Back to top]

Attributes	Value
cycle-bound	false
partial-setting	false
type	acquisition
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
classVersion	OUT	char	array
deployUnitVersion	OUT	char	array
fesaVersion	OUT	char	array

Global Interface

   [Back to top]

Setting Properties

   [Back to top]

DiagnosticSetting

   [Back to top]

Generic property which allows to diagnose any FESA classes

Attributes	Value
multiplexed	false
partial-setting	false
type	setting
visibility	expert

Value-Items	Direction	Type	Scalarity	Description
requestState	IN	bool	scalar

Acquisition Properties

   [Back to top]

RunTimeInfo

   [Back to top]

Attributes	Value
cycle-bound	false
partial-setting	false
type	acquisition
visibility	expert

Value-Items	Direction	Type	Scalarity	Description
runTimeData	OUT	double	array2D
runTimeDataMax	OUT	double	array2D
processIndex	OUT	int32_t	scalar
sequenceIndex	OUT	int32_t	scalar
chainIndex	OUT	int32_t	scalar
eventNumber	OUT	int32_t	scalar
timingGroupID	OUT	int32_t	scalar
acquisitionStamp	OUT	int64_t	scalar
eventStamp	OUT	int64_t	scalar
processStartStamp	OUT	int64_t	scalar
sequenceStartStamp	OUT	int64_t	scalar
chainStartStamp	OUT	int64_t	scalar

DeviceDescription

   [Back to top]

Attributes	Value
cycle-bound	false
partial-setting	false
type	acquisition
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
deviceNameTimingReceiver	OUT	char	array
propertyNames	OUT	char	array2D
deviceNames	OUT	char	array2D
globalDeviceName	OUT	char	array
host	OUT	char	array

Subset Interface

   [Back to top]

CoolerRampedHvPS

   [Back to top]

Properties
Init
Reset
Setting
Inverter
RawRampData
DCValue
DCMode
Connect
Power
Status
ModuleStatus
Acquisition
Configuration
DCValueAcq
Version

DegaussPS

   [Back to top]

Properties
Init
Reset
DCMode
Status
ModuleStatus
Acquisition
Configuration
DCValueAcq
Version

RampedRf

   [Back to top]

Properties
Init
Reset
Setting
Inverter
RawRampData
DCValue
DCMode
Connect
Power
Status
ModuleStatus
Acquisition
Configuration
DCValueAcq
Version

RampedRfAmpl

   [Back to top]

Properties
Init
Reset
Setting
Inverter
RawRampData
DCValue
DCMode
Connect
Power
Status
ModuleStatus
Acquisition
Configuration
DCValueAcq
Version

CryCoolerHvPS

   [Back to top]

Properties
Init
Reset
Setting
Inverter
DCValue
DCMode
Connect
Power
Status
ModuleStatus
Acquisition
Configuration
DCValueAcq
Version

BasicPS

   [Back to top]

Properties
Init
Reset
Setting
Inverter
DCValue
DCMode
Connect
Power
Status
ModuleStatus
Acquisition
Configuration
DCValueAcq
Version

BasicHvPS

   [Back to top]

Properties
Init
Reset
Setting
Inverter
DCValue
DCMode
Connect
Power
Status
ModuleStatus
Acquisition
Configuration
DCValueAcq
Version

TuneWobble

   [Back to top]

Properties
Init
Reset
Setting
Inverter
DCValue
DCMode
Connect
Power
Status
ModuleStatus
Acquisition
Configuration
DCValueAcq
Version

CryRF

   [Back to top]

Properties
Init
Reset
Setting
Inverter
DCValue
DCMode
Connect
Power
Status
ModuleStatus
Acquisition
Configuration
DCValueAcq
Version

Dds

   [Back to top]

Properties
Init
Reset
Setting
Inverter
DCValue
DCMode
Connect
Power
Status
ModuleStatus
Acquisition
Configuration
DCValueAcq
Version

DdsGroup

   [Back to top]

Properties
Init
Reset
Setting
DCValue
DCMode
Power
Status
ModuleStatus
Configuration
Version

CryIqPS

   [Back to top]

Properties
Init
Reset
Setting
Inverter
DCValue
DCMode
Connect
Power
Status
ModuleStatus
Acquisition
Configuration
DCValueAcq
Version

RampedPS

   [Back to top]

Properties
Init
Reset
Setting
Inverter
DCValue
DCMode
Connect
Power
Status
ModuleStatus
Acquisition
Configuration
DCValueAcq
Version

RampedHvPS

   [Back to top]

Properties
Init
Reset
Setting
Inverter
DCValue
DCMode
Connect
Power
Status
ModuleStatus
Acquisition
Configuration
DCValueAcq
Version

KOExtraction

   [Back to top]

Properties
Init
Reset
Setting
DCValue
DCMode
Power
Status
ModuleStatus
Configuration
Version

Data

   [Back to top]

Device Data

   [Back to top]

Configuration

   [Back to top]

Name	Type	Description
acceptFilledSelectors	bool
detailedStatus_MfuBitMapping	int32_t
powerSupplyType	POWER_SUPPLY_TYPE
busType	BUS_TYPE
refValueDim	REF_VALUE_DIM	data can be an amount of single values or an amount of ramp data
refValue	ValueConfig	connect reference value elements with setting-property value items
acqValue	ValueConfig	connect acquisition value elements with acquisition-property value items
hasInverter	bool
powerSupplyNumber	int32_t
specialConfig	powerSupplyConfig
runtimeEnvOk_labels	char
daqBufferSize	uint32_t	Number of incoming samples which will be buffered per channel
daqEnabled	bool
detailedStatus_labels	char
detailedStatus_severity	DETAILED_STATUS_SEVERITY
moduleStatus_labels	char
subset	char

Acquisition

   [Back to top]

Name	Type	Description
acqDataArray	double
acqRefDataArray	double
acqDCValueDataArray	double
acqDCValueRefDataArray	double
acqDcMode	bool
daqChannelNames	char
daqChannelTypes	char
runtimeEnvOk	bool
control	DEVICE_CONTROL
powerState	DEVICE_POWER_STATE
status	DEVICE_STATUS
interlock	bool
opReady	bool
modulesReady	bool
detailedStatus	bool
moduleStatus	MODULE_STATUS
acquisitionContext	GSI_ACQ_CONTEXT
error_collection	GSI_ERROR

Setting

   [Back to top]

Name	Type	Description
refValueDataArray	double
dcValueDataArray	double
dcValueProcessIndex	int32_t	use the data of this beamprocessIndex as DcValue
dcValueShadow	ShadowRegister
rampValueData	RAMP_DESCR
shadowRegister	ShadowRegister
koParameter	KOParameter
dcValueKOPara	KOParameter
inverter	INVERTER_POSITION
dcMode	bool
connect	bool
enableSwitch	bool
refTriggerEvent	char
refTriggerFallbackEvent1	char
refTriggerFallbackEvent2	char
power	DEVICE_POWER

Global Data

   [Back to top]

Configuration

   [Back to top]

Name	Type	Description
daqContextTrackerBufferSize	uint32_t	Number of WR-MultiplexingContexts which will be kept in the Circular Context Tracker Buffer
deviceNameTimingReceiver	char

Acquisition

   [Back to top]

Name	Type	Description
runTimeData	RunTimeInfo
runTimeDataMax	RunTimeInfo

Setting

   [Back to top]

None

Custom Types

   [Back to top]

Name	Type
DIAG_TOPIC	custom-types
DEVICE_STATUS	custom-types
DEVICE_POWER_STATE	custom-types
DEVICE_POWER	custom-types
DEVICE_CONTROL	custom-types
TOL_CHECK_MODE	custom-types
AQN_STATUS	custom-types
GSI_ERROR	custom-types
GSI_ACQ_CONTEXT	custom-types
ValueConfig	custom-types
MAX_ERROR_MESSAGE_LENGTH	custom-types
MAX_NUMBER_OF_ERROR_MESSAGES	custom-types
MAX_CYCLE_NAME_LENGTH	custom-types
MAX_VERSION_NAME_LENGTH	custom-types
MAX_DETAILED_STATUS_LABEL_LENGTH	custom-types
DETAILED_STATUS_SIZE	custom-types
MAX_RAMP_INDEX	custom-types
MAX_RAW_RAMP_INDEX	custom-types
MAX_COEFF_INDEX	custom-types
MAX_FGPARAM_INDEX	custom-types
SHADOW_REGISTER_CNT	custom-types
GROUP_DDS_CNT	custom-types
RAMP_PREP_TIME	custom-types
MAX_REALTIME_ERROR_LENGTH	custom-types
DETAILED_STATUS_SEVERITY	custom-types
INVERTER_POSITION	custom-types
POWER_SUPPLY_TYPE	custom-types
BUS_TYPE	custom-types
REF_VALUE_DIM	custom-types
REF_VALUE_TYPE	custom-types
COEFF_DESCR	custom-types
FgParamSet	custom-types
RAMP_DESCR	custom-types
MODULE_STATUS	custom-types
MAX_MODULE_STATUS_LABEL_LENGTH	custom-types
MODULE_STATUS_SIZE	custom-types
MAX_MFU_BITMAPPING_LENGTH	custom-types
RunTimeInfo	custom-types
RUNTIME_INFO_ENTRIES	custom-types
RUNTIME_INFO_MAX	custom-types
RT_ACTION_INDEX	custom-types
SLOTS	custom-types
LOADS	custom-types
powerSupplyConfig	custom-types
CONTROL_MODE	custom-types
ShadowRegister	custom-types
KOParameter	custom-types
ACQUISITION_MODE	custom-types
STREAMING_CLIENT_UPDATE_FREQUENCY	custom-types
MAX_NUMBER_OF_CHANNELS	custom-types
MAX_CHANNEL_NAME_LENGTH	custom-types
MAX_CHANNEL_TYPE_LENGTH	custom-types
MAX_EVENT_NAME_LENGTH	custom-types
MAX_CHANNEL_UNIT_LENGTH	custom-types
ACQUISITION_STATUS_BITENUM	custom-types

Struct and Enumeration Data

   [Back to top]

GSI_ERROR

   [Back to top]

Name	Scalarity	Type	Size	Description
error_string	array	char	MAX_ERROR_MESSAGE_LENGTH
error_code	scalar	int32_t
error_timestamp	scalar	int64_t
error_cycle_name	array	char	MAX_CYCLE_NAME_LENGTH

GSI_ACQ_CONTEXT

   [Back to top]

Name	Scalarity	Type	Size	Description
processIndex	scalar	int32_t		Used in order to index process-multiplexed data
sequenceIndex	scalar	int32_t		Used in order to index sequence-multiplexed data
chainIndex	scalar	int32_t		Refers to a specific beam production chain
eventNumber	scalar	int32_t		The number of the event describes it's type
timingGroupID	scalar	int32_t		ID of the timing group for which the event is relevant
acquisitionStamp	scalar	int64_t		The acquisition stamp is used to indicate when a measurement was done
eventStamp	scalar	int64_t		The event stamp is used to indicate when WhiteRabbit event was triggered on the Timing Receiver
processStartStamp	scalar	int64_t		The process start stamp indicates when the first event of the current process was triggered
sequenceStartStamp	scalar	int64_t		The sequence start stamp indicates when the first event of the current sequence was triggered
chainStartStamp	scalar	int64_t		The chain start stamp indicates when the first event of the current chain was triggered

ValueConfig

   [Back to top]

Name	Scalarity	Type	Size	Description
refValueType	custom-type-scalar	REF_VALUE_TYPE
min	scalar	double
max	scalar	double
limitMin	scalar	double
limitMax	scalar	double
scaling	scalar	double

COEFF_DESCR

   [Back to top]

Name	Scalarity	Type	Size	Description
coeff_t_begin	scalar	double
coeff_t_end	scalar	double
coeff_a	scalar	double
coeff_b	scalar	double
coeff_c	scalar	double
coeff_d	scalar	double

FgParamSet

   [Back to top]

Name	Scalarity	Type	Size	Description
coeff_a	scalar	int16_t
shift_a	scalar	int16_t
coeff_b	scalar	int16_t
shift_b	scalar	int16_t
coeff_c	scalar	int32_t
step	scalar	uint8_t
freq	scalar	uint8_t

RAMP_DESCR

   [Back to top]

Name	Scalarity	Type	Size	Description
armFg	scalar	bool
lastInSequence	scalar	bool
length	scalar	int64_t
coeffArrSize	scalar	uint32_t
coeffArr	custom-type-array	COEFF_DESCR	MAX_RAMP_INDEX
rawCoeffArrSize	scalar	uint32_t

RunTimeInfo

   [Back to top]

Name	Scalarity	Type	Size	Description
delayToInr	scalar	double
delayToEvent	scalar	double
durationOverAll	scalar	double
eventToEnd	scalar	double
eventToEndMax	scalar	double
wrToUtc	scalar	double

powerSupplyConfig

   [Back to top]

Name	Scalarity	Type	Size	Description
slotNumber	custom-type-scalar	SLOTS
loadNumber	custom-type-scalar	LOADS
masterIfb	scalar	int32_t		some IFB driven Powersupplies have more than one IFB, masterIfb is used to handle STATUS, RESET, POWER, INVERTER,...

ShadowRegister

   [Back to top]

Name	Scalarity	Type	Size	Description
harmonic	scalar	double
phaseOffset	scalar	double

KOParameter

   [Back to top]

Name	Scalarity	Type	Size	Description
qFraction	scalar	double
qSpread	scalar	double
frequency	scalar	double
harmonic	scalar	double

DEVICE_STATUS

   [Back to top]

Symbol	Value	Access
UNKNOWN	0	RW
OK	1	RW
WARNING	2	RW
ERROR	3	RW

DEVICE_POWER_STATE

   [Back to top]

Symbol	Value	Access
UNKNOWN	0	RW
ON	1	RW
OFF	2	RW
STANDBY	3	RW
POWER_DOWN	4	RW
POWER_UP	5	RW

DEVICE_POWER

   [Back to top]

Symbol	Value	Access
UNKNOWN	0	RO
ON	1	RW
OFF	2	RW
STANDBY	3	RW

DEVICE_CONTROL

   [Back to top]

Symbol	Value	Access
REMOTE	0	RW
LOCAL	1	RW

TOL_CHECK_MODE

   [Back to top]

Symbol	Value	Access
ABS	0	RO
REL	1	RO

DETAILED_STATUS_SEVERITY

   [Back to top]

Symbol	Value	Access
INFO	0	RO
WARNING_ON_FALSE	1	RO
ERROR_ON_FALSE	2	RO

INVERTER_POSITION

   [Back to top]

Symbol	Value	Access
NEG_INVERTER	-1	RW
NO_INVERTER	0	RW
POS_INVERTER	1	RW

POWER_SUPPLY_TYPE

   [Back to top]

Symbol	Value	Access
ACU	0	RW
CRYIQ	1	RW
CRYTYP2	2	RW
CRYTYP3	3	RW
CRYTYP4	4	RW
CRYTYP5	5	RW
CRYTYP6	6	RW
CRYMIL	7	RW
CRYTYP8	8	RW
CRYTYP9	9	RW
CRYRF	10	RW
BASICPS	11	RW
CRYTYP6A	12	RW
CRYTYP8A	13	RW
CRYTYP10A	14	RW
MIL	15	RW
CRYTYP6B	16	RW
CRYTYP5A	17	RW
SIS18RF	18	RW
DDS	19	RW
SIS18H2RF	20	RW
MILAEG	21	RW
DDSGROUP	22	RW
DDSH2	23	RW
KOEXTR	24	RW
MILDEG	25	RW
CRYTYP12	26	RW
EceHvSwitch	27	RW
TuneWobble	28	RW

BUS_TYPE

   [Back to top]

Symbol	Value	Access
SCU_BUS	2	RW
MIL_BUS	1	RW
DUMMY_BUS	0	RW

REF_VALUE_DIM

   [Back to top]

Symbol	Value	Access
VALUES	0	RO
RAMPS	1	RO
VALUES_TIMED	2	RO
VALUES_SELECT	3	RO
VALUES_MUXED	4	RO

REF_VALUE_TYPE

   [Back to top]

Symbol	Value	Access
UNDEF	0	RO
CURRENT	1	RO
VOLTAGE	2	RO
PHASE	3	RO
TUNE_PHASE	4	RO
FREQUENCY	5	RO
RESO_FREQU	6	RO
DDS_SHADOW	7	RO
KO_PARA	8	RO
SWITCH	9	RO

MODULE_STATUS

   [Back to top]

Symbol	Value	Access
UNKNOWN	0	RO
OK	1	RO
WARNING	2	RO
ERROR	3	RO
NOT_AVAILABLE	4	RO

RT_ACTION_INDEX

   [Back to top]

Symbol	Value	Access
VOLTAGE_SET	0	RO
ACQUISITION_GET	1	RO
TRIGGER_RCVD	2	RO
STATUS_UPDATE	3	RO

SLOTS

   [Back to top]

Symbol	Value	Access
DONT_CARE	-1	RO
MIL_PIGGY	0	RO
SIO_1	1	RO
SIO_2	2	RO
SIO_3	3	RO
SIO_4	4	RO
SIO_5	5	RO
SIO_6	6	RO
SIO_7	7	RO
SIO_8	8	RO
SIO_9	9	RO
SIO_10	10	RO
SIO_11	11	RO
SIO_12	12	RO

LOADS

   [Back to top]

Symbol	Value	Access
DONT_CARE	0	RO
LOAD_1	1	RO
LOAD_2	2	RO
LOAD_3	3	RO
LOAD_4	4	RO
LOAD_5	5	RO

CONTROL_MODE

   [Back to top]

Symbol	Value	Access
KEEP_CONTROLMODE	0	RO
CONTROL_OFF	1	RO
CONTROL_ON	2	RO

ACQUISITION_MODE

   [Back to top]

Symbol	Value	Access
STREAMING	0	RW
FULL_SEQUENCE	1	RW
SNAPSHOT	2	RW
POST_MORTEM	3	RW
TRIGGERED	4	RW

STREAMING_CLIENT_UPDATE_FREQUENCY

   [Back to top]

Symbol	Value	Access
FREQUENCY_1Hz	0	RW
FREQUENCY_10Hz	1	RW
FREQUENCY_25Hz	2	RW

AQN_STATUS

   [Back to top]

bit-enum-32bits

Bit	Name
b0	NOT_OK
b1	BAD_QUALITY
b2	DIFFERENT_FROM_SETTING
b3	OUT_OF_RANGE
b4	BUSY
b5	TIMEOUT
b6	bit6_is_reserved_for_later_usage
b7	bit7_is_reserved_for_later_usage
b8	bit8_is_reserved_for_later_usage
b9	bit9_is_reserved_for_later_usage
b10	bit10_is_reserved_for_later_usage
b11	bit11_is_reserved_for_later_usage
b12	bit12_is_reserved_for_later_usage
b13	bit13_is_reserved_for_later_usage
b14	bit14_is_reserved_for_later_usage
b15	bit15_is_reserved_for_later_usage
b16	bit_16_and_higher_can_be_used_by_the_class_developer

ACQUISITION_STATUS_BITENUM

   [Back to top]

bit-enum-32bits

Bit	Name
b0	OVERVOLTAGE
b1	REALIGNMENT_ERROR
b2	SAMPLES_LOST

Constants

   [Back to top]

Name	Type	Value
MAX_ERROR_MESSAGE_LENGTH	uint32_t	256

Name	Type	Value
MAX_NUMBER_OF_ERROR_MESSAGES	uint32_t	16

Name	Type	Value
MAX_CYCLE_NAME_LENGTH	uint32_t	256

Name	Type	Value
MAX_VERSION_NAME_LENGTH	uint32_t	256

Name	Type	Value
MAX_DETAILED_STATUS_LABEL_LENGTH	uint32_t	30

Name	Type	Value
DETAILED_STATUS_SIZE	uint32_t	64

Name	Type	Value
MAX_RAMP_INDEX	uint32_t	400

Name	Type	Value
MAX_RAW_RAMP_INDEX	uint32_t	1500

Name	Type	Value
MAX_COEFF_INDEX	uint32_t	6

Name	Type	Value
MAX_FGPARAM_INDEX	uint32_t	7

Name	Type	Value
SHADOW_REGISTER_CNT	uint32_t	9

Name	Type	Value
GROUP_DDS_CNT	uint32_t	4

Name	Type	Value
RAMP_PREP_TIME	double	0.010

Name	Type	Value
MAX_REALTIME_ERROR_LENGTH	uint32_t	3

Name	Type	Value
MAX_MODULE_STATUS_LABEL_LENGTH	uint32_t	30

Name	Type	Value
MODULE_STATUS_SIZE	uint32_t	2

Name	Type	Value
MAX_MFU_BITMAPPING_LENGTH	uint32_t	64

Name	Type	Value
RUNTIME_INFO_ENTRIES	uint64_t	6

Name	Type	Value
RUNTIME_INFO_MAX	uint64_t	4

Name	Type	Value
MAX_NUMBER_OF_CHANNELS	uint32_t	100

Name	Type	Value
MAX_CHANNEL_NAME_LENGTH	uint32_t	100

Name	Type	Value
MAX_CHANNEL_TYPE_LENGTH	uint32_t	100

Name	Type	Value
MAX_EVENT_NAME_LENGTH	uint32_t	100

Name	Type	Value
MAX_CHANNEL_UNIT_LENGTH	uint32_t	64