Class OutputToggle

Namespace

Harp.Behavior

Assembly

Harp.Behavior.dll

Represents a register that toggle the specified digital output lines.

public class OutputToggle

Inheritance

object

OutputToggle

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

public const int Address = 36

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U16

Field Value

PayloadType

Methods

FromPayload(MessageType, DigitalOutputs)

Returns a Harp message for the OutputToggle register.

public static HarpMessage FromPayload(MessageType messageType, DigitalOutputs value)

Parameters

messageType MessageType

The type of the Harp message.

value DigitalOutputs

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, DigitalOutputs)

Returns a timestamped Harp message for the OutputToggle register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value DigitalOutputs

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for OutputToggle register messages.

public static DigitalOutputs GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

DigitalOutputs

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for OutputToggle register messages.

public static Timestamped<DigitalOutputs> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<DigitalOutputs>

A value representing the timestamped message payload.