Class InputState

Namespace

Harp.SoundCard

Assembly

Harp.SoundCard.dll

Represents a register that state of the digital inputs.

public class InputState

Inheritance

object

InputState

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

public const int Address = 40

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, DigitalInputs)

Returns a Harp message for the InputState register.

public static HarpMessage FromPayload(MessageType messageType, DigitalInputs value)

Parameters

messageType MessageType

The type of the Harp message.

value DigitalInputs

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, DigitalInputs)

Returns a timestamped Harp message for the InputState register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value DigitalInputs

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for InputState register messages.

public static DigitalInputs GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

DigitalInputs

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for InputState register messages.

public static Timestamped<DigitalInputs> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<DigitalInputs>

A value representing the timestamped message payload.