diag_tree_pb2

Generated protocol buffer code.

Classes:

• DiagTree –

  A tree of diagnostic data

DiagTree

DiagTree(
    *,
    status: DiagStatus | None = ...,
    list: DiagList | None = ...,
    map: DiagMap | None = ...,
    comment: str = ...
)

Bases: Message

A tree of diagnostic data

Returned by:

• API Reference
  • sync_graph  sync_graph
    •  SyncGraph
      •  diagnose_clock
      •  diagnose_clock_reference_adherence
      •  diagnose_graph
      •  diagnose_link
      •  diagnose_phc2sys_link
      •  diagnose_port
      •  diagnose_reference_adherence
      •  diagnose_single_clock_reference_adherence
    •  diagnose_diff
  • sync_tooling_msgs
    •  diag_tree  to_diag_tree
    •  port_state  diagnose_port_state
    •  self_reported_clock_state  diagnose_clock_state
    •  servo_state  diagnose_servo_state

Used by:

• API Reference sync_tooling_msgs  diag_tree
  •  aggregate
  •  flatten
  •  prettify
  •  to_diag_tree

Classes:

• DiagList –

  A list of diagnostic trees

• DiagMap –

  A mapping of strings to diagnostic trees

Methods:

• list –

  A list of diagnostic trees

• map –

  A mapping of strings to diagnostic trees

• status –

  A single diagnostic status

Attributes:

• comment (str) –

  Metadata such as notes or parameters, that are not a diagnostic status

comment instance-attribute

comment: str

Metadata such as notes or parameters, that are not a diagnostic status

DiagList

DiagList(*, list: Iterable[Global___DiagTree] | None = ...)

Bases: Message

A list of diagnostic trees

Methods:

• list –

  Allowed to be empty

list

list() -> (
    RepeatedCompositeFieldContainer[Global___DiagTree]
)

Allowed to be empty

DiagMap

DiagMap(
    *, map: Mapping[str, Global___DiagTree] | None = ...
)

Bases: Message

A mapping of strings to diagnostic trees

Methods:

• map –

  Allowed to be empty. Keys can be freely chosen but should be human-readable

map

map() -> MessageMap[str, Global___DiagTree]

Allowed to be empty. Keys can be freely chosen but should be human-readable

list

list() -> DiagList

A list of diagnostic trees

map

map() -> DiagMap

A mapping of strings to diagnostic trees

status

status() -> DiagStatus

A single diagnostic status