Class DO1Threshold

Namespace

Harp.AnalogInput

Assembly

Harp.AnalogInput.dll

Represents a register that value used to threshold an ADC read, and trigger DO1 pin.

public class DO1Threshold

Inheritance

object

DO1Threshold

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

public const int Address = 67

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = S16

Field Value

PayloadType

Methods

FromPayload(MessageType, short)

Returns a Harp message for the DO1Threshold register.

public static HarpMessage FromPayload(MessageType messageType, short value)

Parameters

messageType MessageType

The type of the Harp message.

value short

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, short)

Returns a timestamped Harp message for the DO1Threshold register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value short

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for DO1Threshold register messages.

public static short GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

short

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for DO1Threshold register messages.

public static Timestamped<short> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<short>

A value representing the timestamped message payload.