Class DeviceName

Namespace

Bonsai.Harp

Assembly

Bonsai.Harp.dll

Represents a register that stores the user-specified device name.

public class DeviceName

Inheritance

object

DeviceName

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

public const int Address = 12

Field Value

int

RegisterLength

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

public const int RegisterLength = 25

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, string)

Returns a Harp message for the DeviceName register.

public static HarpMessage FromPayload(MessageType messageType, string value)

Parameters

messageType MessageType

The type of the Harp message.

value string

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, string)

Returns a timestamped Harp message for the DeviceName register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value string

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for DeviceName register messages.

public static string GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

string

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for DeviceName register messages.

public static Timestamped<string> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<string>

A value representing the timestamped message payload.