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

#include <Svc/FprimeRouter/FprimeRouter.hpp>

Inheritance diagram for Svc::FprimeRouter:
Svc::FprimeRouterComponentBase Fw::PassiveComponentBase Fw::ObjBase

Public Member Functions

 FprimeRouter (const char *const compName)
 Construct FprimeRouter object. More...
 
 ~FprimeRouter ()
 Destroy FprimeRouter object. More...
 
- Public Member Functions inherited from Svc::FprimeRouterComponentBase
void init (FwEnumStoreType instance=0)
 Initialize FprimeRouterComponentBase object. More...
 
Fw::InputCmdResponsePortget_cmdResponseIn_InputPort (FwIndexType portNum)
 
Fw::InputDataWithContextPortget_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_bufferDeallocate_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
 Connect port to bufferDeallocate[portNum]. More...
 
void set_commandOut_OutputPort (FwIndexType portNum, Fw::InputComPort *port)
 Connect port to commandOut[portNum]. More...
 
void set_fileOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
 Connect port to fileOut[portNum]. More...
 
void set_unknownDataOut_OutputPort (FwIndexType portNum, Fw::InputDataWithContextPort *port)
 Connect port to unknownDataOut[portNum]. More...
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const U32)
 Set the ID base. More...
 
U32 getIdBase () const
 

Additional Inherited Members

- Protected Types inherited from Svc::FprimeRouterComponentBase
enum  { NUM_CMDRESPONSEIN_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_BUFFERDEALLOCATE_OUTPUT_PORTS = 1, NUM_COMMANDOUT_OUTPUT_PORTS = 1, NUM_FILEOUT_OUTPUT_PORTS = 1, NUM_UNKNOWNDATAOUT_OUTPUT_PORTS = 1 }
 Enumerations for numbers of typed output ports. More...
 
enum  { EVENTID_SERIALIZATIONERROR = 0x0, EVENTID_DESERIALIZATIONERROR = 0x1 }
 Event IDs. More...
 
- Protected Member Functions inherited from Svc::FprimeRouterComponentBase
 FprimeRouterComponentBase (const char *compName="")
 Construct FprimeRouterComponentBase object. More...
 
virtual ~FprimeRouterComponentBase ()
 Destroy FprimeRouterComponentBase object. More...
 
FwIndexType getNum_cmdResponseIn_InputPorts () const
 
FwIndexType getNum_dataIn_InputPorts () const
 
FwIndexType getNum_logOut_OutputPorts () const
 
FwIndexType getNum_timeCaller_OutputPorts () const
 
FwIndexType getNum_bufferDeallocate_OutputPorts () const
 
FwIndexType getNum_commandOut_OutputPorts () const
 
FwIndexType getNum_fileOut_OutputPorts () const
 
FwIndexType getNum_unknownDataOut_OutputPorts () const
 
bool isConnected_logOut_OutputPort (FwIndexType portNum)
 
bool isConnected_timeCaller_OutputPort (FwIndexType portNum)
 
bool isConnected_bufferDeallocate_OutputPort (FwIndexType portNum)
 
bool isConnected_commandOut_OutputPort (FwIndexType portNum)
 
bool isConnected_fileOut_OutputPort (FwIndexType portNum)
 
bool isConnected_unknownDataOut_OutputPort (FwIndexType portNum)
 
void cmdResponseIn_handlerBase (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)
 Handler base-class function for input port cmdResponseIn. More...
 
void dataIn_handlerBase (FwIndexType portNum, Fw::Buffer &data, Fw::Buffer &context)
 Handler base-class function for input port dataIn. More...
 
void bufferDeallocate_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Invoke output port bufferDeallocate. More...
 
void commandOut_out (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
 Invoke output port commandOut. More...
 
void fileOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Invoke output port fileOut. More...
 
void unknownDataOut_out (FwIndexType portNum, Fw::Buffer &data, Fw::Buffer &context)
 Invoke output port unknownDataOut. More...
 
void log_WARNING_HI_SerializationError (U32 status) const
 
void log_WARNING_HI_DeserializationError (U32 status) const
 
Fw::Time getTime ()
 
- 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...
 

Detailed Description

Definition at line 14 of file FprimeRouter.hpp.

Constructor & Destructor Documentation

◆ FprimeRouter()

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

Construct FprimeRouter object.

Parameters
compNameThe component name

Definition at line 18 of file FprimeRouter.cpp.

◆ ~FprimeRouter()

Svc::FprimeRouter::~FprimeRouter ( )

Destroy FprimeRouter object.

Definition at line 20 of file FprimeRouter.cpp.


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