Class ResetDevice

Namespace

Bonsai.Harp

Assembly

Bonsai.Harp.dll

Represents a register that resets the device and saves non-volatile registers.

public class ResetDevice

Inheritance

object

ResetDevice

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 ResetDevice register. This field is constant.

public const int Address = 11

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, ResetFlags)

Returns a Harp message for the ResetDevice register.

public static HarpMessage FromPayload(MessageType messageType, ResetFlags value)

Parameters

messageType MessageType

The type of the Harp message.

value ResetFlags

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, ResetFlags)

Returns a timestamped Harp message for the ResetDevice register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value ResetFlags

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for ResetDevice register messages.

public static ResetFlags GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

ResetFlags

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for ResetDevice register messages.

public static Timestamped<ResetFlags> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<ResetFlags>

A value representing the timestamped message payload.