Skip to content

Commit 4649cf6

Browse files
authored
docs(diagnostic_graph_aggregator): update document (#10199)
Signed-off-by: Mamoru Sobue <mamoru.sobue@tier4.jp>
1 parent 6ef2396 commit 4649cf6

File tree

5 files changed

+29
-19
lines changed

5 files changed

+29
-19
lines changed

system/autoware_diagnostic_graph_aggregator/doc/format/graph.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The graph object is the top level structure that makes up the configuration file
44

55
## Format
66

7-
| Name | Type | Required | Description |
8-
| ------- | -------------------------------------- | -------- | --------------------------------------------- |
9-
| `files` | <code>list\[[path](./path.md)\]</code> | no | List of path objects for importing subgraphs. |
10-
| `units` | <code>list\[[unit](./unit.md)\]</code> | no | List of unit objects that make up the graph. |
7+
| Name | Type | Required | Description |
8+
| ------- | ------------------------------------- | -------- | --------------------------------------------- |
9+
| `files` | <code>list\[[path](./path.md)]</code> | no | List of path objects for importing subgraphs. |
10+
| `units` | <code>list\[[unit](./unit.md)]</code> | no | List of unit objects that make up the graph. |

system/autoware_diagnostic_graph_aggregator/doc/format/unit.md

+15-11
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,25 @@ Any derived object can be used where a unit object is required.
55

66
## Format
77

8-
| Name | Type | Required | Description |
9-
| ------ | -------- | -------- | ------------------------------------------------- |
10-
| `type` | `string` | yes | The string indicating the type of derived object. |
11-
| `path` | `string` | no | Any string to reference from other units. |
8+
| Name | Type | Required | Description |
9+
| ------------------- | -------- | -------- | ------------------------------------------------------------------------ |
10+
| `path` | `string` | no | Any string to reference from other units. |
11+
| `type` | `string` | yes | The string indicating the type of derived object. |
12+
| `$derived argument` | `any` | no | Additional arguments for constructing the derived object of given `type` |
1213

13-
## Derived objects
14+
`$derived_arguments` denotes additional arguments to be passed for constructing the object which is specified by `type` parameter. For example, if "and" is provided as `type`, `list` parameter is also required.
15+
16+
## Derived object types
1417

1518
- [diag](./unit/diag.md)
19+
- [link](./unit/link.md)
1620
- [and](./unit/and.md)
1721
- [or](./unit/or.md)
1822
- [remapping](./unit/remap.md)
19-
- warn-to-ok
20-
- warn-to-error
23+
- `warn-to-ok`
24+
- `warn-to-error`
2125
- [constant](./unit/const.md)
22-
- ok
23-
- warn
24-
- error
25-
- stale
26+
- `ok`
27+
- `warn`
28+
- `error`
29+
- `stale`

system/autoware_diagnostic_graph_aggregator/doc/format/unit/and.md

+2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ Note that error level `stale` is treated as `error`.
1010
| `type` | <code>string</code> | yes | Specify `and` or `short-circuit-and` when using this object. |
1111
| `list` | <code>list\[[unit](../unit.md)]</code> | yes | List of input unit objects. |
1212

13+
If `list` is undeclared or empty, this object is evaluated as `ok`.
14+
1315
## Short-circuit evaluation
1416

1517
!!! warning

system/autoware_diagnostic_graph_aggregator/doc/format/unit/diag.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ The `diag` object is a unit that refers to a specific status within the source d
44

55
## Format
66

7-
| Name | Type | Required | Description |
8-
| ------ | -------- | -------- | -------------------------------------- |
9-
| `type` | `string` | yes | Specify `diag` when using this object. |
10-
| `diag` | `string` | yes | The name of the diagnostic status. |
7+
| Name | Type | Required | Description |
8+
| --------- | -------- | -------- | --------------------------------------------- |
9+
| `type` | `string` | yes | Specify `diag` when using this object. |
10+
| `node` | `string` | yes | Node name that outputs the diagnostic status. |
11+
| `name` | `string` | yes | The name of the diagnostic status. |
12+
| `timeout` | `float` | yes | The name of the diagnostic status. |

system/autoware_diagnostic_graph_aggregator/doc/format/unit/or.md

+2
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,5 @@ Note that error level `stale` is treated as `error`.
99
| ------ | -------------------------------------- | -------- | ------------------------------------ |
1010
| `type` | <code>string</code> | yes | Specify `or` when using this object. |
1111
| `list` | <code>list\[[unit](../unit.md)]</code> | yes | List of input unit objects. |
12+
13+
If `list` is undeclared or empty, this object is evaluated as `error`.

0 commit comments

Comments
 (0)