Subset

version 1.1.5 class documentation

matthies ( CSCO )

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	false
partial-setting	true
type	setting
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
aValueA	INOUT	bool	scalar
aValueB	INOUT	int32_t	scalar

SecondSetting

   [Back to top]

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

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
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 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
multiplexed	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

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
anAcqValueA	OUT	bool	scalar
anAcqValueB	OUT	int32_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]

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

Subset Interface

   [Back to top]

SubsetA

   [Back to top]

Properties
Init
Reset
Setting
SecondSetting
Power
Status
ModuleStatus
Acquisition
Version

SubsetB

   [Back to top]

Properties
Init
Reset
Setting
Power
Status
ModuleStatus
Acquisition
Version

Data

   [Back to top]

Device Data

   [Back to top]

Configuration

   [Back to top]

Name	Type	Description
detailedStatus_labels	char
detailedStatus_severity	DETAILED_STATUS_SEVERITY
moduleStatus_labels	char
subset	char

Acquisition

   [Back to top]

Name	Type	Description
anAcqFieldA	bool
anAcqFieldB	int32_t
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
power	DEVICE_POWER

Global Data

   [Back to top]

Configuration

   [Back to top]

Name	Type	Description
deviceNameTimingReceiver	char

Acquisition

   [Back to top]

None

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
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
DETAILED_STATUS_SEVERITY	custom-types
MAX_MODULE_STATUS_LABEL_LENGTH	custom-types
MODULE_STATUS_SIZE	custom-types
MODULE_STATUS	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

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
ON	1	RW
OFF	2	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

MODULE_STATUS

   [Back to top]

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

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

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	2

Name	Type	Value
MAX_MODULE_STATUS_LABEL_LENGTH	uint32_t	30

Name	Type	Value
MODULE_STATUS_SIZE	uint32_t	2