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

#include <Svc/PassThroughRouter/PassThroughRouter.hpp>

Inheritance diagram for Svc::PassThroughRouter:
Svc::PassThroughRouterComponentBase Fw::PassiveComponentBase Fw::ObjBase

Public Member Functions

 PassThroughRouter (const char *const compName)
 Construct PassThroughRouter object. More...
 
 ~PassThroughRouter ()
 Destroy PassThroughRouter object. More...
 
- Public Member Functions inherited from Svc::PassThroughRouterComponentBase
void init (FwEnumStoreType instance=0)
 Initialize PassThroughRouterComponentBase object. More...
 
Fw::InputBufferSendPortget_allPacketsReturnIn_InputPort (FwIndexType portNum)
 
Svc::InputComDataWithContextPortget_dataIn_InputPort (FwIndexType portNum)
 
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_allPacketsOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
 Connect port to allPacketsOut[portNum]. More...
 
void set_dataReturnOut_OutputPort (FwIndexType portNum, Svc::InputComDataWithContextPort *port)
 Connect port to dataReturnOut[portNum]. More...
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const FwIdType)
 Set the ID base. More...
 
FwIdType getIdBase () const
 
virtual void deinit ()
 Deinitialization function. More...
 

Additional Inherited Members

- Protected Types inherited from Svc::PassThroughRouterComponentBase
enum  { NUM_ALLPACKETSRETURNIN_INPUT_PORTS = 1, NUM_DATAIN_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
enum  { NUM_LOGOUT_OUTPUT_PORTS = 1, NUM_LOGTEXTOUT_OUTPUT_PORTS = 1, NUM_TIMECALLER_OUTPUT_PORTS = 1 }
 Enumerations for numbers of special output ports. More...
 
enum  { NUM_ALLPACKETSOUT_OUTPUT_PORTS = 1, NUM_DATARETURNOUT_OUTPUT_PORTS = 1 }
 Enumerations for numbers of typed output ports. More...
 
- Protected Member Functions inherited from Svc::PassThroughRouterComponentBase
 PassThroughRouterComponentBase (const char *compName="")
 Construct PassThroughRouterComponentBase object. More...
 
virtual ~PassThroughRouterComponentBase ()
 Destroy PassThroughRouterComponentBase object. More...
 
bool isConnected_logOut_OutputPort (FwIndexType portNum)
 
bool isConnected_timeCaller_OutputPort (FwIndexType portNum)
 
bool isConnected_allPacketsOut_OutputPort (FwIndexType portNum)
 
bool isConnected_dataReturnOut_OutputPort (FwIndexType portNum)
 
void allPacketsReturnIn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Handler base-class function for input port allPacketsReturnIn. More...
 
void dataIn_handlerBase (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
 Handler base-class function for input port dataIn. More...
 
void allPacketsOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Invoke output port allPacketsOut. More...
 
void dataReturnOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
 Invoke output port dataReturnOut. More...
 
Fw::Time getTime () const
 
- 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::PassThroughRouterComponentBase
static constexpr FwIndexType getNum_allPacketsReturnIn_InputPorts ()
 
static constexpr FwIndexType getNum_dataIn_InputPorts ()
 
static constexpr FwIndexType getNum_logOut_OutputPorts ()
 
static constexpr FwIndexType getNum_timeCaller_OutputPorts ()
 
static constexpr FwIndexType getNum_allPacketsOut_OutputPorts ()
 
static constexpr FwIndexType getNum_dataReturnOut_OutputPorts ()
 

Detailed Description

Definition at line 14 of file PassThroughRouter.hpp.

Constructor & Destructor Documentation

◆ PassThroughRouter()

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

Construct PassThroughRouter object.

Parameters
compNameThe component name

Definition at line 15 of file PassThroughRouter.cpp.

◆ ~PassThroughRouter()

Svc::PassThroughRouter::~PassThroughRouter ( )

Destroy PassThroughRouter object.

Definition at line 17 of file PassThroughRouter.cpp.


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