Class EnableEvents

Namespace

Harp.Synchronizer

Assembly

Harp.Synchronizer.dll

Represents a register that specifies all the active events in the device.

public class EnableEvents

Inheritance

object

EnableEvents

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

public const int Address = 40

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, SynchronizerEvents)

Returns a Harp message for the EnableEvents register.

public static HarpMessage FromPayload(MessageType messageType, SynchronizerEvents value)

Parameters

messageType MessageType

The type of the Harp message.

value SynchronizerEvents

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, SynchronizerEvents)

Returns a timestamped Harp message for the EnableEvents register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value SynchronizerEvents

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for EnableEvents register messages.

public static SynchronizerEvents GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

SynchronizerEvents

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for EnableEvents register messages.

public static Timestamped<SynchronizerEvents> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<SynchronizerEvents>

A value representing the timestamped message payload.