PassiveRateGroup.hpp

Go to the documentation of this file.

/*
 * \author: Tim Canham
 * \file:
 * \brief
 *
 * This file implements the PassiveRateGroup component,
 * which invokes a set of components the comprise the rate group.
 *
 *   Copyright 2014-2015, by the California Institute of Technology.
 *   ALL RIGHTS RESERVED. United States Government Sponsorship
 *   acknowledged.
 */

#ifndef SVC_PASSIVERATEGROUP_IMPL_HPP
#define SVC_PASSIVERATEGROUP_IMPL_HPP

#include <Fw/DataStructures/Array.hpp>
#include <Fw/Deprecate.hpp>
#include <Svc/PassiveRateGroup/PassiveRateGroupComponentAc.hpp>
#include <atomic>

namespace Svc {


class PassiveRateGroup final : public PassiveRateGroupComponentBase {
    // Allow unit tests to access private members for testing
    friend class PassiveRateGroupTester;

  public:
    static constexpr FwIndexType CONNECTION_COUNT_MAX = NUM_RATEGROUPMEMBEROUT_OUTPUT_PORTS;

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

    explicit PassiveRateGroup(const char* compName);  

    void configure(const ContextArray& contexts, const Os::RawTimeSource rawTimeSource = Os::RAWTIME_DEFAULT);

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

    ~PassiveRateGroup();

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

    void CLEAR_STATISTICS_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) override;

    Os::RawTime createRawTime() const;

    U32 m_cycles;                
    std::atomic<U32> m_maxTime;  
    std::atomic<U32> m_portCycleTimeHWMUsec[NUM_RATEGROUPMEMBEROUT_OUTPUT_PORTS];  
    Os::RawTimeSource m_rawTimeSource;                                             
    FwIndexType m_numContexts;                                                     
    U32 m_contexts[NUM_RATEGROUPMEMBEROUT_OUTPUT_PORTS];  
};

}  // namespace Svc

#endif