ni.measurementlink.measurement.v2.measurement_service_pb2

Attributes

`DESCRIPTOR`
`global___GetMetadataRequest`
`global___GetMetadataResponse`
`global___MeasureRequest`
`global___MeasureResponse`
`global___MeasurementDetails`
`global___MeasurementSignature`
`global___UserInterfaceDetails`
`global___ConfigurationParameter`
`global___Output`

Classes

`GetMetadataRequest`	Abstract base class for protocol messages.
`GetMetadataResponse`	Abstract base class for protocol messages.
`MeasureRequest`	Abstract base class for protocol messages.
`MeasureResponse`	Abstract base class for protocol messages.
`MeasurementDetails`	Message that contains standard information reported by a measurement.
`MeasurementSignature`	Message that defines the signature of a measurement.
`UserInterfaceDetails`	Contains measurement User Interface details.
`ConfigurationParameter`	Message that defines a configuration parameter for the measurement.
`Output`	Message that defines an output of the measurement.

Package Contents

ni.measurementlink.measurement.v2.measurement_service_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class ni.measurementlink.measurement.v2.measurement_service_pb2.GetMetadataRequest

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.

DESCRIPTOR: google.protobuf.descriptor.Descriptor

ni.measurementlink.measurement.v2.measurement_service_pb2.global___GetMetadataRequest

class ni.measurementlink.measurement.v2.measurement_service_pb2.GetMetadataResponse(*, measurement_details=..., measurement_signature=..., user_interface_details=...)

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:

measurement_details (global___MeasurementDetails | None)
measurement_signature (global___MeasurementSignature | None)
user_interface_details (collections.abc.Iterable[global___UserInterfaceDetails] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

MEASUREMENT_DETAILS_FIELD_NUMBER: int

MEASUREMENT_SIGNATURE_FIELD_NUMBER: int

USER_INTERFACE_DETAILS_FIELD_NUMBER: int

property measurement_details: global___MeasurementDetails

Required. Specifies basic information about the measurement.

Return type:: global___MeasurementDetails

property measurement_signature: global___MeasurementSignature

Required. Specifies the signature of the measurement.

Return type:: global___MeasurementSignature

property user_interface_details: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___UserInterfaceDetails]

Optional. Specifies the user interfaces available for use with the measurement, if any.

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

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

ni.measurementlink.measurement.v2.measurement_service_pb2.global___GetMetadataResponse

class ni.measurementlink.measurement.v2.measurement_service_pb2.MeasureRequest(*, configuration_parameters=..., pin_map_context=...)

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:

configuration_parameters (google.protobuf.any_pb2.Any | None)
pin_map_context (ni.measurementlink.pin_map_context_pb2.PinMapContext | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

CONFIGURATION_PARAMETERS_FIELD_NUMBER: int

PIN_MAP_CONTEXT_FIELD_NUMBER: int

property configuration_parameters: google.protobuf.any_pb2.Any

Required. Specifies the configuration to be used for the measurement. Each measurement will define its own set of required and optional parameters and generate errors as appropriate if the configuration does not conform to valid input ranges.

Return type:: google.protobuf.any_pb2.Any

property pin_map_context: ni.measurementlink.pin_map_context_pb2.PinMapContext

Optional. Specifies the pin map context for the measurement, if any. This field is optional in that callers may not always have a pin map context available to include in the request message. Each measurement will define if a valid pin map context is required in order to run or not and generate errors appropriately.

Return type:: ni.measurementlink.pin_map_context_pb2.PinMapContext

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

ni.measurementlink.measurement.v2.measurement_service_pb2.global___MeasureRequest

class ni.measurementlink.measurement.v2.measurement_service_pb2.MeasureResponse(*, outputs=...)

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:: outputs (google.protobuf.any_pb2.Any | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

OUTPUTS_FIELD_NUMBER: int

property outputs: google.protobuf.any_pb2.Any

Required. Includes the output results from running the measurement. This field is required in that all measurements should return a valid output message even if it is just an empty message with no fields. Each measurement will define which of its output fields are required and which are optional based on the configuration for the measurement.

Return type:: google.protobuf.any_pb2.Any

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

ni.measurementlink.measurement.v2.measurement_service_pb2.global___MeasureResponse

class ni.measurementlink.measurement.v2.measurement_service_pb2.MeasurementDetails(*, display_name=..., version=...)

Bases: google.protobuf.message.Message

Message that contains standard information reported by a measurement.

Parameters:

display_name (str)
version (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

DISPLAY_NAME_FIELD_NUMBER: int

VERSION_FIELD_NUMBER: int

display_name: str: Required. The user visible name of the measurement.

version: str: Optional. The current version of the measurement.

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.measurement.v2.measurement_service_pb2.global___MeasurementDetails

class ni.measurementlink.measurement.v2.measurement_service_pb2.MeasurementSignature(*, configuration_parameters_message_type=..., configuration_parameters=..., configuration_defaults=..., outputs_message_type=..., outputs=...)

Bases: google.protobuf.message.Message

Message that defines the signature of a measurement.

Parameters:

configuration_parameters_message_type (str)
configuration_parameters (collections.abc.Iterable[global___ConfigurationParameter] | None)
configuration_defaults (google.protobuf.any_pb2.Any | None)
outputs_message_type (str)
outputs (collections.abc.Iterable[global___Output] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

CONFIGURATION_PARAMETERS_MESSAGE_TYPE_FIELD_NUMBER: int

CONFIGURATION_PARAMETERS_FIELD_NUMBER: int

CONFIGURATION_DEFAULTS_FIELD_NUMBER: int

OUTPUTS_MESSAGE_TYPE_FIELD_NUMBER: int

OUTPUTS_FIELD_NUMBER: int

configuration_parameters_message_type: str: Required. The type name of the message used to define the measurement’s configuration. This is the gRPC full name for the message.

outputs_message_type: str: Required. The type name of the message used to define the measurement’s outputs. This is the gRPC full name for the message.

property configuration_parameters: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ConfigurationParameter]

Required. Defines the configuration parameters for the measurement.

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

property configuration_defaults: google.protobuf.any_pb2.Any

Optional. The default values to use for the configuration parameters. Caller can use these default values rather than specifying their own. These values should be supplied using the message type defined by configuration_parameters_message_type.

Return type:: google.protobuf.any_pb2.Any

property outputs: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Output]

Required. Defines the outputs for the measurement.

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

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

ni.measurementlink.measurement.v2.measurement_service_pb2.global___MeasurementSignature

class ni.measurementlink.measurement.v2.measurement_service_pb2.UserInterfaceDetails(*, file_url=...)

Bases: google.protobuf.message.Message

Contains measurement User Interface details.

Parameters:: file_url (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

FILE_URL_FIELD_NUMBER: int

file_url: str: Optional. The URL to the file (such as .measui or .vi) providing a user interface for the measurement.

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.measurement.v2.measurement_service_pb2.global___UserInterfaceDetails

class ni.measurementlink.measurement.v2.measurement_service_pb2.ConfigurationParameter(*, field_number=..., type=..., name=..., repeated=..., annotations=..., message_type=...)

Bases: google.protobuf.message.Message

Message that defines a configuration parameter for the measurement.

Parameters:

field_number (int)
type (google.protobuf.type_pb2.Field.Kind.ValueType)
name (str)
repeated (bool)
annotations (collections.abc.Mapping[str, str] | None)
message_type (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

class AnnotationsEntry(*, 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 (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

KEY_FIELD_NUMBER: int

VALUE_FIELD_NUMBER: int

key: str

value: 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

FIELD_NUMBER_FIELD_NUMBER: int

TYPE_FIELD_NUMBER: int

NAME_FIELD_NUMBER: int

REPEATED_FIELD_NUMBER: int

ANNOTATIONS_FIELD_NUMBER: int

MESSAGE_TYPE_FIELD_NUMBER: int

field_number: int: Required. The field number for the configuration parameter as defined by the message indicated by MethodSignature.configuration_parameters_message_type.

type: google.protobuf.type_pb2.Field.Kind.ValueType: Required. The data type for the configuration parameter. NOTE: If this is Kind.TypeMessage, you must also fill in the ‘message_type’ field below with the gRPC full name of the message.

name: str: Required. The name of the configuration parameter. When defining a user interface for the measurement, a control that matches this name will be used to supply a value to this configuration parameter.

repeated: bool: Required. True if this configuration parameter represents repeated data and False if it represents a scalar value.

message_type: str: Required when ‘type’ is Kind.TypeMessage. Ignored for any other ‘type’. This is the gRPC full name of the message type.

property annotations: google.protobuf.internal.containers.ScalarMap[str, str]

Optional. Represents a set of annotations on the type.

Well-known annotations:

Type specialization. The keys to other annotations will be read based on the value of ni/type_specialization annotation.
- Key: “ni/type_specialization”
- Common Values: “ioresource”, “path”, “enum”…
- “ioresource” and “path” parameters require the type field to be TYPE_STRING.
- “enum” parameters requires the type field to be TYPE_ENUM.
For string parameter with ni/type_specialization annotation equals “ioresource”, the “ni/ioresource.instrument_type” annotation will be used by UIs to limit selection of I/O to the specified instrument type.
- Key: “ni/ioresource.instrument_type”
- Common Values: “niDCPower”, “niScope”…
For enum parameter with ni/type_specialization annotation equals “enum”
- Key: “ni/enum.values”
- Expected format: JSON dictionary string”
- Example: “{"RED":0, "GREEN":25, "BLUE":5}”

Return type:: google.protobuf.internal.containers.ScalarMap[str, 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.measurement.v2.measurement_service_pb2.global___ConfigurationParameter

class ni.measurementlink.measurement.v2.measurement_service_pb2.Output(*, field_number=..., type=..., name=..., repeated=..., annotations=..., message_type=...)

Bases: google.protobuf.message.Message

Message that defines an output of the measurement.

Parameters:

field_number (int)
type (google.protobuf.type_pb2.Field.Kind.ValueType)
name (str)
repeated (bool)
annotations (collections.abc.Mapping[str, str] | None)
message_type (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

class AnnotationsEntry(*, 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 (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

KEY_FIELD_NUMBER: int

VALUE_FIELD_NUMBER: int

key: str

value: 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

FIELD_NUMBER_FIELD_NUMBER: int

TYPE_FIELD_NUMBER: int

NAME_FIELD_NUMBER: int

REPEATED_FIELD_NUMBER: int

ANNOTATIONS_FIELD_NUMBER: int

MESSAGE_TYPE_FIELD_NUMBER: int

field_number: int: Required. The field number for the output as defined by the message indicated by MethodSignature.outputs_message_type.

type: google.protobuf.type_pb2.Field.Kind.ValueType: Required. The data type for the output. NOTE: If this is Kind.TypeMessage, you must also fill in the ‘message_type’ field below with the gRPC full name of the message.

name: str: Required. The name of the output. When defining a user interface for the measurement, an indicator that matches this name will be used to display the value for this output.

repeated: bool: Required. True if this output represents repeated data and False if it represents a scalar value.

message_type: str: Required when ‘type’ is Kind.TypeMessage. Ignored for any other ‘type’. This is the gRPC full name of the message type.

property annotations: google.protobuf.internal.containers.ScalarMap[str, str]

Optional. Represents a set of annotations on the type. See documentation for ConfigurationParameter annotations for more details and examples.

Return type:: google.protobuf.internal.containers.ScalarMap[str, 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.measurement.v2.measurement_service_pb2.global___Output