Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add SDD aggregation into the core website #3139

Merged
merged 25 commits into from
Jan 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/actions/markdown-check/mlc-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@
},
{
"pattern": "^\\.\\./tree/HEAD/"
},
{
"pattern": ".*\\.[chf]pp"
},
{
"pattern": "../../../.."
}
]
}
1 change: 1 addition & 0 deletions .github/actions/spelling/excludes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -100,3 +100,4 @@
^\Qdocs/Tutorials/FullSystemTutorial/Tutorial.md\E$
^\QSvc/FileUplink/test/ut/dest.bin\E$
ignore$
mlc-config.json
1 change: 0 additions & 1 deletion Drv/BlockDriver/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page DrvBlockDriverComponent Drv::BlockDriver Component
# Drv::BlockDriver Component

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Drv/ByteStreamDriverModel/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page DrvByteStreamDriverModel Drv::ByteStreamDriverModel Byte Stream Driver Model
# Drv::ByteStreamDriverModel Byte Stream Driver Model

The byte stream driver is a generic model for drivers implementing a "stream of bytes" interface. Typically these
Expand Down
1 change: 0 additions & 1 deletion Drv/Ip/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page DrvIp Drv::Ip IPv4 Socket Implementations
# Drv::Ip IPv4 Socket Implementations

This package contains utility classes to help interact with standard IPv4 (Berkeley) sockets. These classes implement the
Expand Down
1 change: 0 additions & 1 deletion Drv/StreamCrossover/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page DrvStreamCrossover Drv::StreamCrossover Stream Crossover Component
# Drv::StreamCrossover Stream Crossover Component

The Stream Crossover component allows a connection of byte stream driver model ports of type ByteStreamRecv and
Expand Down
1 change: 0 additions & 1 deletion Drv/TcpClient/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page DrvTcpClient Drv::TcpClient Component
# Drv::TcpClient TCP Client Component

The TCP client component bridges the byte stream driver model interface to a remote TCP server to which this tcp client
Expand Down
1 change: 0 additions & 1 deletion Drv/TcpServer/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page DrvTcpServer Drv::TcpServer Component
# Drv::TcpServer Tcp Server Component

The TCP server component bridges the byte stream driver model interface to a remote TCP client to which this tcp server
Expand Down
1 change: 0 additions & 1 deletion Drv/Udp/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page DrvUdp Drv::Udp Component
# Drv::Udp UDP Component

The UDP client component bridges the byte stream driver model interface to a remote UDP port to which this udp component
Expand Down
1 change: 0 additions & 1 deletion Fw/Buffer/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page FwBufferSerializableBufferGetBufferSend Fw::Buffer Serializable / Fw::BufferGet Port / Fw::BufferSend Port
# Fw::Buffer Serializable / Fw::BufferGet Port / Fw::BufferSend Port

## 1 Introduction
Expand Down
1 change: 0 additions & 1 deletion Fw/Cmd/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page FwCmdFwCmdResponseFwCmdReg Fw::Cmd / Fw::CmdResponse / Fw::CmdReg Ports
# Fw::Cmd / Fw::CmdResponse / Fw::CmdReg Ports

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Fw/Com/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page FwComPort Fw::Com Port
# Fw::Com Port

## 1. Introduction
Expand Down
9 changes: 4 additions & 5 deletions Fw/Dp/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
\page FwDp Framework Support for Data Products
# Framework Support for Data Products
# Fw::Dp Framework Support for Data Products

## 1. Introduction

This build module defines FPP ports and C++ classes that support
the collection and storage of data products.
For more information on data products and records, see the
[data products documentation](../../../docs/documentation/user-manual/design/data-products.md).
[data products documentation](../../../../../user-manual/design/data-products.md).

## 2. Configuration

Expand Down Expand Up @@ -82,7 +81,7 @@ The header hash has the following format.

|Field Name|Serialized Size|Description|
|----------|---------------|-----------|
|`Header Hash`|[`HASH_DIGEST_LENGTH`](../../../Utils/Hash/README.md)|The hash value guarding the header.|
|`Header Hash`|[`HASH_DIGEST_LENGTH`](../../../../api/cpp/html/index.html)|The hash value guarding the header.|

#### 5.1.3. Data

Expand Down Expand Up @@ -119,7 +118,7 @@ The data hash has the following format.

|Field Name|Serialized Size|Description|
|----------|---------------|-----------|
|`Data Hash`|[`HASH_DIGEST_LENGTH`](../../../Utils/Hash/README.md)|The hash value guarding the data.|
|`Data Hash`|[`HASH_DIGEST_LENGTH`](../../../../api/cpp/html/index.html)|The hash value guarding the data.|

### 5.2. Further Information

Expand Down
1 change: 0 additions & 1 deletion Fw/FilePacket/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page FwFilePacketClasses Fw::FilePacket Classes
# Fw::FilePacket Classes

## 1 Introduction
Expand Down
1 change: 0 additions & 1 deletion Fw/Log/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page FwLogLogText Fw::Log, Fw::LogText Ports
# Fw::Log / Fw::LogText Ports

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Fw/Obj/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page FwObjClasses Fw::Obj Classes
# Fw::Obj Classes

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Fw/Port/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page FwPortClasses Fw::Port Classes
# Fw::Port Classes

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Fw/Prm/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page FwPrmGetPrmSet Fw::PrmGet / PrmSet Ports
# Fw::PrmGet / PrmSet Ports

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Fw/Time/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page FwTimePort Fw::Time Port
# Fw::Time Port

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Fw/Tlm/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page FwTlmPort Fw::Tlm Port
# Fw::Tlm Port

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Fw/Types/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page FwTypeClasses Fw::Type Classes and Types
# Fw::Type Classes and Types

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Ref/PingReceiver/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page RefPingReceiverComponent Ref::PingReceiver Component
# Ref::PingReceiver Component

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Ref/RecvBuffApp/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page RefRecvBuffAppComponent Ref::RecvBuffApp Component
# Ref::RecvBuffApp Component

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Ref/SendBuffApp/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page RefSendBuffAppComponent Ref::SendBuffApp Component
# Ref::SendBuffApp Component

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Ref/SignalGen/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page RefSignalGenComponent Ref::SignalGen Component
# Ref::SignalGen Component

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Svc/ActiveLogger/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page SvcActiveLoggerComponent Svc::ActiveLogger Component
# Svc::ActiveLogger Component

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Svc/ActiveRateGroup/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page SvcActiveRateGroupComponent Svc::ActiveRateGroup Component
# Svc::ActiveRateGroup Component

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Svc/ActiveTextLogger/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page SvcActiveTextLoggerComponent Svc::ActiveTextLogger Component
# Svc::ActiveTextLogger Component

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Svc/AssertFatalAdapter/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page SvcAssertFatalAdapterComponent Svc::AssertFatalAdapter Component
# Svc::AssertFatalAdapter Component

## 1. Introduction
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page SvcBufferAccumulatorComponent Svc::BufferAccumulator Component
# BufferAccumulator Component Dictionary


Expand Down
1 change: 0 additions & 1 deletion Svc/BufferManager/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page SvcBufferManagerComponent Svc::BufferManager Component
# Svc::BufferManager

## 1 Introduction
Expand Down
1 change: 0 additions & 1 deletion Svc/BufferRepeater/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page SvcBufferRepeaterComponent Svc::BufferRepeater Component
# Svc::BufferRepeater: Buffer Repeater (Passive Component)

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Svc/CmdDispatcher/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page SvcCmdDispatcherComponent Svc::CmdDispatcher Component
# Svc::CmdDispatcher Component

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Svc/CmdSequencer/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page SvcCmdSequencerComponent Svc::CmdSequencer Component
# Svc::CmdSequencer Component

## 1 Introduction
Expand Down
1 change: 0 additions & 1 deletion Svc/CmdSplitter/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page SvcCmdSplitter Svc::CmdSplitter Component
# Svc::CmdSplitter Component

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Svc/ComQueue/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page SvcComQueueComponent Svc::ComQueue Component
# Svc::ComQueue (Active Component)

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Svc/ComStub/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page SvcComStubComponent Svc::ComStub Component
# Svc::ComStub (Passive Component)

## 1. Introduction
Expand Down
29 changes: 7 additions & 22 deletions Svc/Deframer/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page SvcDeframerComponent Svc::Deframer Component
# Svc::Deframer (Passive Component)

## 1. Introduction
Expand Down Expand Up @@ -95,9 +94,7 @@ SVC-DEFRAMER-011 | `Svc::Deframer` shall operate nominally when its port for sen

The diagram below shows the `Deframer` component.

<div>
<img src="img/Deframer.png" width=700/>
</div>
![Deframer](img/Deframer.png)

### 4.2. Ports

Expand Down Expand Up @@ -349,24 +346,18 @@ optional.

**Topology 1a: Buffers containing framed data (active byte stream driver):**

<div>
<img src="img/top/framed-active.png" width=1000/>
</div>
![active](img/top/framed-active.png)

**Topology 1b: Buffers containing framed data (passive byte stream driver):**

<div>
<img src="img/top/framed-passive.png" width=1000/>
</div>
![passive](img/top/framed-passive.png)

Revise the port number of `rateGroup.RateGroupMemberOut` as
appropriate for your application.

**Topology 2: Command packets and command responses:**

<div>
<img src="img/top/cmd.png" width=800/>
</div>
![cmd](img/top/cmd.png)

Revise the port numbers of `cmdDisp.seqCmdBuff` and
`cmdDisp.compCmdStat` as appropriate for your application.
Expand All @@ -375,9 +366,7 @@ assign these numbers.

**Topology 3: Buffers containing packet data:**

<div>
<img src="img/top/deframer-file.png" width=1000/>
</div>
![file](img/top/deframer-file.png)

### 6.2. Sequence Diagrams

Expand Down Expand Up @@ -507,17 +496,13 @@ instance `hub` of type `Svc::GenericHub`.

**Topology 2: Command packets**

<div>
<img src="img/top/hub-cmd.png" width=800/>
</div>
![hub-cmd](img/top/hub-cmd.png)

Revise the port number of `hub.portIn` as appropriate for your application.

**Topology 3: Buffers containing packet data**

<div>
<img src="img/top/hub-file.png" width=1000/>
</div>
![file](img/top/hub-file.png)

Revise the port number of `hub.buffersIn` as appropriate for your application.
When `hub` receives a buffer on `buffersIn`, it copies the data across
Expand Down
1 change: 0 additions & 1 deletion Svc/DpCatalog/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page SvcDpCatalogComponent Svc::DpCatalog Component
# Svc::DpCatalog Component

## 1 Introduction
Expand Down
20 changes: 6 additions & 14 deletions Svc/DpManager/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page SvcDpManagerComponent Svc::DpManager Component
# Svc::DpManager (Active Component)

## 1. Introduction
Expand All @@ -22,7 +21,7 @@ It does the following:
client components.
Upon receiving a buffer, send the buffer out on a port.
Another component such as
[`Svc::BufferAccumulator`](../../BufferAccumulator/docs/BufferAccumulator.md)
[`Svc::BufferAccumulator`](../../BufferAccumulator/docs/sdd.md)
or [`Svc::DpWriter`](../../DpWriter/docs/sdd.md)
will process the buffer and then send it back to the buffer manager
for deallocation.
Expand All @@ -42,9 +41,7 @@ SVC-DPMANAGER-004 | `Svc::DpManager` shall provide telemetry that reports the nu

The diagram below shows the `DpManager` component.

<div>
<img src="img/DpManager.png" width=700/>
</div>
![DpManager](img/DpManager.png)

### 3.2. Ports

Expand Down Expand Up @@ -197,21 +194,16 @@ connections.

#### 5.1.1. Synchronously Getting Data Product Buffers

<div>
<img src="img/top/buffer-get.png" width=800/>
</div>
![Buffer Get](img/top/buffer-get.png)

#### 5.1.2. Asynchronously Requesting Data Product Buffers

<div>
<img src="img/top/buffer-request.png" width=800/>
</div>
![Buffer Request](img/top/buffer-request.png)


#### 5.1.3. Sending Data Products

<div>
<img src="img/top/product-send.png" width=1000/>
</div>
![Product Send](img/top/product-send.png)

### 5.2. Sequence Diagrams

Expand Down
11 changes: 3 additions & 8 deletions Svc/DpWriter/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page SvcDpWriterComponent Svc::DpWriter Component
# Svc::DpWriter (Active Component)

## 1. Introduction
Expand All @@ -12,7 +11,7 @@ data products.
They typically pass through an instance of
[`Svc::DpManager`](../../DpManager/docs/sdd.md), and possibly through
an instance of
[`Svc::BufferAccumulator`](../../BufferAccumulator/docs/BufferAccumulator.md),
[`Svc::BufferAccumulator`](../../BufferAccumulator/docs/sdd.md),
before reaching `DpWriter`.

1. For each buffer _B_ received in step 1:
Expand Down Expand Up @@ -43,9 +42,7 @@ SVC-DPWRITER-006 | `Svc::DpManager` shall provide telemetry that reports the num

The diagram below shows the `DpWriter` component.

<div>
<img src="img/DpWriter.png" width=700/>
</div>
![DpWriter](img/DpWriter.png)

### 3.2. Ports

Expand Down Expand Up @@ -206,9 +203,7 @@ The diagrams use the following instances:

* `producer`: A component that produces data products.

<div>
<img src="img/top/product-write.png" width=800/>
</div>
![product-write](./img/top/product-write.png)

### 6.2. Sequence Diagrams

Expand Down
1 change: 0 additions & 1 deletion Svc/Fatal/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page SvcFatalPort Svc::Fatal Port
# Svc::Fatal Port

## 1. Introduction
Expand Down
1 change: 0 additions & 1 deletion Svc/FatalHandler/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
\page SvcFatalHandlerComponent Svc::FatalHandler Component
# Svc::FatalHandler Component

## 1. Introduction
Expand Down
Loading
Loading