fix doc example typo
[boost.git] / boost / date_time / gregorian / greg_year.hpp
blob3d98fd06b2851540931a678b32cb3ffd366992c6
1 #ifndef GREG_YEAR_HPP___
2 #define GREG_YEAR_HPP___
4 /* Copyright (c) 2002,2003 CrystalClear Software, Inc.
5 * Use, modification and distribution is subject to the
6 * Boost Software License, Version 1.0. (See accompanying
7 * file LICENSE_1_0.txt or http://www.boost.org/LICENSE_1_0.txt)
8 * Author: Jeff Garland
9 * $Date$
12 #include "boost/date_time/constrained_value.hpp"
13 #include <stdexcept>
14 #include <string>
16 namespace boost {
17 namespace gregorian {
19 //! Exception type for gregorian year
20 struct bad_year : public std::out_of_range
22 bad_year() :
23 std::out_of_range(std::string("Year is out of valid range: 1400..10000"))
26 //! Policy class that declares error handling gregorian year type
27 typedef CV::simple_exception_policy<unsigned short, 1400, 10000, bad_year> greg_year_policies;
29 //! Generated representation for gregorian year
30 typedef CV::constrained_value<greg_year_policies> greg_year_rep;
32 //! Represent a day of the month (range 1900 - 10000)
33 /*! This small class allows for simple conversion an integer value into
34 a year for the gregorian calendar. This currently only allows a
35 range of 1900 to 10000. Both ends of the range are a bit arbitrary
36 at the moment, but they are the limits of current testing of the
37 library. As such they may be increased in the future.
39 class greg_year : public greg_year_rep {
40 public:
41 greg_year(unsigned short year) : greg_year_rep(year) {}
42 operator unsigned short() const {return value_;}
43 private:
49 } } //namespace gregorian
53 #endif