SchedulingRequest.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 SchedulingRequest.hpp

  @author Jean-Christophe FABRE <jean-christophe.fabre@inra.fr>
*/


#ifndef __OPENFLUID_BASE_SCHEDULINGREQUEST_HPP__
#define __OPENFLUID_BASE_SCHEDULINGREQUEST_HPP__


#include <openfluid/core/DateTime.hpp>


namespace openfluid { namespace base {

/**
  Description of a scheduling request, mainly used during simulations
  for simulators scheduling after every execution
*/
class SchedulingRequest
{
  public:

    enum RequestType_t {UNDEFINED, DURATION, ATTHEEND, NEVER};

    RequestType_t RequestType;

    openfluid::core::Duration_t Duration;


    SchedulingRequest() : RequestType(UNDEFINED)
    { }

    SchedulingRequest(const openfluid::core::Duration_t& D) : RequestType(DURATION), Duration(D)
    { }

    SchedulingRequest(const RequestType_t& RT) : RequestType(RT)
    { }
};


} }  // namespaces

#endif /* __OPENFLUID_BASE_SCHEDULINGREQUEST_HPP__ */