F´ Flight Software - C/C++ Documentation
devel
A framework for building embedded system applications to NASA flight quality standards.
|
#include <Svc/BufferLogger/BufferLogger.hpp>
Public Member Functions | |
BufferLogger (const char *const compName) | |
Create a BufferLogger object. More... | |
void | initLog (const char *const logFilePrefix, const char *const logFileSuffix, const U32 maxFileSize, const U8 sizeOfSize) |
Set up log file parameters. More... | |
Public Member Functions inherited from Svc::BufferLoggerComponentBase | |
void | init (FwSizeType queueDepth, FwEnumStoreType instance=0) |
Initialize BufferLoggerComponentBase object. More... | |
Fw::InputCmdPort * | get_cmdIn_InputPort (FwIndexType portNum) |
Fw::InputBufferSendPort * | get_bufferSendIn_InputPort (FwIndexType portNum) |
Fw::InputComPort * | get_comIn_InputPort (FwIndexType portNum) |
Svc::InputPingPort * | get_pingIn_InputPort (FwIndexType portNum) |
Svc::InputSchedPort * | get_schedIn_InputPort (FwIndexType portNum) |
void | set_cmdRegOut_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port) |
Connect port to cmdRegOut[portNum]. More... | |
void | set_cmdResponseOut_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port) |
Connect port to cmdResponseOut[portNum]. More... | |
void | set_eventOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port) |
Connect port to eventOut[portNum]. More... | |
void | set_timeCaller_OutputPort (FwIndexType portNum, Fw::InputTimePort *port) |
Connect port to timeCaller[portNum]. More... | |
void | set_tlmOut_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port) |
Connect port to tlmOut[portNum]. More... | |
void | set_bufferSendOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port) |
Connect port to bufferSendOut[portNum]. More... | |
void | set_pingOut_OutputPort (FwIndexType portNum, Svc::InputPingPort *port) |
Connect port to pingOut[portNum]. More... | |
void | regCommands () |
Register commands with the Command Dispatcher. More... | |
Public Member Functions inherited from Fw::ActiveComponentBase | |
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 More... | |
void | exit () |
exit task in active component More... | |
Os::Task::Status | join () |
Join the thread. More... | |
DEPRECATED (Os::Task::Status join(void **value_ptr), "Switch to .join()") | |
Join to thread with discarded value_ptr. More... | |
Public Member Functions inherited from Fw::PassiveComponentBase | |
void | setIdBase (const U32) |
Set the ID base. More... | |
U32 | getIdBase () const |
Additional Inherited Members | |
Public Types inherited from Fw::ActiveComponentBase | |
enum | { ACTIVE_COMPONENT_EXIT } |
Public Types inherited from Fw::QueuedComponentBase | |
enum | MsgDispatchStatus { MSG_DISPATCH_OK , MSG_DISPATCH_EMPTY , MSG_DISPATCH_ERROR , MSG_DISPATCH_EXIT } |
Protected Types inherited from Svc::BufferLoggerComponentBase | |
enum | { NUM_CMDIN_INPUT_PORTS = 1 } |
Enumerations for numbers of special input ports. More... | |
enum | { NUM_BUFFERSENDIN_INPUT_PORTS = 1 , NUM_COMIN_INPUT_PORTS = 1 , NUM_PINGIN_INPUT_PORTS = 1 , NUM_SCHEDIN_INPUT_PORTS = 1 } |
Enumerations for numbers of typed input ports. More... | |
enum | { NUM_CMDREGOUT_OUTPUT_PORTS = 1 , NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1 , NUM_EVENTOUT_OUTPUT_PORTS = 1 , NUM_EVENTOUTTEXT_OUTPUT_PORTS = 1 , NUM_TIMECALLER_OUTPUT_PORTS = 1 , NUM_TLMOUT_OUTPUT_PORTS = 1 } |
Enumerations for numbers of special output ports. More... | |
enum | { NUM_BUFFERSENDOUT_OUTPUT_PORTS = 1 , NUM_PINGOUT_OUTPUT_PORTS = 1 } |
Enumerations for numbers of typed output ports. More... | |
enum | { OPCODE_BL_OPENFILE = 0x0 , OPCODE_BL_CLOSEFILE = 0x1 , OPCODE_BL_SETLOGGING = 0x2 , OPCODE_BL_FLUSHFILE = 0x3 } |
Command opcodes. More... | |
enum | { EVENTID_BL_LOGFILECLOSED = 0x0 , EVENTID_BL_LOGFILEOPENERROR = 0x1 , EVENTID_BL_LOGFILEVALIDATIONERROR = 0x2 , EVENTID_BL_LOGFILEWRITEERROR = 0x3 , EVENTID_BL_ACTIVATED = 0x4 , EVENTID_BL_DEACTIVATED = 0x5 , EVENTID_BL_NOLOGFILEOPENINITERROR = 0x6 } |
Event IDs. More... | |
enum | { CHANNELID_BUFFERLOGGER_NUMLOGGEDBUFFERS = 0x0 } |
Channel IDs. More... | |
Protected Types inherited from Fw::ActiveComponentBase | |
enum | Lifecycle { CREATED , DISPATCHING , FINALIZING , DONE } |
Tracks the lifecycle of the component. More... | |
Protected Member Functions inherited from Svc::BufferLoggerComponentBase | |
BufferLoggerComponentBase (const char *compName="") | |
Construct BufferLoggerComponentBase object. More... | |
virtual | ~BufferLoggerComponentBase () |
Destroy BufferLoggerComponentBase object. More... | |
FwIndexType | getNum_cmdIn_InputPorts () const |
FwIndexType | getNum_bufferSendIn_InputPorts () const |
FwIndexType | getNum_comIn_InputPorts () const |
FwIndexType | getNum_pingIn_InputPorts () const |
FwIndexType | getNum_schedIn_InputPorts () const |
FwIndexType | getNum_cmdRegOut_OutputPorts () const |
FwIndexType | getNum_cmdResponseOut_OutputPorts () const |
FwIndexType | getNum_eventOut_OutputPorts () const |
FwIndexType | getNum_timeCaller_OutputPorts () const |
FwIndexType | getNum_tlmOut_OutputPorts () const |
FwIndexType | getNum_bufferSendOut_OutputPorts () const |
FwIndexType | getNum_pingOut_OutputPorts () const |
bool | isConnected_cmdRegOut_OutputPort (FwIndexType portNum) |
bool | isConnected_cmdResponseOut_OutputPort (FwIndexType portNum) |
bool | isConnected_eventOut_OutputPort (FwIndexType portNum) |
bool | isConnected_timeCaller_OutputPort (FwIndexType portNum) |
bool | isConnected_tlmOut_OutputPort (FwIndexType portNum) |
bool | isConnected_bufferSendOut_OutputPort (FwIndexType portNum) |
bool | isConnected_pingOut_OutputPort (FwIndexType portNum) |
void | bufferSendIn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer) |
Handler base-class function for input port bufferSendIn. More... | |
void | comIn_handlerBase (FwIndexType portNum, Fw::ComBuffer &data, U32 context) |
Handler base-class function for input port comIn. More... | |
void | pingIn_handlerBase (FwIndexType portNum, U32 key) |
Handler base-class function for input port pingIn. More... | |
void | schedIn_handlerBase (FwIndexType portNum, U32 context) |
Handler base-class function for input port schedIn. More... | |
virtual void | bufferSendIn_preMsgHook (FwIndexType portNum, Fw::Buffer &fwBuffer) |
Pre-message hook for async input port bufferSendIn. More... | |
virtual void | comIn_preMsgHook (FwIndexType portNum, Fw::ComBuffer &data, U32 context) |
Pre-message hook for async input port comIn. More... | |
virtual void | pingIn_preMsgHook (FwIndexType portNum, U32 key) |
Pre-message hook for async input port pingIn. More... | |
virtual void | schedIn_preMsgHook (FwIndexType portNum, U32 context) |
Pre-message hook for async input port schedIn. More... | |
void | bufferSendOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer) |
Invoke output port bufferSendOut. More... | |
void | pingOut_out (FwIndexType portNum, U32 key) |
Invoke output port pingOut. More... | |
void | cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response) |
Emit command response. More... | |
void | BL_OpenFile_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
void | BL_CloseFile_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
void | BL_SetLogging_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
void | BL_FlushFile_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
virtual void | BL_OpenFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
Pre-message hook for command BL_OpenFile. More... | |
virtual void | BL_CloseFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
Pre-message hook for command BL_CloseFile. More... | |
virtual void | BL_SetLogging_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
Pre-message hook for command BL_SetLogging. More... | |
virtual void | BL_FlushFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
Pre-message hook for command BL_FlushFile. More... | |
void | log_DIAGNOSTIC_BL_LogFileClosed (const Fw::StringBase &file) |
void | log_WARNING_HI_BL_LogFileOpenError (U32 errornum, const Fw::StringBase &file) |
void | log_WARNING_HI_BL_LogFileValidationError (const Fw::StringBase &validationFile, U32 status) |
void | log_WARNING_HI_BL_LogFileWriteError (U32 errornum, U32 bytesWritten, U32 bytesToWrite, const Fw::StringBase &file) |
void | log_ACTIVITY_LO_BL_Activated () |
void | log_ACTIVITY_LO_BL_Deactivated () |
void | log_WARNING_HI_BL_NoLogFileOpenInitError () |
void | tlmWrite_BufferLogger_NumLoggedBuffers (U32 arg, Fw::Time _tlmTime=Fw::Time()) |
Fw::Time | getTime () |
Protected Member Functions inherited from Fw::ActiveComponentBase | |
ActiveComponentBase (const char *name) | |
Constructor. More... | |
virtual | ~ActiveComponentBase () |
Destructor. More... | |
void | init (NATIVE_INT_TYPE instance) |
initialization code More... | |
virtual void | preamble () |
A function that will be called before the event loop is entered. More... | |
MsgDispatchStatus | dispatch () |
The function that will dispatching messages. More... | |
virtual void | finalizer () |
A function that will be called after exiting the loop. More... | |
Protected Member Functions inherited from Fw::QueuedComponentBase | |
QueuedComponentBase (const char *name) | |
Constructor. More... | |
virtual | ~QueuedComponentBase () |
Destructor. More... | |
void | init (NATIVE_INT_TYPE instance) |
initialization function More... | |
Os::Queue::Status | createQueue (FwSizeType depth, FwSizeType msgSize) |
NATIVE_INT_TYPE | getNumMsgsDropped () |
return number of messages dropped More... | |
void | incNumMsgDropped () |
increment the number of messages dropped More... | |
Protected Member Functions inherited from Fw::PassiveComponentBase | |
PassiveComponentBase (const char *name) | |
Named constructor. More... | |
virtual | ~PassiveComponentBase () |
Destructor. More... | |
void | init (NATIVE_INT_TYPE instance) |
Initialization function. More... | |
NATIVE_INT_TYPE | getInstance () const |
Protected Member Functions inherited from Fw::ObjBase | |
ObjBase (const char *name) | |
ObjBase constructor. More... | |
virtual | ~ObjBase () |
Destructor. More... | |
void | init () |
Object initializer. More... | |
Protected Attributes inherited from Fw::ActiveComponentBase | |
Os::Task | m_task |
task object for active component More... | |
Protected Attributes inherited from Fw::QueuedComponentBase | |
Os::Queue | m_queue |
queue object for active component More... | |
Definition at line 25 of file BufferLogger.hpp.
Svc::BufferLogger::BufferLogger | ( | const char *const | compName | ) |
Create a BufferLogger object.
compName | The component name |
Definition at line 22 of file BufferLogger.cpp.
void Svc::BufferLogger::initLog | ( | const char *const | logFilePrefix, |
const char *const | logFileSuffix, | ||
const U32 | maxFileSize, | ||
const U8 | sizeOfSize | ||
) |
Set up log file parameters.
logFilePrefix | The log file name prefix |
logFileSuffix | The log file name suffix |
maxFileSize | The maximum file size |
sizeOfSize | The number of bytes to use when storing the size field at the start of each buffer |
Definition at line 36 of file BufferLogger.cpp.