F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
CompressChunkPortAc.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title CompressChunkPortAc.hpp
3 // \author Generated by fpp-to-cpp
4 // \brief hpp file for CompressChunk port
5 // ======================================================================
6 
7 #ifndef Svc_CompressChunkPortAc_HPP
8 #define Svc_CompressChunkPortAc_HPP
9 
10 #include "Fw/Buffer/Buffer.hpp"
11 #include "Fw/FPrimeBasicTypes.hpp"
14 #if !FW_DIRECT_PORT_CALLS
18 #endif
19 
20 namespace Svc {
21 
22 #if !FW_DIRECT_PORT_CALLS
23 
26  public Fw::InputPortBase
27  {
28 
29  public:
30 
31  // ----------------------------------------------------------------------
32  // Public types for InputCompressChunkPort
33  // ----------------------------------------------------------------------
34 
37  Fw::PassiveComponentBase* callComp,
38  FwIndexType portNum,
39  Fw::Buffer& buffer,
40  FwSizeType min_compression,
41  FwSizeType write_offset
42  );
43 
44  public:
45 
46  // ----------------------------------------------------------------------
47  // Public constructors for InputCompressChunkPort
48  // ----------------------------------------------------------------------
49 
52 
53  public:
54 
55  // ----------------------------------------------------------------------
56  // Public member functions for InputCompressChunkPort
57  // ----------------------------------------------------------------------
58 
60  void init();
61 
63  void addCallComp(
64  Fw::PassiveComponentBase* callComp,
65  CompFuncPtr funcPtr
66  );
67 
70  Fw::Buffer& buffer,
71  FwSizeType min_compression,
72  FwSizeType write_offset
73  );
74 
75  private:
76 
77  // ----------------------------------------------------------------------
78  // Private member functions for InputCompressChunkPort
79  // ----------------------------------------------------------------------
80 
81 #if FW_PORT_SERIALIZATION == 1
82 
85  Fw::SerializeStatus invokeSerial(
86  Fw::LinearBufferBase& _buffer
87  );
88 
89 #endif
90 
91  private:
92 
93  // ----------------------------------------------------------------------
94  // Private member variables for InputCompressChunkPort
95  // ----------------------------------------------------------------------
96 
98  CompFuncPtr m_func;
99 
100  };
101 
104  public Fw::OutputPortBase
105  {
106 
107  public:
108 
109  // ----------------------------------------------------------------------
110  // Public constructors for OutputCompressChunkPort
111  // ----------------------------------------------------------------------
112 
115 
116  public:
117 
118  // ----------------------------------------------------------------------
119  // Public member functions for OutputCompressChunkPort
120  // ----------------------------------------------------------------------
121 
123  void init();
124 
126  void addCallPort(
127  InputCompressChunkPort* callPort
128  );
129 
133  Fw::Buffer& buffer,
134  FwSizeType min_compression,
135  FwSizeType write_offset
136  ) const;
137 
138  private:
139 
140  // ----------------------------------------------------------------------
141  // Private member variables for OutputCompressChunkPort
142  // ----------------------------------------------------------------------
143 
145  InputCompressChunkPort* m_port;
146 
147  };
148 
149 #endif
150 
151 }
152 
153 #endif
PlatformSizeType FwSizeType
SerializeStatus
forward declaration for string
void addCallPort(InputCompressChunkPort *callPort)
Register an input port.
void init()
Initialization function.
Svc::CompressionAlgorithm invoke(Fw::Buffer &buffer, FwSizeType min_compression, FwSizeType write_offset)
Invoke a port interface.
Output CompressChunk port.
void addCallComp(Fw::PassiveComponentBase *callComp, CompFuncPtr funcPtr)
Register a component.
void init()
Initialization function.
Svc::CompressionAlgorithm invoke(Fw::Buffer &buffer, FwSizeType min_compression, FwSizeType write_offset) const
PlatformIndexType FwIndexType
RateGroupDivider component implementation.
Input CompressChunk port.
Svc::CompressionAlgorithm(* CompFuncPtr)(Fw::PassiveComponentBase *callComp, FwIndexType portNum, Fw::Buffer &buffer, FwSizeType min_compression, FwSizeType write_offset)
The port callback function type.