Class OperationControl

Namespace

Bonsai.Harp

Assembly

Bonsai.Harp.dll

Represents a register that stores the configuration mode of the device.

public class OperationControl

Inheritance

object

OperationControl

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Fields

Address

Represents the address of the OperationControl register. This field is constant.

public const int Address = 10

Field Value

int

RegisterLength

Represents the length of the OperationControl register. This field is constant.

public const int RegisterLength = 1

Field Value

int

RegisterType

Represents the payload type of the OperationControl register. This field is constant.

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, OperationControlPayload)

Returns a Harp message for the OperationControl register.

public static HarpMessage FromPayload(MessageType messageType, OperationControlPayload value)

Parameters

messageType MessageType

The type of the Harp message.

value OperationControlPayload

The value to be stored in the message payload.

Returns

HarpMessage

A HarpMessage object for the OperationControl register with the specified message type and payload.

FromPayload(double, MessageType, OperationControlPayload)

Returns a timestamped Harp message for the OperationControl register.

public static HarpMessage FromPayload(double timestamp, MessageType messageType, OperationControlPayload value)

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value OperationControlPayload

The value to be stored in the message payload.

Returns

HarpMessage

A HarpMessage object for the OperationControl register with the specified message type, timestamp, and payload.

GetPayload(HarpMessage)

Returns the payload data for OperationControl register messages.

public static OperationControlPayload GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

OperationControlPayload

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for OperationControl register messages.

public static Timestamped<OperationControlPayload> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<OperationControlPayload>

A value representing the timestamped message payload.