F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Loading...
Searching...
No Matches
Svc::ActiveLoggerImpl Class Reference

#include <Svc/ActiveLogger/ActiveLoggerImpl.hpp>

Inheritance diagram for Svc::ActiveLoggerImpl:
Svc::ActiveLoggerComponentBase Fw::ActiveComponentBase Fw::QueuedComponentBase Fw::PassiveComponentBase Fw::ObjBase

Public Member Functions

 ActiveLoggerImpl (const char *compName)
 constructor
 
virtual ~ActiveLoggerImpl ()
 destructor
 
- Public Member Functions inherited from Svc::ActiveLoggerComponentBase
void init (FwSizeType queueDepth, FwEnumStoreType instance=0)
 Initialize ActiveLoggerComponentBase object.
 
Fw::InputCmdPortget_CmdDisp_InputPort (FwIndexType portNum)
 
Fw::InputLogPortget_LogRecv_InputPort (FwIndexType portNum)
 
Svc::InputPingPortget_pingIn_InputPort (FwIndexType portNum)
 
void set_CmdReg_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port)
 Connect port to CmdReg[portNum].
 
void set_CmdStatus_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port)
 Connect port to CmdStatus[portNum].
 
void set_Log_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
 Connect port to Log[portNum].
 
void set_Time_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
 Connect port to Time[portNum].
 
void set_FatalAnnounce_OutputPort (FwIndexType portNum, Svc::InputFatalEventPort *port)
 Connect port to FatalAnnounce[portNum].
 
void set_PktSend_OutputPort (FwIndexType portNum, Fw::InputComPort *port)
 Connect port to PktSend[portNum].
 
void set_pingOut_OutputPort (FwIndexType portNum, Svc::InputPingPort *port)
 Connect port to pingOut[portNum].
 
void regCommands ()
 Register commands with the Command Dispatcher.
 
- 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
 
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.
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const U32)
 Set the ID base.
 
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::ActiveLoggerComponentBase
enum  { NUM_CMDDISP_INPUT_PORTS = 1 }
 Enumerations for numbers of special input ports. More...
 
enum  { NUM_LOGRECV_INPUT_PORTS = 1 , NUM_PINGIN_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
enum  {
  NUM_CMDREG_OUTPUT_PORTS = 1 , NUM_CMDSTATUS_OUTPUT_PORTS = 1 , NUM_LOG_OUTPUT_PORTS = 1 , NUM_LOGTEXT_OUTPUT_PORTS = 1 ,
  NUM_TIME_OUTPUT_PORTS = 1
}
 Enumerations for numbers of special output ports. More...
 
enum  { NUM_FATALANNOUNCE_OUTPUT_PORTS = 1 , NUM_PKTSEND_OUTPUT_PORTS = 1 , NUM_PINGOUT_OUTPUT_PORTS = 1 }
 Enumerations for numbers of typed output ports. More...
 
enum  { OPCODE_SET_EVENT_FILTER = 0x0 , OPCODE_SET_ID_FILTER = 0x2 , OPCODE_DUMP_FILTER_STATE = 0x3 }
 Command opcodes. More...
 
enum  {
  EVENTID_SEVERITY_FILTER_STATE = 0x0 , EVENTID_ID_FILTER_ENABLED = 0x1 , EVENTID_ID_FILTER_LIST_FULL = 0x2 , EVENTID_ID_FILTER_REMOVED = 0x3 ,
  EVENTID_ID_FILTER_NOT_FOUND = 0x4
}
 Event 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::ActiveLoggerComponentBase
 ActiveLoggerComponentBase (const char *compName="")
 Construct ActiveLoggerComponentBase object.
 
virtual ~ActiveLoggerComponentBase ()
 Destroy ActiveLoggerComponentBase object.
 
FwIndexType getNum_CmdDisp_InputPorts () const
 
FwIndexType getNum_LogRecv_InputPorts () const
 
FwIndexType getNum_pingIn_InputPorts () const
 
FwIndexType getNum_CmdReg_OutputPorts () const
 
FwIndexType getNum_CmdStatus_OutputPorts () const
 
FwIndexType getNum_Log_OutputPorts () const
 
FwIndexType getNum_Time_OutputPorts () const
 
FwIndexType getNum_FatalAnnounce_OutputPorts () const
 
FwIndexType getNum_PktSend_OutputPorts () const
 
FwIndexType getNum_pingOut_OutputPorts () const
 
bool isConnected_CmdReg_OutputPort (FwIndexType portNum)
 
bool isConnected_CmdStatus_OutputPort (FwIndexType portNum)
 
bool isConnected_Log_OutputPort (FwIndexType portNum)
 
bool isConnected_Time_OutputPort (FwIndexType portNum)
 
bool isConnected_FatalAnnounce_OutputPort (FwIndexType portNum)
 
bool isConnected_PktSend_OutputPort (FwIndexType portNum)
 
bool isConnected_pingOut_OutputPort (FwIndexType portNum)
 
void LogRecv_handlerBase (FwIndexType portNum, FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::LogBuffer &args)
 Handler base-class function for input port LogRecv.
 
void pingIn_handlerBase (FwIndexType portNum, U32 key)
 Handler base-class function for input port pingIn.
 
virtual void pingIn_preMsgHook (FwIndexType portNum, U32 key)
 Pre-message hook for async input port pingIn.
 
void FatalAnnounce_out (FwIndexType portNum, FwEventIdType Id)
 Invoke output port FatalAnnounce.
 
void PktSend_out (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
 Invoke output port PktSend.
 
void pingOut_out (FwIndexType portNum, U32 key)
 Invoke output port pingOut.
 
void loqQueue_internalInterfaceInvoke (FwEventIdType id, const Fw::Time &timeTag, const Fw::LogSeverity &severity, const Fw::LogBuffer &args)
 Internal interface base-class function for loqQueue.
 
void cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
 Emit command response.
 
void SET_EVENT_FILTER_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 
void SET_ID_FILTER_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 
void DUMP_FILTER_STATE_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 
virtual void SET_ID_FILTER_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
 Pre-message hook for command SET_ID_FILTER.
 
virtual void DUMP_FILTER_STATE_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
 Pre-message hook for command DUMP_FILTER_STATE.
 
void log_ACTIVITY_LO_SEVERITY_FILTER_STATE (Svc::ActiveLogger_FilterSeverity severity, bool enabled) const
 
void log_ACTIVITY_HI_ID_FILTER_ENABLED (U32 ID) const
 
void log_WARNING_LO_ID_FILTER_LIST_FULL (U32 ID) const
 
void log_ACTIVITY_HI_ID_FILTER_REMOVED (U32 ID) const
 
void log_WARNING_LO_ID_FILTER_NOT_FOUND (U32 ID) const
 
Fw::Time getTime ()
 
- Protected Member Functions inherited from Fw::ActiveComponentBase
 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.
 
- Protected Member Functions inherited from Fw::QueuedComponentBase
 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
 
- Protected Member Functions inherited from Fw::PassiveComponentBase
 PassiveComponentBase (const char *name)
 Named constructor.
 
virtual ~PassiveComponentBase ()
 Destructor.
 
void init (NATIVE_INT_TYPE instance)
 Initialization function.
 
NATIVE_INT_TYPE getInstance () const
 
- Protected Member Functions inherited from Fw::ObjBase
 ObjBase (const char *name)
 ObjBase constructor.
 
virtual ~ObjBase ()
 Destructor.
 
void init ()
 Object initializer.
 
- Protected Attributes inherited from Fw::ActiveComponentBase
Os::Task m_task
 task object for active component
 
- Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue m_queue
 queue object for active component
 

Detailed Description

Definition at line 17 of file ActiveLoggerImpl.hpp.

Constructor & Destructor Documentation

◆ ActiveLoggerImpl()

Svc::ActiveLoggerImpl::ActiveLoggerImpl ( const char *  compName)

constructor

Definition at line 19 of file ActiveLoggerImpl.cpp.

◆ ~ActiveLoggerImpl()

Svc::ActiveLoggerImpl::~ActiveLoggerImpl ( )
virtual

destructor

Definition at line 40 of file ActiveLoggerImpl.cpp.


The documentation for this class was generated from the following files: