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 \file ChronologicalSerie.hpp 00035 \brief Header of ... 00036 00037 \author Jean-Christophe FABRE <fabrejc@supagro.inra.fr> 00038 */ 00039 00040 00041 00042 #ifndef __CHRONOLOGICALSERIE_HPP__ 00043 #define __CHRONOLOGICALSERIE_HPP__ 00044 00045 00046 #include <list> 00047 00048 #include <openfluid/core/DateTime.hpp> 00049 #include <openfluid/dllexport.hpp> 00050 00051 namespace openfluid { namespace tools { 00052 00053 00054 typedef std::pair<openfluid::core::DateTime,double> ChronItem_t; 00055 00056 00057 /** 00058 Container for a chronological data serie 00059 */ 00060 class DLLEXPORT ChronologicalSerie : public std::list<ChronItem_t> 00061 { 00062 private: 00063 00064 std::list<ChronItem_t>::iterator m_InternalIterator; 00065 std::list<ChronItem_t>::iterator m_PreviousInternalIterator; 00066 00067 00068 public: 00069 00070 /** 00071 Default constructor 00072 */ 00073 ChronologicalSerie() : std::list<ChronItem_t>(), m_InternalIterator(begin()), m_PreviousInternalIterator(begin()) 00074 { } 00075 00076 /** 00077 Resets the internal iterator 00078 */ 00079 void reset(); 00080 00081 /** 00082 Finds the two surrending values for a given date. If the given date is exactly found in the serie, 00083 the two surrounding values are the same. 00084 @param[in] DT The date to find surrounding values 00085 @param[out] Before The closest date before the given date 00086 @param[out] After The closest date after the given date 00087 @return true if the closest dates before and after have been found 00088 */ 00089 bool getSurroundingValues(const openfluid::core::DateTime& DT, ChronItem_t& Before, ChronItem_t& After); 00090 00091 }; 00092 00093 } } // namespaces 00094 00095 00096 #endif /* __CHRONOLOGICALSERIE_HPP__ */