Class Config

Namespace

Harp.TimestampGeneratorGen3

Assembly

Harp.TimestampGeneratorGen3.dll

Represents a register that specifies the device configuration.

public class Config

Inheritance

object

Config

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

public const int Address = 32

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, ConfigurationFlags)

Returns a Harp message for the Config register.

public static HarpMessage FromPayload(MessageType messageType, ConfigurationFlags value)

Parameters

messageType MessageType

The type of the Harp message.

value ConfigurationFlags

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, ConfigurationFlags)

Returns a timestamped Harp message for the Config register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value ConfigurationFlags

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for Config register messages.

public static ConfigurationFlags GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

ConfigurationFlags

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for Config register messages.

public static Timestamped<ConfigurationFlags> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<ConfigurationFlags>

A value representing the timestamped message payload.