![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
#include <Svc/ActiveTextLogger/ActiveTextLogger.hpp>
Public Member Functions | |
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. | |
![]() | |
void | init (FwSizeType queueDepth, FwEnumStoreType instance=0) |
Initialize ActiveTextLoggerComponentBase object. | |
Fw::InputLogTextPort * | get_TextLogger_InputPort (FwIndexType portNum) |
![]() | |
void | start (Os::Task::ParamType priority=Os::Task::TASK_DEFAULT, Os::Task::ParamType stackSize=Os::Task::TASK_DEFAULT, Os::Task::ParamType cpuAffinity=Os::Task::TASK_DEFAULT, Os::Task::ParamType identifier=Os::Task::TASK_DEFAULT) |
called by instantiator when task is to be started | |
void | exit () |
exit task in active component | |
Os::Task::Status | join () |
Join the thread. | |
DEPRECATED (Os::Task::Status join(void **value_ptr), "Switch to .join()") | |
Join to thread with discarded value_ptr. | |
![]() | |
void | setIdBase (const U32) |
Set the ID base. | |
U32 | getIdBase () const |
Additional Inherited Members | |
![]() | |
enum | { ACTIVE_COMPONENT_EXIT } |
![]() | |
enum | MsgDispatchStatus { MSG_DISPATCH_OK , MSG_DISPATCH_EMPTY , MSG_DISPATCH_ERROR , MSG_DISPATCH_EXIT } |
![]() | |
enum | { NUM_TEXTLOGGER_INPUT_PORTS = 1 } |
Enumerations for numbers of typed input ports. More... | |
![]() | |
enum | Lifecycle { CREATED , DISPATCHING , FINALIZING , DONE } |
Tracks the lifecycle of the component. More... | |
![]() | |
ActiveTextLoggerComponentBase (const char *compName="") | |
Construct ActiveTextLoggerComponentBase object. | |
virtual | ~ActiveTextLoggerComponentBase () |
Destroy ActiveTextLoggerComponentBase object. | |
FwIndexType | getNum_TextLogger_InputPorts () const |
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. | |
void | TextQueue_internalInterfaceInvoke (const Fw::InternalInterfaceString &text) |
Internal interface base-class function for TextQueue. | |
![]() | |
ActiveComponentBase (const char *name) | |
Constructor. | |
virtual | ~ActiveComponentBase () |
Destructor. | |
void | init (NATIVE_INT_TYPE instance) |
initialization code | |
virtual void | preamble () |
A function that will be called before the event loop is entered. | |
MsgDispatchStatus | dispatch () |
The function that will dispatching messages. | |
virtual void | finalizer () |
A function that will be called after exiting the loop. | |
![]() | |
QueuedComponentBase (const char *name) | |
Constructor. | |
virtual | ~QueuedComponentBase () |
Destructor. | |
void | init (NATIVE_INT_TYPE instance) |
initialization function | |
Os::Queue::Status | createQueue (FwSizeType depth, FwSizeType msgSize) |
NATIVE_INT_TYPE | getNumMsgsDropped () |
return number of messages dropped | |
void | incNumMsgDropped () |
increment the number of messages dropped | |
![]() | |
PassiveComponentBase (const char *name) | |
Named constructor. | |
virtual | ~PassiveComponentBase () |
Destructor. | |
void | init (NATIVE_INT_TYPE instance) |
Initialization function. | |
NATIVE_INT_TYPE | getInstance () const |
![]() | |
ObjBase (const char *name) | |
ObjBase constructor. | |
virtual | ~ObjBase () |
Destructor. | |
void | init () |
Object initializer. | |
![]() | |
Os::Task | m_task |
task object for active component | |
![]() | |
Os::Queue | m_queue |
queue object for active component | |
Definition at line 24 of file ActiveTextLogger.hpp.
|
explicit |
Component constructor.
The constructor initializes the state of the component.
Note: Making constructor explicit to prevent implicit type conversion.
compName | the component instance name |
Definition at line 17 of file ActiveTextLogger.cpp.
|
virtual |
bool Svc::ActiveTextLogger::set_log_file | ( | const char * | fileName, |
const U32 | maxSize, | ||
const U32 | maxBackups = 10 |
||
) |
Set log file and max size.
This is to create an optional log file to write all the messages to. The file will not be written to once the max size is hit.
fileName | The name of the file to create. Must be less than 80 characters. |
maxSize | The max size of the file |
maxBackups | The maximum backups of the log file. Default: 10 |
Definition at line 110 of file ActiveTextLogger.cpp.