connection_monitoring.substitutions

Note

Click here to check the source code of this file.

This file is a substitutions file implementing ssh_monitor_core.template in order to monitor network connections.

In particular, this substitutions file implements ssh_monitor_core.template one time in a dedicated scope (‘scope1’).

Note that in the Doxygen documentation, a scope is interpreted as a class, and an EPICS macro substitution is interpreted either by a global variable or by a class attribute.

namespace connection_monitoring

Variables

str PREFIX = "${PREFIX_MACRO}"

The ‘PREFIX’ macro prefixes all the PVs names of this ‘.substitutions’ file.

This macro is set to the ‘PREFIX_MACRO’ macro, which has to be defined in the ‘.cmd’ file.

str SSH_OPTS_AND_ARGS = "${SSH_OPTS_AND_ARGS_MACRO}"

The ‘SSH_OPTS_AND_ARGS’ macro defines the SSH options and arguments used for all the SSH commands (including shell instructions) of this ‘.substitutions’ file.

This macro is set to the ‘SSH_OPTS_AND_ARGS_MACRO’ macro, which has to be defined in the ‘.cmd’ file.

class scope1

Public Static Attributes

static str CATEGORY = "connection:"

The ‘CATEGORY’ macro defines the category name of this scope.

static str SCAN = "${SCAN_MACRO=10 minute}"

The ‘SCAN’ macro defines how often the commands of this scope should be triggered.

This macro is set to the ‘SCAN_MACRO’ macro, which defaults to ‘10 minute’ and can be re-defined in the ‘cmd’ file.

static str PV_NAME_SCALAR_1 = "arbitrary_scalar_test"

This macro defines the PV name, note that this PV name is composed like so: ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_1}’.

static str SCALAR_1_INSTRUCTION = "echo 1234567890"

This macro defines a shell instruction writing an arbitrary scalar (‘1234567890’) and making sure it has been retrieved as intended.

static str PREC_SCALAR_1 = "0"

This macro specifies the floating point precision (i.e.

the number of digits to show after decimal point) with which to display the value of the associated scalar instruction.

static str LOAD_SCALAR_1 = ""

This macro uncomments the ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_1}’ ai record.

static str HIHI_SCALAR_1 = "1234567891"

This macro sets to ‘1234567891’ the ‘HIHI’ field (i,e, the “high high” alarm level) of the associated ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_1}’ ai record.

static str LOAD_HIHI_SCALAR_1 = ""

This macro uncomments the ‘HIHI’ field of the associated ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_1}’ ai record.

static str HHSV_SCALAR_1 = "MAJOR"

This macro sets to ‘MAJOR’ the ‘HHSV’ field (i,e, the severity of the ‘HIHI’ field) of the associated ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_1}’ ai record.

static str LOAD_HHSV_SCALAR_1 = ""

This macro uncomments the ‘HHSV’ field of the associated ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_1}’ ai record.

static str LOLO_SCALAR_1 = "1234567889"

This macro sets to ‘1234567889’ the ‘LOLO’ field (i,e, the “low low” alarm level) of the associated ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_1}’ ai record.

static str LOAD_LOLO_SCALAR_1 = ""

This macro uncomments the ‘LOLO’ field of the associated ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_1}’ ai record.

static str LLSV_SCALAR_1 = "MAJOR"

This macro sets to ‘MAJOR’ the ‘LLSV’ field (i,e, the severity of the ‘LOLO’ field) of the associated ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_1}’ ai record.

static str LOAD_LLSV_SCALAR_1 = ""

This macro uncomments the ‘LLSV’ field of the associated ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_1}’ ai record.

static str PV_NAME_STRING_1 = "arbitrary_string_test"

This macro defines the PV name, note that this PV name is composed like so: ‘${PREFIX}${CATEGORY}${PV_NAME_STRING_1}’.

static str STRING_1_INSTRUCTION = "echo OK"

This macro defines a shell instruction writing an arbitrary string (‘OK’) in order to make sure it has been retrieved as intended.

static str LOAD_STRING_1 = ""

This macro uncomments the ‘${PREFIX}${CATEGORY}${PV_NAME_STRING_1}’ ai record.