00001 /* 00002 00003 This file is part of OpenFLUID software 00004 Copyright(c) 2007, INRA - Montpellier SupAgro 00005 00006 00007 == GNU General Public License Usage == 00008 00009 OpenFLUID is free software: you can redistribute it and/or modify 00010 it under the terms of the GNU General Public License as published by 00011 the Free Software Foundation, either version 3 of the License, or 00012 (at your option) any later version. 00013 00014 OpenFLUID is distributed in the hope that it will be useful, 00015 but WITHOUT ANY WARRANTY; without even the implied warranty of 00016 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00017 GNU General Public License for more details. 00018 00019 You should have received a copy of the GNU General Public License 00020 along with OpenFLUID. If not, see <http://www.gnu.org/licenses/>. 00021 00022 00023 == Other Usage == 00024 00025 Other Usage means a use of OpenFLUID that is inconsistent with the GPL 00026 license, and requires a written agreement between You and INRA. 00027 Licensees for Other Usage of OpenFLUID may use this file in accordance 00028 with the terms contained in the written agreement between You and INRA. 00029 00030 */ 00031 00032 00033 00034 /** 00035 @file 00036 00037 @author Jean-Christophe FABRE <fabrejc@supagro.inra.fr> 00038 */ 00039 00040 00041 #ifndef __EVENTSCOLL_H__ 00042 #define __EVENTSCOLL_H__ 00043 00044 #include <openfluid/core/Event.hpp> 00045 #include <openfluid/dllexport.hpp> 00046 00047 #include <list> 00048 00049 00050 namespace openfluid { namespace core { 00051 00052 class DLLEXPORT Event; 00053 00054 typedef std::list<Event> EventsList_t; 00055 00056 /** 00057 @brief Class defining a collection of discrete events 00058 */ 00059 class DLLEXPORT EventsCollection 00060 { 00061 private: 00062 00063 EventsList_t m_Events; 00064 00065 public: 00066 00067 /** 00068 Default constructor 00069 */ 00070 EventsCollection(); 00071 00072 virtual ~EventsCollection(); 00073 00074 00075 /** 00076 Inserts an event in the event collection, ordered by date 00077 @deprecated 00078 */ 00079 bool addEvent(const Event* Ev) OPENFLUID_DEPRECATED; 00080 00081 /** 00082 Inserts an event in the event collection, ordered by date 00083 */ 00084 bool addEvent(const Event& Ev); 00085 00086 /** 00087 Returns an event collection extracted from the current event collection, taking into account a time period 00088 If some events are already in the given collection, they are not deleted. Events matching the period are appended 00089 at the end of the given collection 00090 @deprecated 00091 */ 00092 bool getEventsBetween(const DateTime BeginDate, const DateTime EndDate, EventsCollection *Events) const OPENFLUID_DEPRECATED; 00093 00094 /** 00095 Returns an event collection extracted from the current event collection, taking into account a time period 00096 If some events are already in the given collection, they are not deleted. Events matching the period are appended 00097 at the end of the given collection 00098 */ 00099 bool getEventsBetween(const DateTime BeginDate, const DateTime EndDate, EventsCollection& Events) const; 00100 00101 /** 00102 Returns the event collection as a list 00103 */ 00104 inline EventsList_t* getEventsList() { return &m_Events; }; 00105 00106 /** 00107 Returns number of events in the event collection 00108 */ 00109 inline int getCount() const { return m_Events.size(); }; 00110 00111 /** 00112 Clears the event collection 00113 */ 00114 void clear() { m_Events.clear(); }; 00115 00116 void println() const; 00117 }; 00118 00119 00120 } } // namespace openfluid::core 00121 00122 00123 00124 #endif /* __EVENTSCOLL_H__*/