Added CfdpManager skeleton

Author: Brian-Campuzano

Svc/Ccsds/CMakeLists.txt

@@ -5,3 +5,4 @@ add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/SpacePacketFramer/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/TcDeframer/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/TmFramer/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/ApidManager/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/CfdpManager/")

Svc/Ccsds/CfdpManager/CMakeLists.txt

@@ -0,0 +1,36 @@
+####
+# F Prime CMakeLists.txt:
+#
+# SOURCES: list of source files (to be compiled)
+# AUTOCODER_INPUTS: list of files to be passed to the autocoders
+# DEPENDS: list of libraries that this module depends on
+#
+# More information in the F´ CMake API documentation:
+# https://fprime.jpl.nasa.gov/latest/docs/reference/api/cmake/API/
+#
+####
+
+# Module names are derived from the path from the nearest project/library/framework
+# root when not specifically overridden by the developer, i.e. the module defined by
+# `MyProj/Some/Path/CMakeLists.txt` will be named `MyProj_Some_Path`.
+
+register_fprime_library(
+    AUTOCODER_INPUTS
+        "${CMAKE_CURRENT_LIST_DIR}/CfdpManager.fpp"
+    SOURCES
+        "${CMAKE_CURRENT_LIST_DIR}/CfdpManager.cpp"
+#   DEPENDS
+#       MyPackage_MyOtherModule
+)
+
+### Unit Tests ###
+# register_fprime_ut(
+#     AUTOCODER_INPUTS
+#         "${CMAKE_CURRENT_LIST_DIR}/CfdpManager.fpp"
+#     SOURCES
+#         "${CMAKE_CURRENT_LIST_DIR}/test/ut/CfdpManagerTestMain.cpp"
+#         "${CMAKE_CURRENT_LIST_DIR}/test/ut/CfdpManagerTester.cpp"
+#     DEPENDS
+#         STest # For rules-based testing
+#     UT_AUTO_HELPERS
+# )

Svc/Ccsds/CfdpManager/CfdpManager.cpp

@@ -0,0 +1,30 @@
+// ======================================================================
+// \title  CfdpManager.cpp
+// \author campuzan
+// \brief  cpp file for CfdpManager component implementation class
+// ======================================================================
+
+#include "Svc/Ccsds/CfdpManager/CfdpManager.hpp"
+
+namespace Svc {
+namespace Ccsds {
+
+// ----------------------------------------------------------------------
+// Component construction and destruction
+// ----------------------------------------------------------------------
+
+CfdpManager ::CfdpManager(const char* const compName) : CfdpManagerComponentBase(compName) {}
+
+CfdpManager ::~CfdpManager() {}
+
+// ----------------------------------------------------------------------
+// Handler implementations for commands
+// ----------------------------------------------------------------------
+
+void CfdpManager ::TODO_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) {
+    // TODO
+    this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
+}
+
+}  // namespace Ccsds
+}  // namespace Svc

Svc/Ccsds/CfdpManager/CfdpManager.fpp

@@ -0,0 +1,53 @@
+module Svc {
+module Ccsds {
+    @ F' implementation of the CFDP file transfer prototcol
+    active component CfdpManager {
+
+        # One async command/port is required for active components
+        # This should be overridden by the developers with a useful command/port
+        @ TODO
+        async command TODO opcode 0
+
+        ##############################################################################
+        #### Uncomment the following examples to start customizing your component ####
+        ##############################################################################
+
+        # @ Example async command
+        # async command COMMAND_NAME(param_name: U32)
+
+        # @ Example telemetry counter
+        # telemetry ExampleCounter: U64
+
+        # @ Example event
+        # event ExampleStateEvent(example_state: Fw.On) severity activity high id 0 format "State set to {}"
+
+        # @ Example port: receiving calls from the rate group
+        # sync input port run: Svc.Sched
+
+        # @ Example parameter
+        # param PARAMETER_NAME: U32
+
+        ###############################################################################
+        # Standard AC Ports: Required for Channels, Events, Commands, and Parameters  #
+        ###############################################################################
+        @ Port for requesting the current time
+        time get port timeCaller
+
+        @ Enables command handling
+        import Fw.Command
+
+        @ Enables event handling
+        import Fw.Event
+
+        @ Enables telemetry channels handling
+        import Fw.Channel
+
+        @ Port to return the value of a parameter
+        param get port prmGetOut
+
+        @Port to set the value of a parameter
+        param set port prmSetOut
+
+    }
+} # end Ccsds
+} # end Svc

Svc/Ccsds/CfdpManager/CfdpManager.hpp

@@ -0,0 +1,44 @@
+// ======================================================================
+// \title  CfdpManager.hpp
+// \author campuzan
+// \brief  hpp file for CfdpManager component implementation class
+// ======================================================================
+
+#ifndef Ccsds_CfdpManager_HPP
+#define Ccsds_CfdpManager_HPP
+
+#include "Svc/Ccsds/CfdpManager/CfdpManagerComponentAc.hpp"
+
+namespace Svc {
+namespace Ccsds {
+
+class CfdpManager final : public CfdpManagerComponentBase {
+  public:
+    // ----------------------------------------------------------------------
+    // Component construction and destruction
+    // ----------------------------------------------------------------------
+
+    //! Construct CfdpManager object
+    CfdpManager(const char* const compName  //!< The component name
+    );
+
+    //! Destroy CfdpManager object
+    ~CfdpManager();
+
+  private:
+    // ----------------------------------------------------------------------
+    // Handler implementations for commands
+    // ----------------------------------------------------------------------
+
+    //! Handler implementation for command TODO
+    //!
+    //! TODO
+    void TODO_cmdHandler(FwOpcodeType opCode,  //!< The opcode
+                         U32 cmdSeq            //!< The command sequence number
+                         ) override;
+};
+
+}  // namespace Ccsds
+}  // namespace Svc
+
+#endif

Svc/Ccsds/CfdpManager/docs/sdd.md

@@ -0,0 +1,66 @@
+# Ccsds::CfdpManager
+
+F' implementation of the CFDP file transfer prototcol
+
+## Usage Examples
+Add usage examples here
+
+### Diagrams
+Add diagrams here
+
+### Typical Usage
+And the typical usage of the component here
+
+## 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 |
+|---|---|---|---|
+|---|---|---|---|
+
+## Requirements
+Add requirements in the chart below
+| Name | Description | Validation |
+|---|---|---|
+|---|---|---|
+
+## Change Log
+| Date | Description |
+|---|---|
+|---| Initial Draft |