![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
#include <Svc/PassiveRateGroup/PassiveRateGroup.hpp>
Public Types | |
| using | ContextArray = Fw::Array< U32, CONNECTION_COUNT_MAX > |
| Array of context values for rate group members, indexed by output port number. More... | |
Public Member Functions | |
| PassiveRateGroup (const char *compName) | |
| PassiveRateGroupImpl constructor. More... | |
| void | configure (const ContextArray &contexts, const Os::RawTimeSource rawTimeSource=Os::RAWTIME_DEFAULT) |
| PassiveRateGroupImpl initialization function. More... | |
| DEPRECATED (void configure(const U32 contexts[], const FwIndexType numContexts), "Use configure(const PassiveRateGroup::ContextArray& contexts) instead") | |
| PassiveRateGroup configuration function. More... | |
| ~PassiveRateGroup () | |
| PassiveRateGroupImpl destructor. More... | |
Public Member Functions inherited from Svc::PassiveRateGroupComponentBase | |
| void | init (FwEnumStoreType instance=0) |
| Initialize PassiveRateGroupComponentBase object. More... | |
| Fw::InputCmdPort * | get_CmdDisp_InputPort (FwIndexType portNum) |
| Svc::InputCyclePort * | get_CycleIn_InputPort (FwIndexType portNum) |
| void | set_CmdReg_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port) |
| Connect port to CmdReg[portNum]. More... | |
| void | set_CmdStatus_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port) |
| Connect port to CmdStatus[portNum]. More... | |
| void | set_Time_OutputPort (FwIndexType portNum, Fw::InputTimePort *port) |
| Connect port to Time[portNum]. More... | |
| void | set_Tlm_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port) |
| Connect port to Tlm[portNum]. More... | |
| void | set_RateGroupMemberOut_OutputPort (FwIndexType portNum, Svc::InputSchedPort *port) |
| Connect port to RateGroupMemberOut[portNum]. More... | |
| void | regCommands () |
| Register commands with the Command Dispatcher. 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... | |
Static Public Attributes | |
| static constexpr FwIndexType | CONNECTION_COUNT_MAX = NUM_RATEGROUPMEMBEROUT_OUTPUT_PORTS |
Friends | |
| class | PassiveRateGroupTester |
Definition at line 33 of file PassiveRateGroup.hpp.
| using Svc::PassiveRateGroup::ContextArray = Fw::Array<U32, CONNECTION_COUNT_MAX> |
Array of context values for rate group members, indexed by output port number.
Definition at line 41 of file PassiveRateGroup.hpp.
|
explicit |
PassiveRateGroupImpl constructor.
The constructor of the class clears all the flags and copies the contents of the context array to private storage.
| compName | Name of the component |
Definition at line 22 of file PassiveRateGroup.cpp.
| Svc::PassiveRateGroup::~PassiveRateGroup | ( | ) |
PassiveRateGroupImpl destructor.
The destructor of the class is empty
Definition at line 30 of file PassiveRateGroup.cpp.
| void Svc::PassiveRateGroup::configure | ( | const ContextArray & | contexts, |
| const Os::RawTimeSource | rawTimeSource = Os::RAWTIME_DEFAULT |
||
| ) |
PassiveRateGroupImpl initialization function.
PassiveRateGroup configuration function
The configuration function takes an array of context values to pass to members of the rate group. It also writes initial telemetry values so that every channel has a value before the first cycle; call it after the telemetry and time ports are connected for these writes to be delivered.
| contexts | Array of context values that will be sent to each member component. The index of the array corresponds to the output port number. |
| rawTimeSource | Timer source for cycle time measurements. WARNING: Only the end timestamp uses this source; the start timestamp comes from the cycle driver (typically RAWTIME_DEFAULT). Non-default values produce incorrect timing unless the cycle driver is modified to use the same source. |
Definition at line 36 of file PassiveRateGroup.cpp.
| Svc::PassiveRateGroup::DEPRECATED | ( | void | configureconst U32 contexts[], const FwIndexType numContexts, |
| "Use configure(const PassiveRateGroup::ContextArray& contexts) instead" | |||
| ) |
PassiveRateGroup configuration function.
The configuration function takes an array of context values to pass to members of the rate group.
| contexts | Array of integers that contain the context values that will be sent to each member component. The index of the array corresponds to the output port number. |
| numContexts | The number of elements in the context array. |
|
friend |
Definition at line 35 of file PassiveRateGroup.hpp.
|
static |
Definition at line 38 of file PassiveRateGroup.hpp.