![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
Auto-generated base for FprimeFramer component. More...
#include <Svc/FprimeFramer/FprimeFramerComponentAc.hpp>
Protected Types | |
| enum | { NUM_COMSTATUSIN_INPUT_PORTS = 1, NUM_DATAIN_INPUT_PORTS = 1, NUM_DATARETURNIN_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_COMSTATUSOUT_OUTPUT_PORTS = 1, NUM_DATAOUT_OUTPUT_PORTS = 1, NUM_DATARETURNOUT_OUTPUT_PORTS = 1 } |
| Enumerations for numbers of typed output ports. More... | |
| enum | { EVENTID_NOBUFFERAVAILABLE = 0x0 } |
| Event IDs. More... | |
| enum | { EVENTID_NOBUFFERAVAILABLE_THROTTLE = 5 } |
| Event throttle values: sets initial value of countdown variables. More... | |
Protected Member Functions | |
| FprimeFramerComponentBase (const char *compName="") | |
| Construct FprimeFramerComponentBase object. More... | |
| virtual | ~FprimeFramerComponentBase () |
| Destroy FprimeFramerComponentBase object. More... | |
| bool | isConnected_logOut_OutputPort (FwIndexType portNum) const |
| bool | isConnected_timeCaller_OutputPort (FwIndexType portNum) const |
| bool | isConnected_bufferAllocate_OutputPort (FwIndexType portNum) const |
| bool | isConnected_bufferDeallocate_OutputPort (FwIndexType portNum) const |
| bool | isConnected_comStatusOut_OutputPort (FwIndexType portNum) const |
| bool | isConnected_dataOut_OutputPort (FwIndexType portNum) const |
| bool | isConnected_dataReturnOut_OutputPort (FwIndexType portNum) const |
| virtual void | comStatusIn_handler (FwIndexType portNum, Fw::Success &condition)=0 |
| Handler for input port comStatusIn. More... | |
| virtual void | dataIn_handler (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)=0 |
| Handler for input port dataIn. More... | |
| virtual void | dataReturnIn_handler (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)=0 |
| Handler for input port dataReturnIn. More... | |
| void | comStatusIn_handlerBase (FwIndexType portNum, Fw::Success &condition) |
| Handler base-class function for input port comStatusIn. More... | |
| void | dataIn_handlerBase (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context) |
| Handler base-class function for input port dataIn. More... | |
| void | dataReturnIn_handlerBase (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context) |
| Handler base-class function for input port dataReturnIn. More... | |
| Fw::Buffer | bufferAllocate_out (FwIndexType portNum, FwSizeType size) const |
| Invoke output port bufferAllocate. More... | |
| void | bufferDeallocate_out (FwIndexType portNum, Fw::Buffer &fwBuffer) const |
| Invoke output port bufferDeallocate. More... | |
| void | comStatusOut_out (FwIndexType portNum, Fw::Success &condition) const |
| Invoke output port comStatusOut. More... | |
| void | dataOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context) const |
| Invoke output port dataOut. More... | |
| void | dataReturnOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context) const |
| Invoke output port dataReturnOut. More... | |
| void | log_WARNING_HI_NoBufferAvailable () |
| void | log_WARNING_HI_NoBufferAvailable_ThrottleClear () |
| Reset throttle value for NoBufferAvailable. 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 | |
| static constexpr FwIndexType | getNum_comStatusIn_InputPorts () |
| static constexpr FwIndexType | getNum_dataIn_InputPorts () |
| static constexpr FwIndexType | getNum_dataReturnIn_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_comStatusOut_OutputPorts () |
| static constexpr FwIndexType | getNum_dataOut_OutputPorts () |
| static constexpr FwIndexType | getNum_dataReturnOut_OutputPorts () |
Friends | |
| class | FprimeFramerTesterBase |
| Friend class tester to support autocoded test harness. More... | |
| class | FprimeFramerTester |
| Friend class tester implementation to support white-box testing. More... | |
Auto-generated base for FprimeFramer component.
Framer implementation for the F Prime protocol
Definition at line 35 of file FprimeFramerComponentAc.hpp.
|
protected |
Enumerations for numbers of typed input ports.
| Enumerator | |
|---|---|
| NUM_COMSTATUSIN_INPUT_PORTS | |
| NUM_DATAIN_INPUT_PORTS | |
| NUM_DATARETURNIN_INPUT_PORTS | |
Definition at line 55 of file FprimeFramerComponentAc.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 62 of file FprimeFramerComponentAc.hpp.
|
protected |
Enumerations for numbers of typed output ports.
| Enumerator | |
|---|---|
| NUM_BUFFERALLOCATE_OUTPUT_PORTS | |
| NUM_BUFFERDEALLOCATE_OUTPUT_PORTS | |
| NUM_COMSTATUSOUT_OUTPUT_PORTS | |
| NUM_DATAOUT_OUTPUT_PORTS | |
| NUM_DATARETURNOUT_OUTPUT_PORTS | |
Definition at line 69 of file FprimeFramerComponentAc.hpp.
|
protected |
Event IDs.
| Enumerator | |
|---|---|
| EVENTID_NOBUFFERAVAILABLE | No buffer was available to hold the frame, which was dropped. |
Definition at line 78 of file FprimeFramerComponentAc.hpp.
|
protected |
Event throttle values: sets initial value of countdown variables.
| Enumerator | |
|---|---|
| EVENTID_NOBUFFERAVAILABLE_THROTTLE | Throttle reset count for NoBufferAvailable. |
Definition at line 83 of file FprimeFramerComponentAc.hpp.
|
protected |
Construct FprimeFramerComponentBase object.
| compName | The component name |
Definition at line 569 of file FprimeFramerComponentAc.cpp.
|
protectedvirtual |
Destroy FprimeFramerComponentBase object.
Definition at line 576 of file FprimeFramerComponentAc.cpp.
|
protected |
Invoke output port bufferAllocate.
| portNum | The port number |
| size | The requested size |
Definition at line 763 of file FprimeFramerComponentAc.cpp.
|
protected |
Invoke output port bufferDeallocate.
| portNum | The port number |
| fwBuffer | The buffer |
Definition at line 783 of file FprimeFramerComponentAc.cpp.
|
protectedpure virtual |
Handler for input port comStatusIn.
| portNum | The port number |
| condition | Condition success/failure |
|
protected |
Handler base-class function for input port comStatusIn.
| portNum | The port number |
| condition | Condition success/failure |
Definition at line 696 of file FprimeFramerComponentAc.cpp.
|
protected |
Invoke output port comStatusOut.
| portNum | The port number |
| condition | Condition success/failure |
Definition at line 803 of file FprimeFramerComponentAc.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 715 of file FprimeFramerComponentAc.cpp.
|
protected |
Invoke output port dataOut.
| portNum | The port number |
Definition at line 823 of file FprimeFramerComponentAc.cpp.
|
protectedpure virtual |
Handler for input port dataReturnIn.
| portNum | The port number |
|
protected |
Handler base-class function for input port dataReturnIn.
| portNum | The port number |
Definition at line 736 of file FprimeFramerComponentAc.cpp.
|
protected |
Invoke output port dataReturnOut.
| portNum | The port number |
Definition at line 845 of file FprimeFramerComponentAc.cpp.
| Fw::InputSuccessConditionPort * Svc::FprimeFramerComponentBase::get_comStatusIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 280 of file FprimeFramerComponentAc.cpp.
| Svc::InputComDataWithContextPort * Svc::FprimeFramerComponentBase::get_dataIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 291 of file FprimeFramerComponentAc.cpp.
| Svc::InputComDataWithContextPort * Svc::FprimeFramerComponentBase::get_dataReturnIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 302 of file FprimeFramerComponentAc.cpp.
|
inlinestaticprotected |
Get the number of bufferAllocate output ports
Definition at line 348 of file FprimeFramerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of bufferDeallocate output ports
Definition at line 355 of file FprimeFramerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of comStatusIn input ports
Definition at line 290 of file FprimeFramerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of comStatusOut output ports
Definition at line 362 of file FprimeFramerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of dataIn input ports
Definition at line 297 of file FprimeFramerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of dataOut output ports
Definition at line 369 of file FprimeFramerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of dataReturnIn input ports
Definition at line 304 of file FprimeFramerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of dataReturnOut output ports
Definition at line 376 of file FprimeFramerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of logOut output ports
Definition at line 317 of file FprimeFramerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of timeCaller output ports
Definition at line 335 of file FprimeFramerComponentAc.hpp.
|
protected |
| void Svc::FprimeFramerComponentBase::init | ( | FwEnumStoreType | instance = 0 | ) |
Initialize FprimeFramerComponentBase object.
| instance | The instance number |
Definition at line 21 of file FprimeFramerComponentAc.cpp.
|
protected |
Check whether port bufferAllocate is connected
| portNum | The port number |
Definition at line 633 of file FprimeFramerComponentAc.cpp.
|
protected |
Check whether port bufferDeallocate is connected
| portNum | The port number |
Definition at line 644 of file FprimeFramerComponentAc.cpp.
|
protected |
Check whether port comStatusOut is connected
| portNum | The port number |
Definition at line 655 of file FprimeFramerComponentAc.cpp.
|
protected |
Check whether port dataOut is connected
| portNum | The port number |
Definition at line 666 of file FprimeFramerComponentAc.cpp.
|
protected |
Check whether port dataReturnOut is connected
| portNum | The port number |
Definition at line 677 of file FprimeFramerComponentAc.cpp.
|
protected |
Check whether port logOut is connected
| portNum | The port number |
Definition at line 588 of file FprimeFramerComponentAc.cpp.
|
protected |
Check whether port timeCaller is connected
| portNum | The port number |
Definition at line 614 of file FprimeFramerComponentAc.cpp.
|
protected |
Log event NoBufferAvailable
No buffer was available to hold the frame, which was dropped
Definition at line 873 of file FprimeFramerComponentAc.cpp.
|
protected |
Reset throttle value for NoBufferAvailable.
Definition at line 950 of file FprimeFramerComponentAc.cpp.
| void Svc::FprimeFramerComponentBase::set_bufferAllocate_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputBufferGetPort * | port | ||
| ) |
Connect port to bufferAllocate[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 375 of file FprimeFramerComponentAc.cpp.
| void Svc::FprimeFramerComponentBase::set_bufferDeallocate_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputBufferSendPort * | port | ||
| ) |
Connect port to bufferDeallocate[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 389 of file FprimeFramerComponentAc.cpp.
| void Svc::FprimeFramerComponentBase::set_comStatusOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputSuccessConditionPort * | port | ||
| ) |
Connect port to comStatusOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 403 of file FprimeFramerComponentAc.cpp.
| void Svc::FprimeFramerComponentBase::set_dataOut_OutputPort | ( | FwIndexType | portNum, |
| Svc::InputComDataWithContextPort * | port | ||
| ) |
Connect port to dataOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 417 of file FprimeFramerComponentAc.cpp.
| void Svc::FprimeFramerComponentBase::set_dataReturnOut_OutputPort | ( | FwIndexType | portNum, |
| Svc::InputComDataWithContextPort * | port | ||
| ) |
Connect port to dataReturnOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 431 of file FprimeFramerComponentAc.cpp.
| void Svc::FprimeFramerComponentBase::set_logOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputLogPort * | port | ||
| ) |
Connect port to logOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 321 of file FprimeFramerComponentAc.cpp.
| void Svc::FprimeFramerComponentBase::set_timeCaller_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputTimePort * | port | ||
| ) |
Connect port to timeCaller[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 353 of file FprimeFramerComponentAc.cpp.
|
friend |
Friend class tester implementation to support white-box testing.
Definition at line 46 of file FprimeFramerComponentAc.hpp.
|
friend |
Friend class tester to support autocoded test harness.
Definition at line 44 of file FprimeFramerComponentAc.hpp.