ActiveRateGroup.hpp

Go to the documentation of this file.

/*
 * \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 <Fw/DataStructures/Array.hpp>
#include <Fw/Deprecate.hpp>
#include <Svc/ActiveRateGroup/ActiveRateGroupComponentAc.hpp>

namespace Svc {


class ActiveRateGroup final : public ActiveRateGroupComponentBase {
    friend class ActiveRateGroupTester;

  public:
    static constexpr FwIndexType CONNECTION_COUNT_MAX = NUM_RATEGROUPMEMBEROUT_OUTPUT_PORTS;

    using ContextArray = Fw::Array<U32, CONNECTION_COUNT_MAX>;

    ActiveRateGroup(const char* compName);


    void configure(const ContextArray& contexts);


    DEPRECATED(void configure(const U32 contexts[], const FwIndexType numContexts),
               "Use configure(const ActiveRateGroup::ContextArray& contexts) instead");


    ~ActiveRateGroup();

  private:

    void CycleIn_handler(FwIndexType portNum, Os::RawTime& cycleStart);


    void CycleIn_preMsgHook(FwIndexType portNum, Os::RawTime& cycleStart);  


    void PingIn_handler(FwIndexType portNum, U32 key);


    void preamble();

    U32 m_cycles;                          
    U32 m_maxTime;                         
    volatile bool m_cycleStarted;          
    U32 m_contexts[CONNECTION_COUNT_MAX];  
    FwIndexType m_numContexts;             
    FwIndexType m_overrunThrottle;         
    U32 m_cycleSlips;                      
};

}  // namespace Svc

#endif