machine/ExecutionTimePoint.hpp

Go to the documentation of this file.

/*

  This file is part of OpenFLUID software
  Copyright(c) 2007, INRA - Montpellier SupAgro


 == GNU General Public License Usage ==

  OpenFLUID is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  OpenFLUID is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with OpenFLUID. If not, see <http://www.gnu.org/licenses/>.


 == Other Usage ==

  Other Usage means a use of OpenFLUID that is inconsistent with the GPL
  license, and requires a written agreement between You and INRA.
  Licensees for Other Usage of OpenFLUID may use this file in accordance
  with the terms contained in the written agreement between You and INRA.
  
*/


/**
  \file TimePoint.hpp
  \brief Header of ...

  \author Jean-Christophe FABRE <fabrejc@supagro.inra.fr>
 */


#ifndef __EXECUTIONTIMEPOINT_HPP__
#define __EXECUTIONTIMEPOINT_HPP__


#include <openfluid/dllexport.hpp>
#include <openfluid/machine/ModelItemInstance.hpp>


// =====================================================================
// =====================================================================


namespace openfluid { namespace machine {

struct SortModelItemsByOriginalPosition
{
  bool operator()(ModelItemInstance* a, ModelItemInstance* b) const
  {
    return (a->OriginalPosition < b->OriginalPosition);
  }
};


// =====================================================================
// =====================================================================



class DLLEXPORT ExecutionTimePoint
{
  private:
    std::list<ModelItemInstance*> m_ItemsPtrList;

    openfluid::core::TimeIndex_t m_TimeIndex;


  public:

    ExecutionTimePoint(openfluid::core::TimeIndex_t TimeIndex);

    ~ExecutionTimePoint();

    void appendItem(openfluid::machine::ModelItemInstance* Item);

    inline bool hasItemsToProcess() const
    { return !m_ItemsPtrList.empty(); };

    openfluid::base::SchedulingRequest processNextItem();

    inline openfluid::machine::ModelItemInstance* getNextItem() const
    { return m_ItemsPtrList.front(); };

    inline openfluid::core::TimeIndex_t getTimeIndex() const
    { return m_TimeIndex; };

    inline void sortByOriginalPosition()
    {
      m_ItemsPtrList.sort(SortModelItemsByOriginalPosition());
    }

};


} } //namespaces



#endif /* __EXECUTIONTIMEPOINT_HPP__ */