boost::date_time::first_kday_of_month< date_type > Class Template Reference

Useful generator functor for finding holidays and daylight savings. More...

#include <date_generators.hpp>

Inheritance diagram for boost::date_time::first_kday_of_month< date_type >:

Collaboration diagram for boost::date_time::first_kday_of_month< date_type >:

Public Types
typedef date_type::calendar_type	calendar_type
typedef calendar_type::day_of_week_type	day_of_week_type
typedef calendar_type::month_type	month_type
typedef calendar_type::year_type	year_type
typedef date_type::duration_type	duration_type

Public Member Functions
	first_kday_of_month (day_of_week_type dow, month_type m)
	Specify the first 'Sunday' in 'April' spec. More...
date_type	get_date (year_type year) const
	Return a concrete date when provided with a year specific year. More...
month_type	month () const
day_of_week_type	day_of_week () const
virtual std::string	to_string () const
	Returns string suitable for use in POSIX time zone string. More...

Detailed Description

template<class date_type>
class boost::date_time::first_kday_of_month< date_type >

Useful generator functor for finding holidays and daylight savings.

Similar to nth_kday_of_month, but requires less paramters

Member Typedef Documentation

template<class date_type >

typedef date_type::calendar_type boost::date_time::first_kday_of_month< date_type >::calendar_type

template<class date_type >

typedef calendar_type::day_of_week_type boost::date_time::first_kday_of_month< date_type >::day_of_week_type

template<class date_type >

typedef date_type::duration_type boost::date_time::first_kday_of_month< date_type >::duration_type

template<class date_type >

typedef calendar_type::month_type boost::date_time::first_kday_of_month< date_type >::month_type

template<class date_type >

typedef calendar_type::year_type boost::date_time::first_kday_of_month< date_type >::year_type

Constructor & Destructor Documentation

template<class date_type >

boost::date_time::first_kday_of_month< date_type >::first_kday_of_month ( day_of_week_type  dow, month_type  m  )

inline

Specify the first 'Sunday' in 'April' spec.

Parameters

dow	The day of week, eg: Sunday, Monday, etc
m	The month of the year, eg: Jan, Feb, Mar, etc

Member Function Documentation

template<class date_type >

day_of_week_type boost::date_time::first_kday_of_month< date_type >::day_of_week ( ) const

inline

Referenced by boost::date_time::date_generator_formatter< time_type::date_type, CharT >::put_first_kday(), and boost::serialization::save().

template<class date_type >

date_type boost::date_time::first_kday_of_month< date_type >::get_date ( year_type  year ) const

inlinevirtual

Return a concrete date when provided with a year specific year.

Implements boost::date_time::year_based_generator< date_type >.

Referenced by boost::date_time::us_dst_trait< date_type >::local_dst_end_day(), boost::date_time::us_dst_rules< date_type_, time_duration_type_, dst_start_offset_minutes, dst_length_minutes >::local_dst_end_day(), boost::date_time::us_dst_trait< date_type >::local_dst_start_day(), and boost::date_time::us_dst_rules< date_type_, time_duration_type_, dst_start_offset_minutes, dst_length_minutes >::local_dst_start_day().

template<class date_type >

month_type boost::date_time::first_kday_of_month< date_type >::month ( ) const

inline

Referenced by boost::date_time::date_generator_formatter< time_type::date_type, CharT >::put_first_kday(), and boost::serialization::save().

template<class date_type >

virtual std::string boost::date_time::first_kday_of_month< date_type >::to_string ( ) const

inlinevirtual

Returns string suitable for use in POSIX time zone string.

Returns a string formatted as "M4.1.0" ==> 1st Sunday in April.

Implements boost::date_time::year_based_generator< date_type >.

---

The documentation for this class was generated from the following file:

• boost_1_57_0/boost/date_time/date_generators.hpp