start SDD and rename author

nasa · Feb 1, 2025 · e2b5426 · e2b5426
1 parent 13f8cd1
commit e2b5426
Show file tree

Hide file tree

Showing 12 changed files with 30 additions and 65 deletions.
diff --git a/Svc/Deframer/Deframer.cpp b/Svc/Deframer/Deframer.cpp
@@ -1,6 +1,6 @@
 // ======================================================================
 // \title  Deframer.cpp
-// \author chammard
+// \author thomas-bc
 // \brief  cpp file for Deframer component implementation class
 // ======================================================================
 

diff --git a/Svc/Deframer/Deframer.hpp b/Svc/Deframer/Deframer.hpp
@@ -1,6 +1,6 @@
 // ======================================================================
 // \title  Deframer.hpp
-// \author chammard
+// \author thomas-bc
 // \brief  hpp file for Deframer component implementation class
 // ======================================================================
 

diff --git a/Svc/Deframer/test/ut/DeframerTestMain.cpp b/Svc/Deframer/test/ut/DeframerTestMain.cpp
@@ -1,6 +1,6 @@
 // ======================================================================
 // \title  DeframerTestMain.cpp
-// \author chammard
+// \author thomas-bc
 // \brief  cpp file for Deframer component test main function
 // ======================================================================
 

diff --git a/Svc/Deframer/test/ut/DeframerTester.cpp b/Svc/Deframer/test/ut/DeframerTester.cpp
@@ -1,6 +1,6 @@
 // ======================================================================
 // \title  DeframerTester.cpp
-// \author chammard
+// \author thomas-bc
 // \brief  cpp file for Deframer component test harness implementation class
 // ======================================================================
 
@@ -26,6 +26,7 @@ DeframerTester ::~DeframerTester() {}
 // ----------------------------------------------------------------------
 
 void DeframerTester ::testNominalFrame() {
+    // TODO: make this test multiple times with different random bytes and lengths
     // Get random byte of data
     U8 randomByte = STest::Random::lowerUpper(0, 255);
     //           |  F´ start word        |     Length (= 1)      |   Data     |   Checksum (4 bytes)   |

diff --git a/Svc/Deframer/test/ut/DeframerTester.hpp b/Svc/Deframer/test/ut/DeframerTester.hpp
@@ -1,6 +1,6 @@
 // ======================================================================
 // \title  DeframerTester.hpp
-// \author chammard
+// \author thomas-bc
 // \brief  hpp file for Deframer component test harness implementation class
 // ======================================================================
 

diff --git a/Svc/FrameAccumulator/docs/sdd.md b/Svc/FrameAccumulator/docs/sdd.md
@@ -1,66 +1,30 @@
 # Svc::FrameAccumulator
 
-Accumulates data into frames
+The `Svc::FrameAccumulator` component accumulates a stream of data into frames.
 
 ## Usage Examples
-Add usage examples here
 
-### Diagrams
-Add diagrams here
+The `Svc::FrameAccumulator` component is used in the uplink stack of many reference F´ application such as the tutorials reference code.
 
-### Typical Usage
-And the typical usage of the component here
+### Diagrams
 
 ## Class Diagram
-Add a class diagram here
-
-## Port Descriptions
-| Name | Description |
-|---|---|
-|---|---|
-
-## Component States
-Add component states in the chart below
-| Name | Description |
-|---|---|
-|---|---|
-
-## Sequence Diagrams
-Add sequence diagrams here
-
-## Parameters
-| Name | Description |
-|---|---|
-|---|---|
-
-## Commands
-| Name | Description |
-|---|---|
-|---|---|
-
-## Events
-| Name | Description |
-|---|---|
-|---|---|
-
-## Telemetry
-| Name | Description |
-|---|---|
-|---|---|
 
-## Unit Tests
-Add unit test descriptions in the chart below
-| Name | Description | Output | Coverage |
-|---|---|---|---|
-|---|---|---|---|
+```mermaid
+classDiagram
+    class FrameAccumulator~PassiveComponent~ {
+        + void configure(FrameDetector& detector, NATIVE_UINT_TYPE allocationId, Fw::MemAllocator& allocator, FwSizeType store_size)
+        + void dataIn_handler(FwIndexType portNum, Fw::Buffer& recvBuffer, const Drv::RecvStatus& recvStatus)
+        + void processBuffer(Fw::Buffer& buffer)
+        + void processRing()
+    }
+```
 
 ## Requirements
-Add requirements in the chart below
-| Name | Description | Validation |
-|---|---|---|
-|---|---|---|
 
-## Change Log
-| Date | Description |
-|---|---|
-|---| Initial Draft |
+Requirement | Description | Rationale | Verification Method
+----------- | ----------- | ----------| -------------------
+SVC-FRAMEACCUMULATOR-001 | `Svc::FrameAccumulator` shall accumulate a sequence of byte buffers until their sequence forms a full frame | FrameAccumulator is designed to re-assemble frames from sequence of bytes | Unit test
+SVC-FRAMEACCUMULATOR-002 | `Svc::FrameAccumulator` shall detect once the accumulated buffers form a full frame and emit said frame | Pass frames to other parts of the system | Unit test
+SVC-FRAMEACCUMULATOR-003 | `Svc::FrameAccumulator` shall accept byte buffers containing frames that are not aligned on a buffer boundary. | For flexibility, we do not require that the frames be aligned on a buffer boundary. | Unit test
+SVC-FRAMEACCUMULATOR-004 | `Svc::FrameAccumulator` shall accept byte buffers containing frames that span one or more buffers. | For flexibility, we do not require each frame to fit in a single buffer. | Unit test
diff --git a/Svc/FrameAccumulator/test/ut/FrameAccumulatorTestMain.cpp b/Svc/FrameAccumulator/test/ut/FrameAccumulatorTestMain.cpp
@@ -1,6 +1,6 @@
 // ======================================================================
 // \title  FrameAccumulatorTestMain.cpp
-// \author chammard
+// \author thomas-bc
 // \brief  cpp file for FrameAccumulator component test main function
 // ======================================================================
 

diff --git a/Svc/FrameAccumulator/test/ut/FrameAccumulatorTester.cpp b/Svc/FrameAccumulator/test/ut/FrameAccumulatorTester.cpp
@@ -1,6 +1,6 @@
 // ======================================================================
 // \title  FrameAccumulatorTester.cpp
-// \author chammard
+// \author thomas-bc
 // \brief  cpp file for FrameAccumulator component test harness implementation class
 // ======================================================================
 

diff --git a/Svc/FrameAccumulator/test/ut/FrameAccumulatorTester.hpp b/Svc/FrameAccumulator/test/ut/FrameAccumulatorTester.hpp
@@ -1,6 +1,6 @@
 // ======================================================================
 // \title  FrameAccumulatorTester.hpp
-// \author chammard
+// \author thomas-bc
 // \brief  hpp file for FrameAccumulator component test harness implementation class
 // ======================================================================
 

diff --git a/Svc/Router/test/ut/RouterTestMain.cpp b/Svc/Router/test/ut/RouterTestMain.cpp
@@ -1,6 +1,6 @@
 // ======================================================================
 // \title  RouterTestMain.cpp
-// \author chammard
+// \author thomas-bc
 // \brief  cpp file for Router component test main function
 // ======================================================================
 

diff --git a/Svc/Router/test/ut/RouterTester.cpp b/Svc/Router/test/ut/RouterTester.cpp
@@ -1,6 +1,6 @@
 // ======================================================================
 // \title  RouterTester.cpp
-// \author chammard
+// \author thomas-bc
 // \brief  cpp file for Router component test harness implementation class
 // ======================================================================
 

diff --git a/Svc/Router/test/ut/RouterTester.hpp b/Svc/Router/test/ut/RouterTester.hpp
@@ -1,6 +1,6 @@
 // ======================================================================
 // \title  RouterTester.hpp
-// \author chammard
+// \author thomas-bc
 // \brief  hpp file for Router component test harness implementation class
 // ======================================================================