Method FromUInt16

Namespace

Bonsai.Harp

Assembly

Bonsai.Harp.dll

FromUInt16(int, MessageType, ushort)

Returns a HarpMessage with the specified address, message type, and a single value 16-bit unsigned integer payload.

public static HarpMessage FromUInt16(int address, MessageType messageType, ushort value)

Parameters

address int

The address of the register to which the Harp message refers to.

messageType MessageType

The type of the Harp message.

value ushort

The value to be stored in the payload.

Returns

HarpMessage

A valid HarpMessage instance with the specified address, message type and payload.

FromUInt16(int, int, MessageType, ushort)

Returns a HarpMessage with the specified address, message type, port, and a single value 16-bit unsigned integer payload.

public static HarpMessage FromUInt16(int address, int port, MessageType messageType, ushort value)

Parameters

address int

The address of the register to which the Harp message refers to.

port int

The origin or destination of the Harp message, for routing purposes.

messageType MessageType

The type of the Harp message.

value ushort

The value to be stored in the payload.

Returns

HarpMessage

A valid HarpMessage instance with the specified address, message type, port, and payload.

FromUInt16(int, double, MessageType, ushort)

Returns a HarpMessage with the specified address, message type, timestamp, and a single value 16-bit unsigned integer payload.

public static HarpMessage FromUInt16(int address, double timestamp, MessageType messageType, ushort value)

Parameters

address int

The address of the register to which the Harp message refers to.

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value ushort

The value to be stored in the payload.

Returns

HarpMessage

A valid HarpMessage instance with the specified address, message type, timestamp, and payload.

FromUInt16(int, int, double, MessageType, ushort)

Returns a HarpMessage with the specified address, message type, port, timestamp, and a single value 16-bit unsigned integer payload.

public static HarpMessage FromUInt16(int address, int port, double timestamp, MessageType messageType, ushort value)

Parameters

address int

The address of the register to which the Harp message refers to.

port int

The origin or destination of the Harp message, for routing purposes.

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value ushort

The value to be stored in the payload.

Returns

HarpMessage

A valid HarpMessage instance with the specified address, message type, port, timestamp, and payload.

FromUInt16(int, MessageType, params ushort[])

Returns a HarpMessage with the specified address, message type, and an array payload of 16-bit unsigned integers.

public static HarpMessage FromUInt16(int address, MessageType messageType, params ushort[] values)

Parameters

address int

The address of the register to which the Harp message refers to.

messageType MessageType

The type of the Harp message.

values ushort[]

The values to be stored in the payload.

Returns

HarpMessage

A valid HarpMessage instance with the specified address, message type and payload.

FromUInt16(int, int, MessageType, params ushort[])

Returns a HarpMessage with the specified address, message type, port, and an array payload of 16-bit unsigned integers.

public static HarpMessage FromUInt16(int address, int port, MessageType messageType, params ushort[] values)

Parameters

address int

The address of the register to which the Harp message refers to.

port int

The origin or destination of the Harp message, for routing purposes.

messageType MessageType

The type of the Harp message.

values ushort[]

The values to be stored in the payload.

Returns

HarpMessage

A valid HarpMessage instance with the specified address, message type, port, and payload.

FromUInt16(int, double, MessageType, params ushort[])

Returns a HarpMessage with the specified address, message type, timestamp, and an array payload of 16-bit unsigned integers.

public static HarpMessage FromUInt16(int address, double timestamp, MessageType messageType, params ushort[] values)

Parameters

address int

The address of the register to which the Harp message refers to.

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

values ushort[]

The values to be stored in the payload.

Returns

HarpMessage

A valid HarpMessage instance with the specified address, message type, timestamp, and payload.

FromUInt16(int, int, double, MessageType, params ushort[])

Returns a HarpMessage with the specified address, message type, port, timestamp, and an array payload of 16-bit unsigned integers.

public static HarpMessage FromUInt16(int address, int port, double timestamp, MessageType messageType, params ushort[] values)

Parameters

address int

The address of the register to which the Harp message refers to.

port int

The origin or destination of the Harp message, for routing purposes.

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

values ushort[]

The values to be stored in the payload.

Returns

HarpMessage

A valid HarpMessage instance with the specified address, message type, port, timestamp, and payload.