Class MimicPort1Valve

Namespace

Harp.Behavior

Assembly

Harp.Behavior.dll

Represents a register that specifies the digital output to mimic the Port 1 valve state.

public class MimicPort1Valve

Inheritance

object

MimicPort1Valve

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

public const int Address = 118

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, MimicOutput)

Returns a Harp message for the MimicPort1Valve register.

public static HarpMessage FromPayload(MessageType messageType, MimicOutput value)

Parameters

messageType MessageType

The type of the Harp message.

value MimicOutput

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, MimicOutput)

Returns a timestamped Harp message for the MimicPort1Valve register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value MimicOutput

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for MimicPort1Valve register messages.

public static MimicOutput GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

MimicOutput

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for MimicPort1Valve register messages.

public static Timestamped<MimicOutput> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<MimicOutput>

A value representing the timestamped message payload.