Class WhoAmI

Namespace

Bonsai.Harp

Assembly

Bonsai.Harp.dll

Represents a register that specifies the identity class of the device.

public class WhoAmI

Inheritance

object

WhoAmI

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

public const int Address = 0

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U16

Field Value

PayloadType

Methods

FromPayload(MessageType, int)

Returns a Harp message for the WhoAmI register.

public static HarpMessage FromPayload(MessageType messageType, int value)

Parameters

messageType MessageType

The type of the Harp message.

value int

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, int)

Returns a timestamped Harp message for the WhoAmI register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value int

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for WhoAmI register messages.

public static int GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

int

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for WhoAmI register messages.

public static Timestamped<int> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<int>

A value representing the timestamped message payload.