Page History

...

Panel

Anchor

	_pdsdata.control.PVMonitor
	_pdsdata.control.PVMonitor

Class PVMonitor

Python wrapper for pdsdata/control/PVMonitor class.

Construction

This class cannot be instantiated directly, methods of other classes return instances of this type.

Method name()

Usage: val = control.name()

Returns name of the monitoring channel.

Method array()

Usage: val = control.array()

Returns true for array.

Method index()

Usage: val = control.index()

Returns index in the array.

Method loValue()

Usage: val = control.loValue()

Returns low value as floating number.

Method hiValue()

Usage: val = control.hiValue()

Returns high value as floating number.

...

Module _pdsdata.epics

This module contains classes corresponding to those in C++ pdsdata/epics package. The module reuses different bits and pieces, such as data type constants, from the underlying EPICS library. Complete EPICS documentation is available at main EPICS site.

Panel

Anchor

	_pdsdata.epics.Constants
	_pdsdata.epics.Constants

Constants

Module defines a number of constants which determine the type of the EPICS data. This constants are:

DBR_<TYPE>
DBR_CTRL_<TYPE>
DBR_GR_<TYPE>
DBR_STS_<TYPE>
DBR_TIME_<TYPE>

where the <TYPE>> is one of the basic data types:

CHAR
DOUBLE
ENUM
FLOAT
LONG
SHORT
STRING

Currently the data EPICS stored in XTC files is either of DBR_CTRL_<TYPE> or DBR_TIME_<TYPE>. DBR_CTRL_<TYPE> type is usually used in Configure transition, L1Accept transitions store DBR_TIME_<TYPE> type.

...

Panel

Anchor

	_pdsdata.epics.dbr_type_is_CTRL
	_pdsdata.epics.dbr_type_is_CTRL

Function dbr_type_is_CTRL()

Usage: val = epics.dbr_type_is_CTRL(data)

Returns true if the EPICS type constant of the data object is one of DBR_CTRL_<TYPE> constants. It also means that the data object itself has epics.EpicsPvCtrl type.

...

Panel

Anchor

	_pdsdata.epics.dbr_type_is_TIME
	_pdsdata.epics.dbr_type_is_TIME

Function dbr_type_is_TIME()

Usage: val = epics.dbr_type_is_TIME(data)

Returns true if the EPICS type constant of the data object is one of DBR_TIME_<TYPE> constants. It also means that the data object itself has epics.EpicsPvTime type.

...

Panel

Array epicsAlarmConditionStrings

Wiki Markup
Usage: {{str = epics.epicsAlarmConditionStrings\[_status_\]}}

Stores string representation of the EPICS status codes.

...

Panel

Array epicsAlarmSeverityStrings

Wiki Markup
Usage: {{str = epics.epicsAlarmSeverityStrings\[_severity_\]}}

Stores string representation of the EPICS severity codes.

...

Panel

Anchor

	_pdsdata.epics.EpicsPvCtrl
	_pdsdata.epics.EpicsPvCtrl

Class EpicsPvCtrl

Python wrapper for pdsdata/epics/EpicsPvCtrl<T> classes.

Construction

This class cannot be instantiated directly, methods of other classes return instances of this type.

Property iPvId

Usage: val = data.iPvId

Returns PV ID as integer number.

Property iDbrType

Usage: val = data.iDbrType

Returns one of the DBR_CTRL_<TYPE> constants.

Property iNumElements

Usage: val = data.iNumElements

Returns size of PV array.

Property sPvName

Usage: val = data.sPvName

Returns PV name.

Property status

Usage: val = data.status

Returns status as integer number. Value can be used as an index into epics.epicsAlarmConditionStrings list. Status 0 means success.

Property severity

Usage: val = data.severity

Returns severity as integer number. Value can be used as an index into epics.epicsAlarmSeverityStrings list. Severity 0 means success.

Property precision

Usage: val = data.precision

Returns precision of the floating point data as number of decimal digits. For non-floating types precision is None.

Property units

Usage: val = data.units

String describing physical units, None for ENUM and STRING PV types.