F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
ActiveTextLogger.hpp
Go to the documentation of this file.
1 // \copyright
2 // Copyright 2009-2015, by the California Institute of Technology.
3 // ALL RIGHTS RESERVED. United States Government Sponsorship
4 // acknowledged.
5 
6 
7 #ifndef ACTIVETEXTLOGGERIMPL_HPP_
8 #define ACTIVETEXTLOGGERIMPL_HPP_
9 
12 
13 
14 namespace Svc {
15 
23 
25 
26  public:
27 
36  explicit ActiveTextLogger(const char* compName);
37 
40  virtual ~ActiveTextLogger();
41 
52  bool set_log_file(const char* fileName, const U32 maxSize, const U32 maxBackups = 10);
53 
54 
55  PRIVATE:
56 
57  // ----------------------------------------------------------------------
58  // Prohibit Copying
59  // ----------------------------------------------------------------------
60 
65 
69  ActiveTextLogger& operator=(const ActiveTextLogger&);
70 
71  // ----------------------------------------------------------------------
72  // Constants/Types
73  // ----------------------------------------------------------------------
74 
75  // ----------------------------------------------------------------------
76  // Member Functions
77  // ----------------------------------------------------------------------
78 
79  // ----------------------------------------------------------------------
80  // Handlers to implement for typed input ports
81  // ----------------------------------------------------------------------
82 
84  //
85  virtual void TextLogger_handler(
86  NATIVE_INT_TYPE portNum,
87  FwEventIdType id,
88  Fw::Time &timeTag,
89  const Fw::LogSeverity& severity,
90  Fw::TextLogString &text
91  );
92 
93  // ----------------------------------------------------------------------
94  // Internal interface handlers
95  // ----------------------------------------------------------------------
96 
99  virtual void TextQueue_internalInterfaceHandler(
100  const Fw::InternalInterfaceString& text
101  );
102 
103  // ----------------------------------------------------------------------
104  // Member Variables
105  // ----------------------------------------------------------------------
106 
107  // The optional file to text logs to:
108  LogFile m_log_file;
109 
110  };
111 
112 }
113 #endif /* ACTIVETEXTLOGGERIMPL_HPP_ */
PlatformIntType NATIVE_INT_TYPE
Definition: BasicTypes.h:55
U32 FwEventIdType
Definition: FpConfig.h:103
Enum representing event severity.
Definition: Time.hpp:9
Auto-generated base for ActiveTextLogger component.
ActiveTextLogger(const char *compName)
Component constructor.
virtual ~ActiveTextLogger()
Component destructor.
bool set_log_file(const char *fileName, const U32 maxSize, const U32 maxBackups=10)
Set log file and max size.
LogFile struct.
Definition: LogFile.hpp:22