F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
DpWrittenPortAc.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title DpWrittenPortAc.hpp
3 // \author Generated by fpp-to-cpp
4 // \brief hpp file for DpWritten port
5 // ======================================================================
6 
7 #ifndef Svc_DpWrittenPortAc_HPP
8 #define Svc_DpWrittenPortAc_HPP
9 
10 #include <cstdio>
11 #include <cstring>
12 
13 #include "FpConfig.hpp"
18 #include "Fw/Types/StringType.hpp"
19 
20 namespace Svc {
21 
25  public Fw::InputPortBase
26  {
27 
28  public:
29 
30  // ----------------------------------------------------------------------
31  // Constants
32  // ----------------------------------------------------------------------
33 
34  enum {
38  sizeof(FwDpPriorityType) +
39  sizeof(FwSizeType)
40  };
41 
42  public:
43 
44  // ----------------------------------------------------------------------
45  // Types
46  // ----------------------------------------------------------------------
47 
49  typedef void (*CompFuncPtr)(
50  Fw::PassiveComponentBase* callComp,
51  FwIndexType portNum,
52  const Fw::StringBase& fileName,
53  FwDpPriorityType priority,
54  FwSizeType size
55  );
56 
57  public:
58 
59  // ----------------------------------------------------------------------
60  // Input Port Member functions
61  // ----------------------------------------------------------------------
62 
65 
67  void init();
68 
70  void addCallComp(
71  Fw::PassiveComponentBase* callComp,
72  CompFuncPtr funcPtr
73  );
74 
76  void invoke(
77  const Fw::StringBase& fileName,
78  FwDpPriorityType priority,
79  FwSizeType size
80  );
81 
82  private:
83 
84 #if FW_PORT_SERIALIZATION == 1
85 
87  Fw::SerializeStatus invokeSerial(Fw::SerializeBufferBase& _buffer);
88 
89 #endif
90 
91  private:
92 
93  // ----------------------------------------------------------------------
94  // Member variables
95  // ----------------------------------------------------------------------
96 
98  CompFuncPtr m_func;
99 
100  };
101 
105  public Fw::OutputPortBase
106  {
107 
108  public:
109 
110  // ----------------------------------------------------------------------
111  // Output Port Member functions
112  // ----------------------------------------------------------------------
113 
116 
118  void init();
119 
121  void addCallPort(
122  InputDpWrittenPort* callPort
123  );
124 
126  void invoke(
127  const Fw::StringBase& fileName,
128  FwDpPriorityType priority,
129  FwSizeType size
130  );
131 
132  private:
133 
134  // ----------------------------------------------------------------------
135  // Member variables
136  // ----------------------------------------------------------------------
137 
139  InputDpWrittenPort* m_port;
140 
141  };
142 
143 }
144 
145 #endif
U32 FwDpPriorityType
Definition: FpConfig.h:119
PlatformSizeType FwSizeType
Definition: FpConfig.h:35
PlatformIndexType FwIndexType
Definition: FpConfig.h:25
C++-compatible configuration header for fprime configuration.
static constexpr SizeType STATIC_SERIALIZED_SIZE(SizeType maxLength)
Definition: StringBase.hpp:35
void addCallComp(Fw::PassiveComponentBase *callComp, CompFuncPtr funcPtr)
Register a component.
InputDpWrittenPort()
Constructor.
@ SERIALIZED_SIZE
The size of the serial representations of the port arguments.
void(* CompFuncPtr)(Fw::PassiveComponentBase *callComp, FwIndexType portNum, const Fw::StringBase &fileName, FwDpPriorityType priority, FwSizeType size)
The port callback function type.
void invoke(const Fw::StringBase &fileName, FwDpPriorityType priority, FwSizeType size)
Invoke a port interface.
void init()
Initialization function.
void invoke(const Fw::StringBase &fileName, FwDpPriorityType priority, FwSizeType size)
Invoke a port interface.
void addCallPort(InputDpWrittenPort *callPort)
Register an input port.
void init()
Initialization function.
SerializeStatus
forward declaration for string