|
| | BufferLogger (const char *const compName) |
| | Create a BufferLogger object. More...
|
| |
| void | initLog (const char *const logFilePrefix, const char *const logFileSuffix, const FwSizeType maxFileSize, const U8 sizeOfSize) |
| | Set up log file parameters. More...
|
| |
| 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) |
| |
| 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...
|
| |
| void | start (FwTaskPriorityType priority=Os::Task::TASK_PRIORITY_DEFAULT, FwSizeType stackSize=Os::Task::TASK_DEFAULT, FwSizeType cpuAffinity=Os::Task::TASK_DEFAULT, FwTaskIdType identifier=static_cast< FwTaskIdType >(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...
|
| |
| void | deinit () override |
| | Allows de-initialization on teardown. More...
|
| |
| void | setIdBase (const FwIdType) |
| | Set the ID base. More...
|
| |
| FwIdType | getIdBase () const |
| |
|
| enum | { ACTIVE_COMPONENT_EXIT
} |
| |
| enum | MsgDispatchStatus { MSG_DISPATCH_OK,
MSG_DISPATCH_EMPTY,
MSG_DISPATCH_ERROR,
MSG_DISPATCH_EXIT
} |
| |
| 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
} |
| | 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,
EVENTID_BL_LOGFILENAMEERROR = 0x7
} |
| | Event IDs. More...
|
| |
| enum | { CHANNELID_BUFFERLOGGER_NUMLOGGEDBUFFERS = 0x0
} |
| | Channel IDs. More...
|
| |
| enum | Lifecycle { CREATED,
DISPATCHING,
FINALIZING,
DONE
} |
| | Tracks the lifecycle of the component. More...
|
| |
| | BufferLoggerComponentBase (const char *compName="") |
| | Construct BufferLoggerComponentBase object. More...
|
| |
| virtual | ~BufferLoggerComponentBase () |
| | Destroy BufferLoggerComponentBase object. More...
|
| |
| bool | isConnected_cmdRegOut_OutputPort (FwIndexType portNum) const |
| |
| bool | isConnected_cmdResponseOut_OutputPort (FwIndexType portNum) const |
| |
| bool | isConnected_eventOut_OutputPort (FwIndexType portNum) const |
| |
| bool | isConnected_timeCaller_OutputPort (FwIndexType portNum) const |
| |
| bool | isConnected_tlmOut_OutputPort (FwIndexType portNum) const |
| |
| bool | isConnected_bufferSendOut_OutputPort (FwIndexType portNum) const |
| |
| bool | isConnected_pingOut_OutputPort (FwIndexType portNum) const |
| |
| void | cmdIn_handlerBase (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| | Handler base-class function for input port cmdIn. More...
|
| |
| 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...
|
| |
| 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...
|
| |
| void | bufferSendOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer) const |
| | Invoke output port bufferSendOut. More...
|
| |
| void | pingOut_out (FwIndexType portNum, U32 key) const |
| | 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) const |
| |
| void | log_WARNING_HI_BL_LogFileOpenError (U32 errornum, const Fw::StringBase &file) const |
| |
| void | log_WARNING_HI_BL_LogFileValidationError (const Fw::StringBase &validationFile, U32 status) const |
| |
| void | log_WARNING_HI_BL_LogFileWriteError (U32 errornum, U32 bytesWritten, U32 bytesToWrite, const Fw::StringBase &file) const |
| |
| void | log_ACTIVITY_LO_BL_Activated () const |
| |
| void | log_ACTIVITY_LO_BL_Deactivated () const |
| |
| void | log_WARNING_HI_BL_NoLogFileOpenInitError () const |
| |
| void | log_WARNING_HI_BL_LogFileNameError (const Fw::StringFormatStatus &status) const |
| |
| void | tlmWrite (FwChanIdType id, Fw::TlmBuffer &_tlmBuff, Fw::Time _tlmTime=Fw::Time()) const |
| |
| void | tlmWrite_BufferLogger_NumLoggedBuffers (U32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| |
| Fw::Time | getTime () const |
| |
| | ActiveComponentBase (const char *name) |
| | Constructor. More...
|
| |
| virtual | ~ActiveComponentBase () |
| | Destructor. More...
|
| |
| void | init (FwEnumStoreType 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...
|
| |
| | QueuedComponentBase (const char *name) |
| | Constructor. More...
|
| |
| virtual | ~QueuedComponentBase () |
| | Destructor. More...
|
| |
| void | init (FwEnumStoreType instance) |
| | initialization function More...
|
| |
| Os::Queue::Status | createQueue (FwSizeType depth, FwSizeType msgSize) |
| |
| MsgDispatchStatus | dispatchAvailableMessages () |
| | dispatches all messages currently in the queue, returning status of the dispatch More...
|
| |
| FwSizeType | getNumMsgsDropped () |
| | return number of messages dropped More...
|
| |
| void | incNumMsgDropped () |
| | increment the number of messages dropped More...
|
| |
| | PassiveComponentBase (const char *name) |
| | Named constructor. More...
|
| |
| virtual | ~PassiveComponentBase () |
| | Destructor. More...
|
| |
| void | init (FwEnumStoreType instance) |
| | Initialization function. More...
|
| |
| FwEnumStoreType | getInstance () const |
| |
| | ObjBase (const char *name) |
| | ObjBase constructor. More...
|
| |
| virtual | ~ObjBase () |
| | Destructor. More...
|
| |
| void | init () |
| | Object initializer. More...
|
| |
| static constexpr FwIndexType | getNum_cmdIn_InputPorts () |
| |
| static constexpr FwIndexType | getNum_bufferSendIn_InputPorts () |
| |
| static constexpr FwIndexType | getNum_comIn_InputPorts () |
| |
| static constexpr FwIndexType | getNum_pingIn_InputPorts () |
| |
| static constexpr FwIndexType | getNum_cmdRegOut_OutputPorts () |
| |
| static constexpr FwIndexType | getNum_cmdResponseOut_OutputPorts () |
| |
| static constexpr FwIndexType | getNum_eventOut_OutputPorts () |
| |
| static constexpr FwIndexType | getNum_timeCaller_OutputPorts () |
| |
| static constexpr FwIndexType | getNum_tlmOut_OutputPorts () |
| |
| static constexpr FwIndexType | getNum_bufferSendOut_OutputPorts () |
| |
| static constexpr FwIndexType | getNum_pingOut_OutputPorts () |
| |
| Os::Task | m_task |
| | task object for active component More...
|
| |
| Os::Queue | m_queue |
| | queue object for active component More...
|
| |
Definition at line 37 of file BufferLogger.hpp.