ni_measurementlink_service
releases/1.0
  • API Reference
    • ni_measurementlink_service
      • Subpackages
        • ni_measurementlink_service.measurement
          • Submodules
            • ni_measurementlink_service.measurement.info
              • Module Contents
                • Classes
                  • MeasurementInfo
                    • MeasurementInfo.display_name
                    • MeasurementInfo.version
                    • MeasurementInfo.ui_file_paths
                  • ServiceInfo
                    • ServiceInfo.service_class
                    • ServiceInfo.description_url
                  • TypeSpecialization
                    • TypeSpecialization.NoType
                    • TypeSpecialization.Pin
                    • TypeSpecialization.Path
                  • DataType
                    • DataType.Int32
                    • DataType.Int64
                    • DataType.UInt32
                    • DataType.UInt64
                    • DataType.Float
                    • DataType.Double
                    • DataType.Boolean
                    • DataType.String
                    • DataType.Pin
                    • DataType.Path
                    • DataType.Int32Array1D
                    • DataType.Int64Array1D
                    • DataType.UInt32Array1D
                    • DataType.UInt64Array1D
                    • DataType.FloatArray1D
                    • DataType.DoubleArray1D
                    • DataType.BooleanArray1D
                    • DataType.StringArray1D
                    • DataType.PinArray1D
                    • DataType.PathArray1D
                  • MeasurementInfo
                  • ServiceInfo
                  • TypeSpecialization
                    • NoType
                    • Pin
                    • Path
                  • DataType
                    • Int32
                    • Int64
                    • UInt32
                    • UInt64
                    • Float
                    • Double
                    • Boolean
                    • String
                    • Pin
                    • Path
                    • Int32Array1D
                    • Int64Array1D
                    • UInt32Array1D
                    • UInt64Array1D
                    • FloatArray1D
                    • DoubleArray1D
                    • BooleanArray1D
                    • StringArray1D
                    • PinArray1D
                    • PathArray1D
            • ni_measurementlink_service.measurement.service
      • Submodules
      • Package Contents
ni_measurementlink_service
  • API Reference
  • ni_measurementlink_service
  • ni_measurementlink_service.measurement
  • ni_measurementlink_service.measurement.info
  • Edit on GitHub

ni_measurementlink_service.measurement.info

Contains classes and enums to represent measurement metadata.

Module Contents

Classes

MeasurementInfo

Class that represents the measurement information.

ServiceInfo

Class the represents the service information.

TypeSpecialization

Enum that represents the type specializations for measurement parameters.

DataType

Enum that represents the supported data types.

class ni_measurementlink_service.measurement.info.MeasurementInfo[source]

Bases: NamedTuple

Class that represents the measurement information.

Attributes

display_name (str): The measurement display name for client to display to user.

version (str): The measurement version that helps to maintain versions of a measurement in future.

ui_file_paths (list): Absolute paths of the UI file(s) linked to the measurement.

display_name :str
version :str
ui_file_paths :List[pathlib.Path]
class ni_measurementlink_service.measurement.info.ServiceInfo[source]

Bases: NamedTuple

Class the represents the service information.

Attributes

service_class (str): Service class that the measurement belongs to. Measurements under same service class expected to perform same logic. For e.g., different version of measurement can come under same service class.

description_url (str): Description URL of the measurement.

service_class :str
description_url :str
class ni_measurementlink_service.measurement.info.TypeSpecialization[source]

Bases: enum.Enum

Enum that represents the type specializations for measurement parameters.

NoType =
Pin = pin
Path = path
class ni_measurementlink_service.measurement.info.DataType[source]

Bases: enum.Enum

Enum that represents the supported data types.

Int32
Int64
UInt32
UInt64
Float
Double
Boolean
String
Pin
Path
Int32Array1D
Int64Array1D
UInt32Array1D
UInt64Array1D
FloatArray1D
DoubleArray1D
BooleanArray1D
StringArray1D
PinArray1D
PathArray1D
Previous Next

© Copyright 2023, National Instruments. Revision 299ad6c0.

Built with Sphinx using a theme provided by Read the Docs.