![]() |
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_BUFFERALLOCATE_OUTPUT_PORTS = 1, NUM_BUFFERDEALLOCATE_OUTPUT_PORTS = 1, 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 } |
| 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) |
| bool | isConnected_timeCaller_OutputPort (FwIndexType portNum) |
| bool | isConnected_bufferAllocate_OutputPort (FwIndexType portNum) |
| bool | isConnected_bufferDeallocate_OutputPort (FwIndexType portNum) |
| bool | isConnected_commandOut_OutputPort (FwIndexType portNum) |
| bool | isConnected_dataReturnOut_OutputPort (FwIndexType portNum) |
| bool | isConnected_fileOut_OutputPort (FwIndexType portNum) |
| bool | isConnected_unknownDataOut_OutputPort (FwIndexType portNum) |
| 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... | |
| Fw::Buffer | bufferAllocate_out (FwIndexType portNum, FwSizeType size) |
| Invoke output port bufferAllocate. 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 | dataReturnOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context) |
| Invoke output port dataReturnOut. More... | |
| void | fileOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer) |
| Invoke output port fileOut. More... | |
| void | unknownDataOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &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 () 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 | |
| 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_bufferAllocate_OutputPorts () |
| static constexpr FwIndexType | getNum_bufferDeallocate_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 34 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 54 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 61 of file FprimeRouterComponentAc.hpp.
|
protected |
Enumerations for numbers of typed output ports.
| Enumerator | |
|---|---|
| NUM_BUFFERALLOCATE_OUTPUT_PORTS | |
| NUM_BUFFERDEALLOCATE_OUTPUT_PORTS | |
| NUM_COMMANDOUT_OUTPUT_PORTS | |
| NUM_DATARETURNOUT_OUTPUT_PORTS | |
| NUM_FILEOUT_OUTPUT_PORTS | |
| NUM_UNKNOWNDATAOUT_OUTPUT_PORTS | |
Definition at line 68 of file FprimeRouterComponentAc.hpp.
|
protected |
Event IDs.
| Enumerator | |
|---|---|
| EVENTID_SERIALIZATIONERROR | An error occurred while serializing a com buffer. |
| EVENTID_DESERIALIZATIONERROR | An error occurred while deserializing a packet. |
Definition at line 78 of file FprimeRouterComponentAc.hpp.
|
protected |
Construct FprimeRouterComponentBase object.
| compName | The component name |
Definition at line 584 of file FprimeRouterComponentAc.cpp.
|
protectedvirtual |
Destroy FprimeRouterComponentBase object.
Definition at line 591 of file FprimeRouterComponentAc.cpp.
|
protected |
Invoke output port bufferAllocate.
| portNum | The port number |
| size | The requested size |
Definition at line 781 of file FprimeRouterComponentAc.cpp.
|
protected |
Invoke output port bufferDeallocate.
| portNum | The port number |
| fwBuffer | The buffer |
Definition at line 801 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 714 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 821 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 737 of file FprimeRouterComponentAc.cpp.
|
protected |
Invoke output port dataReturnOut.
| portNum | The port number |
Definition at line 843 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 758 of file FprimeRouterComponentAc.cpp.
|
protected |
Invoke output port fileOut.
| portNum | The port number |
| fwBuffer | The buffer |
Definition at line 865 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 277 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 288 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 299 of file FprimeRouterComponentAc.cpp.
|
inlinestaticprotected |
Get the number of bufferAllocate output ports
Definition at line 344 of file FprimeRouterComponentAc.hpp.
|
inlinestaticprotected |
Get the number of bufferDeallocate output ports
Definition at line 351 of file FprimeRouterComponentAc.hpp.
|
inlinestaticprotected |
Get the number of cmdResponseIn input ports
Definition at line 286 of file FprimeRouterComponentAc.hpp.
|
inlinestaticprotected |
Get the number of commandOut output ports
Definition at line 358 of file FprimeRouterComponentAc.hpp.
|
inlinestaticprotected |
Get the number of dataIn input ports
Definition at line 293 of file FprimeRouterComponentAc.hpp.
|
inlinestaticprotected |
Get the number of dataReturnOut output ports
Definition at line 365 of file FprimeRouterComponentAc.hpp.
|
inlinestaticprotected |
Get the number of fileBufferReturnIn input ports
Definition at line 300 of file FprimeRouterComponentAc.hpp.
|
inlinestaticprotected |
Get the number of fileOut output ports
Definition at line 372 of file FprimeRouterComponentAc.hpp.
|
inlinestaticprotected |
Get the number of logOut output ports
Definition at line 313 of file FprimeRouterComponentAc.hpp.
|
inlinestaticprotected |
Get the number of timeCaller output ports
Definition at line 331 of file FprimeRouterComponentAc.hpp.
|
inlinestaticprotected |
Get the number of unknownDataOut output ports
Definition at line 379 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 bufferAllocate is connected
| portNum | The port number |
Definition at line 642 of file FprimeRouterComponentAc.cpp.
|
protected |
Check whether port bufferDeallocate is connected
| portNum | The port number |
Definition at line 653 of file FprimeRouterComponentAc.cpp.
|
protected |
Check whether port commandOut is connected
| portNum | The port number |
Definition at line 664 of file FprimeRouterComponentAc.cpp.
|
protected |
Check whether port dataReturnOut is connected
| portNum | The port number |
Definition at line 675 of file FprimeRouterComponentAc.cpp.
|
protected |
Check whether port fileOut is connected
| portNum | The port number |
Definition at line 686 of file FprimeRouterComponentAc.cpp.
|
protected |
Check whether port logOut is connected
| portNum | The port number |
Definition at line 601 of file FprimeRouterComponentAc.cpp.
|
protected |
Check whether port timeCaller is connected
| portNum | The port number |
Definition at line 627 of file FprimeRouterComponentAc.cpp.
|
protected |
Check whether port unknownDataOut is connected
| portNum | The port number |
Definition at line 697 of file FprimeRouterComponentAc.cpp.
|
protected |
Log event DeserializationError
An error occurred while deserializing a packet
| status | The status of the operation |
Definition at line 993 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 911 of file FprimeRouterComponentAc.cpp.
| void Svc::FprimeRouterComponentBase::set_bufferAllocate_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputBufferGetPort * | port | ||
| ) |
Connect port to bufferAllocate[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 364 of file FprimeRouterComponentAc.cpp.
| void Svc::FprimeRouterComponentBase::set_bufferDeallocate_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputBufferSendPort * | port | ||
| ) |
Connect port to bufferDeallocate[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 378 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 392 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 406 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 420 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 314 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 346 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 434 of file FprimeRouterComponentAc.cpp.
|
protected |
Invoke output port unknownDataOut.
| portNum | The port number |
Definition at line 885 of file FprimeRouterComponentAc.cpp.
|
friend |
Friend class tester implementation to support white-box testing.
Definition at line 45 of file FprimeRouterComponentAc.hpp.
|
friend |
Friend class tester to support autocoded test harness.
Definition at line 43 of file FprimeRouterComponentAc.hpp.