![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
Auto-generated base for FprimeRouter component. More...
#include <Svc/FprimeRouter/FprimeRouterComponentAc.hpp>
Protected Types | |
| enum | { NUM_CMDRESPONSEIN_INPUT_PORTS = 1, NUM_DATAIN_INPUT_PORTS = 1, NUM_FILEBUFFERRETURNIN_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_COMMANDOUT_OUTPUT_PORTS = 1, NUM_DATARETURNOUT_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, EVENTID_FILEOUTCONTEXTTABLEFULL = 0x2, EVENTID_UNKNOWNDATAOUTCONTEXTTABLEFULL = 0x3, EVENTID_BUFFERCONTEXTNOTFOUND = 0x4 } |
| Event IDs. More... | |
Protected Member Functions | |
| FprimeRouterComponentBase (const char *compName="") | |
| Construct FprimeRouterComponentBase object. More... | |
| virtual | ~FprimeRouterComponentBase () |
| Destroy FprimeRouterComponentBase object. More... | |
| bool | isConnected_logOut_OutputPort (FwIndexType portNum) const |
| bool | isConnected_timeCaller_OutputPort (FwIndexType portNum) const |
| bool | isConnected_commandOut_OutputPort (FwIndexType portNum) const |
| bool | isConnected_dataReturnOut_OutputPort (FwIndexType portNum) const |
| bool | isConnected_fileOut_OutputPort (FwIndexType portNum) const |
| bool | isConnected_unknownDataOut_OutputPort (FwIndexType portNum) const |
| virtual void | cmdResponseIn_handler (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)=0 |
| Handler for input port cmdResponseIn. More... | |
| virtual void | dataIn_handler (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)=0 |
| Handler for input port dataIn. More... | |
| virtual void | fileBufferReturnIn_handler (FwIndexType portNum, Fw::Buffer &fwBuffer)=0 |
| Handler for input port fileBufferReturnIn. More... | |
| 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, const ComCfg::FrameContext &context) |
| Handler base-class function for input port dataIn. More... | |
| void | fileBufferReturnIn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer) |
| Handler base-class function for input port fileBufferReturnIn. More... | |
| void | commandOut_out (FwIndexType portNum, Fw::ComBuffer &data, U32 context) const |
| Invoke output port commandOut. More... | |
| void | dataReturnOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context) const |
| Invoke output port dataReturnOut. More... | |
| void | fileOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer) const |
| Invoke output port fileOut. More... | |
| void | unknownDataOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context) const |
| Invoke output port unknownDataOut. More... | |
| void | log_WARNING_HI_SerializationError (U32 status) const |
| void | log_WARNING_HI_DeserializationError (U32 status) const |
| void | log_WARNING_HI_FileOutContextTableFull () const |
| void | log_WARNING_HI_UnknownDataOutContextTableFull () const |
| void | log_WARNING_HI_BufferContextNotFound () const |
| Fw::Time | getTime () const |
| virtual void | lock () |
| Lock the guarded mutex. More... | |
| virtual void | unLock () |
| Unlock the guarded mutex. 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 | |
| static constexpr FwIndexType | getNum_cmdResponseIn_InputPorts () |
| static constexpr FwIndexType | getNum_dataIn_InputPorts () |
| static constexpr FwIndexType | getNum_fileBufferReturnIn_InputPorts () |
| static constexpr FwIndexType | getNum_logOut_OutputPorts () |
| static constexpr FwIndexType | getNum_timeCaller_OutputPorts () |
| static constexpr FwIndexType | getNum_commandOut_OutputPorts () |
| static constexpr FwIndexType | getNum_dataReturnOut_OutputPorts () |
| static constexpr FwIndexType | getNum_fileOut_OutputPorts () |
| static constexpr FwIndexType | getNum_unknownDataOut_OutputPorts () |
Friends | |
| class | FprimeRouterTesterBase |
| Friend class tester to support autocoded test harness. More... | |
| class | FprimeRouterTester |
| Friend class tester implementation to support white-box testing. More... | |
Auto-generated base for FprimeRouter component.
Routes packets deframed by the Deframer to the rest of the system
Definition at line 36 of file FprimeRouterComponentAc.hpp.
|
protected |
Enumerations for numbers of typed input ports.
| Enumerator | |
|---|---|
| NUM_CMDRESPONSEIN_INPUT_PORTS | |
| NUM_DATAIN_INPUT_PORTS | |
| NUM_FILEBUFFERRETURNIN_INPUT_PORTS | |
Definition at line 56 of file FprimeRouterComponentAc.hpp.
|
protected |
Enumerations for numbers of special output ports.
| Enumerator | |
|---|---|
| NUM_LOGOUT_OUTPUT_PORTS | |
| NUM_LOGTEXTOUT_OUTPUT_PORTS | |
| NUM_TIMECALLER_OUTPUT_PORTS | |
Definition at line 63 of file FprimeRouterComponentAc.hpp.
|
protected |
Enumerations for numbers of typed output ports.
| Enumerator | |
|---|---|
| NUM_COMMANDOUT_OUTPUT_PORTS | |
| NUM_DATARETURNOUT_OUTPUT_PORTS | |
| NUM_FILEOUT_OUTPUT_PORTS | |
| NUM_UNKNOWNDATAOUT_OUTPUT_PORTS | |
Definition at line 70 of file FprimeRouterComponentAc.hpp.
|
protected |
Event IDs.
Definition at line 78 of file FprimeRouterComponentAc.hpp.
|
protected |
Construct FprimeRouterComponentBase object.
| compName | The component name |
Definition at line 534 of file FprimeRouterComponentAc.cpp.
|
protectedvirtual |
Destroy FprimeRouterComponentBase object.
Definition at line 541 of file FprimeRouterComponentAc.cpp.
|
protectedpure virtual |
Handler for input port cmdResponseIn.
| portNum | The port number |
| opCode | Command Op Code |
| cmdSeq | Command Sequence |
| response | The command response argument |
|
protected |
Handler base-class function for input port cmdResponseIn.
| portNum | The port number |
| opCode | Command Op Code |
| cmdSeq | Command Sequence |
| response | The command response argument |
Definition at line 650 of file FprimeRouterComponentAc.cpp.
|
protected |
Invoke output port commandOut.
| portNum | The port number |
| data | Buffer containing packet data |
| context | Call context value; meaning chosen by user |
Definition at line 731 of file FprimeRouterComponentAc.cpp.
|
protectedpure virtual |
Handler for input port dataIn.
| portNum | The port number |
|
protected |
Handler base-class function for input port dataIn.
| portNum | The port number |
Definition at line 673 of file FprimeRouterComponentAc.cpp.
|
protected |
Invoke output port dataReturnOut.
| portNum | The port number |
Definition at line 753 of file FprimeRouterComponentAc.cpp.
|
protectedpure virtual |
Handler for input port fileBufferReturnIn.
| portNum | The port number |
| fwBuffer | The buffer |
|
protected |
Handler base-class function for input port fileBufferReturnIn.
| portNum | The port number |
| fwBuffer | The buffer |
Definition at line 700 of file FprimeRouterComponentAc.cpp.
|
protected |
Invoke output port fileOut.
| portNum | The port number |
| fwBuffer | The buffer |
Definition at line 775 of file FprimeRouterComponentAc.cpp.
| Fw::InputCmdResponsePort * Svc::FprimeRouterComponentBase::get_cmdResponseIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 259 of file FprimeRouterComponentAc.cpp.
| Svc::InputComDataWithContextPort * Svc::FprimeRouterComponentBase::get_dataIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 270 of file FprimeRouterComponentAc.cpp.
| Fw::InputBufferSendPort * Svc::FprimeRouterComponentBase::get_fileBufferReturnIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 281 of file FprimeRouterComponentAc.cpp.
|
inlinestaticprotected |
Get the number of cmdResponseIn input ports
Definition at line 289 of file FprimeRouterComponentAc.hpp.
|
inlinestaticprotected |
Get the number of commandOut output ports
Definition at line 347 of file FprimeRouterComponentAc.hpp.
|
inlinestaticprotected |
Get the number of dataIn input ports
Definition at line 296 of file FprimeRouterComponentAc.hpp.
|
inlinestaticprotected |
Get the number of dataReturnOut output ports
Definition at line 354 of file FprimeRouterComponentAc.hpp.
|
inlinestaticprotected |
Get the number of fileBufferReturnIn input ports
Definition at line 303 of file FprimeRouterComponentAc.hpp.
|
inlinestaticprotected |
Get the number of fileOut output ports
Definition at line 361 of file FprimeRouterComponentAc.hpp.
|
inlinestaticprotected |
Get the number of logOut output ports
Definition at line 316 of file FprimeRouterComponentAc.hpp.
|
inlinestaticprotected |
Get the number of timeCaller output ports
Definition at line 334 of file FprimeRouterComponentAc.hpp.
|
inlinestaticprotected |
Get the number of unknownDataOut output ports
Definition at line 368 of file FprimeRouterComponentAc.hpp.
|
protected |
| void Svc::FprimeRouterComponentBase::init | ( | FwEnumStoreType | instance = 0 | ) |
Initialize FprimeRouterComponentBase object.
| instance | The instance number |
Definition at line 21 of file FprimeRouterComponentAc.cpp.
|
protected |
Check whether port commandOut is connected
| portNum | The port number |
Definition at line 598 of file FprimeRouterComponentAc.cpp.
|
protected |
Check whether port dataReturnOut is connected
| portNum | The port number |
Definition at line 609 of file FprimeRouterComponentAc.cpp.
|
protected |
Check whether port fileOut is connected
| portNum | The port number |
Definition at line 620 of file FprimeRouterComponentAc.cpp.
|
protected |
Check whether port logOut is connected
| portNum | The port number |
Definition at line 553 of file FprimeRouterComponentAc.cpp.
|
protected |
Check whether port timeCaller is connected
| portNum | The port number |
Definition at line 579 of file FprimeRouterComponentAc.cpp.
|
protected |
Check whether port unknownDataOut is connected
| portNum | The port number |
Definition at line 631 of file FprimeRouterComponentAc.cpp.
|
protectedvirtual |
Lock the guarded mutex.
Definition at line 1206 of file FprimeRouterComponentAc.cpp.
|
protected |
Log event BufferContextNotFound
A buffer returned on fileBufferReturnIn was not found in the buffer-to-context table. The buffer is still returned, but with an empty context.
Definition at line 1117 of file FprimeRouterComponentAc.cpp.
|
protected |
Log event DeserializationError
An error occurred while deserializing a packet
| status | The status of the operation |
Definition at line 905 of file FprimeRouterComponentAc.cpp.
|
protected |
Log event FileOutContextTableFull
The buffer-to-context table was full when a buffer was handed off on fileOut. The buffer is still forwarded, but its context cannot be restored on return and will be returned empty.
Definition at line 987 of file FprimeRouterComponentAc.cpp.
|
protected |
Log event SerializationError
An error occurred while serializing a com buffer
| status | The status of the operation |
Definition at line 823 of file FprimeRouterComponentAc.cpp.
|
protected |
Log event UnknownDataOutContextTableFull
The buffer-to-context table was full when a buffer was handed off on unknownDataOut. The buffer is still forwarded, but its context cannot be restored on return and will be returned empty.
Definition at line 1052 of file FprimeRouterComponentAc.cpp.
| void Svc::FprimeRouterComponentBase::set_commandOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputComPort * | port | ||
| ) |
Connect port to commandOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 354 of file FprimeRouterComponentAc.cpp.
| void Svc::FprimeRouterComponentBase::set_dataReturnOut_OutputPort | ( | FwIndexType | portNum, |
| Svc::InputComDataWithContextPort * | port | ||
| ) |
Connect port to dataReturnOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 368 of file FprimeRouterComponentAc.cpp.
| void Svc::FprimeRouterComponentBase::set_fileOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputBufferSendPort * | port | ||
| ) |
Connect port to fileOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 382 of file FprimeRouterComponentAc.cpp.
| void Svc::FprimeRouterComponentBase::set_logOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputLogPort * | port | ||
| ) |
Connect port to logOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 300 of file FprimeRouterComponentAc.cpp.
| void Svc::FprimeRouterComponentBase::set_timeCaller_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputTimePort * | port | ||
| ) |
Connect port to timeCaller[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 332 of file FprimeRouterComponentAc.cpp.
| void Svc::FprimeRouterComponentBase::set_unknownDataOut_OutputPort | ( | FwIndexType | portNum, |
| Svc::InputComDataWithContextPort * | port | ||
| ) |
Connect port to unknownDataOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 396 of file FprimeRouterComponentAc.cpp.
|
protected |
Invoke output port unknownDataOut.
| portNum | The port number |
Definition at line 795 of file FprimeRouterComponentAc.cpp.
|
protectedvirtual |
Unlock the guarded mutex.
Definition at line 1212 of file FprimeRouterComponentAc.cpp.
|
friend |
Friend class tester implementation to support white-box testing.
Definition at line 47 of file FprimeRouterComponentAc.hpp.
|
friend |
Friend class tester to support autocoded test harness.
Definition at line 45 of file FprimeRouterComponentAc.hpp.