DataContainer.hpp

Go to the documentation of this file.

// <Port> -*- C++ -*-
 
 
#pragma once
 
#include "sparta/utils/ValidValue.hpp"
#include "sparta/simulation/Clock.hpp"
 
namespace sparta
{
    template<class DataT>
    class DataContainer
    {
    public:
        DataContainer(const sparta::Clock * clk) :
            clock_(clk)
        {
            sparta_assert(clock_ != nullptr);
        }
 
        bool dataReceived() const {
            return data_.isValid();
        }
 
        bool dataReceivedThisCycle() const {
            return (data_.isValid() &&
                    (data_valid_time_stamp_ == clock_->getScheduler()->getCurrentTick()));
        }
 
        DataT pullData() {
            sparta_assert(dataReceived());
            const DataT & dat = data_.getValue();
            data_.clearValid();
            return dat;
        }
 
        const DataT & peekData() const {
            sparta_assert(dataReceived());
            return data_.getValue();
        }
 
        void clearData() {
            data_.clearValid();
        }
 
        Clock::Cycle getReceivedTimeStamp() const {
            sparta_assert(dataReceived());
            return clock_->getCycle(data_valid_time_stamp_);
        }
 
    protected:
 
        void setData_(const DataT & dat) {
            data_ = dat;
            data_valid_time_stamp_ = clock_->getScheduler()->getCurrentTick();
        }
 
    private:
 
        sparta::utils::ValidValue<DataT> data_;
 
        Scheduler::Tick data_valid_time_stamp_ = 0;
 
        const sparta::Clock * clock_ = nullptr;
 
    };
}