Class DO1Sync

Namespace

Harp.SyringePump

Assembly

Harp.SyringePump.dll

Represents a register that configures which signal is mimicked in the digital output 1.

public class DO1Sync

Inheritance

object

DO1Sync

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

public const int Address = 42

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, DO1SyncConfig)

Returns a Harp message for the DO1Sync register.

public static HarpMessage FromPayload(MessageType messageType, DO1SyncConfig value)

Parameters

messageType MessageType

The type of the Harp message.

value DO1SyncConfig

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, DO1SyncConfig)

Returns a timestamped Harp message for the DO1Sync register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value DO1SyncConfig

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for DO1Sync register messages.

public static DO1SyncConfig GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

DO1SyncConfig

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for DO1Sync register messages.

public static Timestamped<DO1SyncConfig> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<DO1SyncConfig>

A value representing the timestamped message payload.