F´ Flight Software - C/C++ Documentation  NASA-v1.5.0
A framework for building embedded system applications to NASA flight quality standards.
ActiveTextLoggerImpl.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 ActiveTextLoggerComponentImpl(const char* compName);
37 
41 
48  void init(NATIVE_INT_TYPE queueDepth, NATIVE_INT_TYPE instance = 0);
49 
59  bool set_log_file(const char* fileName, const U32 maxSize, const U32 maxBackups = 10);
60 
61 
63 
64  // ----------------------------------------------------------------------
65  // Prohibit Copying
66  // ----------------------------------------------------------------------
67 
72 
77 
78  // ----------------------------------------------------------------------
79  // Constants/Types
80  // ----------------------------------------------------------------------
81 
82  // ----------------------------------------------------------------------
83  // Member Functions
84  // ----------------------------------------------------------------------
85 
86  // ----------------------------------------------------------------------
87  // Handlers to implement for typed input ports
88  // ----------------------------------------------------------------------
89 
91  //
92  virtual void TextLogger_handler(
94  FwEventIdType id,
95  Fw::Time &timeTag,
98  );
99 
100  // ----------------------------------------------------------------------
101  // Internal interface handlers
102  // ----------------------------------------------------------------------
103 
108  );
109 
110  // ----------------------------------------------------------------------
111  // Member Variables
112  // ----------------------------------------------------------------------
113 
114  // The optional file to text logs to:
116 
117  };
118 
119 }
120 #endif /* ACTIVETEXTLOGGERIMPL_HPP_ */
Fw::InternalInterfaceString
Definition: InternalInterfaceString.hpp:11
Svc::ActiveTextLoggerComponentImpl::TextLogger_handler
virtual void TextLogger_handler(NATIVE_INT_TYPE portNum, FwEventIdType id, Fw::Time &timeTag, Fw::TextLogSeverity severity, Fw::TextLogString &text)
Handler for input port TextLogger.
Definition: ActiveTextLoggerImpl.cpp:37
Svc::ActiveTextLoggerComponentBase::text
PROTECTED FwEventIdType Fw::Time Fw::TextLogSeverity Fw::TextLogString & text
Definition: ActiveTextLoggerComponentAc.hpp:101
Fw::TextLogString
Definition: TextLogString.hpp:11
PRIVATE
#define PRIVATE
overridable private for unit testing
Definition: BasicTypes.hpp:118
Fw::Time
Definition: Time.hpp:10
Svc::ActiveTextLoggerComponentImpl::TextQueue_internalInterfaceHandler
virtual void TextQueue_internalInterfaceHandler(const Fw::InternalInterfaceString &text)
Definition: ActiveTextLoggerImpl.cpp:129
Fw::TextLogSeverity
TextLogSeverity
Definition: LogTextPortAc.hpp:26
Svc::ActiveTextLoggerComponentBase::timeTag
PROTECTED FwEventIdType Fw::Time & timeTag
Definition: ActiveTextLoggerComponentAc.hpp:98
Svc::ActiveTextLoggerComponentBase::portNum
PRIVATE NATIVE_INT_TYPE portNum
Definition: ActiveTextLoggerComponentAc.hpp:193
Svc::ActiveTextLoggerComponentBase
Auto-generated base for ActiveTextLogger component.
Definition: ActiveTextLoggerComponentAc.hpp:34
Svc::ActiveTextLoggerComponentImpl
Active text logger component class.
Definition: ActiveTextLoggerImpl.hpp:24
Svc::ActiveTextLoggerComponentImpl::ActiveTextLoggerComponentImpl
ActiveTextLoggerComponentImpl(const char *compName)
Component constructor.
Definition: ActiveTextLoggerImpl.cpp:16
LogFile.hpp
Fw::ObjBase::init
void init(void)
Object initializer.
Definition: ObjBase.cpp:26
ActiveTextLoggerComponentAc.hpp
Svc::ActiveTextLoggerComponentImpl::~ActiveTextLoggerComponentImpl
virtual ~ActiveTextLoggerComponentImpl()
Component destructor.
Definition: ActiveTextLoggerImpl.cpp:23
Svc::ActiveTextLoggerComponentImpl::operator=
ActiveTextLoggerComponentImpl & operator=(const ActiveTextLoggerComponentImpl &)
Copy assignment operator.
Svc::LogFile
LogFile struct.
Definition: LogFile.hpp:22
Svc::ActiveTextLoggerComponentImpl::set_log_file
bool set_log_file(const char *fileName, const U32 maxSize, const U32 maxBackups=10)
Set log file and max size.
Definition: ActiveTextLoggerImpl.cpp:144
Svc
Definition: ActiveLoggerComponentAc.cpp:22
Svc::ActiveTextLoggerComponentBase::severity
PROTECTED FwEventIdType Fw::Time Fw::TextLogSeverity severity
Definition: ActiveTextLoggerComponentAc.hpp:99
Svc::ActiveTextLoggerComponentImpl::m_log_file
LogFile m_log_file
Definition: ActiveTextLoggerImpl.hpp:115
FwEventIdType
#define FwEventIdType
Type representation for a event id.
Definition: FpConfig.hpp:70
NATIVE_INT_TYPE
int NATIVE_INT_TYPE
native integer type declaration
Definition: BasicTypes.hpp:29