ComAggregator.hpp

Go to the documentation of this file.

// ======================================================================
// \title  ComAggregator.hpp
// \author lestarch
// \brief  hpp file for ComAggregator component implementation class
// ======================================================================

#ifndef Svc_ComAggregator_HPP
#define Svc_ComAggregator_HPP

#include <atomic>
#include "Os/Mutex.hpp"
#include "Svc/ComAggregator/ComAggregatorComponentAc.hpp"

namespace Svc {

class ComAggregator final : public ComAggregatorComponentBase {
    friend class ComAggregatorTester;  // Allow unit test access to private members
  public:
    // ----------------------------------------------------------------------
    // Component construction and destruction
    // ----------------------------------------------------------------------

    ComAggregator(const char* const compName  
    );

    ~ComAggregator();

    void preamble() override;

  private:
    // ----------------------------------------------------------------------
    // Handler implementations for typed input ports
    // ----------------------------------------------------------------------

    void comStatusIn_handler(FwIndexType portNum,    
                             Fw::Success& condition  
                             ) override;

    void dataIn_handler(FwIndexType portNum,  
                        Fw::Buffer& data,
                        const ComCfg::FrameContext& context) override;

    void dataReturnIn_handler(FwIndexType portNum,  
                              Fw::Buffer& data,
                              const ComCfg::FrameContext& context) override;

    void timeout_handler(FwIndexType portNum,  
                         U32 context           
                         ) override;

  private:
    // ----------------------------------------------------------------------
    // Implementations for internal state machine actions
    // ----------------------------------------------------------------------

    void Svc_AggregationMachine_action_doClear(SmId smId,                             
                                               Svc_AggregationMachine::Signal signal  
                                               ) override;

    void Svc_AggregationMachine_action_doFill(SmId smId,                              
                                              Svc_AggregationMachine::Signal signal,  
                                              const Svc::ComDataContextPair& value    
                                              ) override;

    void Svc_AggregationMachine_action_doSend(SmId smId,                             
                                              Svc_AggregationMachine::Signal signal  
                                              ) override;

    void Svc_AggregationMachine_action_doHold(SmId smId,                              
                                              Svc_AggregationMachine::Signal signal,  
                                              const Svc::ComDataContextPair& value    
                                              ) override;

    void Svc_AggregationMachine_action_assertNoStatus(SmId smId,                             
                                                      Svc_AggregationMachine::Signal signal  
                                                      ) override;

  private:
    // ----------------------------------------------------------------------
    // Implementations for internal state machine guards
    // ----------------------------------------------------------------------

    bool Svc_AggregationMachine_guard_isFull(SmId smId,                              
                                             Svc_AggregationMachine::Signal signal,  
                                             const Svc::ComDataContextPair& value    
    ) const override;

    bool Svc_AggregationMachine_guard_willFill(SmId smId,                              
                                               Svc_AggregationMachine::Signal signal,  
                                               const Svc::ComDataContextPair& value    
    ) const override;

    bool Svc_AggregationMachine_guard_isNotEmpty(SmId smId,                             
                                                 Svc_AggregationMachine::Signal signal  
    ) const override;

    bool Svc_AggregationMachine_guard_isGood(SmId smId,                              
                                             Svc_AggregationMachine::Signal signal,  
                                             const Fw::Success& value                
    ) const override;

  private:
    U8 m_frameBufferStore[ComCfg::AggregationSize];  
    Fw::Buffer::OwnershipState m_bufferState =
        Fw::Buffer::OwnershipState::OWNED;  
    Fw::Buffer m_frameBuffer;
    Fw::ExternalSerializeBufferWithMemberCopy m_frameSerializer;  
    ComCfg::FrameContext m_lastContext;                           

    Svc::ComDataContextPair m_held;     
    std::atomic<bool> m_allow_timeout;  
};

}  // namespace Svc

#endif