Class RepeaterStatus

Namespace

Harp.TimestampGeneratorGen3

Assembly

Harp.TimestampGeneratorGen3.dll

Represents a register that check whether device is a repeater or spreading internal timestamp.

public class RepeaterStatus

Inheritance

object

RepeaterStatus

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

public const int Address = 34

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, RepeaterFlags)

Returns a Harp message for the RepeaterStatus register.

public static HarpMessage FromPayload(MessageType messageType, RepeaterFlags value)

Parameters

messageType MessageType

The type of the Harp message.

value RepeaterFlags

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, RepeaterFlags)

Returns a timestamped Harp message for the RepeaterStatus register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value RepeaterFlags

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for RepeaterStatus register messages.

public static RepeaterFlags GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

RepeaterFlags

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for RepeaterStatus register messages.

public static Timestamped<RepeaterFlags> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<RepeaterFlags>

A value representing the timestamped message payload.