mirror of
https://github.com/nasa/fprime.git
synced 2025-12-11 13:54:34 -06:00
c69ff72110
* Format Svc and add to CI * Fix comlogger include * fix assert UTs * Fix static analysis warning * formatting
114 lines
4.1 KiB
C++
114 lines
4.1 KiB
C++
/*
|
|
* \author: Tim Canham
|
|
* \file:
|
|
* \brief
|
|
*
|
|
* This file implements the ActiveRateGroup component,
|
|
* which invokes a set of components the comprise the rate group.
|
|
*
|
|
* Copyright 2014-2022, by the California Institute of Technology.
|
|
* ALL RIGHTS RESERVED. United States Government Sponsorship
|
|
* acknowledged.
|
|
*
|
|
*/
|
|
|
|
#ifndef SVC_ACTIVERATEGROUP_HPP
|
|
#define SVC_ACTIVERATEGROUP_HPP
|
|
|
|
#include <Svc/ActiveRateGroup/ActiveRateGroupComponentAc.hpp>
|
|
|
|
namespace Svc {
|
|
|
|
//! \class ActiveRateGroup
|
|
//! \brief Executes a set of components as part of a rate group
|
|
//!
|
|
//! ActiveRateGroup takes an input cycle call to begin the rate group cycle.
|
|
//! It calls each output port in succession and passes the value in the context
|
|
//! array at the index corresponding to the output port number. It keeps track of the execution
|
|
//! time of the rate group and detects overruns.
|
|
//!
|
|
|
|
class ActiveRateGroup final : public ActiveRateGroupComponentBase {
|
|
friend class ActiveRateGroupTester;
|
|
|
|
public:
|
|
static constexpr FwIndexType CONNECTION_COUNT_MAX = NUM_RATEGROUPMEMBEROUT_OUTPUT_PORTS;
|
|
|
|
//! \brief ActiveRateGroup constructor
|
|
//!
|
|
//! The constructor of the class clears all the flags and copies the
|
|
//! contents of the context array to private storage.
|
|
//!
|
|
//! \param compName Name of the component
|
|
ActiveRateGroup(const char* compName);
|
|
|
|
//! \brief ActiveRateGroup configuration function
|
|
//!
|
|
//! The configuration function takes an array of context values to pass to
|
|
//! members of the rate group.
|
|
//!
|
|
//! \param 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.
|
|
//! \param numContexts The number of elements in the context array.
|
|
|
|
void configure(U32 contexts[], FwIndexType numContexts);
|
|
|
|
//! \brief ActiveRateGroup destructor
|
|
//!
|
|
//! The destructor of the class is empty
|
|
|
|
~ActiveRateGroup();
|
|
|
|
private:
|
|
//! \brief Input cycle port handler
|
|
//!
|
|
//! The cycle port handler calls each component in the rate group in turn,
|
|
//! passing the context value. It computes the execution time each cycle,
|
|
//! and writes it to a telemetry value if it reaches a maximum time
|
|
//!
|
|
//! \param portNum incoming port call. For this class, should always be zero
|
|
//! \param cycleStart value stored by the cycle driver, used to compute execution time.
|
|
|
|
void CycleIn_handler(FwIndexType portNum, Os::RawTime& cycleStart);
|
|
|
|
//! \brief Input cycle port pre message hook
|
|
//!
|
|
//! The input cycle port pre message hook is called on the thread of the calling
|
|
//! cycle port. It sets flag to indicate that the cycle has started.
|
|
//!
|
|
//! \param portNum incoming port call. For this class, should always be zero
|
|
//! \param cycleStart value stored by the cycle driver, used to compute execution time.
|
|
|
|
void CycleIn_preMsgHook(FwIndexType portNum, Os::RawTime& cycleStart); //!< CycleIn pre-message hook
|
|
|
|
//! \brief Input ping port handler
|
|
//!
|
|
//! This port is called by the health task to verify task aliveness
|
|
//!
|
|
//! \param portNum incoming port call. For this class, should always be zero
|
|
//! \param key value returned to health task to verify round trip
|
|
|
|
void PingIn_handler(FwIndexType portNum, U32 key);
|
|
|
|
//! \brief Task preamble
|
|
//!
|
|
//! This method is called prior to entering the message loop.
|
|
//! It issues an event indicating that the task has started.
|
|
//!
|
|
|
|
void preamble();
|
|
|
|
U32 m_cycles; //!< cycles executed
|
|
U32 m_maxTime; //!< maximum execution time in microseconds
|
|
volatile bool m_cycleStarted; //!< indicate that cycle has started. Used to detect overruns.
|
|
U32 m_contexts[CONNECTION_COUNT_MAX]; //!< Must match number of output ports
|
|
FwIndexType m_numContexts; //!< Number of contexts passed in by user
|
|
FwIndexType m_overrunThrottle; //!< throttle value for overrun events
|
|
U32 m_cycleSlips; //!< tracks number of cycle slips
|
|
};
|
|
|
|
} // namespace Svc
|
|
|
|
#endif
|