Class template year_based_generator

Boost C++ Libraries

Class template year_based_generator

boost::date_time::year_based_generator — Base class for all generators that take a year and produce a date.

Synopsis

// In header: <boost/date_time/date_generators.hpp>

template<typename date_type> 
class year_based_generator {
public:
  // types
  typedef date_type::calendar_type calendar_type;
  typedef calendar_type::year_type year_type;    

  // construct/copy/destruct
  year_based_generator();
  ~year_based_generator();

  // public member functions
  virtual date_type get_date(year_type) const = 0;
  virtual std::string to_string() const = 0;
};

Description

This class is a base class for polymorphic function objects that take a year and produce a concrete date.

`year_based_generator` public construct/copy/destruct

```
year_based_generator();
```
```
~year_based_generator();
```

`year_based_generator` public member functions

virtual date_type get_date(year_type y) const = 0;

```
virtual std::string to_string() const = 0;
```
Returns a string for use in a POSIX time_zone string.