Skip to content

Latest commit

 

History

History
216 lines (128 loc) · 4.79 KB

datatypes.rst

File metadata and controls

216 lines (128 loc) · 4.79 KB
Raw

NI VeriStand Data types

niveristand.clientapi.BooleanValue

Valid initialization values:

  • bool: True, False
  • string: 'true', 'false', 'True', 'False'
  • int, float: every valid value

Examples:

a = BooleanValue(True)
a = BooleanValue(1.0)
a = BooleanValue(1)

niveristand.clientapi.BooleanValueArray

Valid initialization values:

  • a list of valid BooleanValue initializers.

Examples:

a = BooleanValueArray([True, False])
a = BooleanValueArray([1.0, 0.0])

niveristand.clientapi.ChannelReference

Valid initialization values:

  • string: the path or alias for the channel.

Examples:

a = ChannelReference('Aliases/DesiredRPM')
a = ChannelReference('Targets/Controller/Simulation Models/Models/Engine Demo/Inports/command_RPM')

niveristand.clientapi.DoubleValue

Valid initialization values:

  • (int, float): all valid values.
  • bool: True (1.0), False (0.0)

Non-float values are converted to their closest floating-point representation. Scientific notation is supported.

Examples:

a = DoubleValue(3.1415)
a = DoubleValue(0xFFFF)
a = DoubleValue(True)

niveristand.clientapi.DoubleValueArray

Valid initialization values:

  • a list of valid DoubleValue initializers.

Examples:

a = DoubleValueArray([1, 2.0, 0.3, 0x40])

niveristand.clientapi.I32Value

Valid initialization values:

  • (int, float): [-2,147,483,648 to 2,147,483,647]
  • bool: True (1), False (0)

Floating-point values are rounded down. Scientific notation is supported.

Examples:

a = I32Value(3)
a = I32Value(3.1415)
a = I32Value(0x7FFFFFFF)
a = I32Value(True)

niveristand.clientapi.I32ValueArray

Valid initialization values:

  • a list of valid I32Value initializers.

Examples:

a = I32ValueArray([3, 3.1415, 0x7FFFFFFF, True])

niveristand.clientapi.I64Value

Valid initialization values:

  • (int, float): [–9,223,372,036,854,775,808 to 9,223,372,036,854,775,807]
  • bool: True (1), False (0)

Floating-point values are rounded down. Scientific notation is supported.

Examples:

a = I64Value(3)
a = I64Value(3.1415)
a = I64Value(0x7FFFFFFFFFFFFFFF)
a = I64Value(-9.2e18)
a = I64Value(True)

niveristand.clientapi.I64ValueArray

Valid initialization values:

  • a list of valid I64Value initializers.

Examples:

a = I64ValueArray([3, 3.1415, 0x7FFFFFFFFFFFFFFF, -9.2e18, True])

niveristand.clientapi.U32Value

Valid initialization values:

  • (int, float): [0 to 4,294,967,295]
  • bool: True (1), False (0)

Floating-point values are rounded down. Scientific notation is supported.

Examples:

a = U32Value(3)
a = U32Value(3.1415)
a = U32Value(0xFFFFFFFF)
a = U32Value(True)

niveristand.clientapi.U32ValueArray

Valid initialization values:

  • a list of valid U32Value initializers.

Examples:

a = U32ValueArray([3, 3.1415, 0xFFFFFFFF, True])

niveristand.clientapi.U64Value

Valid initialization values:

  • (int, float): [0 to 18,446,744,073,709,551,615]
  • bool: True (1), False (0)

Floating-point values are rounded down. Scientific notation is supported.

Examples:

a = U64Value(3)
a = U64Value(3.1415)
a = U64Value(0x7FFFFFFFFFFFFFFF)
a = U64Value(18.4e18)
a = U64Value(True)

niveristand.clientapi.U64ValueArray

Valid initialization values:

  • a list of valid U64Value initializers.

Examples:

a = U64ValueArray([3, 3.1415, 0xFFFFFFFFFFFFFFFF, 18.4e18, True])

niveristand.clientapi.VectorChannelReference

Valid initialization values:

  • string: path or alias for the channel.

Examples:

a = VectorChannelReference('engine/a')

niveristand.clientapi._datatypes.rtprimitives.DataType