F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
BufferGetPortAc.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title BufferGetPortAc.hpp
3 // \author Generated by fpp-to-cpp
4 // \brief hpp file for BufferGet port
5 // ======================================================================
6 
7 #ifndef Fw_BufferGetPortAc_HPP
8 #define Fw_BufferGetPortAc_HPP
9 
10 #include "Fw/Buffer/Buffer.hpp"
11 #include "Fw/FPrimeBasicTypes.hpp"
13 #if !FW_DIRECT_PORT_CALLS
17 #endif
18 
19 namespace Fw {
20 
21 #if !FW_DIRECT_PORT_CALLS
22 
27  public Fw::InputPortBase
28  {
29 
30  public:
31 
32  // ----------------------------------------------------------------------
33  // Public types for InputBufferGetPort
34  // ----------------------------------------------------------------------
35 
37  typedef Fw::Buffer (*CompFuncPtr)(
38  Fw::PassiveComponentBase* callComp,
39  FwIndexType portNum,
40  FwSizeType size
41  );
42 
43  public:
44 
45  // ----------------------------------------------------------------------
46  // Public constructors for InputBufferGetPort
47  // ----------------------------------------------------------------------
48 
51 
52  public:
53 
54  // ----------------------------------------------------------------------
55  // Public member functions for InputBufferGetPort
56  // ----------------------------------------------------------------------
57 
59  void init();
60 
62  void addCallComp(
63  Fw::PassiveComponentBase* callComp,
64  CompFuncPtr funcPtr
65  );
66 
69  FwSizeType size
70  );
71 
72  private:
73 
74  // ----------------------------------------------------------------------
75  // Private member functions for InputBufferGetPort
76  // ----------------------------------------------------------------------
77 
78 #if FW_PORT_SERIALIZATION == 1
79 
82  Fw::SerializeStatus invokeSerial(
83  Fw::LinearBufferBase& _buffer
84  );
85 
86 #endif
87 
88  private:
89 
90  // ----------------------------------------------------------------------
91  // Private member variables for InputBufferGetPort
92  // ----------------------------------------------------------------------
93 
95  CompFuncPtr m_func;
96 
97  };
98 
103  public Fw::OutputPortBase
104  {
105 
106  public:
107 
108  // ----------------------------------------------------------------------
109  // Public constructors for OutputBufferGetPort
110  // ----------------------------------------------------------------------
111 
114 
115  public:
116 
117  // ----------------------------------------------------------------------
118  // Public member functions for OutputBufferGetPort
119  // ----------------------------------------------------------------------
120 
122  void init();
123 
125  void addCallPort(
126  InputBufferGetPort* callPort
127  );
128 
132  FwSizeType size
133  ) const;
134 
135  private:
136 
137  // ----------------------------------------------------------------------
138  // Private member variables for OutputBufferGetPort
139  // ----------------------------------------------------------------------
140 
142  InputBufferGetPort* m_port;
143 
144  };
145 
146 #endif
147 
148 }
149 
150 #endif
void addCallComp(Fw::PassiveComponentBase *callComp, CompFuncPtr funcPtr)
Register a component.
PlatformSizeType FwSizeType
SerializeStatus
forward declaration for string
void addCallPort(InputBufferGetPort *callPort)
Register an input port.
Fw::Buffer invoke(FwSizeType size)
Invoke a port interface.
Fw::Buffer(* CompFuncPtr)(Fw::PassiveComponentBase *callComp, FwIndexType portNum, FwSizeType size)
The port callback function type.
Fw::Buffer invoke(FwSizeType size) const
void init()
Initialization function.
InputBufferGetPort()
Constructor.
PlatformIndexType FwIndexType
void init()
Initialization function.
OutputBufferGetPort()
Constructor.
Implementation of malloc based allocator.