Class DI0Trigger

Namespace

Harp.SyringePump

Assembly

Harp.SyringePump.dll

Represents a register that configures the callback function triggered when digital input is triggered.

public class DI0Trigger

Inheritance

object

DI0Trigger

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

public const int Address = 43

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, DI0TriggerConfig)

Returns a Harp message for the DI0Trigger register.

public static HarpMessage FromPayload(MessageType messageType, DI0TriggerConfig value)

Parameters

messageType MessageType

The type of the Harp message.

value DI0TriggerConfig

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, DI0TriggerConfig)

Returns a timestamped Harp message for the DI0Trigger register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value DI0TriggerConfig

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for DI0Trigger register messages.

public static DI0TriggerConfig GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

DI0TriggerConfig

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for DI0Trigger register messages.

public static Timestamped<DI0TriggerConfig> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<DI0TriggerConfig>

A value representing the timestamped message payload.