Class Pwm2AcquisitionMode

Namespace

Harp.OutputExpander

Assembly

Harp.OutputExpander.dll

Represents a register that sets the acquisition mode of PWM2.

public class Pwm2AcquisitionMode

Inheritance

object

Pwm2AcquisitionMode

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

public const int Address = 63

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, AcquisitionMode)

Returns a Harp message for the Pwm2AcquisitionMode register.

public static HarpMessage FromPayload(MessageType messageType, AcquisitionMode value)

Parameters

messageType MessageType

The type of the Harp message.

value AcquisitionMode

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, AcquisitionMode)

Returns a timestamped Harp message for the Pwm2AcquisitionMode register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value AcquisitionMode

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for Pwm2AcquisitionMode register messages.

public static AcquisitionMode GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

AcquisitionMode

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for Pwm2AcquisitionMode register messages.

public static Timestamped<AcquisitionMode> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<AcquisitionMode>

A value representing the timestamped message payload.