Class StartAndStop

Namespace

Harp.CameraControllerGen2

Assembly

Harp.CameraControllerGen2.dll

Represents a register that starts and stops the cameras immediately.

public class StartAndStop

Inheritance

object

StartAndStop

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

public const int Address = 36

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, CameraFlags)

Returns a Harp message for the StartAndStop register.

public static HarpMessage FromPayload(MessageType messageType, CameraFlags value)

Parameters

messageType MessageType

The type of the Harp message.

value CameraFlags

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, CameraFlags)

Returns a timestamped Harp message for the StartAndStop register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value CameraFlags

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for StartAndStop register messages.

public static CameraFlags GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

CameraFlags

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for StartAndStop register messages.

public static Timestamped<CameraFlags> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<CameraFlags>

A value representing the timestamped message payload.