Class Cam1Event

Namespace

Harp.CameraControllerGen2

Assembly

Harp.CameraControllerGen2.dll

Represents a register that signals a frame was triggered on camera 1.

public class Cam1Event

Inheritance

object

Cam1Event

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

public const int Address = 33

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, CameraEvents)

Returns a Harp message for the Cam1Event register.

public static HarpMessage FromPayload(MessageType messageType, CameraEvents value)

Parameters

messageType MessageType

The type of the Harp message.

value CameraEvents

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, CameraEvents)

Returns a timestamped Harp message for the Cam1Event register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value CameraEvents

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for Cam1Event register messages.

public static CameraEvents GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

CameraEvents

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for Cam1Event register messages.

public static Timestamped<CameraEvents> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<CameraEvents>

A value representing the timestamped message payload.