Class CreateMessagePayload

Namespace

Bonsai.Harp

Assembly

Bonsai.Harp.dll

Represents an operator which creates a sequence of Harp messages with the specified payload.

public class CreateMessagePayload

Inheritance

object

CreateMessagePayload

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Address

Gets or sets the address of the register to which the Harp message refers to.

public int Address { get; set; }

Property Value

int

PayloadType

Gets or sets the type of data to include in the message payload.

public PayloadType PayloadType { get; set; }

Property Value

PayloadType

Value

Gets or sets the data to write in the message payload.

public double Value { get; set; }

Property Value

double

Methods

GetMessage(MessageType)

Creates a new Harp message with the specified payload value.

public HarpMessage GetMessage(MessageType messageType)

Parameters

messageType MessageType

Specifies the type of the created message.

Returns

HarpMessage

A new message containing the value of the payload property.

GetMessage(double, MessageType)

Creates a new timestamped Harp message with the specified payload value.

public HarpMessage GetMessage(double timestamp, MessageType messageType)

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

Specifies the type of the created message.

Returns

HarpMessage

A new timestamped message containing the value of the payload property.