caproto.server.records.MbboFields ================================= .. currentmodule:: caproto.server.records .. autoclass:: MbboFields .. if not using autodoc, add this here: automethod:: __init__ .. note:: To use this, specify ``record="mbbo"`` in a :class:`pvproperty`. .. list-table:: MbboFields 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` - * - eight_string - ``EIST`` - Eight String - CHAR - Length(26) **Get** **Put** - * - eight_value - ``EIVL`` - Eight Value - LONG - - * - eleven_string - ``ELST`` - Eleven String - CHAR - Length(26) **Get** **Put** - * - eleven_value - ``ELVL`` - Eleven Value - LONG - - * - event_name - ``EVNT`` - Event Name - CHAR - Length(40) Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - fifteen_string - ``FFST`` - Fifteen String - CHAR - Length(26) **Get** **Put** - * - fifteen_value - ``FFVL`` - Fifteen Value - LONG - - * - five_string - ``FVST`` - Five String - CHAR - Length(26) **Get** **Put** - * - five_value - ``FVVL`` - Five Value - LONG - - * - forward_link - ``FLNK`` - Forward Process Link - STRING - Inherited from :class:`~caproto.server.records.RecordFieldGroup` - * - four_string - ``FRST`` - Four String - CHAR - Length(26) **Get** **Put** - * - four_value - ``FRVL`` - Four Value - LONG - - * - fourteen_string - ``FTST`` - Fourteen String - CHAR - Length(26) **Get** **Put** - * - fourteen_value - ``FTVL`` - Fourteen Value - LONG - - * - 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` - * - nine_string - ``NIST`` - Nine String - CHAR - Length(26) **Get** **Put** - * - nine_value - ``NIVL`` - Nine Value - LONG - - * - number_of_bits - ``NOBT`` - Number of Bits - INT - **Read-only** - * - one_string - ``ONST`` - One String - CHAR - Length(26) **Get** **Put** - * - one_value - ``ONVL`` - One Value - LONG - - * - 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` - * - seven_string - ``SVST`` - Seven String - CHAR - Length(26) **Get** **Put** - * - seven_value - ``SVVL`` - Seven Value - LONG - - * - shift - ``SHFT`` - Shift - INT - - * - 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 - - * - six_string - ``SXST`` - Six String - CHAR - Length(26) **Get** **Put** - * - six_value - ``SXVL`` - Six Value - LONG - - * - state_eight_severity - ``EISV`` - State Eight Severity - ENUM - - * - state_eleven_severity - ``ELSV`` - State Eleven Severity - ENUM - - * - state_fifteen_sevr - ``FFSV`` - State Fifteen Sevr - ENUM - - * - state_five_severity - ``FVSV`` - State Five Severity - ENUM - - * - state_four_severity - ``FRSV`` - State Four Severity - ENUM - - * - state_fourteen_sevr - ``FTSV`` - State Fourteen Sevr - ENUM - - * - state_nine_severity - ``NISV`` - State Nine Severity - ENUM - - * - state_one_severity - ``ONSV`` - State One Severity - ENUM - - * - state_seven_severity - ``SVSV`` - State Seven Severity - ENUM - - * - state_six_severity - ``SXSV`` - State Six Severity - ENUM - - * - state_ten_severity - ``TESV`` - State Ten Severity - ENUM - - * - state_thirteen_sevr - ``TTSV`` - State Thirteen Sevr - ENUM - - * - state_three_severity - ``THSV`` - State Three Severity - ENUM - - * - state_twelve_severity - ``TVSV`` - State Twelve Severity - ENUM - - * - state_two_severity - ``TWSV`` - State Two Severity - ENUM - - * - state_zero_severity - ``ZRSV`` - State Zero Severity - ENUM - - * - states_defined - ``SDEF`` - States Defined - INT - **Read-only** - * - ten_string - ``TEST`` - Ten String - CHAR - Length(26) **Get** **Put** - * - ten_value - ``TEVL`` - Ten Value - LONG - - * - thirteen_string - ``TTST`` - Thirteen String - CHAR - Length(26) **Get** **Put** - * - thirteen_value - ``TTVL`` - Thirteen Value - LONG - - * - three_string - ``THST`` - Three String - CHAR - Length(26) **Get** **Put** - * - three_value - ``THVL`` - Three Value - LONG - - * - 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` - * - twelve_string - ``TVST`` - Twelve String - CHAR - Length(26) **Get** **Put** - * - twelve_value - ``TVVL`` - Twelve Value - LONG - - * - two_string - ``TWST`` - Two String - CHAR - Length(26) **Get** **Put** - * - two_value - ``TWVL`` - Two Value - LONG - - * - 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` - * - unknown_state_sevr - ``UNSV`` - Unknown State Sevr - ENUM - - * - zero_string - ``ZRST`` - Zero String - CHAR - Length(26) - * - zero_value - ``ZRVL`` - Zero Value - LONG - - .. rubric:: Methods .. autosummary:: ~MbboFields.group_read ~MbboFields.group_write ~MbboFields.publish .. rubric:: Attributes .. autosummary:: ~MbboFields.default_values ~MbboFields.has_val_field ~MbboFields.scan_rate_sec ~MbboFields.type_map ~MbboFields.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:: eight_string.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:: eleven_string.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:: fifteen_string.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:: five_string.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:: four_string.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:: fourteen_string.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:: nine_string.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:: one_string.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:: seven_string.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:: six_string.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:: ten_string.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:: thirteen_string.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:: three_string.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:: twelve_string.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:: two_string.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