Class OpticalFlow

Namespace

Harp.OutputExpander

Assembly

Harp.OutputExpander.dll

Represents a register that generated event with the latest read from the optical flow sensor.

public class OpticalFlow

Inheritance

object

OpticalFlow

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

public const int Address = 100

Field Value

int

RegisterLength

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

public const int RegisterLength = 3

Field Value

int

RegisterType

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

public const PayloadType RegisterType = S16

Field Value

PayloadType

Methods

FromPayload(MessageType, OpticalFlowPayload)

Returns a Harp message for the OpticalFlow register.

public static HarpMessage FromPayload(MessageType messageType, OpticalFlowPayload value)

Parameters

messageType MessageType

The type of the Harp message.

value OpticalFlowPayload

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, OpticalFlowPayload)

Returns a timestamped Harp message for the OpticalFlow register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value OpticalFlowPayload

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for OpticalFlow register messages.

public static OpticalFlowPayload GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

OpticalFlowPayload

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for OpticalFlow register messages.

public static Timestamped<OpticalFlowPayload> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<OpticalFlowPayload>

A value representing the timestamped message payload.