DateTimePeriod.h
Go to the documentation of this file.
1 /* Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.
2 
3  This file is part of the TerraLib - a Framework for building GIS enabled applications.
4 
5  TerraLib is free software: you can redistribute it and/or modify
6  it under the terms of the GNU Lesser General Public License as published by
7  the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  TerraLib is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU Lesser General Public License for more details.
14 
15  You should have received a copy of the GNU Lesser General Public License
16  along with TerraLib. See COPYING. If not, write to
17  TerraLib Team at <terralib-team@terralib.org>.
18  */
19 
20 /*!
21  \file terralib/datatype/DateTimePeriod.h
22 
23  \brief An abstract class to represent a period of date and time.
24 */
25 
26 #ifndef __TERRALIB_DATATYPE_INTERNAL_DATETIMEPERIOD_H
27 #define __TERRALIB_DATATYPE_INTERNAL_DATETIMEPERIOD_H
28 
29 // TerraLib
30 #include "DateTime.h"
31 
32 namespace te
33 {
34  namespace dt
35  {
36  class DateTimeInstant;
37 
38  /*!
39  \class DateTimePeriod
40 
41  \brief An abstract class to represent a period of date and time.
42 
43  A time period is a part of the continous time axis limited by two
44  time instants or points.
45 
46  \sa DateTime
47  */
48  class TEDATATYPEEXPORT DateTimePeriod : public DateTime
49  {
50  public:
51 
52  /*! \brief Default constructor. */
53  DateTimePeriod();
54 
55  /*!
56  \brief It gets the initial date time instant.
57 
58  \return The initial time instant
59 
60  \note The caller will take the ownership of the returned pointer.
61  */
62  virtual DateTimeInstant* getInitialInstant() const = 0;
63 
64  /*!
65  \brief It gets the final date time instant.
66 
67  \return The final time instant
68 
69  \note The caller will take the ownership of the returned pointer.
70  */
71  virtual DateTimeInstant* getFinalInstant() const = 0;
72 
73  /*! \brief Virtual destructor. */
74  virtual ~DateTimePeriod();
75  };
76 
77  } // end namespace dt
78 } // end namespace te
79 
80 #endif // __TERRALIB_DATATYPE_INTERNAL_DATETIMEPERIOD_H
81 
DateTime.h
An abstract class for date and time types.
TEDATATYPEEXPORT
#define TEDATATYPEEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: src/terralib/datatype/Config.h:61
te
URI C++ Library.
Definition: Attributes.h:37
dt
static te::dt::TimeDuration dt(20, 30, 50, 11)
te::dt::DateTimePeriod
An abstract class to represent a period of date and time.
Definition: DateTimePeriod.h:48
te::dt::DateTimeInstant
An abstract class to represent an instant of date and time.
Definition: DateTimeInstant.h:43