PlinacMonitorIO

version 0.2.0 class doc.

rapp CSCO

Generated on 2016-01-11T10:16:00+01:00

Table of Contents

1. Introduction

2.1. device-interface

2.1.1. setting properties

2.1.2. acquisition properties

2.2. global-interface

2.2.1. setting properties

2.2.2. acquisition properties

4. Scheduling-units

1. Introduction

Explain the purpose of this class

2. Interface

2.1. device-interface

2.1.1. setting properties

Init

multiplexed: false
visibility: operational
description:
definition:

name	item	direction	type	description

Reset

multiplexed: false
visibility: operational
description:
definition:

name	item	direction	type	description

Setting

multiplexed: false
visibility: operational
description:
definition:

name	item	direction	type	description
Setting	dummyField	IN	scalar: bool
Setting	updateFlags	OUT
Setting	cycleName	OUT	array: char dimension: 32

Power

multiplexed: false
visibility: operational
description:
definition:

name	item	direction	type	description
Power	obsoleteItem	INOUT	scalar: bool
Power	updateFlags	OUT
Power	cycleName	OUT	array: char dimension: 32

2.1.2. acquisition properties

InterlockStatus

multiplexed: false
visibility: operational
description:
definition:

name	item	direction	type	description
InterlockStatus	interlockStatus	OUT	scalar: int32_t
InterlockStatus	updateFlags	OUT
InterlockStatus	cycleName	OUT	array: char dimension: 32

VacuumPressure

multiplexed: false
visibility: operational
description:
definition:

name	item	direction	type	description
VacuumPressure	vacuumPressure	OUT	scalar: double
VacuumPressure	updateFlags	OUT
VacuumPressure	cycleName	OUT	array: char dimension: 32

Status

multiplexed: false
visibility: operational
description:
definition:

name	item	direction	type	description
Status	updateFlags	OUT
Status	cycleName	OUT	array: char dimension: 32

ModuleStatus

multiplexed: false
visibility: development
description:
definition:

name	item	direction	type	description
ModuleStatus	updateFlags	OUT
ModuleStatus	cycleName	OUT	array: char dimension:

Acquisition

multiplexed: true
visibility: operational
description:
definition:

name	item	direction	type	description
Acquisition	updateFlags	OUT
Acquisition	cycleName	OUT	array: char dimension: 32

Version

multiplexed: false
visibility: operational
description:
definition:

name	item	direction	type	description
Version	updateFlags	OUT
Version	cycleName	OUT	array: char dimension: 32

2.2. global-interface

2.2.1. setting properties

DiagnosticSetting

multiplexed: false
visibility: expert
description: Generic property which allows to diagnose any FESA classes
definition:

name	item	direction	type	description
DiagnosticSetting	enableDiagMode	INOUT	scalar: bool
DiagnosticSetting	hostName	INOUT	array: char dimension: 32
DiagnosticSetting	portNumber	INOUT	scalar: int32_t
DiagnosticSetting	requestConfig	IN	scalar: bool
DiagnosticSetting	requestState	IN	scalar: bool
DiagnosticSetting	fwkTopic	INOUT
DiagnosticSetting	customTopic	INOUT	scalar: DIAG_TOPIC
DiagnosticSetting	traceDevices	INOUT	array: char dimension: 320
DiagnosticSetting	bypassActions	INOUT	array: char dimension: 320

2.2.2. acquisition properties

DeviceDescription

multiplexed: false
visibility: operational
description:
definition:

name	item	direction	type	description

3. custom types

DIAG_TOPIC

name	description	elements
DIAG_TOPIC

DEVICE_STATUS

name	description	elements
DEVICE_STATUS		item: access=RW, id=_151119121053_120, meaning=NONE, symbol=UNKNOWN, value=0, ; item: access=RW, id=_151119121053_121, meaning=NONE, symbol=OK, value=1, ; item: access=RW, id=_151119121053_122, meaning=NONE, symbol=WARNING, value=2, ; item: access=RW, id=_151119121053_123, meaning=NONE, symbol=ERROR, value=3, ;

DEVICE_POWER_STATE

name	description	elements
DEVICE_POWER_STATE		item: access=RW, id=_151119121053_124, meaning=NONE, symbol=UNKNOWN, value=0, ; item: access=RW, id=_151119121053_125, meaning=ON, symbol=ON, value=1, ; item: access=RW, id=_151119121053_126, meaning=NONE, symbol=OFF, value=2, ; item: access=RW, id=_151119121053_127, meaning=NONE, symbol=STANDBY, value=3, ; item: access=RW, id=_151119121053_128, meaning=NONE, symbol=POWER_DOWN, value=4, ; item: access=RW, id=_151119121053_129, meaning=NONE, symbol=POWER_UP, value=5, ; item: access=RW, id=_151119121053_130, meaning=NONE, symbol=INTERLOCK, value=6, ;

DEVICE_POWER

name	description	elements
DEVICE_POWER		item: access=RW, id=_151119121053_131, meaning=ON, symbol=ON, value=1, ; item: access=RW, id=_151119121053_132, meaning=OFF, symbol=OFF, value=2, ;

DEVICE_CONTROL

name	description	elements
DEVICE_CONTROL		item: access=RW, id=_151119121053_133, meaning=NONE, symbol=REMOTE, value=0, ; item: access=RW, id=_151119121053_134, meaning=NONE, symbol=LOCAL, value=1, ;

TOL_CHECK_MODE

name	description	elements
TOL_CHECK_MODE		item: access=RO, id=_151119121053_135, symbol=ABS, value=0, ; item: access=RO, id=_151119121053_136, symbol=REL, value=1, ;

AQN_STATUS

name	description	elements
AQN_STATUS		b0: NOT_OK ; b1: NOT_OK ; b2: NOT_OK ; b3: NOT_OK ; b4: NOT_OK ; b5: NOT_OK ; b6: NOT_OK ; b7: NOT_OK ; b8: NOT_OK ; b9: NOT_OK ; b10: NOT_OK ; b11: NOT_OK ; b12: NOT_OK ; b13: NOT_OK ; b14: NOT_OK ; b15: NOT_OK ; b16: NOT_OK ;

GSI_ERROR

name	description	elements
GSI_ERROR		struct-item: error_string id=_151119121053_147, ; struct-item: error_string id=_151119121053_148, ; struct-item: error_string id=_151119121053_149, ; struct-item: error_string id=_151119121053_150, ;

GSI_ACQ_CONTEXT

name	description	elements
GSI_ACQ_CONTEXT		struct-item: acqStamp id=_151119121053_151, ; struct-item: acqStamp id=_151119121053_152, ; struct-item: acqStamp id=_151119121053_153, ; struct-item: acqStamp id=_151119121053_154, ; struct-item: acqStamp id=_151119121053_155, ;

MAX_ERROR_MESSAGE_LENGTH

name	description	elements
MAX_ERROR_MESSAGE_LENGTH

MAX_NUMBER_OF_ERROR_MESSAGES

name	description	elements
MAX_NUMBER_OF_ERROR_MESSAGES

MAX_CYCLE_NAME_LENGTH

name	description	elements
MAX_CYCLE_NAME_LENGTH

MAX_VERSION_NAME_LENGTH

name	description	elements
MAX_VERSION_NAME_LENGTH

MAX_DETAILED_STATUS_LABEL_LENGTH

name	description	elements
MAX_DETAILED_STATUS_LABEL_LENGTH

DETAILED_STATUS_SIZE

name	description	elements
DETAILED_STATUS_SIZE

DETAILED_STATUS_SEVERITY

name	description	elements
DETAILED_STATUS_SEVERITY		item: access=RO, id=_151119121053_137, symbol=INFO, value=0, ; item: access=RO, id=_151119121053_138, symbol=WARNING_ON_FALSE, value=1, ; item: access=RO, id=_151119121053_139, symbol=ERROR_ON_FALSE, value=2, ;

PressureConverterType

name	description	elements
PressureConverterType		item: access=RW, id=_151119121053_140, symbol=IKR050CP300C10, value=0, ; item: access=RW, id=_151119121053_141, symbol=TPR018PI300D, value=1, ;

MODULE_STATUS

name	description	elements
MODULE_STATUS		item: access=RO, id=_151119121053_142, symbol=UNKNOWN, value=0, ; item: access=RO, id=_151119121053_143, symbol=OK, value=1, ; item: access=RO, id=_151119121053_144, symbol=WARNING, value=2, ; item: access=RO, id=_151119121053_145, symbol=ERROR, value=3, ; item: access=RO, id=_151119121053_146, symbol=NOT_AVAILABLE, value=4, ;

MAX_MODULE_STATUS_LABEL_LENGTH

name	description	elements
MAX_MODULE_STATUS_LABEL_LENGTH

MODULE_STATUS_SIZE

name	description	elements
MODULE_STATUS_SIZE

4. Scheduling-units

name	rt-action	device-criterion	logical-event
UpdateValuesSchedulingUnit	UpdateMonitorValue	-	timeToUpdateValuesEvent