`ni_measurementlink_service._internal.parameter.metadata`

Contains classes that represents metadata.

Module Contents

Classes

ParameterMetadata

Class that represents the metadata of parameters.

Functions

validate_default_value_type(parameter_metadata)

Validate and raise exception if the default value does not match the type info.

class ni_measurementlink_service._internal.parameter.metadata.ParameterMetadata[source]

Bases: NamedTuple

Class that represents the metadata of parameters.

Attributes

display_name (str): The display name of the parameter.

type (type_pb2.Field): The datatype of the parameter represented by the gRPC Field Enum.

repeated (bool): Represent if the parameter is a scalar or 1D array.

True for 1DArray and false for scalar.

default_value (Any): The default value of the parameter.

annotations (Dict[str,str]): Represents a set of annotations on the type.

display_name :str

type :google.protobuf.type_pb2.Field.Kind.ValueType

repeated :bool

default_value :Any

annotations :Dict[str, str]

ni_measurementlink_service._internal.parameter.metadata.validate_default_value_type(parameter_metadata)[source]: Validate and raise exception if the default value does not match the type info.

Args

parameter_metadata (ParameterMetadata): Parameter metadata

Raises

TypeError: If default value does not match the Datatype.