Explain the purpose of this class HTML part of introduction
Table of Contents
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 | false |
| partial-setting | true |
| type | setting |
| visibility | operational |
EtherboneDevice
[Back to top]description
| Attributes | Value | | multiplexed | false |
| partial-setting | false |
| type | setting |
| visibility | operational |
| Value-Items | Direction | Type | Scalarity | Description | | etherboneDevice | INOUT | char | array | etherbone hardware device file that is used to interact with the data master |
UploadSchedule
[Back to top] | Attributes | Value | | multiplexed | false |
| partial-setting | false |
| type | setting |
| visibility | operational |
| Value-Items | Direction | Type | Scalarity | Description | | uploadSchedule | INOUT | char | array | |
DownloadSchedule
[Back to top] | Attributes | Value | | multiplexed | false |
| partial-setting | false |
| type | setting |
| visibility | operational |
| Value-Items | Direction | Type | Scalarity | Description | | downloadSchedule | OUT | char | array | |
ScheduleAdd
[Back to top] | Attributes | Value | | multiplexed | false |
| partial-setting | false |
| type | setting |
| visibility | operational |
ScheduleRemove
[Back to top] | Attributes | Value | | multiplexed | false |
| partial-setting | false |
| type | setting |
| visibility | operational |
ScheduleKeep
[Back to top] | Attributes | Value | | multiplexed | false |
| partial-setting | false |
| type | setting |
| visibility | operational |
ScheduleClear
[Back to top] | Attributes | Value | | multiplexed | false |
| partial-setting | false |
| type | setting |
| visibility | operational |
ScheduleDump
[Back to top] | Attributes | Value | | multiplexed | false |
| partial-setting | false |
| type | setting |
| visibility | operational |
ScheduleDumpVerbose
[Back to top] | Attributes | Value | | multiplexed | false |
| partial-setting | false |
| type | setting |
| visibility | operational |
DirectorCommands
[Back to top] | Attributes | Value | | multiplexed | false |
| partial-setting | false |
| type | setting |
| visibility | operational |
| Value-Items | Direction | Type | Scalarity | Description | | directorCommands | INOUT | char | array | |
DirectorCommandsExecute
[Back to top] | Attributes | Value | | multiplexed | true |
| partial-setting | false |
| type | setting |
| visibility | operational |
Dictionary
[Back to top] | Attributes | Value | | multiplexed | false |
| partial-setting | false |
| type | setting |
| visibility | operational |
| Value-Items | Direction | Type | Scalarity | Description | | dictionary | INOUT | char | array | |
GroupsTable
[Back to top] | Attributes | Value | | multiplexed | false |
| partial-setting | false |
| type | setting |
| visibility | operational |
| Value-Items | Direction | Type | Scalarity | Description | | groupsTable | INOUT | char | array | |
Power
[Back to top]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 | | multiplexed | false |
| partial-setting | false |
| type | acquisition |
| visibility | operational |
| Value-Items | Direction | Type | Scalarity | Description | | 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 acorresponding 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 | | multiplexed | false |
| partial-setting | false |
| type | acquisition |
| visibility | operational |
| Value-Items | Direction | Type | Scalarity | Description | | moduleStatus | OUT | MODULE_STATUS | custom-type-array | |
| moduleStatus_labels | OUT | char | array2D | |
Acquisition
[Back to top]Used for returning acquisition data which is retrieved from the hardware.
| Attributes | Value | | multiplexed | true |
| partial-setting | false |
| type | acquisition |
| visibility | operational |
| Value-Items | Direction | Type | Scalarity | Description | | 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 | |
WhiteRabbit
[Back to top] | Attributes | Value | | multiplexed | false |
| partial-setting | false |
| type | acquisition |
| visibility | operational |
| Value-Items | Direction | Type | Scalarity | Description | | status | OUT | WHITE_RABBIT_STATUS | custom-type-scalar | |
| time | OUT | int64_t | 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 | |
DataMaster
[Back to top] | Attributes | Value | | multiplexed | false |
| partial-setting | false |
| type | acquisition |
| visibility | operational |
| Value-Items | Direction | Type | Scalarity | Description | | numCpus | OUT | int32_t | scalar | |
| validCpus | OUT | int32_t | scalar | |
| status | OUT | int32_t | array | |
| threadRun | OUT | int32_t | array | |
| threadCursor | OUT | char | array2D | |
| threadOrigin | OUT | char | array2D | |
| messageCount | OUT | int64_t | 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 | |
Version
[Back to top]Returns the current software and hardware versions of a piece of equipment.
| Attributes | Value | | multiplexed | 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]DeviceDescription
[Back to top] | Attributes | Value | | multiplexed | 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 | |
Data
[Back to top] Device Data
[Back to top] Configuration
[Back to top] Acquisition
[Back to top] Setting
[Back to top] Global Data
[Back to top] Configuration
[Back to top] Acquisition
[Back to top]None
Setting
[Back to top]None
Custom Types
[Back to top] Struct and Enumeration Data
[Back to top] GSI_ERROR
[Back to top] 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 |
[Back to top] | Symbol | Value | Access | | UNKNOWN | 0 | RW |
| OK | 1 | RW |
| WARNING | 2 | RW |
| ERROR | 3 | RW |
[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 |
[Back to top] | Symbol | Value | Access | | ON | 1 | RW |
| OFF | 2 | RW |
[Back to top] | Symbol | Value | Access | | REMOTE | 0 | RW |
| LOCAL | 1 | RW |
[Back to top] | Symbol | Value | Access | | ABS | 0 | RO |
| REL | 1 | RO |
[Back to top] | Symbol | Value | Access | | INFO | 0 | RO |
| WARNING_ON_FALSE | 1 | RO |
| ERROR_ON_FALSE | 2 | RO |
[Back to top] | Symbol | Value | Access | | UNKNOWN | 0 | RO |
| OK | 1 | RO |
| WARNING | 2 | RO |
| ERROR | 3 | RO |
| NOT_AVAILABLE | 4 | RO |
[Back to top] | Symbol | Value | Access | | RUNNING | 0 | RO |
| IDLE | 1 | RO |
| ERROR | 2 | RO |
[Back to top] | Symbol | Value | Access | | TRACK_PHASE | 0 | RO |
| LINK_DOWN | 1 | RO |
| LINK_UP | 2 | RO |
[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 |
Constants
[Back to top]