caproto.server.records.BoFields =============================== .. currentmodule:: caproto.server.records .. autoclass:: BoFields .. if not using autodoc, add this here: automethod:: __init__ .. note:: To use this, specify ``record="bo"`` in a :class:`pvproperty`. .. list-table:: BoFields pvproperties :header-rows: 1 :widths: auto * - Attribute - Suffix - Docs - Type - Notes - Alarm Group * - access_security_group - ``ASG`` - Access Security Group - CHAR - Length(29) Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - alarm_acknowledge_severity - ``ACKS`` - Alarm Ack Severity - ENUM - **Read-only** Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - alarm_acknowledge_transient - ``ACKT`` - Alarm Ack Transient - ENUM - **Read-only** Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - alarm_status - ``STAT`` - Alarm Status - ENUM - **Read-only** Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - change_of_state_sevr - ``COSV`` - Change of State Sevr - ENUM - - * - current_alarm_severity - ``SEVR`` - Alarm Severity - ENUM - **Read-only** Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - dbputfield_process - ``PUTF`` - dbPutField process - CHAR - **Read-only** Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - description - ``DESC`` - Descriptor - CHAR - Length(41) Inherited from :class:`~caproto.server.records.RecordFieldGroup` **Get** **Put** - * - desired_output_loc - ``DOL`` - Desired Output Loc - STRING - - * - device_type - ``DTYP`` - Device Type - ENUM - Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - disable - ``DISA`` - Disable - INT - Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - disable_alarm_severity - ``DISS`` - Disable Alarm Sevrty - ENUM - Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - disable_putfield - ``DISP`` - Disable putField - CHAR - Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - disable_value - ``DISV`` - Disable Value - INT - Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - event_name - ``EVNT`` - Event Name - CHAR - Length(40) Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - forward_link - ``FLNK`` - Forward Process Link - STRING - Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - hardware_mask - ``MASK`` - Hardware Mask - LONG - **Read-only** - * - invalid_outpt_action - ``IVOA`` - INVALID outpt action - ENUM - - * - invalid_output_value - ``IVOV`` - INVALID output value - INT - - * - last_value_alarmed - ``LALM`` - Last Value Alarmed - INT - **Read-only** - * - last_value_monitored - ``MLST`` - Last Value Monitored - INT - **Read-only** - * - lock_count - ``LCNT`` - Lock Count - CHAR - **Read-only** Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - new_alarm_severity - ``NSEV`` - New Alarm Severity - ENUM - **Read-only** Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - new_alarm_status - ``NSTA`` - New Alarm Status - ENUM - **Read-only** Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - one_error_severity - ``OSV`` - One Error Severity - ENUM - - * - one_name - ``ONAM`` - One Name - CHAR - Length(26) **Get** **Put** - * - output_mode_select - ``OMSL`` - Output Mode Select - ENUM - - * - output_specification - ``OUT`` - Output Specification - STRING - - * - prev_raw_value - ``ORAW`` - prev Raw Value - LONG - **Read-only** - * - prev_readback_value - ``ORBV`` - Prev Readback Value - LONG - **Read-only** - * - prev_simulation_mode - ``OLDSIMM`` - Prev. Simulation Mode - ENUM - **Read-only** - * - process_at_iocinit - ``PINI`` - Process at iocInit - ENUM - Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - process_record - ``PROC`` - Force Processing - CHAR - Inherited from :class:`~caproto.server.records.RecordFieldGroup` **Put** - * - raw_value - ``RVAL`` - Raw Value - LONG - - * - readback_value - ``RBV`` - Readback Value - LONG - **Read-only** - * - record_active - ``PACT`` - Record active - CHAR - **Read-only** Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - record_name - ``NAME`` - Record Name - CHAR - **Read-only** Length(61) Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - record_type - ``RTYP`` - Record type - STRING - **Read-only** Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - reprocess - ``RPRO`` - Reprocess - CHAR - **Read-only** Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - scan_phase - ``PHAS`` - Scan Phase - INT - Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - scan_rate - ``SCAN`` - Scan Mechanism - ENUM - Inherited from :class:`~caproto.server.records.RecordFieldGroup` **Put** - * - scanning_disable - ``SDIS`` - Scanning Disable - STRING - Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - scheduling_priority - ``PRIO`` - Scheduling Priority - ENUM - Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - seconds_to_hold_high - ``HIGH`` - Seconds to Hold High - DOUBLE - - * - sim_mode_async_delay - ``SDLY`` - Sim. Mode Async Delay - DOUBLE - - * - sim_mode_scan - ``SSCN`` - Sim. Mode Scan - ENUM - - * - simulation_mode - ``SIMM`` - Simulation Mode - ENUM - - * - simulation_mode_link - ``SIML`` - Simulation Mode Link - STRING - - * - simulation_mode_severity - ``SIMS`` - Simulation Mode Severity - ENUM - - * - simulation_output_link - ``SIOL`` - Simulation Output Link - STRING - - * - time_stamp_event - ``TSE`` - Time Stamp Event - INT - Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - time_stamp_link - ``TSEL`` - Time Stamp Link - STRING - Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - trace_processing - ``TPRO`` - Trace Processing - CHAR - Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - undefined - ``UDF`` - Undefined - CHAR - Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - undefined_alarm_severity - ``UDFS`` - Undefined Alarm Sevrty - ENUM - Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - zero_error_severity - ``ZSV`` - Zero Error Severity - ENUM - - * - zero_name - ``ZNAM`` - Zero Name - CHAR - Length(26) **Get** **Put** - .. rubric:: Methods .. autosummary:: ~BoFields.group_read ~BoFields.group_write ~BoFields.publish .. rubric:: Attributes .. autosummary:: ~BoFields.default_values ~BoFields.has_val_field ~BoFields.scan_rate_sec ~BoFields.type_map ~BoFields.type_map_read_only .. rubric:: pvproperty methods .. method:: description.getter(self, instance) .. literalinclude:: /../../../../../miniconda/envs/test_env/lib/python3.7/site-packages/caproto/server/records.py :language: python :linenos: :dedent: 4 :lineno-start: 29 :lines: 29-31 .. method:: one_name.getter(self, instance) .. literalinclude:: /../../../../../miniconda/envs/test_env/lib/python3.7/site-packages/caproto/server/records.py :language: python :linenos: :dedent: 4 :lineno-start: 54 :lines: 54-59 .. method:: zero_name.getter(self, instance) .. literalinclude:: /../../../../../miniconda/envs/test_env/lib/python3.7/site-packages/caproto/server/records.py :language: python :linenos: :dedent: 4 :lineno-start: 54 :lines: 54-59