nitypes.scalar.Scalar

class nitypes.scalar.Scalar(value: TScalar_co, units: str = '')

Bases: Generic[TScalar_co]

A scalar data class, which encapsulates scalar data and units information.

Constructing

To construct a scalar data object, use the Scalar class:

>>> Scalar(False)
nitypes.scalar.Scalar(value=False, units='')
>>> Scalar(0)
nitypes.scalar.Scalar(value=0, units='')
>>> Scalar(5.0, 'volts')
nitypes.scalar.Scalar(value=5.0, units='volts')
>>> Scalar("value", "volts")
nitypes.scalar.Scalar(value='value', units='volts')

Class members

__slots__ = ['_value', '_extended_properties']

property value: TScalar_co

The scalar value.

Return type:: TScalar_co

property units: str

The unit of measurement, such as volts, of the scalar.

Return type:: str

property extended_properties: nitypes.waveform.ExtendedPropertyDictionary

The extended properties for the scalar.

Note

Data stored in the extended properties dictionary may not be encrypted when you send it over the network or write it to a TDMS file.

Return type:: nitypes.waveform.ExtendedPropertyDictionary

__eq__(value: object, /) → bool

Return self==value.

Parameters:: value (object)
Return type:: bool

__gt__(value: Scalar[TScalar_co]) → bool

Return self > value.

Parameters:: value (Scalar[TScalar_co])
Return type:: bool

__ge__(value: Scalar[TScalar_co]) → bool

Return self >= value.

Parameters:: value (Scalar[TScalar_co])
Return type:: bool

__lt__(value: Scalar[TScalar_co]) → bool

Return self < value.

Parameters:: value (Scalar[TScalar_co])
Return type:: bool

__le__(value: Scalar[TScalar_co]) → bool

Return self <= value.

Parameters:: value (Scalar[TScalar_co])
Return type:: bool

__reduce__() → tuple[Any, Ellipsis]

Return object state for pickling.

Return type:: tuple[Any, Ellipsis]

__repr__() → str

Return repr(self).

Return type:: str

__str__() → str

Return str(self).

Return type:: str

Parameters:

value (TScalar_co)
units (str)