ni.measurementlink.pinmap.v1.pin_map_service_pb2

Attributes

`DESCRIPTOR`
`global___PinMap`
`global___CreatePinMapFromXmlRequest`
`global___UpdatePinMapFromXmlRequest`
`global___GetPinMapRequest`
`global___QueryPinsRequest`
`global___QueryPinsResponse`
`global___PinDefinition`
`global___PinGroupDefinition`
`global___QueryRelaysRequest`
`global___QueryRelaysResponse`
`global___RelayDefinition`
`global___RelayGroupDefinition`
`global___QueryResourceAccessInformationRequest`
`global___QueryResourceAccessInformationResponse`
`global___ResourceAccessInformation`
`global___ChannelMapping`
`global___ResolvedPinsOrRelays`

Classes

`PinMap`	Pin map resource type.
`CreatePinMapFromXmlRequest`	Abstract base class for protocol messages.
`UpdatePinMapFromXmlRequest`	Abstract base class for protocol messages.
`GetPinMapRequest`	Abstract base class for protocol messages.
`QueryPinsRequest`	Abstract base class for protocol messages.
`QueryPinsResponse`	Abstract base class for protocol messages.
`PinDefinition`	Abstract base class for protocol messages.
`PinGroupDefinition`	Abstract base class for protocol messages.
`QueryRelaysRequest`	Abstract base class for protocol messages.
`QueryRelaysResponse`	Abstract base class for protocol messages.
`RelayDefinition`	Abstract base class for protocol messages.
`RelayGroupDefinition`	Abstract base class for protocol messages.
`QueryResourceAccessInformationRequest`	Abstract base class for protocol messages.
`QueryResourceAccessInformationResponse`	Abstract base class for protocol messages.
`ResourceAccessInformation`	Abstract base class for protocol messages.
`ChannelMapping`	Abstract base class for protocol messages.
`ResolvedPinsOrRelays`	Abstract base class for protocol messages.

Package Contents

ni.measurementlink.pinmap.v1.pin_map_service_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class ni.measurementlink.pinmap.v1.pin_map_service_pb2.PinMap(*, pin_map_id=...)

Bases: google.protobuf.message.Message

Pin map resource type.

Parameters:: pin_map_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PIN_MAP_ID_FIELD_NUMBER: int

pin_map_id: str: Output only. The resource id of the registered pin map resource.

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, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___PinMap

class ni.measurementlink.pinmap.v1.pin_map_service_pb2.CreatePinMapFromXmlRequest(*, pin_map_id=..., pin_map_xml=...)

Bases: 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.

Parameters:

pin_map_id (str)
pin_map_xml (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PIN_MAP_ID_FIELD_NUMBER: int

PIN_MAP_XML_FIELD_NUMBER: int

pin_map_id: str: Required. The resource id of the pin map to register as a pin map resource.

pin_map_xml: str: Required. A string representing contents of a pin map file.

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, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___CreatePinMapFromXmlRequest

class ni.measurementlink.pinmap.v1.pin_map_service_pb2.UpdatePinMapFromXmlRequest(*, pin_map_id=..., pin_map_xml=...)

Bases: 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.

Parameters:

pin_map_id (str)
pin_map_xml (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PIN_MAP_ID_FIELD_NUMBER: int

PIN_MAP_XML_FIELD_NUMBER: int

pin_map_id: str: Required. The resource id of the pin map to be updated.

pin_map_xml: str: Required. New pin map file content.

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, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___UpdatePinMapFromXmlRequest

class ni.measurementlink.pinmap.v1.pin_map_service_pb2.GetPinMapRequest(*, pin_map_id=...)

Bases: 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.

Parameters:: pin_map_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PIN_MAP_ID_FIELD_NUMBER: int

pin_map_id: str: Required. The resource id of the registered pin map resource.

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, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___GetPinMapRequest

class ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryPinsRequest(*, pin_map_id=..., instrument_type_id=...)

Bases: 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.

Parameters:

pin_map_id (str)
instrument_type_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PIN_MAP_ID_FIELD_NUMBER: int

INSTRUMENT_TYPE_ID_FIELD_NUMBER: int

pin_map_id: str: Required. The resource id of the registered pin map resource.

instrument_type_id: 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.

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, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___QueryPinsRequest

class ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryPinsResponse(*, pins=..., pin_groups=...)

Bases: 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.

Parameters:

pins (collections.abc.Iterable[global___PinDefinition] | None)
pin_groups (collections.abc.Iterable[global___PinGroupDefinition] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PINS_FIELD_NUMBER: int

PIN_GROUPS_FIELD_NUMBER: int

property pins: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___PinDefinition]

List of pins on the registered pin map resource. This list includes both DUT and System pins.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___PinDefinition]

property pin_groups: 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.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___PinGroupDefinition]

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, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___QueryPinsResponse

class ni.measurementlink.pinmap.v1.pin_map_service_pb2.PinDefinition(*, display_name=..., is_system_pin=...)

Bases: 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.

Parameters:

display_name (str)
is_system_pin (bool)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

DISPLAY_NAME_FIELD_NUMBER: int

IS_SYSTEM_PIN_FIELD_NUMBER: int

display_name: str: Name of the dut pin.

is_system_pin: bool: A boolean that indicates a System pin when ‘true’, or DUT pin when ‘false’.

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, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___PinDefinition

class ni.measurementlink.pinmap.v1.pin_map_service_pb2.PinGroupDefinition(*, display_name=..., pin_or_group_references=..., resolved_pins=...)

Bases: 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.

Parameters:

display_name (str)
pin_or_group_references (collections.abc.Iterable[str] | None)
resolved_pins (collections.abc.Iterable[str] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

DISPLAY_NAME_FIELD_NUMBER: int

PIN_OR_GROUP_REFERENCES_FIELD_NUMBER: int

RESOLVED_PINS_FIELD_NUMBER: int

display_name: str: Name of the pin group.

property pin_or_group_references: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

List of other pins or pin groups within this pin group.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property resolved_pins: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

Distinct union of pins within this pin group, including those within nested pin groups.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

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, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___PinGroupDefinition

class ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryRelaysRequest(*, pin_map_id=...)

Bases: 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.

Parameters:: pin_map_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PIN_MAP_ID_FIELD_NUMBER: int

pin_map_id: str: Required. The resource id of the registered pin map resource.

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, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___QueryRelaysRequest

class ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryRelaysResponse(*, relays=..., relay_groups=...)

Bases: 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.

Parameters:

relays (collections.abc.Iterable[global___RelayDefinition] | None)
relay_groups (collections.abc.Iterable[global___RelayGroupDefinition] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

RELAYS_FIELD_NUMBER: int

RELAY_GROUPS_FIELD_NUMBER: int

property relays: 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.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___RelayDefinition]

property relay_groups: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___RelayGroupDefinition]

List of relay groups on the registered pin map resource.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___RelayGroupDefinition]

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, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___QueryRelaysResponse

class ni.measurementlink.pinmap.v1.pin_map_service_pb2.RelayDefinition(*, display_name=..., is_system_relay=...)

Bases: 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.

Parameters:

display_name (str)
is_system_relay (bool)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

DISPLAY_NAME_FIELD_NUMBER: int

IS_SYSTEM_RELAY_FIELD_NUMBER: int

display_name: str: Name of the relay.

is_system_relay: bool: A boolean that indicates a System relay when ‘true’, or Site relay when ‘false’.

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, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___RelayDefinition

class ni.measurementlink.pinmap.v1.pin_map_service_pb2.RelayGroupDefinition(*, display_name=..., relay_or_group_references=..., resolved_relays=...)

Bases: 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.

Parameters:

display_name (str)
relay_or_group_references (collections.abc.Iterable[str] | None)
resolved_relays (collections.abc.Iterable[str] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

DISPLAY_NAME_FIELD_NUMBER: int

RELAY_OR_GROUP_REFERENCES_FIELD_NUMBER: int

RESOLVED_RELAYS_FIELD_NUMBER: int

display_name: str: Name of the relay group.

property relay_or_group_references: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

List of other relays or relay groups within this relay group.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property resolved_relays: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

Distinct union of relays within this relay group, including those within nested relay groups.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

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, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___RelayGroupDefinition

class ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryResourceAccessInformationRequest(*, pin_map_id=..., sites=..., pin_or_relay_names=..., instrument_type_id=...)

Bases: 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.

Parameters:

pin_map_id (str)
sites (collections.abc.Iterable[int] | None)
pin_or_relay_names (collections.abc.Iterable[str] | None)
instrument_type_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PIN_MAP_ID_FIELD_NUMBER: int

SITES_FIELD_NUMBER: int

PIN_OR_RELAY_NAMES_FIELD_NUMBER: int

INSTRUMENT_TYPE_ID_FIELD_NUMBER: int

pin_map_id: str: Required. The resource id of the registered pin map resource.

instrument_type_id: 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.

property sites: 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.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[int]

property pin_or_relay_names: 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.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

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, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___QueryResourceAccessInformationRequest

class ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryResourceAccessInformationResponse(*, resource_access_information=..., group_mappings=...)

Bases: 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.

Parameters:

resource_access_information (collections.abc.Iterable[global___ResourceAccessInformation] | None)
group_mappings (collections.abc.Mapping[str, global___ResolvedPinsOrRelays] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

class GroupMappingsEntry(*, key=..., value=...)

Bases: 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.

Parameters:

key (str)
value (global___ResolvedPinsOrRelays | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

KEY_FIELD_NUMBER: int

VALUE_FIELD_NUMBER: int

key: str

property value: global___ResolvedPinsOrRelays

Return type:: global___ResolvedPinsOrRelays

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, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

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, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

RESOURCE_ACCESS_INFORMATION_FIELD_NUMBER: int

GROUP_MAPPINGS_FIELD_NUMBER: int

property resource_access_information: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ResourceAccessInformation]

List of ResourceAccessInformation objects with instrument resource names and channels.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ResourceAccessInformation]

property group_mappings: google.protobuf.internal.containers.MessageMap[str, global___ResolvedPinsOrRelays]

Represents the mapping between pin or relay groups and their respective pin or relay names.

Return type:: google.protobuf.internal.containers.MessageMap[str, global___ResolvedPinsOrRelays]

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, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___QueryResourceAccessInformationResponse

class ni.measurementlink.pinmap.v1.pin_map_service_pb2.ResourceAccessInformation(*, resource_name=..., channel_list=..., instrument_type_id=..., channel_mappings=...)

Bases: 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.

Parameters:

resource_name (str)
channel_list (str)
instrument_type_id (str)
channel_mappings (collections.abc.Iterable[global___ChannelMapping] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

RESOURCE_NAME_FIELD_NUMBER: int

CHANNEL_LIST_FIELD_NUMBER: int

INSTRUMENT_TYPE_ID_FIELD_NUMBER: int

CHANNEL_MAPPINGS_FIELD_NUMBER: int

resource_name: str: Name of the instrument resource. This string is used for initializing the driver session.

channel_list: 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 <instrument_name>/<channel>, 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 <site_number>/<pin>, 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”.

instrument_type_id: 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.

property channel_mappings: 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.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ChannelMapping]

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, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___ResourceAccessInformation

class ni.measurementlink.pinmap.v1.pin_map_service_pb2.ChannelMapping(*, pin_or_relay_name=..., site=..., channel=..., multiplexer_resource_name=..., multiplexer_route=..., multiplexer_type_id=...)

Bases: 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.

Parameters:

pin_or_relay_name (str)
site (int)
channel (str)
multiplexer_resource_name (str)
multiplexer_route (str)
multiplexer_type_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PIN_OR_RELAY_NAME_FIELD_NUMBER: int

SITE_FIELD_NUMBER: int

CHANNEL_FIELD_NUMBER: int

MULTIPLEXER_RESOURCE_NAME_FIELD_NUMBER: int

MULTIPLEXER_ROUTE_FIELD_NUMBER: int

MULTIPLEXER_TYPE_ID_FIELD_NUMBER: int

pin_or_relay_name: str: The pin or relay that is mapped to a channel.

site: 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.

channel: str: The channel to which the pin or relay is mapped on this site.

multiplexer_resource_name: str: The multiplexer resource name is used to open the multiplexer session in the driver.

multiplexer_route: str: The multiplexer route through which the pin is connected to an instrument’s channel.

multiplexer_type_id: str: User-defined identifier for the multiplexer type in the pin map editor.

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, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___ChannelMapping

class ni.measurementlink.pinmap.v1.pin_map_service_pb2.ResolvedPinsOrRelays(*, pin_or_relay_names=...)

Bases: 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.

Parameters:: pin_or_relay_names (collections.abc.Iterable[str] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PIN_OR_RELAY_NAMES_FIELD_NUMBER: int

property pin_or_relay_names: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

List of pin or relay names in the pin or relay group.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

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, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurementlink.pinmap.v1.pin_map_service_pb2.global___ResolvedPinsOrRelays