ni.measurementlink.measurement.v1.measurement_service_pb2 ========================================================= .. py:module:: ni.measurementlink.measurement.v1.measurement_service_pb2 Attributes ---------- .. autoapisummary:: ni.measurementlink.measurement.v1.measurement_service_pb2.DESCRIPTOR ni.measurementlink.measurement.v1.measurement_service_pb2.global___GetMetadataRequest ni.measurementlink.measurement.v1.measurement_service_pb2.global___GetMetadataResponse ni.measurementlink.measurement.v1.measurement_service_pb2.global___MeasureRequest ni.measurementlink.measurement.v1.measurement_service_pb2.global___MeasureResponse ni.measurementlink.measurement.v1.measurement_service_pb2.global___MeasurementDetails ni.measurementlink.measurement.v1.measurement_service_pb2.global___MeasurementSignature ni.measurementlink.measurement.v1.measurement_service_pb2.global___UserInterfaceDetails ni.measurementlink.measurement.v1.measurement_service_pb2.global___ConfigurationParameter ni.measurementlink.measurement.v1.measurement_service_pb2.global___Output Classes ------- .. autoapisummary:: ni.measurementlink.measurement.v1.measurement_service_pb2.GetMetadataRequest ni.measurementlink.measurement.v1.measurement_service_pb2.GetMetadataResponse ni.measurementlink.measurement.v1.measurement_service_pb2.MeasureRequest ni.measurementlink.measurement.v1.measurement_service_pb2.MeasureResponse ni.measurementlink.measurement.v1.measurement_service_pb2.MeasurementDetails ni.measurementlink.measurement.v1.measurement_service_pb2.MeasurementSignature ni.measurementlink.measurement.v1.measurement_service_pb2.UserInterfaceDetails ni.measurementlink.measurement.v1.measurement_service_pb2.ConfigurationParameter ni.measurementlink.measurement.v1.measurement_service_pb2.Output Package Contents ---------------- .. py:data:: DESCRIPTOR :type: google.protobuf.descriptor.FileDescriptor .. py:class:: GetMetadataRequest 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:data:: global___GetMetadataRequest .. py:class:: GetMetadataResponse(*, measurement_details = ..., measurement_signature = ..., user_interface_details = ...) 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:: MEASUREMENT_DETAILS_FIELD_NUMBER :type: int .. py:attribute:: MEASUREMENT_SIGNATURE_FIELD_NUMBER :type: int .. py:attribute:: USER_INTERFACE_DETAILS_FIELD_NUMBER :type: int .. py:property:: measurement_details :type: global___MeasurementDetails Required. Specifies basic information about the measurement. .. py:property:: measurement_signature :type: global___MeasurementSignature Required. Specifies the signature of the measurement. .. py:property:: user_interface_details :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___UserInterfaceDetails] Optional. Specifies the user interfaces available for use with the measurement, if any. .. 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:data:: global___GetMetadataResponse .. py:class:: MeasureRequest(*, configuration_parameters = ..., pin_map_context = ...) 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:: CONFIGURATION_PARAMETERS_FIELD_NUMBER :type: int .. py:attribute:: PIN_MAP_CONTEXT_FIELD_NUMBER :type: int .. py:property:: configuration_parameters :type: 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. .. py:property:: pin_map_context :type: 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. .. 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:data:: global___MeasureRequest .. py:class:: MeasureResponse(*, outputs = ...) 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:: OUTPUTS_FIELD_NUMBER :type: int .. py:property:: outputs :type: 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. .. 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:data:: global___MeasureResponse .. py:class:: MeasurementDetails(*, display_name = ..., version = ...) Bases: :py:obj:`google.protobuf.message.Message` Message that contains standard information reported by a measurement. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: DISPLAY_NAME_FIELD_NUMBER :type: int .. py:attribute:: VERSION_FIELD_NUMBER :type: int .. py:attribute:: display_name :type: str Required. The user visible name of the measurement. .. py:attribute:: version :type: str Optional. The current version of the measurement. .. 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___MeasurementDetails .. py:class:: MeasurementSignature(*, configuration_parameters_message_type = ..., configuration_parameters = ..., configuration_defaults = ..., outputs_message_type = ..., outputs = ...) Bases: :py:obj:`google.protobuf.message.Message` Message that defines the signature of a measurement. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: CONFIGURATION_PARAMETERS_MESSAGE_TYPE_FIELD_NUMBER :type: int .. py:attribute:: CONFIGURATION_PARAMETERS_FIELD_NUMBER :type: int .. py:attribute:: CONFIGURATION_DEFAULTS_FIELD_NUMBER :type: int .. py:attribute:: OUTPUTS_MESSAGE_TYPE_FIELD_NUMBER :type: int .. py:attribute:: OUTPUTS_FIELD_NUMBER :type: int .. py:attribute:: configuration_parameters_message_type :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. .. py:attribute:: outputs_message_type :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. .. py:property:: configuration_parameters :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ConfigurationParameter] Required. Defines the configuration parameters for the measurement. .. py:property:: configuration_defaults :type: 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. .. py:property:: outputs :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Output] Required. Defines the outputs for the measurement. .. 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:data:: global___MeasurementSignature .. py:class:: UserInterfaceDetails(*, file_url = ...) Bases: :py:obj:`google.protobuf.message.Message` Contains measurement User Interface details. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: FILE_URL_FIELD_NUMBER :type: int .. py:attribute:: file_url :type: str Optional. The URL to the file (such as .measui or .vi) providing a user interface for the measurement. .. 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___UserInterfaceDetails .. py:class:: ConfigurationParameter(*, field_number = ..., type = ..., name = ..., repeated = ..., annotations = ...) Bases: :py:obj:`google.protobuf.message.Message` Message that defines a configuration parameter for the measurement. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:class:: AnnotationsEntry(*, 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:attribute:: value :type: str .. 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:: FIELD_NUMBER_FIELD_NUMBER :type: int .. py:attribute:: TYPE_FIELD_NUMBER :type: int .. py:attribute:: NAME_FIELD_NUMBER :type: int .. py:attribute:: REPEATED_FIELD_NUMBER :type: int .. py:attribute:: ANNOTATIONS_FIELD_NUMBER :type: int .. py:attribute:: field_number :type: int Required. The field number for the configuration parameter as defined by the message indicated by MethodSignature.configuration_parameters_message_type. .. py:attribute:: type :type: google.protobuf.type_pb2.Field.Kind.ValueType Required. The data type for the configuration parameter. .. py:attribute:: name :type: 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. .. py:attribute:: repeated :type: bool Required. True if this configuration parameter represents repeated data and False if it represents a scalar value. .. py:property:: annotations :type: 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" ... - 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"... .. 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___ConfigurationParameter .. py:class:: Output(*, field_number = ..., type = ..., name = ..., repeated = ...) Bases: :py:obj:`google.protobuf.message.Message` Message that defines an output of the measurement. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: FIELD_NUMBER_FIELD_NUMBER :type: int .. py:attribute:: TYPE_FIELD_NUMBER :type: int .. py:attribute:: NAME_FIELD_NUMBER :type: int .. py:attribute:: REPEATED_FIELD_NUMBER :type: int .. py:attribute:: field_number :type: int Required. The field number for the output as defined by the message indicated by MethodSignature.outputs_message_type. .. py:attribute:: type :type: google.protobuf.type_pb2.Field.Kind.ValueType Required. The data type for the output. .. py:attribute:: name :type: 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. .. py:attribute:: repeated :type: bool Required. True if this output represents repeated data and False if it represents a scalar value. .. 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___Output