fix doc example typo
[boost.git] / boost / date_time / gregorian / greg_weekday.hpp
blob60fec3229754dd7987e4f91f7f81940a79a2cd59
1 #ifndef GREG_WEEKDAY_HPP___
2 #define GREG_WEEKDAY_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, Bart Garst
9 * $Date$
12 #include "boost/date_time/constrained_value.hpp"
13 #include "boost/date_time/date_defs.hpp"
14 #include "boost/date_time/compiler_config.hpp"
15 #include <stdexcept>
16 #include <string>
18 namespace boost {
19 namespace gregorian {
21 //bring enum values into the namespace
22 using date_time::Sunday;
23 using date_time::Monday;
24 using date_time::Tuesday;
25 using date_time::Wednesday;
26 using date_time::Thursday;
27 using date_time::Friday;
28 using date_time::Saturday;
31 //! Exception that flags that a weekday number is incorrect
32 struct bad_weekday : public std::out_of_range
34 bad_weekday() : std::out_of_range(std::string("Weekday is out of range 0..6")) {}
36 typedef CV::simple_exception_policy<unsigned short, 0, 6, bad_weekday> greg_weekday_policies;
37 typedef CV::constrained_value<greg_weekday_policies> greg_weekday_rep;
40 //! Represent a day within a week (range 0==Sun to 6==Sat)
41 class BOOST_DATE_TIME_DECL greg_weekday : public greg_weekday_rep {
42 public:
43 typedef boost::date_time::weekdays weekday_enum;
44 greg_weekday(unsigned short day_of_week_num) :
45 greg_weekday_rep(day_of_week_num)
48 unsigned short as_number() const {return value_;}
49 const char* as_short_string() const;
50 const char* as_long_string() const;
51 #ifndef BOOST_NO_STD_WSTRING
52 const wchar_t* as_short_wstring() const;
53 const wchar_t* as_long_wstring() const;
54 #endif // BOOST_NO_STD_WSTRING
55 weekday_enum as_enum() const {return static_cast<weekday_enum>(value_);}
62 } } //namespace gregorian
66 #endif