Class ExpansionBoard

Namespace

Harp.OutputExpander

Assembly

Harp.OutputExpander.dll

Represents a register that selects the board to be interfaced with via the expansion port.

public class ExpansionBoard

Inheritance

object

ExpansionBoard

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

public const int Address = 87

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, ExpansionBoardType)

Returns a Harp message for the ExpansionBoard register.

public static HarpMessage FromPayload(MessageType messageType, ExpansionBoardType value)

Parameters

messageType MessageType

The type of the Harp message.

value ExpansionBoardType

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, ExpansionBoardType)

Returns a timestamped Harp message for the ExpansionBoard register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value ExpansionBoardType

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for ExpansionBoard register messages.

public static ExpansionBoardType GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

ExpansionBoardType

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for ExpansionBoard register messages.

public static Timestamped<ExpansionBoardType> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<ExpansionBoardType>

A value representing the timestamped message payload.