self_reported_clock_state_update_pb2

Generated protocol buffer code.

Classes:

• SelfReportedClockStateUpdate –

  An update containing the self-reported state of a clock.

SelfReportedClockStateUpdate

SelfReportedClockStateUpdate(
    *,
    clock_id: ClockId | None = ...,
    state: ValueType = ...
)

Bases: Message

An update containing the self-reported state of a clock.

Returned by:

• API Reference sync_tooling_msgs  graph_update_pb2  GraphUpdate  self_reported_clock_state_update

Used by:

• API Reference
  • sync_graph  sync_graph  SyncGraph  update_self_reported_clock_state
  • sync_tooling_msgs  graph_update_pb2  GraphUpdate

Classes:

• State –

  A self-reported state of a clock, e.g. that of a sensor.

Methods:

• clock_id –

  The ID of the clock. Has to be a valid clock ID.

Attributes:

• INVALID (ValueType) –

  This is a sentinel value indicating an invalid state.

• LOCKED (ValueType) –

  The clock is locked (i.e. synchronized within a given tolerance).

• LOST (ValueType) –

  The clock is lost (i.e. the clock has been synchronized before but is now

• TRACKING (ValueType) –

  The clock is tracking (i.e. trying to synchronize, but not yet within a

• UNSYNCHRONIZED (ValueType) –

  The clock is unsynchronized.

• state (ValueType) –

  The new state of the clock.

INVALID instance-attribute

INVALID: ValueType

This is a sentinel value indicating an invalid state.

LOCKED instance-attribute

LOCKED: ValueType

The clock is locked (i.e. synchronized within a given tolerance).

LOST instance-attribute

LOST: ValueType

The clock is lost (i.e. the clock has been synchronized before but is now unsynchronized).

TRACKING instance-attribute

TRACKING: ValueType

The clock is tracking (i.e. trying to synchronize, but not yet within a given tolerance).

UNSYNCHRONIZED instance-attribute

UNSYNCHRONIZED: ValueType

The clock is unsynchronized.

state instance-attribute

state: ValueType

The new state of the clock.

State

Bases: _State

A self-reported state of a clock, e.g. that of a sensor.

clock_id

clock_id() -> ClockId

The ID of the clock. Has to be a valid clock ID.