F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
TlmGetPortAc.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title TlmGetPortAc.hpp
3 // \author Generated by fpp-to-cpp
4 // \brief hpp file for TlmGet port
5 // ======================================================================
6 
7 #ifndef Fw_TlmGetPortAc_HPP
8 #define Fw_TlmGetPortAc_HPP
9 
10 #include "Fw/FPrimeBasicTypes.hpp"
11 #include "Fw/Time/Time.hpp"
12 #include "Fw/Tlm/TlmBuffer.hpp"
15 #if !FW_DIRECT_PORT_CALLS
19 #endif
20 
21 namespace Fw {
22 
23 #if !FW_DIRECT_PORT_CALLS
24 
28  public Fw::InputPortBase
29  {
30 
31  public:
32 
33  // ----------------------------------------------------------------------
34  // Public types for InputTlmGetPort
35  // ----------------------------------------------------------------------
36 
39  Fw::PassiveComponentBase* callComp,
40  FwIndexType portNum,
41  FwChanIdType id,
42  Fw::Time& timeTag,
43  Fw::TlmBuffer& val
44  );
45 
46  public:
47 
48  // ----------------------------------------------------------------------
49  // Public constructors for InputTlmGetPort
50  // ----------------------------------------------------------------------
51 
54 
55  public:
56 
57  // ----------------------------------------------------------------------
58  // Public member functions for InputTlmGetPort
59  // ----------------------------------------------------------------------
60 
62  void init();
63 
65  void addCallComp(
66  Fw::PassiveComponentBase* callComp,
67  CompFuncPtr funcPtr
68  );
69 
72  FwChanIdType id,
73  Fw::Time& timeTag,
74  Fw::TlmBuffer& val
75  );
78 
79  private:
80 
81  // ----------------------------------------------------------------------
82  // Private member functions for InputTlmGetPort
83  // ----------------------------------------------------------------------
84 
85 #if FW_PORT_SERIALIZATION == 1
86 
89  Fw::SerializeStatus invokeSerial(
90  Fw::LinearBufferBase& _buffer
91  );
92 
93 #endif
94 
95  private:
96 
97  // ----------------------------------------------------------------------
98  // Private member variables for InputTlmGetPort
99  // ----------------------------------------------------------------------
100 
102  CompFuncPtr m_func;
103 
104  };
105 
109  public Fw::OutputPortBase
110  {
111 
112  public:
113 
114  // ----------------------------------------------------------------------
115  // Public constructors for OutputTlmGetPort
116  // ----------------------------------------------------------------------
117 
120 
121  public:
122 
123  // ----------------------------------------------------------------------
124  // Public member functions for OutputTlmGetPort
125  // ----------------------------------------------------------------------
126 
128  void init();
129 
131  void addCallPort(
132  InputTlmGetPort* callPort
133  );
134 
138  FwChanIdType id,
139  Fw::Time& timeTag,
140  Fw::TlmBuffer& val
141  ) const;
144 
145  private:
146 
147  // ----------------------------------------------------------------------
148  // Private member variables for OutputTlmGetPort
149  // ----------------------------------------------------------------------
150 
152  InputTlmGetPort* m_port;
153 
154  };
155 
156 #endif
157 
158 }
159 
160 #endif
void init()
Initialization function.
void addCallPort(InputTlmGetPort *callPort)
Register an input port.
Fw::TlmValid(* CompFuncPtr)(Fw::PassiveComponentBase *callComp, FwIndexType portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)
The port callback function type.
SerializeStatus
forward declaration for string
Fw::TlmValid invoke(FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val) const
FwIdType FwChanIdType
The type of a telemetry channel identifier.
void init()
Initialization function.
PlatformIndexType FwIndexType
void addCallComp(Fw::PassiveComponentBase *callComp, CompFuncPtr funcPtr)
Register a component.
InputTlmGetPort()
Constructor.
Implementation of malloc based allocator.
OutputTlmGetPort()
Constructor.
Fw::TlmValid invoke(FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)
Invoke a port interface.