CaenHvSYx527

version 0.1.0 class doc.

tmilosic Undefined

Generated on 2015-02-16T16:06:43+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

ExpertSetting

multiplexed: false
visibility: operational
description:
definition:

name	item	direction	type	description
ExpertSetting	dummyField	IN	scalar: bool
	symbolicName	INOUT	array: char dimension: 256
	fanSpeed	INOUT	scalar: FAN_SPEED
ExpertSetting	updateFlags	OUT	NOTIFICATION_UPDATE
ExpertSetting	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	NOTIFICATION_UPDATE
Power	cycleName	OUT	array: char dimension: 32

2.1.2. acquisition properties

Status

multiplexed: false
visibility: operational
description:
definition:

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

Acquisition

multiplexed: false
visibility: operational
description:
definition:

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

Version

multiplexed: false
visibility: operational
description:
definition:

name	item	direction	type	description
Version	updateFlags	OUT	NOTIFICATION_UPDATE
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	scalar: DIAG_FWK_TOPIC
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

NOTIFICATION_UPDATE

name	description	elements
NOTIFICATION_UPDATE		IMMEDIATE: access=RO, meaning=NONE, symbol=IMMEDIATE, value=1, ; SET: access=RO, meaning=NONE, symbol=SET, value=2, ;

DIAG_FWK_TOPIC

name	description	elements
DIAG_FWK_TOPIC		b0: SRV_GET_ACTION_PROFIING ; b1: SRV_GET_ACTION_PROFIING ; b2: SRV_GET_ACTION_PROFIING ; b3: SRV_GET_ACTION_PROFIING ; b4: SRV_GET_ACTION_PROFIING ; b5: SRV_GET_ACTION_PROFIING ; b6: SRV_GET_ACTION_PROFIING ; b7: SRV_GET_ACTION_PROFIING ; b8: SRV_GET_ACTION_PROFIING ; b9: SRV_GET_ACTION_PROFIING ; b10: SRV_GET_ACTION_PROFIING ; b11: SRV_GET_ACTION_PROFIING ; b12: SRV_GET_ACTION_PROFIING ; b13: SRV_GET_ACTION_PROFIING ; b14: SRV_GET_ACTION_PROFIING ;

DIAG_TOPIC

name	description	elements
DIAG_TOPIC

DEVICE_STATUS

name	description	elements
DEVICE_STATUS		custom-state: access=RW, meaning=NONE, symbol=UNKNOWN, value=0, ; custom-state: access=RW, meaning=NONE, symbol=OK, value=1, ; custom-state: access=RW, meaning=NONE, symbol=WARNING, value=2, ; custom-state: access=RW, meaning=NONE, symbol=ERROR, value=3, ;

DEVICE_POWER_STATE

name	description	elements
DEVICE_POWER_STATE		custom-state: access=RW, meaning=NONE, symbol=UNKNOWN, value=0, ; custom-state: access=RW, meaning=ON, symbol=ON, value=1, ; custom-state: access=RW, meaning=NONE, symbol=OFF, value=2, ; custom-state: access=RW, meaning=NONE, symbol=STANDBY, value=3, ; custom-state: access=RW, meaning=NONE, symbol=POWER_DOWN, value=4, ; custom-state: access=RW, meaning=NONE, symbol=POWER_UP, value=5, ;

DEVICE_POWER

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

DEVICE_CONTROL

name	description	elements
DEVICE_CONTROL		custom-state: access=RW, meaning=NONE, symbol=REMOTE, value=0, ; custom-state: access=RW, meaning=NONE, symbol=LOCAL, value=1, ;

TOL_CHECK_MODE

name	description	elements
TOL_CHECK_MODE		item: access=RO, symbol=ABS, value=0, ; item: access=RO, 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 ; struct-item: error_string ; struct-item: error_string ; struct-item: error_string ;

GSI_MUX_CONTEXT

name	description	elements
GSI_MUX_CONTEXT		struct-item: acqStamp ; struct-item: acqStamp ; struct-item: acqStamp ;

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, symbol=INFO, value=0, ; item: access=RO, symbol=WARNING_ON_FALSE, value=1, ; item: access=RO, symbol=ERROR_ON_FALSE, value=2, ;

SYX527_MODEL

name	description	elements
SYX527_MODEL		item: access=RO, value=0, symbol=SY1527, ; item: access=RO, value=1, symbol=SY2527, ; item: access=RO, value=2, symbol=SY4527, ; item: access=RO, value=3, symbol=SY5527, ;

SET_ACQ_MODE

name	description	elements
SET_ACQ_MODE		item: access=RO, value=0, symbol=POLLING_MODE, ; item: access=RO, value=1, symbol=EVENT_MODE, ;

FAN_SPEED

name	description	elements
FAN_SPEED		item: access=RO, value=0, symbol=LOW, ; item: access=RO, value=1, symbol=MEDIUM, ; item: access=RO, value=2, symbol=HIGH, ;

4. Scheduling-units

---- None -----