GSITemplate
version 1.1.10 class documentation
matthies ( CSCO )
Generated on 2015-12-17T15:28:17+01:00


Introduction

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]

AttributesValue
multiplexedfalse
partial-settingtrue
typesetting
visibilityoperational

Reset

   [Back to top]

AttributesValue
multiplexedfalse
partial-settingtrue
typesetting
visibilityoperational

Setting

   [Back to top]

AttributesValue
multiplexedfalse
partial-settingtrue
typesetting
visibilityoperational

Value-ItemsDirectionTypeScalarityDescription
aSettingFieldINOUTboolscalar

ExpertSetting

   [Back to top]

AttributesValue
multiplexedtrue
partial-settingfalse
typesetting
visibilitydevelopment

Value-ItemsDirectionTypeScalarityDescription
aSettingFieldINOUTboolscalar

ThrowCondition

   [Back to top]

AttributesValue
multiplexedfalse
partial-settingfalse
typesetting
visibilitydevelopment

Power

   [Back to top]

AttributesValue
multiplexedfalse
partial-settingtrue
typesetting
visibilityoperational

Value-ItemsDirectionTypeScalarityDescription
powerINOUTDEVICE_POWERcustom-type-scalar

Acquisition Properties

   [Back to top]

Status

   [Back to top]

AttributesValue
multiplexedfalse
partial-settingfalse
typeacquisition
visibilityoperational

Value-ItemsDirectionTypeScalarityDescription
statusOUTDEVICE_STATUScustom-type-scalar
detailedStatusOUTboolarray
detailedStatus_labelsOUTchararray2D
detailedStatus_severityOUTDETAILED_STATUS_SEVERITYcustom-type-array
powerStateOUTDEVICE_POWER_STATEcustom-type-scalar
controlOUTDEVICE_CONTROLcustom-type-scalar
interlockOUTboolscalar
opReadyOUTboolscalar
modulesReadyOUTboolscalar
error_codesOUTint32_tarray
error_messagesOUTchararray2D
error_timestampsOUTint64_tarray
error_cycle_namesOUTchararray2D

ModuleStatus

   [Back to top]

AttributesValue
multiplexedfalse
partial-settingfalse
typeacquisition
visibilitydevelopment

Value-ItemsDirectionTypeScalarityDescription
moduleStatusOUTMODULE_STATUScustom-type-array
moduleStatus_labelsOUTchararray2D

Acquisition

   [Back to top]

AttributesValue
multiplexedtrue
partial-settingfalse
typeacquisition
visibilityoperational

Value-ItemsDirectionTypeScalarityDescription
anAcquisitionFieldOUTdoublescalar
processIndexOUTint32_tscalar
sequenceIndexOUTint32_tscalar
chainIndexOUTint32_tscalar
eventNumberOUTint32_tscalar
timingGroupIDOUTint32_tscalar
acquisitionStampOUTint64_tscalar
eventStampOUTint64_tscalar
processStartStampOUTint64_tscalar
sequenceStartStampOUTint64_tscalar
chainStartStampOUTint64_tscalar

Version

   [Back to top]

AttributesValue
multiplexedfalse
partial-settingfalse
typeacquisition
visibilityoperational

Value-ItemsDirectionTypeScalarityDescription
classVersionOUTchararray
deployUnitVersionOUTchararray
fesaVersionOUTchararray

Global Interface

   [Back to top]

Setting Properties

   [Back to top]

DiagnosticSetting

   [Back to top]

Generic property which allows to diagnose any FESA classes

AttributesValue
multiplexedfalse
partial-settingfalse
typesetting
visibilityexpert

Value-ItemsDirectionTypeScalarityDescription
requestStateINboolscalar

Acquisition Properties

   [Back to top]

DeviceDescription

   [Back to top]

AttributesValue
multiplexedfalse
partial-settingfalse
typeacquisition
visibilityoperational

Value-ItemsDirectionTypeScalarityDescription
deviceNameTimingReceiverOUTchararray
propertyNamesOUTchararray2D
deviceNamesOUTchararray2D
globalDeviceNameOUTchararray
hostOUTchararray

Metrics

   [Back to top]

Generic property to retrieve deploy-unit's metrics

AttributesValue
multiplexedfalse
partial-settingfalse
typeacquisition
visibilityexpert

Data

   [Back to top]

Device Data

   [Back to top]

Configuration

   [Back to top]

NameTypeDescription
detailedStatus_labelschar
detailedStatus_severityDETAILED_STATUS_SEVERITY
moduleStatus_labelschar

Acquisition

   [Back to top]

NameTypeDescription
anAcquisitionFielddouble
controlDEVICE_CONTROL
powerStateDEVICE_POWER_STATE
statusDEVICE_STATUS
interlockbool
opReadybool
modulesReadybool
detailedStatusbool
moduleStatusMODULE_STATUS
acquisitionContextGSI_ACQ_CONTEXT
error_collectionGSI_ERROR

Setting

   [Back to top]

NameTypeDescription
aSettingFieldbool
powerDEVICE_POWER

Global Data

   [Back to top]

Configuration

   [Back to top]

NameTypeDescription
deviceNameTimingReceiverchar

Acquisition

   [Back to top]

None

Setting

   [Back to top]

None

Custom Types

   [Back to top]

NameType
DIAG_TOPICcustom-types
DEVICE_STATUScustom-types
DEVICE_POWER_STATEcustom-types
DEVICE_POWERcustom-types
DEVICE_CONTROLcustom-types
TOL_CHECK_MODEcustom-types
AQN_STATUScustom-types
GSI_ERRORcustom-types
GSI_ACQ_CONTEXTcustom-types
MAX_ERROR_MESSAGE_LENGTHcustom-types
MAX_NUMBER_OF_ERROR_MESSAGEScustom-types
MAX_CYCLE_NAME_LENGTHcustom-types
MAX_VERSION_NAME_LENGTHcustom-types
MAX_DETAILED_STATUS_LABEL_LENGTHcustom-types
DETAILED_STATUS_SIZEcustom-types
DETAILED_STATUS_SEVERITYcustom-types
MODULE_STATUScustom-types
MAX_MODULE_STATUS_LABEL_LENGTHcustom-types
MODULE_STATUS_SIZEcustom-types

Struct and Enumeration Data

   [Back to top]

GSI_ERROR

   [Back to top]
NameScalarityTypeSizeDescription
error_stringarraycharMAX_ERROR_MESSAGE_LENGTH
error_codescalarint32_t
error_timestampscalarint64_t
error_cycle_namearraycharMAX_CYCLE_NAME_LENGTH

GSI_ACQ_CONTEXT

   [Back to top]
NameScalarityTypeSizeDescription
processIndexscalarint32_tUsed in order to index process-multiplexed data
sequenceIndexscalarint32_tUsed in order to index sequence-multiplexed data
chainIndexscalarint32_tRefers to a specific beam production chain
eventNumberscalarint32_tThe number of the event describes it's type
timingGroupIDscalarint32_tID of the timing group for which the event is relevant
acquisitionStampscalarint64_tThe acquisition stamp is used to indicate when a measurement was done
eventStampscalarint64_tThe event stamp is used to indicate when WhiteRabbit event was triggered on the Timing Receiver
processStartStampscalarint64_tThe process start stamp indicates when the first event of the current process was triggered
sequenceStartStampscalarint64_tThe sequence start stamp indicates when the first event of the current sequence was triggered
chainStartStampscalarint64_tThe chain start stamp indicates when the first event of the current chain was triggered

DEVICE_STATUS

   [Back to top]
SymbolValueAccess
UNKNOWN0RW
OK1RW
WARNING2RW
ERROR3RW

DEVICE_POWER_STATE

   [Back to top]
SymbolValueAccess
UNKNOWN0RW
ON1RW
OFF2RW
STANDBY3RW
POWER_DOWN4RW
POWER_UP5RW

DEVICE_POWER

   [Back to top]
SymbolValueAccess
ON1RW
OFF2RW

DEVICE_CONTROL

   [Back to top]
SymbolValueAccess
REMOTE0RW
LOCAL1RW

TOL_CHECK_MODE

   [Back to top]
SymbolValueAccess
ABS0RO
REL1RO

DETAILED_STATUS_SEVERITY

   [Back to top]
SymbolValueAccess
INFO0RO
WARNING_ON_FALSE1RO
ERROR_ON_FALSE2RO

MODULE_STATUS

   [Back to top]
SymbolValueAccess
UNKNOWN0RO
OK1RO
WARNING2RO
ERROR3RO
NOT_AVAILABLE4RO

AQN_STATUS

   [Back to top]

bit-enum-32bits

BitName
b0NOT_OK
b1BAD_QUALITY
b2DIFFERENT_FROM_SETTING
b3OUT_OF_RANGE
b4BUSY
b5TIMEOUT
b6bit6_is_reserved_for_later_usage
b7bit7_is_reserved_for_later_usage
b8bit8_is_reserved_for_later_usage
b9bit9_is_reserved_for_later_usage
b10bit10_is_reserved_for_later_usage
b11bit11_is_reserved_for_later_usage
b12bit12_is_reserved_for_later_usage
b13bit13_is_reserved_for_later_usage
b14bit14_is_reserved_for_later_usage
b15bit15_is_reserved_for_later_usage
b16bit_16_and_higher_can_be_used_by_the_class_developer

Constants

   [Back to top]

NameTypeValue
MAX_ERROR_MESSAGE_LENGTHuint32_t256

NameTypeValue
MAX_NUMBER_OF_ERROR_MESSAGESuint32_t16

NameTypeValue
MAX_CYCLE_NAME_LENGTHuint32_t256

NameTypeValue
MAX_VERSION_NAME_LENGTHuint32_t256

NameTypeValue
MAX_DETAILED_STATUS_LABEL_LENGTHuint32_t30

NameTypeValue
DETAILED_STATUS_SIZEuint32_t5

NameTypeValue
MAX_MODULE_STATUS_LABEL_LENGTHuint32_t30

NameTypeValue
MODULE_STATUS_SIZEuint32_t2