![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
Auto-generated base for BufferLogger component. More...
#include <Svc/BufferLogger/BufferLoggerComponentAc.hpp>
Public Member Functions | |
| 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... | |
Public Member Functions inherited from Fw::ActiveComponentBase | |
| 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... | |
Public Member Functions inherited from Fw::QueuedComponentBase | |
| void | deinit () override |
| Allows de-initialization on teardown. More... | |
Public Member Functions inherited from Fw::PassiveComponentBase | |
| void | setIdBase (const FwIdType) |
| Set the ID base. More... | |
| FwIdType | getIdBase () const |
Protected Member Functions | |
| 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... | |
| virtual void | bufferSendIn_handler (FwIndexType portNum, Fw::Buffer &fwBuffer)=0 |
| Handler for input port bufferSendIn. More... | |
| virtual void | comIn_handler (FwIndexType portNum, Fw::ComBuffer &data, U32 context)=0 |
| Handler for input port comIn. More... | |
| virtual void | pingIn_handler (FwIndexType portNum, U32 key)=0 |
| Handler for input port pingIn. 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... | |
| virtual void | BL_OpenFile_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &file)=0 |
| virtual void | BL_CloseFile_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0 |
| virtual void | BL_SetLogging_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Svc::BufferLogger_LogState &state)=0 |
| virtual void | BL_FlushFile_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0 |
| 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 |
Protected Member Functions inherited from Fw::ActiveComponentBase | |
| 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... | |
Protected Member Functions inherited from Fw::QueuedComponentBase | |
| 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... | |
Protected Member Functions inherited from Fw::PassiveComponentBase | |
| PassiveComponentBase (const char *name) | |
| Named constructor. More... | |
| virtual | ~PassiveComponentBase () |
| Destructor. More... | |
| void | init (FwEnumStoreType instance) |
| Initialization function. More... | |
| FwEnumStoreType | 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... | |
Static Protected Member Functions | |
| 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 () |
Friends | |
| class | BufferLoggerTesterBase |
| Friend class tester to support autocoded test harness. More... | |
| class | BufferLoggerTester |
| Friend class tester implementation to support white-box testing. More... | |
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 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... | |
Auto-generated base for BufferLogger component.
Definition at line 41 of file BufferLoggerComponentAc.hpp.
|
protected |
Enumerations for numbers of special input ports.
| Enumerator | |
|---|---|
| NUM_CMDIN_INPUT_PORTS | |
Definition at line 61 of file BufferLoggerComponentAc.hpp.
|
protected |
Enumerations for numbers of typed input ports.
| Enumerator | |
|---|---|
| NUM_BUFFERSENDIN_INPUT_PORTS | |
| NUM_COMIN_INPUT_PORTS | |
| NUM_PINGIN_INPUT_PORTS | |
Definition at line 66 of file BufferLoggerComponentAc.hpp.
|
protected |
Enumerations for numbers of special output ports.
| Enumerator | |
|---|---|
| NUM_CMDREGOUT_OUTPUT_PORTS | |
| NUM_CMDRESPONSEOUT_OUTPUT_PORTS | |
| NUM_EVENTOUT_OUTPUT_PORTS | |
| NUM_EVENTOUTTEXT_OUTPUT_PORTS | |
| NUM_TIMECALLER_OUTPUT_PORTS | |
| NUM_TLMOUT_OUTPUT_PORTS | |
Definition at line 73 of file BufferLoggerComponentAc.hpp.
|
protected |
Enumerations for numbers of typed output ports.
| Enumerator | |
|---|---|
| NUM_BUFFERSENDOUT_OUTPUT_PORTS | |
| NUM_PINGOUT_OUTPUT_PORTS | |
Definition at line 83 of file BufferLoggerComponentAc.hpp.
|
protected |
Command opcodes.
Definition at line 89 of file BufferLoggerComponentAc.hpp.
|
protected |
Event IDs.
| Enumerator | |
|---|---|
| EVENTID_BL_LOGFILECLOSED | The Buffer Logger closed a log file. |
| EVENTID_BL_LOGFILEOPENERROR | The Buffer Logger encountered an error opening a log file. |
| EVENTID_BL_LOGFILEVALIDATIONERROR | The Buffer Logger encountered an error writing a validation file. |
| EVENTID_BL_LOGFILEWRITEERROR | The Buffer Logger encountered an error writing to a log file. |
| EVENTID_BL_ACTIVATED | Buffer logger was activated. |
| EVENTID_BL_DEACTIVATED | Buffer logger was deactivated. |
| EVENTID_BL_NOLOGFILEOPENINITERROR | No log file open command was received by BufferLogger. |
| EVENTID_BL_LOGFILENAMEERROR | The Buffer Logger encountered an error formatting a log file name. |
Definition at line 97 of file BufferLoggerComponentAc.hpp.
|
protected |
Channel IDs.
| Enumerator | |
|---|---|
| CHANNELID_BUFFERLOGGER_NUMLOGGEDBUFFERS | Channel ID for BufferLogger_NumLoggedBuffers. |
Definition at line 109 of file BufferLoggerComponentAc.hpp.
|
protected |
Construct BufferLoggerComponentBase object.
| compName | The component name |
Definition at line 720 of file BufferLoggerComponentAc.cpp.
|
protectedvirtual |
Destroy BufferLoggerComponentBase object.
Definition at line 727 of file BufferLoggerComponentAc.cpp.
|
protectedpure virtual |
Handler for command BL_CloseFile
Close the currently open log file, if any
| opCode | The opcode |
| cmdSeq | The command sequence number |
|
protected |
Base-class handler function for command BL_CloseFile
Close the currently open log file, if any
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1245 of file BufferLoggerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command BL_CloseFile.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 1441 of file BufferLoggerComponentAc.cpp.
|
protectedpure virtual |
Handler for command BL_FlushFile
Flushes the current open log file to disk; a no-op with fprime's unbuffered file I/O, so always returns success
| opCode | The opcode |
| cmdSeq | The command sequence number |
|
protected |
Base-class handler function for command BL_FlushFile
Flushes the current open log file to disk; a no-op with fprime's unbuffered file I/O, so always returns success
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1363 of file BufferLoggerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command BL_FlushFile.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 1463 of file BufferLoggerComponentAc.cpp.
|
protectedpure virtual |
Handler for command BL_OpenFile
Open a new log file with specified name; also resets unique file counter to 0
| opCode | The opcode |
| cmdSeq | The command sequence number |
|
protected |
Base-class handler function for command BL_OpenFile
Open a new log file with specified name; also resets unique file counter to 0
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1186 of file BufferLoggerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command BL_OpenFile.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 1430 of file BufferLoggerComponentAc.cpp.
|
protectedpure virtual |
Handler for command BL_SetLogging
Sets the volatile logging state
| opCode | The opcode |
| cmdSeq | The command sequence number |
|
protected |
Base-class handler function for command BL_SetLogging
Sets the volatile logging state
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1304 of file BufferLoggerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command BL_SetLogging.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 1452 of file BufferLoggerComponentAc.cpp.
|
protectedpure virtual |
Handler for input port bufferSendIn.
| portNum | The port number |
| fwBuffer | The buffer |
|
protected |
Handler base-class function for input port bufferSendIn.
| portNum | The port number |
| fwBuffer | The buffer |
Definition at line 908 of file BufferLoggerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port bufferSendIn.
| portNum | The port number |
| fwBuffer | The buffer |
Definition at line 1089 of file BufferLoggerComponentAc.cpp.
|
protected |
Invoke output port bufferSendOut.
| portNum | The port number |
| fwBuffer | The buffer |
Definition at line 1123 of file BufferLoggerComponentAc.cpp.
|
protected |
Handler base-class function for input port cmdIn.
| portNum | The port number |
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 847 of file BufferLoggerComponentAc.cpp.
|
protected |
Emit command response.
| opCode | The opcode |
| cmdSeq | The command sequence number |
| response | The command response |
Definition at line 1169 of file BufferLoggerComponentAc.cpp.
|
protectedpure virtual |
Handler for input port comIn.
| portNum | The port number |
| data | Buffer containing packet data |
| context | Call context value; meaning chosen by user |
|
protected |
Handler base-class function for input port comIn.
| portNum | The port number |
| data | Buffer containing packet data |
| context | Call context value; meaning chosen by user |
Definition at line 961 of file BufferLoggerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port comIn.
| portNum | The port number |
| data | Buffer containing packet data |
| context | Call context value; meaning chosen by user |
Definition at line 1098 of file BufferLoggerComponentAc.cpp.
| Fw::InputBufferSendPort * Svc::BufferLoggerComponentBase::get_bufferSendIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 387 of file BufferLoggerComponentAc.cpp.
| Fw::InputCmdPort * Svc::BufferLoggerComponentBase::get_cmdIn_InputPort | ( | FwIndexType | portNum | ) |
Get special input port at index
| portNum | The port number |
Definition at line 368 of file BufferLoggerComponentAc.cpp.
| Fw::InputComPort * Svc::BufferLoggerComponentBase::get_comIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 398 of file BufferLoggerComponentAc.cpp.
| Svc::InputPingPort * Svc::BufferLoggerComponentBase::get_pingIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 409 of file BufferLoggerComponentAc.cpp.
|
inlinestaticprotected |
Get the number of bufferSendIn input ports
Definition at line 364 of file BufferLoggerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of bufferSendOut output ports
Definition at line 443 of file BufferLoggerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of cmdIn input ports
Definition at line 351 of file BufferLoggerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of cmdRegOut output ports
Definition at line 391 of file BufferLoggerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of cmdResponseOut output ports
Definition at line 398 of file BufferLoggerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of comIn input ports
Definition at line 371 of file BufferLoggerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of eventOut output ports
Definition at line 405 of file BufferLoggerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of pingIn input ports
Definition at line 378 of file BufferLoggerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of pingOut output ports
Definition at line 450 of file BufferLoggerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of timeCaller output ports
Definition at line 423 of file BufferLoggerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of tlmOut output ports
Definition at line 430 of file BufferLoggerComponentAc.hpp.
|
protected |
| void Svc::BufferLoggerComponentBase::init | ( | FwSizeType | queueDepth, |
| FwEnumStoreType | instance = 0 |
||
| ) |
Initialize BufferLoggerComponentBase object.
| queueDepth | The queue depth |
| instance | The instance number |
Definition at line 70 of file BufferLoggerComponentAc.cpp.
|
protected |
Check whether port bufferSendOut is connected
| portNum | The port number |
Definition at line 817 of file BufferLoggerComponentAc.cpp.
|
protected |
Check whether port cmdRegOut is connected
| portNum | The port number |
Definition at line 739 of file BufferLoggerComponentAc.cpp.
|
protected |
Check whether port cmdResponseOut is connected
| portNum | The port number |
Definition at line 750 of file BufferLoggerComponentAc.cpp.
|
protected |
Check whether port eventOut is connected
| portNum | The port number |
Definition at line 761 of file BufferLoggerComponentAc.cpp.
|
protected |
Check whether port pingOut is connected
| portNum | The port number |
Definition at line 828 of file BufferLoggerComponentAc.cpp.
|
protected |
Check whether port timeCaller is connected
| portNum | The port number |
Definition at line 787 of file BufferLoggerComponentAc.cpp.
|
protected |
Check whether port tlmOut is connected
| portNum | The port number |
Definition at line 798 of file BufferLoggerComponentAc.cpp.
|
protected |
Log event BL_Activated
Buffer logger was activated
Definition at line 1874 of file BufferLoggerComponentAc.cpp.
|
protected |
Log event BL_Deactivated
Buffer logger was deactivated
Definition at line 1939 of file BufferLoggerComponentAc.cpp.
|
protected |
Log event BL_LogFileClosed
The Buffer Logger closed a log file
| file | The file |
Definition at line 1478 of file BufferLoggerComponentAc.cpp.
|
protected |
Log event BL_LogFileNameError
The Buffer Logger encountered an error formatting a log file name
| status | The status returned from the format operation |
Definition at line 2069 of file BufferLoggerComponentAc.cpp.
|
protected |
Log event BL_LogFileOpenError
The Buffer Logger encountered an error opening a log file
| errornum | The error number returned from the open operation |
| file | The file |
Definition at line 1553 of file BufferLoggerComponentAc.cpp.
|
protected |
Log event BL_LogFileValidationError
The Buffer Logger encountered an error writing a validation file
| validationFile | The validation file |
| status | The Os::Validate::Status return |
Definition at line 1648 of file BufferLoggerComponentAc.cpp.
|
protected |
Log event BL_LogFileWriteError
The Buffer Logger encountered an error writing to a log file
| errornum | The error number returned from the write operation |
| bytesWritten | The number of bytes successfully written |
| bytesToWrite | The number of bytes attempted |
| file | The file |
Definition at line 1743 of file BufferLoggerComponentAc.cpp.
|
protected |
Log event BL_NoLogFileOpenInitError
No log file open command was received by BufferLogger
Definition at line 2004 of file BufferLoggerComponentAc.cpp.
|
protectedpure virtual |
Handler for input port pingIn.
| portNum | The port number |
| key | Value to return to pinger |
|
protected |
Handler base-class function for input port pingIn.
| portNum | The port number |
| key | Value to return to pinger |
Definition at line 1023 of file BufferLoggerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port pingIn.
| portNum | The port number |
| key | Value to return to pinger |
Definition at line 1108 of file BufferLoggerComponentAc.cpp.
|
protected |
Invoke output port pingOut.
| portNum | The port number |
| key | Value to return to pinger |
Definition at line 1143 of file BufferLoggerComponentAc.cpp.
| void Svc::BufferLoggerComponentBase::regCommands | ( | ) |
Register commands with the Command Dispatcher.
Connect the dispatcher first
Definition at line 690 of file BufferLoggerComponentAc.cpp.
| void Svc::BufferLoggerComponentBase::set_bufferSendOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputBufferSendPort * | port | ||
| ) |
Connect port to bufferSendOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 524 of file BufferLoggerComponentAc.cpp.
| void Svc::BufferLoggerComponentBase::set_cmdRegOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputCmdRegPort * | port | ||
| ) |
Connect port to cmdRegOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 428 of file BufferLoggerComponentAc.cpp.
| void Svc::BufferLoggerComponentBase::set_cmdResponseOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputCmdResponsePort * | port | ||
| ) |
Connect port to cmdResponseOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 442 of file BufferLoggerComponentAc.cpp.
| void Svc::BufferLoggerComponentBase::set_eventOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputLogPort * | port | ||
| ) |
Connect port to eventOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 456 of file BufferLoggerComponentAc.cpp.
| void Svc::BufferLoggerComponentBase::set_pingOut_OutputPort | ( | FwIndexType | portNum, |
| Svc::InputPingPort * | port | ||
| ) |
Connect port to pingOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 538 of file BufferLoggerComponentAc.cpp.
| void Svc::BufferLoggerComponentBase::set_timeCaller_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputTimePort * | port | ||
| ) |
Connect port to timeCaller[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 488 of file BufferLoggerComponentAc.cpp.
| void Svc::BufferLoggerComponentBase::set_tlmOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputTlmPort * | port | ||
| ) |
Connect port to tlmOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 502 of file BufferLoggerComponentAc.cpp.
|
protected |
Write telemetry channel given its local id and serialized value. Warning: This is a low level telemetry interface that does not guarentee channel type safety. It is up to the caller to make sure the serialized data matches the definition in the model. Update on change semantics are ignored, this telemetry is always written
| id | The channel id |
| _tlmBuff | The serialized telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 2158 of file BufferLoggerComponentAc.cpp.
|
protected |
Write telemetry channel BufferLogger_NumLoggedBuffers
The number of buffers logged
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 2189 of file BufferLoggerComponentAc.cpp.
|
friend |
Friend class tester implementation to support white-box testing.
Definition at line 52 of file BufferLoggerComponentAc.hpp.
|
friend |
Friend class tester to support autocoded test harness.
Definition at line 50 of file BufferLoggerComponentAc.hpp.