ni.measurementlink.pinmap.v1.pin_map_service_pb2 ================================================ .. py:module:: ni.measurementlink.pinmap.v1.pin_map_service_pb2 Attributes ---------- .. autoapisummary:: ni.measurementlink.pinmap.v1.pin_map_service_pb2.DESCRIPTOR ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___PinMap ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___CreatePinMapFromXmlRequest ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___UpdatePinMapFromXmlRequest ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___GetPinMapRequest ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___QueryPinsRequest ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___QueryPinsResponse ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___PinDefinition ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___PinGroupDefinition ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___QueryRelaysRequest ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___QueryRelaysResponse ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___RelayDefinition ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___RelayGroupDefinition ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___QueryResourceAccessInformationRequest ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___QueryResourceAccessInformationResponse ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___ResourceAccessInformation ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___ChannelMapping ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___ResolvedPinsOrRelays Classes ------- .. autoapisummary:: ni.measurementlink.pinmap.v1.pin_map_service_pb2.PinMap ni.measurementlink.pinmap.v1.pin_map_service_pb2.CreatePinMapFromXmlRequest ni.measurementlink.pinmap.v1.pin_map_service_pb2.UpdatePinMapFromXmlRequest ni.measurementlink.pinmap.v1.pin_map_service_pb2.GetPinMapRequest ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryPinsRequest ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryPinsResponse ni.measurementlink.pinmap.v1.pin_map_service_pb2.PinDefinition ni.measurementlink.pinmap.v1.pin_map_service_pb2.PinGroupDefinition ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryRelaysRequest ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryRelaysResponse ni.measurementlink.pinmap.v1.pin_map_service_pb2.RelayDefinition ni.measurementlink.pinmap.v1.pin_map_service_pb2.RelayGroupDefinition ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryResourceAccessInformationRequest ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryResourceAccessInformationResponse ni.measurementlink.pinmap.v1.pin_map_service_pb2.ResourceAccessInformation ni.measurementlink.pinmap.v1.pin_map_service_pb2.ChannelMapping ni.measurementlink.pinmap.v1.pin_map_service_pb2.ResolvedPinsOrRelays Package Contents ---------------- .. py:data:: DESCRIPTOR :type: google.protobuf.descriptor.FileDescriptor .. py:class:: PinMap(*, pin_map_id = ...) Bases: :py:obj:`google.protobuf.message.Message` Pin map resource type. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: PIN_MAP_ID_FIELD_NUMBER :type: int .. py:attribute:: pin_map_id :type: str Output only. The resource id of the registered pin map resource. .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___PinMap .. py:class:: CreatePinMapFromXmlRequest(*, pin_map_id = ..., pin_map_xml = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: PIN_MAP_ID_FIELD_NUMBER :type: int .. py:attribute:: PIN_MAP_XML_FIELD_NUMBER :type: int .. py:attribute:: pin_map_id :type: str Required. The resource id of the pin map to register as a pin map resource. .. py:attribute:: pin_map_xml :type: str Required. A string representing contents of a pin map file. .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___CreatePinMapFromXmlRequest .. py:class:: UpdatePinMapFromXmlRequest(*, pin_map_id = ..., pin_map_xml = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: PIN_MAP_ID_FIELD_NUMBER :type: int .. py:attribute:: PIN_MAP_XML_FIELD_NUMBER :type: int .. py:attribute:: pin_map_id :type: str Required. The resource id of the pin map to be updated. .. py:attribute:: pin_map_xml :type: str Required. New pin map file content. .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___UpdatePinMapFromXmlRequest .. py:class:: GetPinMapRequest(*, pin_map_id = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: PIN_MAP_ID_FIELD_NUMBER :type: int .. py:attribute:: pin_map_id :type: str Required. The resource id of the registered pin map resource. .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___GetPinMapRequest .. py:class:: QueryPinsRequest(*, pin_map_id = ..., instrument_type_id = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: PIN_MAP_ID_FIELD_NUMBER :type: int .. py:attribute:: INSTRUMENT_TYPE_ID_FIELD_NUMBER :type: int .. py:attribute:: pin_map_id :type: str Required. The resource id of the registered pin map resource. .. py:attribute:: instrument_type_id :type: str Optional. Filter pins by instrument type. Pin maps have built in instrument definitions using the following NI driver based instrument type ids: - "niDCPower" - "niDigitalPattern" - "niScope" - "niDMM" - "niDAQmx" - "niFGen" For custom instruments the user defined instrument type id is defined in the pin map file. .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___QueryPinsRequest .. py:class:: QueryPinsResponse(*, pins = ..., pin_groups = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: PINS_FIELD_NUMBER :type: int .. py:attribute:: PIN_GROUPS_FIELD_NUMBER :type: int .. py:property:: pins :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___PinDefinition] List of pins on the registered pin map resource. This list includes both DUT and System pins. .. py:property:: pin_groups :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___PinGroupDefinition] List of pin groups on the registered pin map resource. When an instrument type id filter is specified, a pin group will only be included in the response if all pins in the pin group match the instrument type. .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___QueryPinsResponse .. py:class:: PinDefinition(*, display_name = ..., is_system_pin = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: DISPLAY_NAME_FIELD_NUMBER :type: int .. py:attribute:: IS_SYSTEM_PIN_FIELD_NUMBER :type: int .. py:attribute:: display_name :type: str Name of the dut pin. .. py:attribute:: is_system_pin :type: bool A boolean that indicates a System pin when 'true', or DUT pin when 'false'. .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___PinDefinition .. py:class:: PinGroupDefinition(*, display_name = ..., pin_or_group_references = ..., resolved_pins = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: DISPLAY_NAME_FIELD_NUMBER :type: int .. py:attribute:: PIN_OR_GROUP_REFERENCES_FIELD_NUMBER :type: int .. py:attribute:: RESOLVED_PINS_FIELD_NUMBER :type: int .. py:attribute:: display_name :type: str Name of the pin group. .. py:property:: pin_or_group_references :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] List of other pins or pin groups within this pin group. .. py:property:: resolved_pins :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] Distinct union of pins within this pin group, including those within nested pin groups. .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___PinGroupDefinition .. py:class:: QueryRelaysRequest(*, pin_map_id = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: PIN_MAP_ID_FIELD_NUMBER :type: int .. py:attribute:: pin_map_id :type: str Required. The resource id of the registered pin map resource. .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___QueryRelaysRequest .. py:class:: QueryRelaysResponse(*, relays = ..., relay_groups = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: RELAYS_FIELD_NUMBER :type: int .. py:attribute:: RELAY_GROUPS_FIELD_NUMBER :type: int .. py:property:: relays :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___RelayDefinition] List of relays on the registered pin map resource. This list includes both Site relays and System relays. .. py:property:: relay_groups :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___RelayGroupDefinition] List of relay groups on the registered pin map resource. .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___QueryRelaysResponse .. py:class:: RelayDefinition(*, display_name = ..., is_system_relay = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: DISPLAY_NAME_FIELD_NUMBER :type: int .. py:attribute:: IS_SYSTEM_RELAY_FIELD_NUMBER :type: int .. py:attribute:: display_name :type: str Name of the relay. .. py:attribute:: is_system_relay :type: bool A boolean that indicates a System relay when 'true', or Site relay when 'false'. .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___RelayDefinition .. py:class:: RelayGroupDefinition(*, display_name = ..., relay_or_group_references = ..., resolved_relays = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: DISPLAY_NAME_FIELD_NUMBER :type: int .. py:attribute:: RELAY_OR_GROUP_REFERENCES_FIELD_NUMBER :type: int .. py:attribute:: RESOLVED_RELAYS_FIELD_NUMBER :type: int .. py:attribute:: display_name :type: str Name of the relay group. .. py:property:: relay_or_group_references :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] List of other relays or relay groups within this relay group. .. py:property:: resolved_relays :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] Distinct union of relays within this relay group, including those within nested relay groups. .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___RelayGroupDefinition .. py:class:: QueryResourceAccessInformationRequest(*, pin_map_id = ..., sites = ..., pin_or_relay_names = ..., instrument_type_id = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: PIN_MAP_ID_FIELD_NUMBER :type: int .. py:attribute:: SITES_FIELD_NUMBER :type: int .. py:attribute:: PIN_OR_RELAY_NAMES_FIELD_NUMBER :type: int .. py:attribute:: INSTRUMENT_TYPE_ID_FIELD_NUMBER :type: int .. py:attribute:: pin_map_id :type: str Required. The resource id of the registered pin map resource. .. py:attribute:: instrument_type_id :type: str Optional. The instrument type for which to get instrument resource access information. If unspecified, get instrument resource information for all instrument types connected in the registered pin map resource. Pin maps have built in instrument definitions using the following NI driver based instrument type ids: - "niDCPower" - "niDigitalPattern" - "niScope" - "niDMM" - "niDAQmx" - "niFGen" - "niRelayDriver" For custom instruments the user defined instrument type id is defined in the pin map file. .. py:property:: sites :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[int] Optional. The list of sites for which to get instrument resource access information. If unspecified, get instrument resource information for all sites in the registered pin map resource. .. py:property:: pin_or_relay_names :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] Optional. The list of pins, pin groups, relays, or relay groups for which to get instrument resource access information. If unspecified, get instrument resource information for all pins and relays in the registered pin map resource. .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___QueryResourceAccessInformationRequest .. py:class:: QueryResourceAccessInformationResponse(*, resource_access_information = ..., group_mappings = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:class:: GroupMappingsEntry(*, key = ..., value = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: KEY_FIELD_NUMBER :type: int .. py:attribute:: VALUE_FIELD_NUMBER :type: int .. py:attribute:: key :type: str .. py:property:: value :type: global___ResolvedPinsOrRelays .. py:method:: HasField(field_name) Checks if a certain field is set for the message. For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:attribute:: RESOURCE_ACCESS_INFORMATION_FIELD_NUMBER :type: int .. py:attribute:: GROUP_MAPPINGS_FIELD_NUMBER :type: int .. py:property:: resource_access_information :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ResourceAccessInformation] List of ResourceAccessInformation objects with instrument resource names and channels. .. py:property:: group_mappings :type: google.protobuf.internal.containers.MessageMap[str, global___ResolvedPinsOrRelays] Represents the mapping between pin or relay groups and their respective pin or relay names. .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___QueryResourceAccessInformationResponse .. py:class:: ResourceAccessInformation(*, resource_name = ..., channel_list = ..., instrument_type_id = ..., channel_mappings = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: RESOURCE_NAME_FIELD_NUMBER :type: int .. py:attribute:: CHANNEL_LIST_FIELD_NUMBER :type: int .. py:attribute:: INSTRUMENT_TYPE_ID_FIELD_NUMBER :type: int .. py:attribute:: CHANNEL_MAPPINGS_FIELD_NUMBER :type: int .. py:attribute:: resource_name :type: str Name of the instrument resource. This string is used for initializing the driver session. .. py:attribute:: channel_list :type: str Channels on the instrument resource. This string is used by various driver API methods such as Read, Fetch etc., and driver initialization for some instruments. For a resource that represents a group of instruments or channels in the pin map, the channel list is a comma separated list of fully qualified channels in the format /, e.g. "DCPower1/0, DCPower1/2, DCPower2/0". For a resource that represents a single instrument in the pin map that is not part of a group, the channel list is a comma separated list of channels, e.g. "0, 1, 2". For NI-Digital Pattern devices, the channel list is a comma separated list of pins in the format /, e.g. "site0/PinA, site1/PinB". For a resource that represents a relay driver, the channel list is a comma separated list of NISwitch relay names, e.g. "K0, K1, K2". .. py:attribute:: instrument_type_id :type: str The instrument type of the instrument resource. Pin maps have built in instrument definitions using the following NI driver based instrument type ids: - "niDCPower" - "niDigitalPattern" - "niScope" - "niDMM" - "niDAQmx" - "niFGen" - "niRelayDriver" For custom instruments the user defined instrument type id is defined in the pin map file. .. py:property:: channel_mappings :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ChannelMapping] List of site and pin/relay mappings with optional multiplexer information for each channel in the channel_list. Each item represents a channel-to-pin connection for this instrument resource. In the case of shared pins, there is a separate item for each connection. .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___ResourceAccessInformation .. py:class:: ChannelMapping(*, pin_or_relay_name = ..., site = ..., channel = ..., multiplexer_resource_name = ..., multiplexer_route = ..., multiplexer_type_id = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: PIN_OR_RELAY_NAME_FIELD_NUMBER :type: int .. py:attribute:: SITE_FIELD_NUMBER :type: int .. py:attribute:: CHANNEL_FIELD_NUMBER :type: int .. py:attribute:: MULTIPLEXER_RESOURCE_NAME_FIELD_NUMBER :type: int .. py:attribute:: MULTIPLEXER_ROUTE_FIELD_NUMBER :type: int .. py:attribute:: MULTIPLEXER_TYPE_ID_FIELD_NUMBER :type: int .. py:attribute:: pin_or_relay_name :type: str The pin or relay that is mapped to a channel. .. py:attribute:: site :type: int The site on which the pin or relay is mapped to a channel. For system pins/relays the site number is -1 since they do not belong to a specific site. .. py:attribute:: channel :type: str The channel to which the pin or relay is mapped on this site. .. py:attribute:: multiplexer_resource_name :type: str The multiplexer resource name is used to open the multiplexer session in the driver. .. py:attribute:: multiplexer_route :type: str The multiplexer route through which the pin is connected to an instrument's channel. .. py:attribute:: multiplexer_type_id :type: str User-defined identifier for the multiplexer type in the pin map editor. .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___ChannelMapping .. py:class:: ResolvedPinsOrRelays(*, pin_or_relay_names = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: PIN_OR_RELAY_NAMES_FIELD_NUMBER :type: int .. py:property:: pin_or_relay_names :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] List of pin or relay names in the pin or relay group. .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___ResolvedPinsOrRelays