![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
Auto-generated base for ComLogger component. More...
#include <Svc/ComLogger/ComLoggerComponentAc.hpp>
Public Member Functions | |
void | init (FwSizeType queueDepth, FwEnumStoreType instance=0) |
Initialize ComLoggerComponentBase object. More... | |
Fw::InputCmdPort * | get_cmdIn_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_logOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port) |
Connect port to logOut[portNum]. More... | |
void | set_timeCaller_OutputPort (FwIndexType portNum, Fw::InputTimePort *port) |
Connect port to timeCaller[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 (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... | |
![]() | |
void | setIdBase (const U32) |
Set the ID base. More... | |
U32 | getIdBase () const |
Protected Types | |
enum | { NUM_CMDIN_INPUT_PORTS = 1 } |
Enumerations for numbers of special input ports. More... | |
enum | { NUM_COMIN_INPUT_PORTS = 1, NUM_PINGIN_INPUT_PORTS = 1 } |
Enumerations for numbers of typed input ports. More... | |
enum | { NUM_LOGTEXT_OUTPUT_PORTS = 1, NUM_CMDREGOUT_OUTPUT_PORTS = 1, NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1, NUM_LOGOUT_OUTPUT_PORTS = 1, NUM_TIMECALLER_OUTPUT_PORTS = 1 } |
Enumerations for numbers of special output ports. More... | |
enum | { NUM_PINGOUT_OUTPUT_PORTS = 1 } |
Enumerations for numbers of typed output ports. More... | |
enum | { OPCODE_CLOSEFILE = 0x0 } |
Command opcodes. More... | |
enum | { EVENTID_FILEOPENERROR = 0x0, EVENTID_FILEWRITEERROR = 0x1, EVENTID_FILEVALIDATIONERROR = 0x2, EVENTID_FILECLOSED = 0x3, EVENTID_FILENOTINITIALIZED = 0x4 } |
Event IDs. More... | |
enum | { EVENTID_FILENOTINITIALIZED_THROTTLE = 5 } |
Event throttle values: sets initial value of countdown variables. More... | |
![]() | |
enum | Lifecycle { CREATED, DISPATCHING, FINALIZING, DONE } |
Tracks the lifecycle of the component. More... | |
Protected Member Functions | |
ComLoggerComponentBase (const char *compName="") | |
Construct ComLoggerComponentBase object. More... | |
virtual | ~ComLoggerComponentBase () |
Destroy ComLoggerComponentBase object. More... | |
FwIndexType | getNum_cmdIn_InputPorts () const |
FwIndexType | getNum_comIn_InputPorts () const |
FwIndexType | getNum_pingIn_InputPorts () const |
FwIndexType | getNum_cmdRegOut_OutputPorts () const |
FwIndexType | getNum_cmdResponseOut_OutputPorts () const |
FwIndexType | getNum_logOut_OutputPorts () const |
FwIndexType | getNum_timeCaller_OutputPorts () const |
FwIndexType | getNum_pingOut_OutputPorts () const |
bool | isConnected_cmdRegOut_OutputPort (FwIndexType portNum) |
bool | isConnected_cmdResponseOut_OutputPort (FwIndexType portNum) |
bool | isConnected_logOut_OutputPort (FwIndexType portNum) |
bool | isConnected_timeCaller_OutputPort (FwIndexType portNum) |
bool | isConnected_pingOut_OutputPort (FwIndexType portNum) |
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 | 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 | 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 | 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... | |
virtual void | CloseFile_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0 |
void | CloseFile_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
virtual void | CloseFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
Pre-message hook for command CloseFile. More... | |
void | log_WARNING_HI_FileOpenError (U32 errornum, const Fw::StringBase &file) const |
void | log_WARNING_HI_FileWriteError (U32 errornum, U32 bytesWritten, U32 bytesToWrite, const Fw::StringBase &file) const |
void | log_WARNING_LO_FileValidationError (const Fw::StringBase &validationFile, const Fw::StringBase &file, U32 status) const |
void | log_DIAGNOSTIC_FileClosed (const Fw::StringBase &file) const |
void | log_WARNING_LO_FileNotInitialized () |
Log event FileNotInitialized. More... | |
void | log_WARNING_LO_FileNotInitialized_ThrottleClear () |
Reset throttle value for FileNotInitialized. More... | |
Fw::Time | getTime () |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
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 |
![]() | |
ObjBase (const char *name) | |
ObjBase constructor. More... | |
virtual | ~ObjBase () |
Destructor. More... | |
void | init () |
Object initializer. More... | |
Friends | |
class | ComLoggerComponentBaseFriend |
Friend class for white-box testing. More... | |
Additional Inherited Members | |
![]() | |
enum | { ACTIVE_COMPONENT_EXIT } |
![]() | |
enum | MsgDispatchStatus { MSG_DISPATCH_OK, MSG_DISPATCH_EMPTY, MSG_DISPATCH_ERROR, MSG_DISPATCH_EXIT } |
![]() | |
Os::Task | m_task |
task object for active component More... | |
![]() | |
Os::Queue | m_queue |
queue object for active component More... | |
Auto-generated base for ComLogger component.
A component for logging Com buffers
Definition at line 33 of file ComLoggerComponentAc.hpp.
|
protected |
Enumerations for numbers of special input ports.
Enumerator | |
---|---|
NUM_CMDIN_INPUT_PORTS |
Definition at line 51 of file ComLoggerComponentAc.hpp.
|
protected |
Enumerations for numbers of typed input ports.
Enumerator | |
---|---|
NUM_COMIN_INPUT_PORTS | |
NUM_PINGIN_INPUT_PORTS |
Definition at line 56 of file ComLoggerComponentAc.hpp.
|
protected |
Enumerations for numbers of special output ports.
Enumerator | |
---|---|
NUM_LOGTEXT_OUTPUT_PORTS | |
NUM_CMDREGOUT_OUTPUT_PORTS | |
NUM_CMDRESPONSEOUT_OUTPUT_PORTS | |
NUM_LOGOUT_OUTPUT_PORTS | |
NUM_TIMECALLER_OUTPUT_PORTS |
Definition at line 62 of file ComLoggerComponentAc.hpp.
|
protected |
Enumerations for numbers of typed output ports.
Enumerator | |
---|---|
NUM_PINGOUT_OUTPUT_PORTS |
Definition at line 71 of file ComLoggerComponentAc.hpp.
|
protected |
Command opcodes.
Enumerator | |
---|---|
OPCODE_CLOSEFILE | Forces a close of the currently opened file. |
Definition at line 76 of file ComLoggerComponentAc.hpp.
|
protected |
Event IDs.
Enumerator | |
---|---|
EVENTID_FILEOPENERROR | The ComLogger encountered an error opening a file. |
EVENTID_FILEWRITEERROR | The ComLogger encountered an error writing to a file. |
EVENTID_FILEVALIDATIONERROR | The ComLogger encountered an error writing the validation file. |
EVENTID_FILECLOSED | The ComLogger successfully closed a file on command. |
EVENTID_FILENOTINITIALIZED |
Definition at line 81 of file ComLoggerComponentAc.hpp.
|
protected |
Event throttle values: sets initial value of countdown variables.
Enumerator | |
---|---|
EVENTID_FILENOTINITIALIZED_THROTTLE | Throttle reset count for FileNotInitialized. |
Definition at line 90 of file ComLoggerComponentAc.hpp.
|
protected |
Construct ComLoggerComponentBase object.
compName | The component name |
Definition at line 540 of file ComLoggerComponentAc.cpp.
|
protectedvirtual |
Destroy ComLoggerComponentBase object.
Definition at line 547 of file ComLoggerComponentAc.cpp.
|
protectedpure virtual |
Handler for command CloseFile
Forces a close of the currently opened file.
opCode | The opcode |
cmdSeq | The command sequence number |
|
protected |
Base-class handler function for command CloseFile
Forces a close of the currently opened file.
opCode | The opcode |
cmdSeq | The command sequence number |
args | The command argument buffer |
Definition at line 893 of file ComLoggerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command CloseFile.
opCode | The opcode |
cmdSeq | The command sequence number |
Definition at line 960 of file ComLoggerComponentAc.cpp.
|
protected |
Emit command response.
opCode | The opcode |
cmdSeq | The command sequence number |
response | The command response |
Definition at line 876 of file ComLoggerComponentAc.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 711 of file ComLoggerComponentAc.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 834 of file ComLoggerComponentAc.cpp.
Fw::InputCmdPort * Svc::ComLoggerComponentBase::get_cmdIn_InputPort | ( | FwIndexType | portNum | ) |
Get special input port at index
portNum | The port number |
Definition at line 285 of file ComLoggerComponentAc.cpp.
Fw::InputComPort * Svc::ComLoggerComponentBase::get_comIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 300 of file ComLoggerComponentAc.cpp.
Svc::InputPingPort * Svc::ComLoggerComponentBase::get_pingIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 311 of file ComLoggerComponentAc.cpp.
|
protected |
Get the number of cmdIn input ports
Definition at line 557 of file ComLoggerComponentAc.cpp.
|
protected |
Get the number of cmdRegOut output ports
Definition at line 593 of file ComLoggerComponentAc.cpp.
|
protected |
Get the number of cmdResponseOut output ports
Definition at line 599 of file ComLoggerComponentAc.cpp.
|
protected |
Get the number of comIn input ports
Definition at line 567 of file ComLoggerComponentAc.cpp.
|
protected |
Get the number of logOut output ports
Definition at line 605 of file ComLoggerComponentAc.cpp.
|
protected |
Get the number of pingIn input ports
Definition at line 573 of file ComLoggerComponentAc.cpp.
|
protected |
Get the number of pingOut output ports
Definition at line 621 of file ComLoggerComponentAc.cpp.
|
protected |
Get the number of timeCaller output ports
Definition at line 611 of file ComLoggerComponentAc.cpp.
|
protected |
void Svc::ComLoggerComponentBase::init | ( | FwSizeType | queueDepth, |
FwEnumStoreType | instance = 0 |
||
) |
Initialize ComLoggerComponentBase object.
queueDepth | The queue depth |
instance | The instance number |
Definition at line 73 of file ComLoggerComponentAc.cpp.
|
protected |
Check whether port cmdRegOut is connected
portNum | The port number |
Definition at line 646 of file ComLoggerComponentAc.cpp.
|
protected |
Check whether port cmdResponseOut is connected
portNum | The port number |
Definition at line 657 of file ComLoggerComponentAc.cpp.
|
protected |
Check whether port logOut is connected
portNum | The port number |
Definition at line 668 of file ComLoggerComponentAc.cpp.
|
protected |
Check whether port pingOut is connected
portNum | The port number |
Definition at line 694 of file ComLoggerComponentAc.cpp.
|
protected |
Check whether port timeCaller is connected
portNum | The port number |
Definition at line 679 of file ComLoggerComponentAc.cpp.
|
protected |
Log event FileClosed
The ComLogger successfully closed a file on command.
file | The file |
Definition at line 1295 of file ComLoggerComponentAc.cpp.
|
protected |
Log event FileOpenError
The ComLogger encountered an error opening a file
errornum | The error number returned from open file |
file | The file |
Definition at line 975 of file ComLoggerComponentAc.cpp.
|
protected |
Log event FileWriteError
The ComLogger encountered an error writing to a file
errornum | The error number returned from write file |
bytesWritten | The number of bytes successfully written to file |
bytesToWrite | The number of bytes attempted to write to file |
file | The file |
Definition at line 1067 of file ComLoggerComponentAc.cpp.
|
protected |
Log event FileNotInitialized.
Definition at line 1367 of file ComLoggerComponentAc.cpp.
|
protected |
Reset throttle value for FileNotInitialized.
Definition at line 1444 of file ComLoggerComponentAc.cpp.
|
protected |
Log event FileValidationError
The ComLogger encountered an error writing the validation file
validationFile | The validation file |
file | The file |
status | The Os::Validate::Status return |
Definition at line 1195 of file ComLoggerComponentAc.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 773 of file ComLoggerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port pingIn.
portNum | The port number |
key | Value to return to pinger |
Definition at line 844 of file ComLoggerComponentAc.cpp.
|
protected |
Invoke output port pingOut.
portNum | The port number |
key | Value to return to pinger |
Definition at line 857 of file ComLoggerComponentAc.cpp.
void Svc::ComLoggerComponentBase::regCommands | ( | ) |
Register commands with the Command Dispatcher.
Connect the dispatcher first
Definition at line 526 of file ComLoggerComponentAc.cpp.
void Svc::ComLoggerComponentBase::set_cmdRegOut_OutputPort | ( | FwIndexType | portNum, |
Fw::InputCmdRegPort * | port | ||
) |
Connect port to cmdRegOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 344 of file ComLoggerComponentAc.cpp.
void Svc::ComLoggerComponentBase::set_cmdResponseOut_OutputPort | ( | FwIndexType | portNum, |
Fw::InputCmdResponsePort * | port | ||
) |
Connect port to cmdResponseOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 358 of file ComLoggerComponentAc.cpp.
void Svc::ComLoggerComponentBase::set_logOut_OutputPort | ( | FwIndexType | portNum, |
Fw::InputLogPort * | port | ||
) |
Connect port to logOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 372 of file ComLoggerComponentAc.cpp.
void Svc::ComLoggerComponentBase::set_pingOut_OutputPort | ( | FwIndexType | portNum, |
Svc::InputPingPort * | port | ||
) |
Connect port to pingOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 404 of file ComLoggerComponentAc.cpp.
void Svc::ComLoggerComponentBase::set_timeCaller_OutputPort | ( | FwIndexType | portNum, |
Fw::InputTimePort * | port | ||
) |
Connect port to timeCaller[portNum].
portNum | The port number |
port | The input port |
Definition at line 386 of file ComLoggerComponentAc.cpp.
|
friend |
Friend class for white-box testing.
Definition at line 42 of file ComLoggerComponentAc.hpp.