F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Svc::EventManager Class Referencefinal

#include <Svc/EventManager/EventManager.hpp>

Inheritance diagram for Svc::EventManager:
Svc::EventManagerComponentBase Fw::ActiveComponentBase Fw::QueuedComponentBase Fw::PassiveComponentBase Fw::ObjBase

Public Member Functions

 EventManager (const char *compName)
 constructor More...
 
virtual ~EventManager ()
 destructor More...
 
- Public Member Functions inherited from Svc::EventManagerComponentBase
void init (FwSizeType queueDepth, FwEnumStoreType instance=0)
 Initialize EventManagerComponentBase object. More...
 
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]. More...
 
void set_CmdStatus_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port)
 Connect port to CmdStatus[portNum]. More...
 
void set_Log_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
 Connect port to Log[portNum]. More...
 
void set_Time_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
 Connect port to Time[portNum]. More...
 
void set_FatalAnnounce_OutputPort (FwIndexType portNum, Svc::InputFatalEventPort *port)
 Connect port to FatalAnnounce[portNum]. More...
 
void set_PktSend_OutputPort (FwIndexType portNum, Fw::InputComPort *port)
 Connect port to PktSend[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
 

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::EventManagerComponentBase
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::EventManagerComponentBase
 EventManagerComponentBase (const char *compName="")
 Construct EventManagerComponentBase object. More...
 
virtual ~EventManagerComponentBase ()
 Destroy EventManagerComponentBase object. More...
 
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. More...
 
void pingIn_handlerBase (FwIndexType portNum, U32 key)
 Handler base-class function for input port pingIn. More...
 
virtual void pingIn_preMsgHook (FwIndexType portNum, U32 key)
 Pre-message hook for async input port pingIn. More...
 
void FatalAnnounce_out (FwIndexType portNum, FwEventIdType Id)
 Invoke output port FatalAnnounce. More...
 
void PktSend_out (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
 Invoke output port PktSend. More...
 
void pingOut_out (FwIndexType portNum, U32 key)
 Invoke output port pingOut. More...
 
void loqQueue_internalInterfaceInvoke (FwEventIdType id, const Fw::Time &timeTag, const Fw::LogSeverity &severity, const Fw::LogBuffer &args)
 Internal interface base-class function for loqQueue. More...
 
void cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
 Emit command response. More...
 
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. More...
 
virtual void DUMP_FILTER_STATE_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
 Pre-message hook for command DUMP_FILTER_STATE. More...
 
void log_ACTIVITY_LO_SEVERITY_FILTER_STATE (Svc::EventManager_FilterSeverity severity, bool enabled) const
 
void log_ACTIVITY_HI_ID_FILTER_ENABLED (FwEventIdType ID) const
 
void log_WARNING_LO_ID_FILTER_LIST_FULL (FwEventIdType ID) const
 
void log_ACTIVITY_HI_ID_FILTER_REMOVED (FwEventIdType ID) const
 
void log_WARNING_LO_ID_FILTER_NOT_FOUND (FwEventIdType ID) 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 inherited from Svc::EventManagerComponentBase
static constexpr FwIndexType getNum_CmdDisp_InputPorts ()
 
static constexpr FwIndexType getNum_LogRecv_InputPorts ()
 
static constexpr FwIndexType getNum_pingIn_InputPorts ()
 
static constexpr FwIndexType getNum_CmdReg_OutputPorts ()
 
static constexpr FwIndexType getNum_CmdStatus_OutputPorts ()
 
static constexpr FwIndexType getNum_Log_OutputPorts ()
 
static constexpr FwIndexType getNum_Time_OutputPorts ()
 
static constexpr FwIndexType getNum_FatalAnnounce_OutputPorts ()
 
static constexpr FwIndexType getNum_PktSend_OutputPorts ()
 
static constexpr FwIndexType getNum_pingOut_OutputPorts ()
 
- 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...
 

Detailed Description

Definition at line 17 of file EventManager.hpp.

Constructor & Destructor Documentation

◆ EventManager()

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

constructor

Definition at line 21 of file EventManager.cpp.

◆ ~EventManager()

Svc::EventManager::~EventManager ( )
virtual

destructor

Definition at line 39 of file EventManager.cpp.


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