Class DO1TargetChannel

Namespace

Harp.AnalogInput

Assembly

Harp.AnalogInput.dll

Represents a register that target ADC channel that will be used to trigger a threshold event on DO1 pin.

public class DO1TargetChannel

Inheritance

object

DO1TargetChannel

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

public const int Address = 59

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, AdcChannel)

Returns a Harp message for the DO1TargetChannel register.

public static HarpMessage FromPayload(MessageType messageType, AdcChannel value)

Parameters

messageType MessageType

The type of the Harp message.

value AdcChannel

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, AdcChannel)

Returns a timestamped Harp message for the DO1TargetChannel register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value AdcChannel

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for DO1TargetChannel register messages.

public static AdcChannel GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

AdcChannel

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for DO1TargetChannel register messages.

public static Timestamped<AdcChannel> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<AdcChannel>

A value representing the timestamped message payload.