ni_measurementlink_service.measurement.info
Contains classes and enums to represent measurement metadata.
Module Contents
Classes
Class that represents the measurement information. |
|
Class the represents the service information. |
|
Enum that represents the type specializations for measurement parameters. |
|
Enum that represents the supported data types. |
- class ni_measurementlink_service.measurement.info.MeasurementInfo[source]
Bases:
NamedTupleClass 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:
NamedTupleClass 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.EnumEnum that represents the type specializations for measurement parameters.
- NoType =
- Pin = pin
- Path = path
- class ni_measurementlink_service.measurement.info.DataType[source]
Bases:
enum.EnumEnum 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