F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
PassiveTextLoggerComponentAc.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title PassiveTextLoggerComponentAc.hpp
3 // \author Generated by fpp-to-cpp
4 // \brief hpp file for PassiveTextLogger component base class
5 // ======================================================================
6 
7 #ifndef Svc_PassiveTextLoggerComponentAc_HPP
8 #define Svc_PassiveTextLoggerComponentAc_HPP
9 
10 #include "FpConfig.hpp"
12 #if FW_ENABLE_TEXT_LOGGING == 1
13 #include "Fw/Log/LogTextPortAc.hpp"
14 #endif
17 
18 namespace Svc {
19 
26  {
27 
28  // ----------------------------------------------------------------------
29  // Friend classes
30  // ----------------------------------------------------------------------
31 
34 
35  PROTECTED:
36 
37  // ----------------------------------------------------------------------
38  // Constants
39  // ----------------------------------------------------------------------
40 
42  enum {
44  };
45 
46  public:
47 
48  // ----------------------------------------------------------------------
49  // Component initialization
50  // ----------------------------------------------------------------------
51 
53  void init(
54  FwEnumStoreType instance = 0
55  );
56 
57  public:
58 
59  // ----------------------------------------------------------------------
60  // Getters for typed input ports
61  // ----------------------------------------------------------------------
62 
67  FwIndexType portNum
68  );
69 
70  PROTECTED:
71 
72  // ----------------------------------------------------------------------
73  // Component construction and destruction
74  // ----------------------------------------------------------------------
75 
78  const char* compName = ""
79  );
80 
83 
84  PROTECTED:
85 
86  // ----------------------------------------------------------------------
87  // Getters for numbers of typed input ports
88  // ----------------------------------------------------------------------
89 
94 
95  PROTECTED:
96 
97  // ----------------------------------------------------------------------
98  // Handlers to implement for typed input ports
99  // ----------------------------------------------------------------------
100 
102  virtual void TextLogger_handler(
103  FwIndexType portNum,
104  FwEventIdType id,
105  Fw::Time& timeTag,
106  const Fw::LogSeverity& severity,
107  Fw::TextLogString& text
108  ) = 0;
109 
110  PROTECTED:
111 
112  // ----------------------------------------------------------------------
113  // Port handler base-class functions for typed input ports
114  //
115  // Call these functions directly to bypass the corresponding ports
116  // ----------------------------------------------------------------------
117 
120  FwIndexType portNum,
121  FwEventIdType id,
122  Fw::Time& timeTag,
123  const Fw::LogSeverity& severity,
124  Fw::TextLogString& text
125  );
126 
127  PRIVATE:
128 
129  // ----------------------------------------------------------------------
130  // Calls for messages received on typed input ports
131  // ----------------------------------------------------------------------
132 
134  static void m_p_TextLogger_in(
135  Fw::PassiveComponentBase* callComp,
136  FwIndexType portNum,
137  FwEventIdType id,
138  Fw::Time& timeTag,
139  const Fw::LogSeverity& severity,
140  Fw::TextLogString& text
141  );
142 
143  PRIVATE:
144 
145  // ----------------------------------------------------------------------
146  // Typed input ports
147  // ----------------------------------------------------------------------
148 
150  Fw::InputLogTextPort m_TextLogger_InputPort[NUM_TEXTLOGGER_INPUT_PORTS];
151 
152  };
153 
154 }
155 
156 #endif
I32 FwEnumStoreType
Definition: FpConfig.h:64
U32 FwEventIdType
Definition: FpConfig.h:103
PlatformIndexType FwIndexType
Definition: FpConfig.h:25
C++-compatible configuration header for fprime configuration.
Enum representing event severity.
void init()
Object initializer.
Definition: ObjBase.cpp:27
Definition: Time.hpp:9
Auto-generated base for PassiveTextLogger component.
virtual ~PassiveTextLoggerComponentBase()
Destroy PassiveTextLoggerComponentBase object.
friend class PassiveTextLoggerComponentBaseFriend
Friend class for white-box testing.
virtual void TextLogger_handler(FwIndexType portNum, FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::TextLogString &text)=0
Handler for input port TextLogger.
PassiveTextLoggerComponentBase(const char *compName="")
Construct PassiveTextLoggerComponentBase object.
void TextLogger_handlerBase(FwIndexType portNum, FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::TextLogString &text)
Handler base-class function for input port TextLogger.
Fw::InputLogTextPort * get_TextLogger_InputPort(FwIndexType portNum)