caproto.server.records.BiFields =============================== .. currentmodule:: caproto.server.records .. inheritance-diagram:: BiFields .. autoclass:: BiFields .. if not using autodoc, add this here: automethod:: __init__ .. note:: To use this, specify ``record="bi"`` in a :class:`pvproperty`. .. list-table:: BiFields pvproperties :header-rows: 1 :widths: auto * - Attribute - Suffix - Docs - Type - Notes - Alarm Group * - access_security_group - ``ASG`` - Access Security Group - PvpropertyChar - Length(29) Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - alarm_acknowledge_severity - ``ACKS`` - Alarm Ack Severity - PvpropertyEnumRO - **Read-only** Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - alarm_acknowledge_transient - ``ACKT`` - Alarm Ack Transient - PvpropertyEnumRO - **Read-only** Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - alarm_status - ``STAT`` - Alarm Status - PvpropertyEnumRO - **Read-only** Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - change_of_state_svr - ``COSV`` - Change of State Svr - PvpropertyEnum - Inherited from :class:`~caproto.server.records.base.BiFields` - * - current_alarm_severity - ``SEVR`` - Alarm Severity - PvpropertyEnumRO - **Read-only** Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - dbputfield_process - ``PUTF`` - dbPutField process - PvpropertyByteRO - **Read-only** Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - description - ``DESC`` - Descriptor - PvpropertyChar - Length(41) Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - device_type - ``DTYP`` - Device Type - PvpropertyEnum - Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - disable - ``DISA`` - Disable - PvpropertyShort - Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - disable_alarm_severity - ``DISS`` - Disable Alarm Sevrty - PvpropertyEnum - Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - disable_putfield - ``DISP`` - Disable putField - PvpropertyByte - Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - disable_value - ``DISV`` - Disable Value - PvpropertyShort - Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - event_name - ``EVNT`` - Event Name - PvpropertyChar - Length(40) Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - forward_link - ``FLNK`` - Forward Process Link - PvpropertyString - Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - hardware_mask - ``MASK`` - Hardware Mask - PvpropertyIntegerRO - **Read-only** Inherited from :class:`~caproto.server.records.base.BiFields` - * - input_specification - ``INP`` - Input Specification - PvpropertyString - Inherited from :class:`~caproto.server.records.base.BiFields` - * - last_value_alarmed - ``LALM`` - Last Value Alarmed - PvpropertyShortRO - **Read-only** Inherited from :class:`~caproto.server.records.base.BiFields` - * - last_value_monitored - ``MLST`` - Last Value Monitored - PvpropertyShortRO - **Read-only** Inherited from :class:`~caproto.server.records.base.BiFields` - * - lock_count - ``LCNT`` - Lock Count - PvpropertyByteRO - **Read-only** Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - new_alarm_severity - ``NSEV`` - New Alarm Severity - PvpropertyEnumRO - **Read-only** Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - new_alarm_status - ``NSTA`` - New Alarm Status - PvpropertyEnumRO - **Read-only** Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - one_error_severity - ``OSV`` - One Error Severity - PvpropertyEnum - Inherited from :class:`~caproto.server.records.base.BiFields` - * - one_name - ``ONAM`` - One Name - PvpropertyChar - Length(26) Inherited from :class:`~caproto.server.records.base.BiFields` **Get** **Put** - * - prev_raw_value - ``ORAW`` - prev Raw Value - PvpropertyIntegerRO - **Read-only** Inherited from :class:`~caproto.server.records.base.BiFields` - * - prev_simulation_mode - ``OLDSIMM`` - Prev. Simulation Mode - PvpropertyEnumRO - **Read-only** Inherited from :class:`~caproto.server.records.base.BiFields` - * - process_at_iocinit - ``PINI`` - Process at iocInit - PvpropertyEnum - Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - process_record - ``PROC`` - Force Processing - PvpropertyByte - Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - raw_value - ``RVAL`` - Raw Value - PvpropertyInteger - Inherited from :class:`~caproto.server.records.base.BiFields` **Put** - * - record_active - ``PACT`` - Record active - PvpropertyByteRO - **Read-only** Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - record_name - ``NAME`` - Record Name - PvpropertyCharRO - **Read-only** Length(61) Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - record_type - ``RTYP`` - Record type - PvpropertyStringRO - **Read-only** Inherited from :class:`~caproto.server.records.records.RecordFieldGroup` - * - reprocess - ``RPRO`` - Reprocess - PvpropertyByteRO - **Read-only** Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - scan_phase - ``PHAS`` - Scan Phase - PvpropertyShort - Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - scan_rate - ``SCAN`` - Scan Mechanism - PvpropertyEnum - Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - scanning_disable - ``SDIS`` - Scanning Disable - PvpropertyString - Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - scheduling_priority - ``PRIO`` - Scheduling Priority - PvpropertyEnum - Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - sim_mode_async_delay - ``SDLY`` - Sim. Mode Async Delay - PvpropertyDouble - Inherited from :class:`~caproto.server.records.base.BiFields` - * - sim_mode_scan - ``SSCN`` - Sim. Mode Scan - PvpropertyEnum - Inherited from :class:`~caproto.server.records.base.BiFields` - * - simulation_input_link - ``SIOL`` - Simulation Input Link - PvpropertyString - Inherited from :class:`~caproto.server.records.base.BiFields` - * - simulation_mode - ``SIMM`` - Simulation Mode - PvpropertyEnum - Inherited from :class:`~caproto.server.records.base.BiFields` - * - simulation_mode_link - ``SIML`` - Simulation Mode Link - PvpropertyString - Inherited from :class:`~caproto.server.records.base.BiFields` - * - simulation_mode_severity - ``SIMS`` - Simulation Mode Severity - PvpropertyEnum - Inherited from :class:`~caproto.server.records.base.BiFields` - * - simulation_value - ``SVAL`` - Simulation Value - PvpropertyInteger - Inherited from :class:`~caproto.server.records.base.BiFields` - * - time_stamp_event - ``TSE`` - Time Stamp Event - PvpropertyShort - Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - time_stamp_link - ``TSEL`` - Time Stamp Link - PvpropertyString - Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - trace_processing - ``TPRO`` - Trace Processing - PvpropertyByte - Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - undefined - ``UDF`` - Undefined - PvpropertyByte - Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - undefined_alarm_severity - ``UDFS`` - Undefined Alarm Sevrty - PvpropertyEnum - Inherited from :class:`~caproto.server.records.base.RecordFieldGroup` - * - zero_error_severity - ``ZSV`` - Zero Error Severity - PvpropertyEnum - Inherited from :class:`~caproto.server.records.base.BiFields` - * - zero_name - ``ZNAM`` - Zero Name - PvpropertyChar - Length(26) Inherited from :class:`~caproto.server.records.base.BiFields` **Get** **Put** - .. rubric:: Methods .. autosummary:: ~BiFields.group_read ~BiFields.group_write ~BiFields.publish ~BiFields.value_write_hook .. rubric:: Attributes .. autosummary:: ~BiFields.default_values ~BiFields.has_val_field ~BiFields.scan_rate_sec ~BiFields.type_map ~BiFields.type_map_read_only ~BiFields.parent ~BiFields.pvdb ~BiFields.attr_pvdb ~BiFields.attr_to_pvname ~BiFields.groups .. rubric:: pvproperty methods .. method:: one_name.getter(self, instance) .. literalinclude:: /../../../../../../../opt/hostedtoolcache/Python/3.8.16/x64/lib/python3.8/site-packages/caproto/server/records/utils.py :language: python :linenos: :dedent: 4 :lineno-start: 66 :lines: 66-71 .. method:: zero_name.getter(self, instance) .. literalinclude:: /../../../../../../../opt/hostedtoolcache/Python/3.8.16/x64/lib/python3.8/site-packages/caproto/server/records/utils.py :language: python :linenos: :dedent: 4 :lineno-start: 66 :lines: 66-71