diff --git a/xmldoc/date_time_autodoc.boostbook b/xmldoc/date_time_autodoc.boostbook deleted file mode 100644 index f5ded09..0000000 --- a/xmldoc/date_time_autodoc.boostbook +++ /dev/null @@ -1,9008 +0,0 @@ - - - -
-Date Time Reference -
- - - - - Functor to iterate a fixed number of days. - - date_type::duration_type - - - - duration_type - - const date_type & - - - - duration_type - - const date_type & - - - - - - int - - - - - - Provides calculation to find next nth month given a date. - - This adjustment function provides the logic for 'month-based' advancement on a ymd based calendar. The policy it uses to handle the non existant end of month days is to back up to the last day of the month. Also, if the starting date is the last day of a month, this functor will attempt to adjust to the end of the month. - - - date_type::duration_type - - - date_type::calendar_type - - - cal_type::ymd_type - - - cal_type::day_type - - - - duration_type - - const date_type & - - - - duration_type - - const date_type & - - Returns a negative duration_type. - - - - - int - - - - - - Functor to iterate a over weeks. - - date_type::duration_type - - - date_type::calendar_type - - - - duration_type - - const date_type & - - - - duration_type - - const date_type & - - - - - - int - - - - - - Functor to iterate by a year adjusting for leap years. - - date_type::duration_type - - - - duration_type - - const date_type & - - - - duration_type - - const date_type & - - - - - - int - - - - - -
-
- Time adjustment calculations based on machine - - - - - Adjust to / from utc using the C API. - - Warning!!! This class assumes that timezone settings of the machine are correct. This can be a very dangerous assumption. - - - time_type::time_duration_type - - - time_type::date_type - - - date_type::duration_type - - - - time_type - - const time_type & - - Convert a utc time to local time. - - - - - -
-
- Provide workarounds related to the ctime header - - - - - Provides a uniform interface to some 'ctime' functions. - - Provides a uniform interface to some ctime functions and their '_r' counterparts. The '_r' functions require a pointer to a user created std::tm struct whereas the regular functions use a staticly created struct and return a pointer to that. These wrapper functions require the user to create a std::tm struct and send in a pointer to it. A pointer to the user created struct will be returned. - - - - std::tm * - - const std::time_t * - - - std::tm * - - requires a pointer to a user created std::tm struct - - - std::tm * - - const std::time_t * - - - std::tm * - - requires a pointer to a user created std::tm struct - - - std::tm * - - const std::time_t * - - - std::tm * - - requires a pointer to a user created std::tm struct - - - std::tm * - - const std::time_t * - - - std::tm * - - requires a pointer to a user created std::tm struct - - - - - -
-
- -
-
- - - - - A template to specify a constrained basic value type. - - This template provides a quick way to generate an integer type with a constrained range. The type provides for the ability to specify the min, max, and and error handling policy. - value policies A class that provides the range limits via the min and max functions as well as a function on_error that determines how errors are handled. A common strategy would be to assert or throw and exception. The on_error is passed both the current value and the new value that is in error. - - - value_policies::value_type - - - - value_type - Coerce into the representation type. - - - - - value_type - - - - - value_type - - - - - value_type max - Return the max allowed value (traits method). - - - value_type min - Return the min allowed value (traits method). - - - - - void - - value_type - - - - - - - Template to shortcut the constrained_value policy creation process. - - rep_type - - - - rep_type min - - - rep_type max - - - void - - rep_type - - - rep_type - - - violation_enum - - - - - - - - Represent a min or max violation type. - - - -
-
- - - - - Representation of timepoint at the one day level resolution. - - The date template represents an interface shell for a date class that is based on a year-month-day system such as the gregorian or iso systems. It provides basic operations to enable calculation and comparisons. - Theory - This date representation fundamentally departs from the C tm struct approach. The goal for this type is to provide efficient date operations (add, subtract) and storage (minimize space to represent) in a concrete class. Thus, the date uses a count internally to represent a particular date. The calendar parameter defines the policies for converting the the year-month-day and internal counted form here. Applications that need to perform heavy formatting of the same date repeatedly will perform better by using the year-month-day representation. - Internally the date uses a day number to represent the date. This is a monotonic time representation. This representation allows for fast comparison as well as simplifying the creation of writing numeric operations. Essentially, the internal day number is like adjusted julian day. The adjustment is determined by the Epoch date which is represented as day 1 of the calendar. Day 0 is reserved for negative infinity so that any actual date is automatically greater than negative infinity. When a date is constructed from a date or formatted for output, the appropriate conversions are applied to create the year, month, day representations. - - - T - - - calendar - - - calendar::date_traits_type - - - duration_type_ - - - calendar::year_type - - - calendar::month_type - - - calendar::day_type - - - calendar::ymd_type - - - calendar::date_rep_type - - - calendar::date_int_type - - - calendar::day_of_week_type - - - - year_type - - - month_type - - - day_type - - - day_of_week_type - - - ymd_type - - - bool - - const date_type & - - - - bool - - const date_type & - - - - bool - check to see if date is a special value - - - bool - check to see if date is not a value - - - bool - check to see if date is one of the infinity values - - - bool - check to see if date is greater than all possible dates - - - bool - check to see if date is greater than all possible dates - - - special_values - return as a special value or a not_special if a normal date - - - duration_type - - const date_type & - - - - date_type - - const duration_type & - - - - date_type - - const duration_type & - - - - date_rep_type - - - date_type - - const duration_type & - - - - date_type - - const duration_type & - - - - - - year_type - - - month_type - - - day_type - - - - - const ymd_type & - - - - - - date_int_type - - - This is a private constructor which allows for the creation of new dates. It is not exposed to users since that would require class users to understand the inner workings of the date class. - - - - - date_rep_type - - - - - -
-
- - - - - A clock providing day level services based on C time_t capabilities. - - This clock uses Posix interfaces as its implementation and hence uses the timezone settings of the operating system. Incorrect user settings will result in incorrect results for the calls to local_day. - - - date_type::ymd_type - - - - date_type - Get the local day as a date type. - - - date_type::ymd_type - Get the local day as a ymd_type. - - - date_type::ymd_type - Get the current day in universal date as a ymd_type. - - - date_type - Get the UTC day as a date type. - - - - - ::std::tm * - - std::tm & - - - - ::std::tm * - - std::tm & - - - - - - -
-
- - - - - - - - - - - An enumeration of weekday names. - - - - 1 - - - - - - - - - - - - - - - Simple enum to allow for nice programming with Jan, Feb, etc. - - - -
-
- - - - - Duration type with date level resolution. - - duration_rep_traits::int_type - - - duration_rep_traits::impl_type - - - - duration_rep - returns days_ as it's instantiated type - used for streaming - - - bool - - - duration_rep_type - returns days as value, not object. - - - bool - - const date_duration & - - Equality. - - - bool - - const date_duration & - - Less. - - - - date_duration - - - const date_duration & - - Subtract another duration -- result is signed. - - - - date_duration - - - const date_duration & - - Add a duration -- result is signed. - - - - date_duration - - unary- Allows for dd = -date_duration(2); -> dd == -2 - - - date_duration< duration_rep_traits > - - int - - Division operations on a duration with an integer. - - - date_duration< duration_rep_traits > - - int - - - - bool - return sign information - - - - - duration_rep - - Construct from a day count. - - - - special_values - - - construct from special_values - only works when instantiated with duration_traits_adapted - - - - - const date_duration< duration_rep_traits > & - - Construct from another date_duration (Copy Constructor). - - - - - date_duration - - Returns the smallest duration -- used by to calculate 'end'. - - - - - - Struct for instantiating date_duration with NO special values functionality. Allows for transparent implementation of either date_duration<long> or date_duration<int_adapter<long> > - - - long - - - long - - - - int_type - - impl_type - - - - - - - Struct for instantiating date_duration WITH special values functionality. Allows for transparent implementation of either date_duration<long> or date_duration<int_adapter<long> > - - - long - - - boost::date_time::int_adapter< long > - - - - int_type - - - impl_type - - - - - - - -
-
- - - - - boost::date_time::date_duration< duration_config > - Additional duration type that represents a number of n*7 days. - - - - typename duration_config::impl_type - - - - - special_values - - - - - - additional duration type that represents a logical month - - A logical month enables things like: "date(2002,Mar,2) + months(2) -> 2002-May2". If the date is a last day-of-the-month, the result will also be a last-day-of-the-month. - - - - int_rep - - - duration_type - - const date_type & - - returns a negative duration - - - duration_type - - const date_type & - - - - bool - - const months_type & - - - - bool - - const months_type & - - - - - months_type - - - const months_type & - - - - months_type & - - const months_type & - - - - - months_type - - - const months_type & - - - - months_type & - - const months_type & - - - - - months_type - - - const int_type - - - - months_type & - - const int_type - - - - - months_type - - - const int_type - - - - months_type & - - const int_type - - - - - months_type - - - const years_type & - - - - months_type & - - const years_type & - - - - - months_type - - - const years_type & - - - - months_type & - - const years_type & - - - - - - int_rep - - - - - special_values - - - - - - additional duration type that represents a logical year - - A logical year enables things like: "date(2002,Mar,2) + years(2) -> 2004-Mar-2". If the date is a last day-of-the-month, the result will also be a last-day-of-the-month (ie date(2001-Feb-28) + years(3) -> 2004-Feb-29). - - - - int_rep - - - duration_type - - const date_type & - - returns a negative duration - - - duration_type - - const date_type & - - - - bool - - const years_type & - - - - bool - - const years_type & - - - - - years_type - - - const years_type & - - - - years_type & - - const years_type & - - - - - years_type - - - const years_type & - - - - years_type & - - const years_type & - - - - - years_type - - - const int_type - - - - years_type & - - const int_type - - - - - years_type - - - const int_type - - - - years_type & - - const int_type - - - - - months_type - - - const months_type & - - - - - months_type - - - const months_type & - - - - - - int_rep - - - - - special_values - - - - - -
-
- - - - - - Class that provides format based I/O facet for date types. - This class allows the formatting of dates by using format string. Format strings are: - -A => long_weekday_format - Full name Ex: Tuesdaya => short_weekday_format - Three letter abbreviation Ex: TueB => long_month_format - Full name Ex: Octoberb => short_month_format - Three letter abbreviation Ex: Octx => standard_format_specifier - defined by the localeY-%b-%d => default_date_format - YYYY-Mon-dd - - Default month format == b Default weekday format == a - - - date_type::duration_type - - - date_type::day_of_week_type - - - date_type::day_type - - - date_type::month_type - - - boost::date_time::period< date_type, duration_type > - - - std::basic_string< CharT > - - - CharT - - - boost::date_time::period_formatter< CharT > - - - boost::date_time::special_values_formatter< CharT > - - - std::vector< std::basic_string< CharT > > - - - date_generator_formatter< date_type, CharT > - - - partial_date< date_type > - - - nth_kday_of_month< date_type > - - - first_kday_of_month< date_type > - - - last_kday_of_month< date_type > - - - first_kday_after< date_type > - - - first_kday_before< date_type > - - - - std::locale::id & - - void - - - - void - - const char_type *const - - - - virtual void - - - virtual void - - - void - - const char_type *const - - - - void - - const char_type *const - - - - void - - - period_formatter_type - - - - - void - - const special_values_formatter_type & - - - - void - - const input_collection_type & - - - - void - - const input_collection_type & - - - - void - - const input_collection_type & - - - - void - - const input_collection_type & - - - - void - - const input_collection_type & - - - typename date_gen_formatter_type::phrase_elements - date_gen_formatter_type::first - - - - OutItrT - - OutItrT - - - std::ios_base & - - - char_type - - - const date_type & - - - - OutItrT - - OutItrT - - - std::ios_base & - - - char_type - - - const duration_type & - - - - OutItrT - - OutItrT - - - std::ios_base & - - - char_type - - - const month_type & - - - - OutItrT - - OutItrT - - - std::ios_base & - - - char_type - - - const day_type & - - puts the day of month - - - OutItrT - - OutItrT - - - std::ios_base & - - - char_type - - - const day_of_week_type & - - - - OutItrT - - OutItrT - - - std::ios_base & - - - char_type - - - const period_type & - - - - OutItrT - - OutItrT - - - std::ios_base & - - - char_type - - - const partial_date_type & - - - - OutItrT - - OutItrT - - - std::ios_base & - - - char_type - - - const nth_kday_type & - - - - OutItrT - - OutItrT - - - std::ios_base & - - - char_type - - - const first_kday_type & - - - - OutItrT - - OutItrT - - - std::ios_base & - - - char_type - - - const last_kday_type & - - - - OutItrT - - OutItrT - - - std::ios_base & - - - char_type - - - const kday_before_type & - - - - OutItrT - - OutItrT - - - std::ios_base & - - - char_type - - - const kday_after_type & - - - - - - ::size_t - 0 - - - - - const char_type * - - - const input_collection_type & - - - ::size_t - 0 - - - - - const char_type * - - - - period_formatter_type - - period_formatter_type() - - - - special_values_formatter_type - - special_values_formatter_type() - - - - date_gen_formatter_type - - date_gen_formatter_type() - - - ::size_t - 0 - - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - std::locale::id - - - - tm - - tm & - - Helper function to initialize all fields in a tm struct. - - - virtual OutItrT - - OutItrT - - - std::ios_base & - - - char_type - - - const boost::date_time::special_values - - - - virtual OutItrT - - OutItrT - - - std::ios_base & - - - char_type - - - const tm & - - - string_type - - - - - - - Input facet. - - date_type::duration_type - - - date_type::day_of_week_type - - - date_type::day_type - - - date_type::month_type - - - date_type::year_type - - - boost::date_time::period< date_type, duration_type > - - - std::basic_string< CharT > - - - CharT - - - boost::date_time::period_parser< date_type, CharT > - - - special_values_parser< date_type, CharT > - - - std::vector< std::basic_string< CharT > > - - - format_date_parser< date_type, CharT > - - - date_generator_parser< date_type, CharT > - - - partial_date< date_type > - - - nth_kday_of_month< date_type > - - - first_kday_of_month< date_type > - - - last_kday_of_month< date_type > - - - first_kday_after< date_type > - - - first_kday_before< date_type > - - - - void - - const char_type *const - - - - virtual void - - - virtual void - - - void - - const char_type *const - - - - void - - const char_type *const - - - - void - - const char_type *const - - - - void - - - period_parser_type - - - - - void - - const input_collection_type & - - - - void - - const input_collection_type & - - - - void - - const input_collection_type & - - - - void - - const input_collection_type & - - - - void - - const input_collection_type & - - - - void - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - - void - - - special_values_parser_type - - - - - InItrT - - InItrT & - - - InItrT & - - - std::ios_base & - - - date_type & - - - - InItrT - - InItrT & - - - InItrT & - - - std::ios_base & - - - month_type & - - - - InItrT - - InItrT & - - - InItrT & - - - std::ios_base & - - - day_of_week_type & - - - - InItrT - - InItrT & - - - InItrT & - - - std::ios_base & - - - day_type & - - - - InItrT - - InItrT & - - - InItrT & - - - std::ios_base & - - - year_type & - - - - InItrT - - InItrT & - - - InItrT & - - - std::ios_base & - - - duration_type & - - - - InItrT - - InItrT & - - - InItrT & - - - std::ios_base & - - - period_type & - - - - InItrT - - InItrT & - - - InItrT & - - - std::ios_base & - - - nth_kday_type & - - - - InItrT - - InItrT & - - - InItrT & - - - std::ios_base & - - - partial_date_type & - - - - InItrT - - InItrT & - - - InItrT & - - - std::ios_base & - - - first_kday_type & - - - - InItrT - - InItrT & - - - InItrT & - - - std::ios_base & - - - last_kday_type & - - - - InItrT - - InItrT & - - - InItrT & - - - std::ios_base & - - - kday_before_type & - - - - InItrT - - InItrT & - - - InItrT & - - - std::ios_base & - - - kday_after_type & - - - - - - ::size_t - 0 - - - - - const string_type & - - - ::size_t - 0 - - - - - const string_type & - - - const format_date_parser_type & - - - const special_values_parser_type & - - - const period_parser_type & - - - const date_gen_parser_type & - - - ::size_t - 0 - - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - std::locale::id - - - - -
-
- - - - - Class to provide simple basic formatting rules. - - - const charT * - String used printed is date is invalid. - - - const charT * - String used to for positive infinity value. - - - const charT * - String used to for positive infinity value. - - - month_format_spec - Describe month format. - - - ymd_order_spec - - - bool - This format uses '-' to separate date elements. - - - charT - Char to sep? - - - charT - char between year-month - - - charT - Char to separate month-day. - - - charT - char between date-hours - - - charT - char between hour and minute - - - charT - char for second - - - - - - - wchar_t - - Specialization of formmating rules for wchar_t. - - - const wchar_t * - String used printed is date is invalid. - - - const wchar_t * - String used to for positive infinity value. - - - const wchar_t * - String used to for positive infinity value. - - - month_format_spec - Describe month format. - - - ymd_order_spec - - - bool - This format uses '-' to separate date elements. - - - wchar_t - Char to sep? - - - wchar_t - char between year-month - - - wchar_t - Char to separate month-day. - - - wchar_t - char between date-hours - - - wchar_t - char between hour and minute - - - wchar_t - char for second - - - - - -
-
- - - - - Formats a month as as string into an ostream. - - - std::basic_ostream< charT > & - - const month_type & - - - std::basic_ostream< charT > & - - Formats a month as as string into an ostream. - - This function demands that month_type provide functions for converting to short and long strings if that capability is used. - - - - std::ostream & - - const month_type & - - - std::ostream & - - Formats a month as as string into an ostream. - - This function demands that month_type provide functions for converting to short and long strings if that capability is used. - - - - - - - Convert ymd to a standard string formatting policies. - - - std::basic_string< charT > - - ymd_type - - Convert ymd to a standard string formatting policies. - - This is standard code for handling date formatting with year-month-day based date information. This function uses the format_type to control whether the string will contain separator characters, and if so what the character will be. In addtion, it can format the month as either an integer or a string as controled by the formatting policy - - - - std::string - - ymd_type - - Convert ymd to a standard string formatting policies. - - This is standard code for handling date formatting with year-month-day based date information. This function uses the format_type to control whether the string will contain separator characters, and if so what the character will be. In addtion, it can format the month as either an integer or a string as controled by the formatting policy - - - - - - - Convert a date to string using format policies. - - std::basic_string< charT > - - - - string_type - - date_type - - Convert to a date to standard string using format policies. - - - std::string - - date_type - - Convert to a date to standard string using format policies. - - - - - -
-
- - - -
-
- - - - - Formats a month as as string into an ostream. - - facet_type::month_type - - - std::basic_ostream< charT > - - - - void - - const month_type & - - - ostream_type & - - - const facet_type & - - Formats a month as as string into an output iterator. - - - - - - Formats a weekday. - - facet_type::month_type - - - std::basic_ostream< charT > - - - - void - - const weekday_type & - - - ostream_type & - - - const facet_type & - - - bool - - Formats a month as as string into an output iterator. - - - - - - Convert ymd to a standard string formatting policies. - - ymd_type::month_type - - - ostream_month_formatter< facet_type, charT > - - - std::basic_ostream< charT > - - - std::basic_string< charT > - - - - void - - ymd_type - - - ostream_type & - - - const facet_type & - - Convert ymd to a standard string formatting policies. - - This is standard code for handling date formatting with year-month-day based date information. This function uses the format_type to control whether the string will contain separator characters, and if so what the character will be. In addtion, it can format the month as either an integer or a string as controled by the formatting policy - - - - - - - Convert a date to string using format policies. - - std::basic_ostream< charT > - - - date_type::ymd_type - - - - void - - const date_type & - - - ostream_type & - - - const facet_type & - - Put date into an ostream. - - - void - - const date_type & - - - ostream_type & - - Put date into an ostream. - - - - - -
-
- - - - - Formats date_generators for output. - - Formatting of date_generators follows specific orders for the various types of date_generators. -partial_date => "dd Month"nth_day_of_the_week_in_month => "nth weekday of month"first_day_of_the_week_in_month => "first weekday of month"last_day_of_the_week_in_month => "last weekday of month"first_day_of_the_week_after => "weekday after"first_day_of_the_week_before => "weekday before" While the order of the elements in these phrases cannot be changed, the elements themselves can be. Weekday and Month get their formats and names from the date_facet. The remaining elements are stored in the date_generator_formatter and can be customized upon construction or via a member function. The default elements are those shown in the examples above. - - - - partial_date< date_type > - - - nth_kday_of_month< date_type > - - - first_kday_of_month< date_type > - - - last_kday_of_month< date_type > - - - first_kday_after< date_type > - - - first_kday_before< date_type > - - - CharT - - - std::basic_string< char_type > - - - std::vector< string_type > - - - - 0 - - - - - - - - - - - - - - void - - const collection_type & - - - phrase_elements - first - - Replace the set of phrase elements with those contained in new_strings. - - The order of the strings in the given collection is important. They must follow: -first, second, third, fourth, fifth, last, before, after, of. - - It is not necessary to send in a complete set if only a few elements are to be replaced as long as the correct beg_pos is used. - Ex: To keep the default first through fifth elements, but replace the rest with a collection of: -"final", "prior", "following", "in". The beg_pos of date_generator_formatter::last would be used. - - - - - OutItrT - - - OutItrT - - - std::ios_base & - - - CharT - - - const partial_date_type & - - - const facet_type & - - Put a partial_date => "dd Month". - - - OutItrT - - - OutItrT - - - std::ios_base & - - - CharT - - - const nth_kday_type & - - - const facet_type & - - Put an nth_day_of_the_week_in_month => "nth weekday of month". - - - OutItrT - - - OutItrT - - - std::ios_base & - - - CharT - - - const first_kday_type & - - - const facet_type & - - Put a first_day_of_the_week_in_month => "first weekday of month". - - - OutItrT - - - OutItrT - - - std::ios_base & - - - CharT - - - const last_kday_type & - - - const facet_type & - - Put a last_day_of_the_week_in_month => "last weekday of month". - - - OutItrT - - - OutItrT - - - std::ios_base & - - - CharT - - - const kday_before_type & - - - const facet_type & - - Put a first_day_of_the_week_before => "weekday before". - - - OutItrT - - - OutItrT - - - std::ios_base & - - - CharT - - - const kday_after_type & - - - const facet_type & - - Put a first_day_of_the_week_after => "weekday after". - - - - Default format elements used. - - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - Constructor that allows for a custom set of phrase elements. - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - - OutItrT - - OutItrT - - - const string_type & - - helper function to put the various member string into stream - - - - - -
-
- - - - - Class for date_generator parsing. - - The elements of a date_generator "phrase" are parsed from the input stream in a particular order. All elements are required and the order in which they appear cannot change, however, the elements themselves can be changed. The default elements and their order are as follows: -partial_date => "dd Month"nth_day_of_the_week_in_month => "nth weekday of month"first_day_of_the_week_in_month => "first weekday of month"last_day_of_the_week_in_month => "last weekday of month"first_day_of_the_week_after => "weekday after"first_day_of_the_week_before => "weekday before" - - Weekday and Month names and formats are handled via the date_input_facet. - TODO: add doc-comments for which elements can be changed - - - std::basic_string< charT > - - - std::istreambuf_iterator< charT > - - - date_type::month_type - - - date_type::day_of_week_type - - - date_type::day_type - - - string_parse_tree< charT > - - - parse_tree_type::parse_match_result_type - - - std::vector< std::basic_string< charT > > - - - partial_date< date_type > - - - nth_kday_of_month< date_type > - - - first_kday_of_month< date_type > - - - last_kday_of_month< date_type > - - - first_kday_after< date_type > - - - first_kday_before< date_type > - - - charT - - - - 0 - - - - - - - - - - - - - - void - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - Replace strings that determine nth week for generator. - - - void - - const collection_type & - - - - - partial_date_type - - - - stream_itr_type & - - - stream_itr_type & - - - std::ios_base & - - - const facet_type & - - returns partial_date parsed from stream - - - - nth_kday_type - - - - stream_itr_type & - - - stream_itr_type & - - - std::ios_base & - - - const facet_type & - - returns nth_kday_of_week parsed from stream - - - - first_kday_type - - - - stream_itr_type & - - - stream_itr_type & - - - std::ios_base & - - - const facet_type & - - returns first_kday_of_week parsed from stream - - - - last_kday_type - - - - stream_itr_type & - - - stream_itr_type & - - - std::ios_base & - - - const facet_type & - - returns last_kday_of_week parsed from stream - - - - kday_before_type - - - - stream_itr_type & - - - stream_itr_type & - - - std::ios_base & - - - const facet_type & - - returns first_kday_of_week parsed from stream - - - - kday_after_type - - - - stream_itr_type & - - - stream_itr_type & - - - std::ios_base & - - - const facet_type & - - returns first_kday_of_week parsed from stream - - - - Creates a date_generator_parser with the default set of "element_strings". - - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - Creates a date_generator_parser using a user defined set of element strings. - - - - const date_generator_parser< date_type, charT > * - - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - - void - - stream_itr_type & - - - stream_itr_type & - - - typename date_generator_parser::phrase_elements - - Extracts phrase element from input. Throws ios_base::failure on error. - - - - - -
-
- Definition and implementation of date algorithm templates - - - - - Base class for all generators that take a year and produce a date. - - This class is a base class for polymorphic function objects that take a year and produce a concrete date. - - - - date_type::calendar_type - - - calendar_type::year_type - - - - virtual date_type - - year_type - - - - virtual std::string - Returns a string for use in a POSIX time_zone string. - - - - - - - - boost::date_time::year_based_generator< date_type > - Generates a date by applying the year to the given month and day. - - Example usage: partial_date pd(1, Jan); - partial_date pd2(70); - date d = pd.get_date(2002); //2002-Jan-01 - date d2 = pd2.get_date(2002); //2002-Mar-10 - - - - date_type::calendar_type - - - calendar_type::day_type - - - calendar_type::month_type - - - calendar_type::year_type - - - date_type::duration_type - - - duration_type::duration_rep - - - - date_type - - year_type - - Return a concrete date when provided with a year specific year. - - Will throw an 'invalid_argument' exception if a partial_date object, instantiated with Feb-29, has get_date called with a non-leap year. Example: partial_date pd(29, Feb); - pd.get_date(2003); // throws invalid_argument exception - pg.get_date(2000); // returns 2000-2-29 - - - - - date_type - - year_type - - - - bool - - const partial_date & - - - - bool - - const partial_date & - - - - month_type - - - day_type - - - virtual std::string - Returns string suitable for use in POSIX time zone string. - - Returns string formatted with up to 3 digits: Jan-01 == "0" Feb-29 == "58" Dec-31 == "365" - - - - - - day_type - - - month_type - - - - - duration_rep - - Partial date created from number of days into year. Range 1-366. - - Allowable values range from 1 to 366. 1=Jan1, 366=Dec31. If argument exceeds range, partial_date will be created with closest in-range value. 60 will always be Feb29, if get_date() is called with a non-leap year an exception will be thrown - - - - - - boost::date_time::year_based_generator< date_type > - Useful generator functor for finding holidays. - - Based on the idea in Cal. Calc. for finding holidays that are the 'first Monday of September'. When instantiated with 'fifth' kday of month, the result will be the last kday of month which can be the fourth or fifth depending on the structure of the month. - The algorithm here basically guesses for the first day of the month. Then finds the first day of the correct type. That is, if the first of the month is a Tuesday and it needs Wenesday then we simply increment by a day and then we can add the length of a week until we get to the 'nth kday'. There are probably more efficient algorithms based on using a mod 7, but this one works reasonably well for basic applications. - - - date_type::calendar_type - - - calendar_type::day_of_week_type - - - calendar_type::month_type - - - calendar_type::year_type - - - date_type::duration_type - - - - 1 - - - - - - - - - date_type - - year_type - - Return a concrete date when provided with a year specific year. - - - month_type - - - week_num - - - day_of_week_type - - - const char * - - - virtual std::string - Returns string suitable for use in POSIX time zone string. - - Returns a string formatted as "M4.3.0" ==> 3rd Sunday in April. - - - - - - week_num - - - day_of_week_type - - - month_type - - - - - - boost::date_time::year_based_generator< date_type > - Useful generator functor for finding holidays and daylight savings. - - Similar to nth_kday_of_month, but requires less paramters - - - date_type::calendar_type - - - calendar_type::day_of_week_type - - - calendar_type::month_type - - - calendar_type::year_type - - - date_type::duration_type - - - - date_type - - year_type - - Return a concrete date when provided with a year specific year. - - - month_type - - - day_of_week_type - - - virtual std::string - Returns string suitable for use in POSIX time zone string. - - Returns a string formatted as "M4.1.0" ==> 1st Sunday in April. - - - - - - day_of_week_type - - The day of week, eg: Sunday, Monday, etc - - - - month_type - - The month of the year, eg: Jan, Feb, Mar, etc - - - Specify the first 'Sunday' in 'April' spec. - - - - - - - - - boost::date_time::year_based_generator< date_type > - Calculate something like Last Sunday of January. - - Useful generator functor for finding holidays and daylight savings Get the last day of the month and then calculate the difference to the last previous day. - - - - date_type::calendar_type - - - calendar_type::day_of_week_type - - - calendar_type::month_type - - - calendar_type::year_type - - - date_type::duration_type - - - - date_type - - year_type - - Return a concrete date when provided with a year specific year. - - - month_type - - - day_of_week_type - - - virtual std::string - Returns string suitable for use in POSIX time zone string. - - Returns a string formatted as "M4.5.0" ==> last Sunday in April. - - - - - - day_of_week_type - - The day of week, eg: Sunday, Monday, etc - - - - month_type - - The month of the year, eg: Jan, Feb, Mar, etc - - - Specify the date spec like last 'Sunday' in 'April' spec. - - - - - - - - - Calculate something like "First Sunday after Jan 1,2002. - - Date generator that takes a date and finds kday after typedef boost::date_time::first_kday_after<date> firstkdayafter; - firstkdayafter fkaf(Monday); - fkaf.get_date(date(2002,Feb,1)); - - - - date_type::calendar_type - - - calendar_type::day_of_week_type - - - date_type::duration_type - - - - date_type - - date_type - - Return next kday given. - - - day_of_week_type - - - - - day_of_week_type - - - - - - Calculate something like "First Sunday before Jan 1,2002. - - Date generator that takes a date and finds kday after typedef boost::date_time::first_kday_before<date> firstkdaybefore; - firstkdaybefore fkbf(Monday); - fkbf.get_date(date(2002,Feb,1)); - - - - date_type::calendar_type - - - calendar_type::day_of_week_type - - - date_type::duration_type - - - - date_type - - date_type - - Return next kday given. - - - day_of_week_type - - - - - day_of_week_type - - - - - BOOST_DATE_TIME_DECL const char * - - int - - Returns nth arg as string. 1 -> "first", 2 -> "second", max is 5. - - - date_type::duration_type - - - const date_type & - - - const weekday_type & - - Calculates the number of days until the next weekday. - - Calculates the number of days until the next weekday. If the date given falls on a Sunday and the given weekday is Tuesday the result will be 2 days - - - - date_type::duration_type - - - const date_type & - - - const weekday_type & - - Calculates the number of days since the previous weekday. - - Calculates the number of days since the previous weekday If the date given falls on a Sunday and the given weekday is Tuesday the result will be 5 days. The answer will be a positive number because Tuesday is 5 days before Sunday, not -5 days before. - - - - date_type - - - const date_type & - - - const weekday_type & - - Generates a date object representing the date of the following weekday from the given date. - - Generates a date object representing the date of the following weekday from the given date. If the date given is 2004-May-9 (a Sunday) and the given weekday is Tuesday then the resulting date will be 2004-May-11. - - - - date_type - - - const date_type & - - - const weekday_type & - - Generates a date object representing the date of the previous weekday from the given date. - - Generates a date object representing the date of the previous weekday from the given date. If the date given is 2004-May-9 (a Sunday) and the given weekday is Tuesday then the resulting date will be 2004-May-4. - - - - -
-
- - - - - Base date iterator type. - - This class provides the skeleton for the creation of iterators. New and interesting interators can be created by plugging in a new function that derives the next value from the current state. generation of various types of -based information. - Template Parameters - date_type - The date_type is a concrete date_type. The date_type must define a duration_type and a calendar_type. - - - date_type::duration_type - - - date_type - - - std::input_iterator_tag - - - - date_itr_base & - - - date_itr_base & - - - virtual duration_type - - const date_type & - - - - virtual duration_type - - const date_type & - - - - date_type - - - date_type * - - - bool - - const date_type & - - - - bool - - const date_type & - - - - bool - - const date_type & - - - - bool - - const date_type & - - - - bool - - const date_type & - - - - bool - - const date_type & - - - - - - date_type - - - - - - - boost::date_time::date_itr_base< date_type > - Overrides the base date iterator providing hook for functors. - - date_type::duration_type - - - - - date_type - - - int - 1 - - - - - virtual duration_type - - const date_type & - - - - virtual duration_type - - const date_type & - - - - - - - - - - - - - An iterator over dates with varying resolution (day, week, month, year, etc). - - - -
-
- - - - - Output facet base class for gregorian dates. - - This class is a base class for date facets used to localize the names of months and the names of days in the week. - Requirements of Config -define an enumeration month_enum that enumerates the months. The enumeration should be '1' based eg: Jan==1define as_short_string and as_long_string - - (see langer & kreft p334). - - - OutputIterator - - - Config::month_type - - - Config::month_enum - - - Config::weekday_enum - - - Config::special_value_enum - - - std::basic_string< charT > - - - charT - - - - std::locale::id & - - void - - - - void - - iter_type & - - - special_value_enum - - - - void - - iter_type & - - - month_enum - - - - void - - iter_type & - - - month_enum - - - - void - - iter_type & - - - weekday_enum - - - - void - - iter_type & - - - weekday_enum - - - - bool - - - void - - iter_type & - - - - void - - iter_type & - - char between year-month - - - void - - iter_type & - - Char to separate month-day. - - - ymd_order_spec - Determines the order to put the date elements. - - - month_format_spec - Determines if month is displayed as integer, short or long string. - - - - - const char_type - - - const char_type - - - std::locale::id - Generate storage location for a std::locale::id. - - - - virtual void - - iter_type & - - - month_enum - - Default facet implementation uses month_type defaults. - - - virtual void - - iter_type & - - - month_enum - - Default facet implementation uses month_type defaults. - - - virtual void - - iter_type & - - - special_value_enum - - Default facet implementation for special value types. - - - virtual void - - iter_type & - - - weekday_enum - - - - virtual void - - iter_type & - - - weekday_enum - - - - virtual bool - - - virtual void - - iter_type & - - - - virtual void - - iter_type & - - char between year-month - - - virtual void - - iter_type & - - Char to separate month-day. - - - virtual ymd_order_spec - Default for date order. - - - virtual month_format_spec - Default month format. - - - void - - iter_type & - - - const charT *const - - - - void - - iter_type & - - - const string_type & - - - - - - - boost::date_time::date_names_put< Config, charT, OutputIterator > - A date name output facet that takes an array of char* to define strings. - - OutputIterator - - - Config::month_enum - - - Config::weekday_enum - - - Config::special_value_enum - - - - const charT *const * - - - const charT *const * - - - const charT *const * - - - const charT *const * - - - const charT *const * - - - - - const charT *const - - - const charT *const - - - const charT *const - - - const charT *const - - - const charT *const - - - charT - '-' - - - ymd_order_spec - ymd_order_iso - - - month_format_spec - month_as_short_string - - - - - virtual void - - iter_type & - - - month_enum - - Generic facet that takes array of chars. - - - virtual void - - iter_type & - - - month_enum - - Long month names. - - - virtual void - - iter_type & - - - special_value_enum - - Special values names. - - - virtual void - - iter_type & - - - weekday_enum - - - - virtual void - - iter_type & - - - weekday_enum - - - - virtual void - - iter_type & - - char between year-month - - - virtual void - - iter_type & - - Char to separate month-day. - - - virtual ymd_order_spec - Set the date ordering. - - - virtual month_format_spec - Set the date ordering. - - - - - -
-
-
- Contains template class to provide static dst rule calculations - - - - - Dynamic class used to caluclate dst transition information. - - time_duration_type_ - - - date_type_ - - - - time_is_dst_result - - const time_duration_type & - - Time offset in the day for the local time - - - - unsigned int - - Local day offset for start of dst - - - - long - - Number of minutes to adjust clock forward - - - Check the local time offset when on dst start day. - - On this dst transition, the time label between the transition boundary and the boudary + the offset are invalid times. If before the boundary then still not in dst. - - - - - - time_is_dst_result - - const time_duration_type & - - Time offset in the day for the local time - - - - unsigned int - - Local time of day for end of dst - - - - long - - Check the local time offset when on the last day of dst. - - This is the calculation for the DST end day. On that day times prior to the conversion time - dst_length (1 am in US) are still in dst. Times between the above and the switch time are ambiguous. Times after the start_offset are not in dst. - - - - - - time_is_dst_result - - const date_type & - - The day to check for dst - - - - const time_duration_type & - - Time offset within the day to check - - - - const date_type & - - Starting day of dst for the given locality - - - - const time_duration_type & - - Time offset within day for dst boundary - - - - const date_type & - - Ending day of dst for the given locality - - - - const time_duration_type & - - Time offset within day given in dst for dst boundary - - - - const time_duration_type & - - Calculates if the given local time is dst or not. - - Determines if the time is really in DST or not. Also checks for invalid and ambiguous. - - - - - - time_is_dst_result - - const date_type & - - The day to check for dst - - - - const time_duration_type & - - Time offset within the day to check - - - - const date_type & - - Starting day of dst for the given locality - - - - unsigned int - - Offset within day for dst boundary (eg 120 for US which is 02:00:00) - - - - const date_type & - - Ending day of dst for the given locality - - - - unsigned int - - Offset within day given in dst for dst boundary (eg 120 for US which is 02:00:00) - - - - long - - Length of dst adjusment (eg: 60 for US) - - - Calculates if the given local time is dst or not. - - Determines if the time is really in DST or not. Also checks for invalid and ambiguous. - - - - - - - - - Compile-time configurable daylight savings time calculation engine. - - date_type::year_type - - - date_type::calendar_type - - - dst_calculator< date_type, time_duration_type > - - - - time_is_dst_result - - const date_type & - - - const time_duration_type & - - Calculates if the given local time is dst or not. - - Determines if the time is really in DST or not. Also checks for invalid and ambiguous. - - - - - bool - - date_type - - - - time_duration_type - The time of day for the dst transition (eg: typically 01:00:00 or 02:00:00). - - - date_type - - year_type - - - - date_type - - year_type - - - - - - - Depricated: Class to calculate dst boundaries for US time zones. - - time_duration_type_ - - - date_type_ - - - date_type::year_type - - - date_type::calendar_type - - - date_time::last_kday_of_month< date_type > - - - date_time::first_kday_of_month< date_type > - - - dst_calculator< date_type, time_duration_type > - - - - time_is_dst_result - - const date_type & - - - const time_duration_type & - - Calculates if the given local time is dst or not. - - Determines if the time is really in DST or not. Also checks for invalid and ambiguous. - - - - - bool - - date_type - - - - date_type - - year_type - - - - date_type - - year_type - - - - time_duration_type - - - - - - Used for local time adjustments in places that don't use dst. - - time_duration_type_ - - - date_type_ - - - - time_is_dst_result - - const date_type & - - - const time_duration_type & - - Calculates if the given local time is dst or not. - - - - - - - time_is_dst_result - - const date_type & - - - const time_duration_type & - - Calculates if the given utc time is in dst. - - - bool - - date_type - - - - time_duration_type - - - - - - - - - - - -
-
- - - - - Defines base interface for calculating start and end date of daylight savings. - - date_type::year_type - - - - virtual date_type - - year_type - - - - virtual std::string - - - virtual date_type - - year_type - - - - virtual std::string - - - - - - - boost::date_time::dst_day_calc_rule< spec::date_type > - Canonical form for a class that provides day rule calculation. - - This class is used to generate specific sets of dst rules - - - - - spec::date_type - - - date_type::year_type - - - spec::start_rule - - - spec::end_rule - - - - virtual date_type - - year_type - - - - virtual std::string - - - virtual date_type - - year_type - - - - virtual std::string - - - - - start_rule - - - end_rule - - - - - -
-
- Function(s) for converting between a FILETIME structure and a time object. This file is only available on systems that have BOOST_HAS_FTIME defined. - - - - time_type - - - const FILETIME & - - Create a time object from an initialized FILETIME struct. - - Create a time object from an initialized FILETIME struct. A FILETIME struct holds 100-nanosecond units (0.0000001). When built with microsecond resolution the FILETIME's sub second value will be truncated. Nanosecond resolution has no truncation. - - - - -
-
- - - - - Class with generic date parsing using a format string. - - The following is the set of recognized format specifiers -a - Short weekday nameA - Long weekday nameb - Abbreviated month nameB - Full month named - Day of the month as decimal 01 to 31j - Day of year as decimal from 001 to 366m - Month name as a decimal 01 to 12U - Week number 00 to 53 with first Sunday as the first day of week 1?w - Weekday as decimal number 0 to 6 where Sunday == 0W - Week number 00 to 53 where Monday is first day of week 1x - facet default date representationy - Year without the century - eg: 04 for 2004Y - Year with century - - The weekday specifiers (a and A) do not add to the date construction, but they provide a way to skip over the weekday names for formats that provide them. - todo -- Another interesting feature that this approach could provide is an option to fill in any missing fields with the current values from the clock. So if you have m-%d the parser would detect the missing year value and fill it in using the clock. - todo -- What to do with the x. x in the classic facet is just bad... - - - std::basic_string< charT > - - - std::basic_stringstream< charT > - - - std::istreambuf_iterator< charT > - - - string_type::const_iterator - - - date_type::year_type - - - date_type::month_type - - - date_type::day_type - - - date_type::duration_type - - - date_type::day_of_week_type - - - date_type::day_of_year_type - - - string_parse_tree< charT > - - - parse_tree_type::parse_match_result_type - - - std::vector< std::basic_string< charT > > - - - - string_type - - - void - - string_type - - - - void - - const input_collection_type & - - - - void - - const input_collection_type & - - - - void - - const input_collection_type & - - - - void - - const input_collection_type & - - - - date_type - - const string_type & - - - const string_type & - - - const special_values_parser< date_type, charT > & - - - - date_type - - std::istreambuf_iterator< charT > & - - - std::istreambuf_iterator< charT > & - - - const special_values_parser< date_type, charT > & - - - - date_type - - std::istreambuf_iterator< charT > & - - - std::istreambuf_iterator< charT > & - - - string_type - - - const special_values_parser< date_type, charT > & - - - Of all the objects that the format_date_parser can parse, only a date can be a special value. Therefore, only parse_date checks for special_values. - - - - month_type - - std::istreambuf_iterator< charT > & - - - std::istreambuf_iterator< charT > & - - - string_type - - Throws bad_month if unable to parse. - - - month_type - - std::istreambuf_iterator< charT > & - - - std::istreambuf_iterator< charT > & - - - string_type - - - match_results & - - Throws bad_month if unable to parse. - - - day_type - - std::istreambuf_iterator< charT > & - - - std::istreambuf_iterator< charT > & - - throws bad_day_of_month if unable to parse - - - day_of_week_type - - std::istreambuf_iterator< charT > & - - - std::istreambuf_iterator< charT > & - - - string_type - - - - day_of_week_type - - std::istreambuf_iterator< charT > & - - - std::istreambuf_iterator< charT > & - - - string_type - - - match_results & - - - - year_type - - std::istreambuf_iterator< charT > & - - - std::istreambuf_iterator< charT > & - - - string_type - - throws bad_year if unable to parse - - - year_type - - std::istreambuf_iterator< charT > & - - - std::istreambuf_iterator< charT > & - - - string_type - - - match_results & - - throws bad_year if unable to parse - - - - - const string_type & - - - const input_collection_type & - - - const input_collection_type & - - - const input_collection_type & - - - const input_collection_type & - - - - - const string_type & - - - const std::locale & - - - - - const format_date_parser< date_type, charT > & - - - - - int_type - - - std::istreambuf_iterator< charT > & - - - std::istreambuf_iterator< charT > & - - - parse_match_result< charT > & - - - unsigned int - - Helper function for parsing fixed length strings into integers. - - Will consume 'length' number of characters from stream. Consumed character are transfered to parse_match_result struct. Returns '-1' if no number can be parsed or incorrect number of digits in stream. - - - - int_type - - - std::istreambuf_iterator< charT > & - - - std::istreambuf_iterator< charT > & - - - unsigned int - - Helper function for parsing varied length strings into integers. - - Will consume 'max_length' characters from stream only if those characters are digits. Returns '-1' if no number can be parsed. Will not parse a number preceeded by a '+' or '-'. - - - - -
-
- - - - - An implementation of the Gregorian calendar. - - This is a parameterized implementation of a proleptic Gregorian Calendar that can be used in the creation of date systems or just to perform calculations. All the methods of this class are static functions, so the intent is to never create instances of this class. - - - - define a type a date split into components - ymd_type_ - - - define a type for representing months - ymd_type::month_type - - - define a type for representing days - ymd_type::day_type - - - Type to hold a stand alone year value (eg: 2002). - ymd_type::year_type - - - Define the integer type to use for internal calculations. - date_int_type_ - - - - unsigned short - - const ymd_type & - - - - int - - const ymd_type & - - - - date_int_type - - const ymd_type & - - - - date_int_type - - const ymd_type & - - - - long - - const ymd_type & - - - - ymd_type - - date_int_type - - - - ymd_type - - date_int_type - - - - ymd_type - - long - - - - bool - - year_type - - - - unsigned short - - year_type - - - month_type - - - - ymd_type - - - unsigned short - - - - - -
-
- - - - - Adapter to create integer types with +-infinity, and not a value. - - This class is used internally in counted date/time representations. It adds the floating point like features of infinities and not a number. It also provides mathmatical operations with consideration to special values following these rules: +infinity - infinity == Not A Number (NAN) - infinity * non-zero == infinity - infinity * zero == NAN - +infinity * -integer == -infinity - infinity / infinity == NAN - infinity * infinity == infinity - * - - - - int_type_ - - - - bool - - - bool - - - bool - - - bool - - - bool - - - bool - - const int_adapter & - - - - bool - - const int & - - - - bool - - const int_adapter & - - - - bool - - const int & - - - - bool - - const int_adapter & - - - - bool - - const int & - - - - bool - - const int_adapter & - - - - int_type - - - special_values - Returns either special value type or is_not_special. - - - - int_adapter - - - - const int_adapter< rhs_type > & - - - Operator allows for adding dissimilar int_adapter types. The return type will match that of the the calling object's type - - - - - int_adapter - - - const int_type - - - - - int_adapter - - - - const int_adapter< rhs_type > & - - - Operator allows for subtracting dissimilar int_adapter types. The return type will match that of the the calling object's type - - - - - int_adapter - - - const int_type - - - - - int_adapter - - - const int_adapter & - - - - - int_adapter - - - const int - - - Provided for cases when automatic conversion from 'int' to 'int_adapter' causes incorrect results. - - - - - int_adapter - - - const int_adapter & - - - - - int_adapter - - - const int - - - Provided for cases when automatic conversion from 'int' to 'int_adapter' causes incorrect results. - - - - - int_adapter - - - const int_adapter & - - - - - int_adapter - - - const int - - - Provided for cases when automatic conversion from 'int' to 'int_adapter' causes incorrect results. - - - - - - int_type - - - - - bool - - - const int_adapter - - - const int_adapter - - - const int_adapter - - - int_adapter max - - - int_adapter min - - - - int_adapter - - - special_values - - - - bool - - int_type - - - - bool - - int_type - - - - bool - - int_type - - - - bool - - int_type - - - - special_values - - int_type - - Returns either special value type or is_not_special. - - - int_type - - - - - int - - const int_adapter & - - returns -1, 0, 1, or 2 if 'this' is <, ==, >, or 'nan comparison' rhs - - - - int_adapter - - - const int_adapter & - - Assumes at least 'this' or 'rhs' is a special value. - - - - int_adapter - - - const int & - - Assumes 'this' is a special value. - - - - - std::basic_ostream< charT, traits > & - - - std::basic_ostream< charT, traits > & - - - const int_adapter< int_type > & - - - Expected output is either a numeric representation or a special values representation. - Ex. "12", "+infinity", "not-a-number", etc. - - - - -
-
- - - - - Class to provide common iso formatting spec. - - - month_format_spec - Describe month format -- its an integer in iso format. - - - const charT * - String used printed is date is invalid. - - - const charT * - String used to for positive infinity value. - - - const charT * - String used to for positive infinity value. - - - charT - ISO char for a year -- used in durations. - - - charT - ISO char for a month. - - - charT - ISO char for a day. - - - charT - char for minute - - - charT - char for minute - - - charT - char for second - - - charT - ISO char for a period. - - - charT - Used in time in mixed strings to set start of time. - - - charT - Used in mixed strings to identify start of a week number. - - - charT - Separators for periods. - - - charT - Separator for hh:mm:ss. - - - charT - Preferred Separator for hh:mm:ss,decimal_fraction. - - - bool - - charT - - - - bool - - charT - - - - bool - - charT - - - - charT - - - - - - - wchar_t - - Class to provide common iso formatting spec. - - - month_format_spec - Describe month format -- its an integer in iso format. - - - const wchar_t * - String used printed is date is invalid. - - - const wchar_t * - String used to for positive infinity value. - - - const wchar_t * - String used to for positive infinity value. - - - wchar_t - ISO char for a year -- used in durations. - - - wchar_t - ISO char for a month. - - - wchar_t - ISO char for a day. - - - wchar_t - char for minute - - - wchar_t - char for minute - - - wchar_t - char for second - - - wchar_t - ISO char for a period. - - - wchar_t - Used in time in mixed strings to set start of time. - - - wchar_t - Used in mixed strings to identify start of a week number. - - - wchar_t - Separators for periods. - - - wchar_t - Separator for hh:mm:ss. - - - wchar_t - Preferred Separator for hh:mm:ss,decimal_fraction. - - - bool - - wchar_t - - - - bool - - wchar_t - - - - bool - - wchar_t - - - - wchar_t - - - - - - boost::date_time::iso_format_base< charT > - Format description for iso normal YYYYMMDD. - - - bool - The ios standard format doesn't use char separators. - - - - - - boost::date_time::iso_format_base< charT > - Extended format uses seperators YYYY-MM-DD. - - - bool - Extended format needs char separators. - - - - - -
-
- Time adjustment calculations for local times - - - - - Provides a base offset adjustment from utc. - - - time_duration_type - - - time_duration_type - - - - - - Allow sliding utc adjustment with fixed dst rules. - - time_type::time_duration_type - - - time_type::date_type - - - - time_duration_type - - bool - - Presumes local time. - - - - - time_duration_type - - - - - - Embed the rules for local time adjustments at compile time. - - time_type::time_duration_type - - - time_type::date_type - - - - time_duration_type - - const time_type & - - UTC time to calculate offset to local time This adjustment depends on the following observations about the workings of the DST boundary offset. Since UTC time labels are monotonically increasing we can determine if a given local time is in DST or not and therefore adjust the offset appropriately. - - - Calculates the offset from a utc time to local based on dst and utc offset. - - -The logic is as follows. Starting with UTC time use the offset to create a label for an non-dst adjusted local time. Then call dst_rules::local_is_dst with the non adjust local time. The results of this function will either unabiguously decide that the initial local time is in dst or return an illegal or ambiguous result. An illegal result only occurs at the end of dst (where labels are skipped) and indicates that dst has ended. An ambiguous result means that we need to recheck by making a dst adjustment and then rechecking. If the dst offset is added to the utc time and the recheck proves non-ambiguous then we are past the boundary. If it is still ambiguous then we are ahead of the boundary and dst is still in effect. - TODO -- check if all dst offsets are positive. If not then the algorithm needs to check for this and reverse the illegal/ambiguous logic. - - - - time_duration_type - - const time_type & - - - date_time::dst_flags - date_time::calculate - - Get the offset to UTC given a local time. - - - - - - Template that simplifies the creation of local time calculator. - - Use this template to create the timezone to utc convertors as required. - This class will also work for other regions that don't use dst and have a utc offset which is an integral number of hours. - Template Parameters -time_type -- Time class to use -utc_offset -- Number hours local time is adjust from utc -use_dst -- true (default) if region uses dst, false otherwise For example: //eastern timezone is utc-5 - typedef date_time::local_adjustor<ptime, -5, us_dst> us_eastern; - typedef date_time::local_adjustor<ptime, -6, us_dst> us_central; - typedef date_time::local_adjustor<ptime, -7, us_dst> us_mountain; - typedef date_time::local_adjustor<ptime, -8, us_dst> us_pacific; - typedef date_time::local_adjustor<ptime, -7, no_dst> us_arizona; - - - - time_type::time_duration_type - - - time_type::date_type - - - static_local_time_adjustor< time_type, dst_rule, utc_adjustment< time_duration_type, utc_offset > > - - - - time_type - - const time_type & - - Convert a utc time to local time. - - - time_type - - const time_type & - - - date_time::dst_flags - date_time::calculate - - Convert a local time to utc. - - - - - void - - - -
-
- - - - - Specification for daylight savings start rules in US. - - This class is used to configure dst_calc_engine template typically as follows: using namespace boost::gregorian; - using namespace boost::posix_time; - typedef us_dst_trait<date> us_dst_traits; - typedef boost::date_time::dst_calc_engine<date, time_duration, - us_dst_traits> - us_dst_calc; - //calculate the 2002 transition day of USA April 7 2002 - date dst_start = us_dst_calc::local_dst_start_day(2002); - - //calculate the 2002 transition day of USA Oct 27 2002 - date dst_end = us_dst_calc::local_dst_end_day(2002); - - //check if a local time is in dst or not -- posible answers - //are yes, no, invalid time label, ambiguous - ptime t(...some time...); - if (us_dst::local_is_dst(t.date(), t.time_of_day()) - == boost::date_time::is_not_in_dst) - { - - } -This generates a type suitable for the calculation of dst transitions for the United States. Of course other templates can be used for other locales. - - - date_type::day_of_week_type - - - date_type::month_type - - - date_time::first_kday_of_month< date_type > - - - date_time::last_kday_of_month< date_type > - - - - day_of_week_type - - - month_type - - - day_of_week_type - - - month_type - - - int - - - int - - - int - - - - - - Rules for daylight savings start in the EU (Last Sun in Mar). - - These amount to the following: -Start of dst day is last Sunday in MarchEnd day of dst is last Sunday in OctGoing forward switch time is 2:00 am (offset 120 minutes)Going back switch time is 3:00 am (off set 180 minutes)Shift duration is one hour (60 minutes) - - - - date_type::day_of_week_type - - - date_type::month_type - - - date_time::last_kday_of_month< date_type > - - - date_time::last_kday_of_month< date_type > - - - - day_of_week_type - - - month_type - - - day_of_week_type - - - month_type - - - int - - - int - - - int - - - - - - boost::date_time::eu_dst_trait< date_type > - Alternative dst traits for some parts of the United Kingdom. - - - int - - - int - - - int - - - - - - - date_type::day_of_week_type - - - date_type::month_type - - - date_time::last_kday_of_month< date_type > - - - date_time::last_kday_of_month< date_type > - - - - day_of_week_type - - - month_type - - - day_of_week_type - - - month_type - - - int - - - int - - - int - - - - - -
-
-
- This file contains a high resolution time clock implementation. - - - - - A clock providing microsecond level resolution. - - A high precision clock that measures the local time at a resolution up to microseconds and adjusts to the resolution of the time system. For example, for the a library configuration with nano second resolution, the last 3 places of the fractional seconds will always be 000 since there are 1000 nano-seconds in a micro second. - - - time_type::date_type - - - time_type::time_duration_type - - - time_duration_type::rep_type - - - - time_type - - - shared_ptr< time_zone_type > - - return a local time object for the given zone, based on computer clock - - - time_type - Return the local time based on computer clock settings. - - - time_type - Get the current day in universal date as a ymd_type. - - - - - time_type - - TZ_FOR_CREATE - - - - time_type - Return the local time based on computer clock settings. - - - time_type - Return the UTC time based on computer settings. - - - time_type - - FILETIME & - - - TZ_FOR_CREATE - - - - - - -
-
- - - - - - - Enum for distinguishing parsing and formatting options. - - - - - - Enum for distinguishing the order of Month, Day, & Year. - - Enum for distinguishing the order in which Month, Day, & Year will appear in a date string - - - - -
-
- This file contain the implementation of the period abstraction. This is basically the same idea as a range. Although this class is intended for use in the time library, it is pretty close to general enough for other numeric uses. - - - - - Provides generalized period type useful in date-time systems. - - This template uses a class to represent a time point within the period and another class to represent a duration. As a result, this class is not appropriate for use when the number and duration representation are the same (eg: in the regular number domain). - A period can be specified by providing either the begining point and a duration or the begining point and the end point( end is NOT part of the period but 1 unit past it. A period will be "invalid" if either end_point <= begin_point or the given duration is <= 0. Any valid period will return false for is_null(). - Zero length periods are also considered invalid. Zero length periods are periods where the begining and end points are the same, or, the given duration is zero. For a zero length period, the last point will be one unit less than the begining point. - In the case that the begin and last are the same, the period has a length of one unit. - The best way to handle periods is usually to provide a begining point and a duration. So, day1 + 7 days is a week period which includes all of the first day and 6 more days (eg: Sun to Sat). - - - point_rep - - - duration_rep - - - - point_rep - Return the first element in the period. - - - point_rep - Return one past the last element. - - - point_rep - Return the last item in the period. - - - duration_rep - Return the length of the period. - - - bool - True if period is ill formed (length is zero or less). - - - bool - - const period & - - Equality operator. - - - bool - - const period & - - Strict as defined by rhs.last <= lhs.last. - - - void - - const duration_rep & - - Shift the start and end by the specified amount. - - - bool - - const point_rep & - - True if the point is inside the period, zero length periods contain no points. - - - bool - - const period & - - True if this period fully contains (or equals) the other period. - - - bool - - const period & - - True if the periods overlap in any way. - - - bool - - const period & - - True if periods are next to each other without a gap. - - - bool - - const point_rep & - - True if all of the period is prior to the passed point or end <= t. - - - bool - - const point_rep & - - True if all of the period is prior or t < start. - - - - period - - - const period & - - Returns the period of intersection or invalid range no intersection. - - - - period - - - const period & - - Returns the union of intersecting periods -- or null period. - - - - period - - - const period & - - Combine two periods with earliest start and latest end. - - Combines two periods and any gap between them such that start = min(p1.start, p2.start) end = max(p1.end , p2.end) [---p1---) - [---p2---) - result: - [-----------p3----------) - * - - - - - - - point_rep - - - point_rep - - create a period from begin to last eg: [begin,end) - - If end <= begin then the period will be invalid - - - - - point_rep - - - duration_rep - - create a period as [begin, begin+len) - - If len is <= 0 then the period will be invalid - - - - - -
-
- - - - - Not a facet, but a class used to specify and control period formats. - - Provides settings for the following: -period_separator -- default '/'period_open_start_delimeter -- default '['period_open_range_end_delimeter -- default ')'period_closed_range_end_delimeter -- default ']'display_as_open_range, display_as_closed_range -- default closed_range - - Thus the default formatting for a period is as follows: [period.start()/period.last()] - * -So for a typical date_period this would be [2004-Jan-04/2004-Feb-01] - * -where the date formatting is controlled by the date facet - - - std::basic_string< CharT > - - - CharT - - - std::basic_string< char_type >::const_iterator - - - std::vector< std::basic_string< CharT > > - - - - - - - - OutItrT - - OutItrT & - - Puts the characters between period elements into stream -- default is /. - - - OutItrT - - OutItrT & - - Puts the period start characters into stream -- default is [. - - - OutItrT - - OutItrT & - - Puts the period end characters into stream as controled by open/closed range setting. - - - range_display_options - - - void - - range_display_options - - Reset the range_option control. - - - void - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - - OutItrT - - - OutItrT - - - std::ios_base & - - - char_type - - - const period_type & - - - const facet_type & - - Generic code to output a period -- no matter the period type. - - This generic code will output any period using a facet to to output the 'elements'. For example, in the case of a date_period the elements will be instances of a date which will be formatted according the to setup in the passed facet parameter. - The steps for formatting a period are always the same: -put the start delimiterput start elementput the separatorput either last or end element depending on range settingsput end delimeter depending on range settings - - Thus for a typical date period the result might look like this: [March 01, 2004/June 07, 2004] <-- closed range - [March 01, 2004/June 08, 2004) <-- open range - - * - - - - - - - range_display_options - AS_CLOSED_RANGE - - - const char_type *const - default_period_separator - - - const char_type *const - default_period_start_delimeter - - - const char_type *const - default_period_open_range_end_delimeter - - - const char_type *const - default_period_closed_range_end_delimeter - - Constructor that sets up period formatter options -- default should suffice most cases. - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - - -
-
- - - - - Not a facet, but a class used to specify and control period parsing. - - Provides settings for the following: -period_separator -- default '/'period_open_start_delimeter -- default '['period_open_range_end_delimeter -- default ')'period_closed_range_end_delimeter -- default ']'display_as_open_range, display_as_closed_range -- default closed_range - - For a typical date_period, the contents of the input stream would be [2004-Jan-04/2004-Feb-01] - * -where the date format is controlled by the date facet - - - std::basic_string< CharT > - - - CharT - - - std::istreambuf_iterator< CharT > - - - string_parse_tree< CharT > - - - parse_tree_type::parse_match_result_type - - - std::vector< std::basic_string< CharT > > - - - - - - - - period_range_option - - - void - - period_range_option - - - - collection_type - - - void - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - - period_type - - - stream_itr_type & - - - stream_itr_type & - - - std::ios_base & - - - const period_type & - - - const duration_type & - - - const facet_type & - - Generic code to parse a period -- no matter the period type. - - This generic code will parse any period using a facet to to get the 'elements'. For example, in the case of a date_period the elements will be instances of a date which will be parsed according the to setup in the passed facet parameter. - The steps for parsing a period are always the same: -consume the start delimiterget start elementconsume the separatorget either last or end element depending on range settingsconsume the end delimeter depending on range settings - - Thus for a typical date period the contents of the input stream might look like this: [March 01, 2004/June 07, 2004] <-- closed range - [March 01, 2004/June 08, 2004) <-- open range - - * - - - - - - - period_range_option - AS_CLOSED_RANGE - - - const char_type *const - default_period_separator - - - const char_type *const - default_period_start_delimeter - - - const char_type *const - default_period_open_range_end_delimeter - - - const char_type *const - default_period_closed_range_end_delimeter - - Constructor that sets up period parser options. - - - - const period_parser< date_type, CharT > & - - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - - void - - stream_itr_type & - - - stream_itr_type & - - - const string_type & - - throws ios_base::failure if delimiter and parsed data do not match - - - - - -
-
- - - - - - - - - - - - - -
-
- - - - - Class that provides generic formmatting ostream formatting for special values. - - This class provides for the formmating of special values to an output stream. In particular, it produces strings for the values of negative and positive infinity as well as not_a_date_time. - While not a facet, this class is used by the date and time facets for formatting special value types. - - - std::basic_string< CharT > - - - CharT - - - std::vector< string_type > - - - - OutItrT - - OutItrT - - - const boost::date_time::special_values & - - - - - Construct special values formatter using default strings. - - Default strings are not-a-date-time -infinity +infinity - - - - - const char_type *const * - - - const char_type *const * - - Construct special values formatter from array of strings. - - This constructor will take pair of iterators from an array of strings that represent the special values and copy them for use in formatting special values. const char* const special_value_names[]={"nadt","-inf","+inf" }; - - special_value_formatter svf(&special_value_names[0], &special_value_names[3]); - * - - - - - - typename collection_type::iterator - - - typename collection_type::iterator - - - - const char_type - Storage for the strings used to indicate special values. - - - - -
-
- - - - - Class for special_value parsing. - - TODO: add doc-comments for which elements can be changed Parses input stream for strings representing special_values. Special values parsed are: -not_a_date_timeneg_infinpod_infinmin_date_timemax_date_time - - - - std::basic_string< charT > - - - std::istreambuf_iterator< charT > - - - date_type::duration_type - - - string_parse_tree< charT > - - - parse_tree_type::parse_match_result_type - - - std::vector< std::basic_string< charT > > - - - charT - - - - void - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - Replace special value strings. - - - bool - - stream_itr_type & - - - stream_itr_type & - - - match_results & - - Sets match_results.current_match to the corresponding special_value or -1. - - - - Creates a special_values_parser with the default set of "sv_strings". - - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - Creates a special_values_parser using a user defined set of element strings. - - - - typename collection_type::iterator - - - typename collection_type::iterator - - - - - const special_values_parser< date_type, charT > & - - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - - -
-
- - - - std::basic_string< OutputT > - - - const std::basic_string< InputT > & - - Converts a string from one value_type to another. - - Converts a wstring to a string (or a string to wstring). If both template parameters are of same type, a copy of the input string is returned. - - - - -
-
- - - - - - std::basic_string< charT > - - - - string_type - - - charT - - - bool - Returns true if more characters were parsed than was necessary. - - Should be used in conjunction with last_char() to get the remaining character. - - - - - - string_type - - - unsigned short - - - short - - - const short - - - - - Recursive data structure to allow efficient parsing of various strings. - - This class provides a quick lookup by building what amounts to a tree data structure. It also features a match function which can can handle nasty input interators by caching values as it recurses the tree so that it can backtrack as needed. - - - std::multimap< charT, string_parse_tree > - - - ptree_coll::value_type - - - ptree_coll::iterator - - - ptree_coll::const_iterator - - - std::basic_string< charT > - - - std::vector< std::basic_string< charT > > - - - parse_match_result< charT > - - - - void - - const string_type & - - - unsigned short - - - - short - - std::istreambuf_iterator< charT > & - - - std::istreambuf_iterator< charT > & - - - parse_match_result_type & - - - unsigned int & - - Recursive function that finds a matching string in the tree. - - Must check match_results::has_remaining() after match() is called. This is required so the user can determine if stream iterator is already pointing to the expected character or not (match() might advance sitr to next char in stream). - A parse_match_result that has been returned from a failed match attempt can be sent in to the match function of a different string_parse_tree to attempt a match there. Use the iterators for the partially consumed stream, the parse_match_result object, and '0' for the level parameter. - - - - parse_match_result_type - - std::istreambuf_iterator< charT > & - - - std::istreambuf_iterator< charT > & - - - Must check match_results::has_remaining() after match() is called. This is required so the user can determine if stream iterator is already pointing to the expected character or not (match() might advance sitr to next char in stream). - - - - void - - std::ostream & - - - int & - - - - void - - std::ostream & - - - - void - - std::ostream & - - - charT - - - - - - collection_type - - - unsigned int - 0 - - - Parameter "starting_point" desingates where the numbering begins. A starting_point of zero will start the numbering at zero (Sun=0, Mon=1, ...) were a starting_point of one starts the numbering at one (Jan=1, Feb=2, ...). The default is zero, negative vaules are not allowed - - - - - short - -1 - - - - ptree_coll - - - short - - - - std::basic_ostream< charT > & - - - std::basic_ostream< charT > & - - - parse_match_result< charT > & - - - - -
-
- - - - std::vector< std::basic_string< charT > > - - - const std::locale & - - The locale to use when gathering the strings - - - - bool - true - - True(default) to gather short strings, false for long strings. - - - This function gathers up all the month strings from a std::locale. - - Using the time_put facet, this function creates a collection of all the month strings from a locale. This is handy when building custom date parsers or formatters that need to be localized. - - - - - - A vector of strings containing the strings in order. eg: Jan, Feb, Mar, etc. - - - - std::vector< std::basic_string< charT > > - - - const std::locale & - - The locale to use when gathering the strings - - - - bool - true - - True(default) to gather short strings, false for long strings. - - - This function gathers up all the weekday strings from a std::locale. - - Using the time_put facet, this function creates a collection of all the weekday strings from a locale starting with the string for 'Sunday'. This is handy when building custom date parsers or formatters that need to be localized. - - - - - - A vector of strings containing the weekdays in order. eg: Sun, Mon, Tue, Wed, Thu, Fri, Sat - - - - -
-
- This file contains the interface for the time associated classes. - - - - - Representation of a precise moment in time, including the date. - - This class is a skeleton for the interface of a temporal type with a resolution that is higher than a day. It is intended that this class be the base class and that the actual time class be derived using the BN pattern. In this way, the derived class can make decisions such as 'should there be a default constructor' and what should it set its value to, should there be optional constructors say allowing only an time_durations that generate a time from a clock,etc. So, in fact multiple time types can be created for a time_system with different construction policies, and all of them can perform basic operations by only writing a copy constructor. Finally, compiler errors are also shorter. - The real behavior of the time class is provided by the time_system template parameter. This class must provide all the logic for addition, subtraction, as well as define all the interface types. - - - T - - - time_system::time_rep_type - - - time_system::date_type - - - time_system::date_duration_type - - - time_system::time_duration_type - - - - date_type - - - time_duration_type - - - std::string - - bool - false - - - Optional bool parameter will return time zone as an offset (ie "+07:00"). Empty string is returned for classes that do not use a time_zone - - - - std::string - - bool - false - - - Optional bool parameter will return time zone as an offset (ie "+07:00"). Empty string is returned for classes that do not use a time_zone - - - - std::string - An empty string is returned for classes that do not use a time_zone. - - - bool - check to see if date is not a value - - - bool - check to see if date is one of the infinity values - - - bool - check to see if date is greater than all possible dates - - - bool - check to see if date is greater than all possible dates - - - bool - check to see if time is a special value - - - bool - - const time_type & - - Equality operator -- others generated by boost::equality_comparable. - - - bool - - const time_type & - - Equality operator -- others generated by boost::less_than_comparable. - - - time_duration_type - - const time_type & - - difference between two times - - - time_type - - const date_duration_type & - - add date durations - - - time_type - - const date_duration_type & - - - - time_type - - const date_duration_type & - - subtract date durations - - - time_type - - const date_duration_type & - - - - time_type - - const time_duration_type & - - add time durations - - - time_type - - const time_duration_type & - - - - time_type - - const time_duration_type & - - subtract time durations - - - time_type - - const time_duration_type & - - - - - - const date_type & - - - const time_duration_type & - - - dst_flags - not_dst - - - - - special_values - - - - - const time_rep_type & - - - - - -
-
- This file contains the interface for clock devices. - - - - - A clock providing time level services based on C time_t capabilities. - - This clock provides resolution to the 1 second level - - - time_type::date_type - - - time_type::time_duration_type - - - - time_type - - - time_type - Get the current day in universal date as a ymd_type. - - - time_type - - - boost::shared_ptr< time_zone_type > - - - - - - time_type - - ::std::tm * - - - - - - -
-
- This file contains nice definitions for handling the resoluion of various time reprsentations. - - - - - - - - - - - - Defines some nice types for handling time level resolutions. - - - - - - Flags for daylight savings or summer time. - - - -
-
- - - - - Represents some amount of elapsed time measure to a given resolution. - - This class represents a standard set of capabilities for all counted time durations. Time duration implementations should derive from this class passing their type as the first template parameter. This design allows the subclass duration types to provide custom construction policies or other custom features not provided here. - - - - - T - - - rep_type - - - rep_type::day_type - - - rep_type::hour_type - - - rep_type::min_type - - - rep_type::sec_type - - - rep_type::fractional_seconds_type - - - rep_type::tick_type - - - rep_type::impl_type - - - - hour_type - Returns number of hours in the duration. - - - min_type - Returns normalized number of minutes. - - - sec_type - Returns normalized number of seconds (0..60). - - - sec_type - Returns total number of seconds truncating any fractional seconds. - - - tick_type - Returns total number of milliseconds truncating any fractional seconds. - - - tick_type - Returns total number of nanoseconds truncating any sub millisecond values. - - - tick_type - Returns total number of microseconds truncating any sub microsecond values. - - - fractional_seconds_type - Returns count of fractional seconds at given resolution. - - - duration_type - - - bool - - - bool - - const time_duration & - - - - bool - - const time_duration & - - - - duration_type - unary- Allows for time_duration td = -td1 - - - duration_type - - const duration_type & - - - - duration_type - - const duration_type & - - - - duration_type - - int - - - - duration_type - - const duration_type & - - - - duration_type - - const duration_type & - - - - duration_type - - int - - Division operations on a duration with an integer. - - - duration_type - - int - - Multiplication operations an a duration with an integer. - - - duration_type - - int - - - - tick_type - - - bool - Is ticks_ a special value? - - - bool - Is duration pos-infinity. - - - bool - Is duration neg-infinity. - - - bool - Is duration not-a-date-time. - - - impl_type - Used for special_values output. - - - - - - hour_type - - - min_type - - - sec_type - 0 - - - fractional_seconds_type - 0 - - - - - const time_duration< T, rep_type > & - - Construct from another time_duration (Copy constructor). - - - - special_values - - Construct from special_values. - - - - duration_type - Returns smallest representable duration. - - - tick_type - Return the number of ticks in a second. - - - time_resolutions - Provide the resolution of this duration type. - - - unsigned short - Returns number of possible digits in fractional seconds. - - - - - - impl_type - - - - - - Template for instantiating derived adjusting durations. - - base_duration::traits_type - - - - - boost::int64_t - - - - - -
-
- - - - - - CharT - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - const char_type - - - - - boost::date_time::date_facet< time_type::date_type, CharT, OutItrT > - - Facet used for format-based output of time types This class provides for the use of format strings to output times. In addition to the flags for formatting date elements, the following are the allowed format flags: -x X => default format - enables addition of more flags to default (ie. "%x %X %z")f => fractional seconds ".123456"F => fractional seconds or none: like frac sec but empty if frac sec == 0s => seconds w/ fractional sec "02.123" (this is the same as "%S%f)S => seconds "02"z => abbreviated time zone "EDT"Z => full time zone name "Eastern Daylight Time" - - - - time_type::date_type - - - time_type::time_duration_type - - - boost::date_time::period< time_type, time_duration_type > - - - boost::date_time::date_facet< typename time_type::date_type, CharT, OutItrT > - - - base_type::string_type - - - base_type::char_type - - - base_type::period_formatter_type - - - base_type::special_values_formatter_type - - - base_type::date_gen_formatter_type - - - - std::locale::id & - - void - - - - void - - const char_type *const - - Changes format for time_duration. - - - virtual void - - - virtual void - - - OutItrT - - OutItrT - - - std::ios_base & - - - char_type - - - const time_type & - - - - OutItrT - - OutItrT - - - std::ios_base & - - - char_type - - - const time_duration_type & - - put function for time_duration - - - OutItrT - - OutItrT - - - std::ios_base & - - - char_type - - - const period_type & - - - - - - ::size_t - 0 - - sets default formats for ptime, local_date_time, and time_duration - - - - const char_type * - - - period_formatter_type - period_formatter_type() - - - const special_values_formatter_type & - special_values_formatter_type() - - - date_gen_formatter_type - date_gen_formatter_type() - - - ::size_t - 0 - - Construct the facet with an explicitly specified format. - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - std::locale::id - - - - string_type - - const time_duration_type & - - - bool - - - - - - - boost::date_time::date_input_facet< time_type::date_type, CharT, InItrT > - Facet for format-based input. - - time_type::date_type - - - time_type::time_duration_type - - - time_duration_type::fractional_seconds_type - - - boost::date_time::period< time_type, time_duration_type > - - - boost::date_time::date_input_facet< typename time_type::date_type, CharT, InItrT > - - - base_type::duration_type - - - base_type::year_type - - - base_type::month_type - - - base_type::day_type - - - base_type::string_type - - - string_type::const_iterator - - - base_type::char_type - - - base_type::format_date_parser_type - - - base_type::period_parser_type - - - base_type::special_values_parser_type - - - base_type::date_gen_parser_type - - - base_type::special_values_parser_type::match_results - - - - void - - const char_type *const - - Set the format for time_duration. - - - virtual void - - - virtual void - - - InItrT - - InItrT & - - - InItrT & - - - std::ios_base & - - - period_type & - - - - InItrT - - InItrT & - - - InItrT & - - - std::ios_base & - - - time_duration_type & - - - - InItrT - - InItrT & - - - InItrT & - - - std::ios_base & - - - time_type & - - Parses a time object from the input stream. - - - InItrT - - InItrT & - - - InItrT & - - - std::ios_base & - - - time_type & - - - string_type & - - Expects a time_zone in the input stream. - - - - - const string_type & - - - ::size_t - 0 - - Constructor that takes a format string for a ptime. - - - - const string_type & - - - const format_date_parser_type & - - - const special_values_parser_type & - - - const period_parser_type & - - - const date_gen_parser_type & - - - ::size_t - 0 - - - - - ::size_t - 0 - - sets default formats for ptime, local_date_time, and time_duration - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - const char_type * - - - std::locale::id - - - - InItrT - - InItrT & - - - InItrT & - - - std::ios_base & - - - time_type & - - - string_type & - - - bool - - - - InItrT - - - InItrT & - - - InItrT & - - - temporal_type & - - - char_type - '\0' - - Helper function to check for special_value. - - First character may have been consumed during original parse attempt. Parameter 'c' should be a copy of that character. Throws ios_base::failure if parse fails. - - - - void - - InItrT & - - - InItrT & - - - fracional_seconds_type & - - Helper function for parsing a fractional second type from the stream. - - - - - int_type - - - int_type - - - const unsigned short - - Helper function to adjust trailing zeros when parsing fractional digits. - - - - - -
-
- - - - - Put a time type into a stream using appropriate facets. - - std::basic_ostream< charT > - - - time_duration_type::fractional_seconds_type - - - - void - - const time_duration_type & - - - ostream_type & - - Put time into an ostream. - - - - - - Put a time type into a stream using appropriate facets. - - std::basic_ostream< charT > - - - time_type::date_type - - - time_type::time_duration_type - - - ostream_time_duration_formatter< time_duration_type, charT > - - - - void - - const time_type & - - - ostream_type & - - Put time into an ostream. - - - - - - Put a time period into a stream using appropriate facets. - - std::basic_ostream< charT > - - - time_period_type::point_type - - - ostream_time_formatter< time_type, charT > - - - - void - - const time_period_type & - - - ostream_type & - - Put time into an ostream. - - - - - -
-
- - - - - Simple time iterator skeleton class. - - time_type::time_duration_type - - - - time_itr & - - - time_itr & - - - time_type - - - time_type * - - - bool - - const time_type & - - - - bool - - const time_type & - - - - bool - - const time_type & - - - - bool - - const time_type & - - - - bool - - const time_type & - - - - bool - - const time_type & - - - - - - time_type - - - time_duration_type - - - - - -
-
- - - - int_type - - - int_type - - - int_type - - computes exponential math like 2^8 => 256, only works with positive integers - - - - time_duration - - - - const std::string & - - Creates a time_duration object from a delimited string. - - Expected format for string is "[-]h[h][:mm][:ss][.fff]". If the number of fractional digits provided is greater than the precision of the time duration type then the extra digits are truncated. - A negative duration will be created if the first character in string is a '-', all other '-' will be treated as delimiters. Accepted delimiters are "-:,.". - - - - bool - - const std::string & - - - char - - - std::string & - - - std::string & - - Utility function to split appart string. - - - time_type - - - const std::string & - - - char - - - - - time_duration - - - - const std::string & - - Parse time duration part of an iso time of form: [-]hhmmss[.fff...] (eg: 120259.123 is 12 hours, 2 min, 59 seconds, 123000 microseconds). - - - time_type - - - const std::string & - - - char - - Parse time string of form YYYYMMDDThhmmss where T is delimeter between date and time. - - - -
-
- - - - traits struct for time_resolution_traits implementation type - - boost::int32_t - - - boost::int32_t - - - - int_type - - impl_type - - - - bool - Used to determine if implemented type is int_adapter or int. - - - - - traits struct for time_resolution_traits implementation type - - boost::int32_t - - - boost::date_time::int_adapter< boost::int32_t > - - - - int_type - - - impl_type - - - - - bool - Used to determine if implemented type is int_adapter or int. - - - - - traits struct for time_resolution_traits implementation type - - boost::int64_t - - - boost::int64_t - - - - int_type - - impl_type - - - - bool - Used to determine if implemented type is int_adapter or int. - - - - - traits struct for time_resolution_traits implementation type - - boost::int64_t - - - boost::date_time::int_adapter< boost::int64_t > - - - - int_type - - - impl_type - - - - - bool - Used to determine if implemented type is int_adapter or int. - - - - - - - frac_sec_type::int_type - - - frac_sec_type::int_type - - - frac_sec_type::impl_type - - - v_type - - - v_type - - - v_type - - - v_type - - - - - - int - - - ticks_per_second - resolution_adjust - - - - - - frac_sec_type::int_type - - typename frac_sec_type::impl_type - - - - bool - - - time_resolutions - - - unsigned short - - - fractional_seconds_type - - - tick_type - - hour_type - - - min_type - - - sec_type - - - fractional_seconds_type - - Any negative argument results in a negative tick_count. - - - - - time_resolution_traits< time_resolution_traits_adapted32_impl, milli, 1000, 3 > - - - time_resolution_traits< time_resolution_traits_adapted64_impl, micro, 1000000, 6 > - - - time_resolution_traits< time_resolution_traits_adapted64_impl, nano, 1000000000, 9 > - - - T - - - T - - Simple function to calculate absolute value of a numeric type. - - - -
-
- - - - - Time representation that uses a single integer count. - - config::int_type - - - config::date_type - - - config::impl_type - - - date_type::duration_type - - - date_type::calendar_type - - - date_type::ymd_type - - - config::time_duration_type - - - config::resolution_traits - - - - date_type - - - unsigned long - - - int_type - - - int_type - - - bool - - - bool - - - bool - - - bool - - - impl_type - - - - - const date_type & - - - const time_duration_type & - - - - - int_type - - - - - impl_type - - - - - int_type - - - - - - An unadjusted time system implementation. - - time_rep - - - time_rep_type::impl_type - - - time_rep_type::time_duration_type - - - time_duration_type::fractional_seconds_type - - - time_rep_type::date_type - - - time_rep_type::date_duration_type - - - - void - - - const T & - - - - time_rep_type - - const date_type & - - - const time_duration_type & - - - date_time::dst_flags - not_dst - - - - time_rep_type - - special_values - - - - date_type - - const time_rep_type & - - - - time_duration_type - - const time_rep_type & - - - - std::string - - const time_rep_type & - - - - bool - - const time_rep_type & - - - const time_rep_type & - - - - bool - - const time_rep_type & - - - const time_rep_type & - - - - time_rep_type - - const time_rep_type & - - - const date_duration_type & - - - - time_rep_type - - const time_rep_type & - - - const date_duration_type & - - - - time_rep_type - - const time_rep_type & - - - const time_duration_type & - - - - time_rep_type - - const time_rep_type & - - - time_duration_type - - - - time_duration_type - - const time_rep_type & - - - const time_rep_type & - - - - - - -
-
- - - - - An unadjusted time system implementation. - - config::time_rep_type - - - config::date_type - - - config::time_duration_type - - - config::date_duration_type - - - config::int_type - - - config::resolution_traits - - - date_time::wrapping_int< int_type, INT64_C(86400)*ticks_per_second - - - date_time::wrapping_int< int_type, ticks_per_day > - - - - time_rep_type - - special_values - - - - time_rep_type - - const date_type & - - - const time_duration_type & - - - date_time::dst_flags - not_dst - - - - date_type - - const time_rep_type & - - - - time_duration_type - - const time_rep_type & - - - - std::string - - const time_rep_type & - - - - bool - - const time_rep_type & - - - const time_rep_type & - - - - bool - - const time_rep_type & - - - const time_rep_type & - - - - time_rep_type - - const time_rep_type & - - - const date_duration_type & - - - - time_rep_type - - const time_rep_type & - - - const date_duration_type & - - - - time_rep_type - - const time_rep_type & - - - const time_duration_type & - - - - time_rep_type - - const time_rep_type & - - - time_duration_type - - - - time_duration_type - - const time_rep_type & - - - const time_rep_type & - - - - - - - - int_type - - - ticks_per_day - INT64_C(86400)*config::tick_per_second - - - - - - -
-
- - - - - Interface class for dynamic time zones. - - This class represents the base interface for all timezone representations. Subclasses may provide different systems for identifying a particular zone. For example some may provide a geographical based zone construction while others may specify the offset from GMT. Another possible implementation would be to convert from POSIX timezone strings. Regardless of the construction technique, this is the interface that these time zone types must provide. - Note that this class is intended to be used as a shared resource (hence the derivation from boost::counted_base. - - - std::basic_string< CharT > - - - std::basic_stringstream< CharT > - - - time_type::date_type::year_type - - - time_type::time_duration_type - - - - virtual string_type - String for the timezone when in daylight savings (eg: EDT). - - - virtual string_type - String for the zone when not in daylight savings (eg: EST). - - - virtual string_type - String for the timezone when in daylight savings (eg: Eastern Daylight Time). - - - virtual string_type - String for the zone when not in daylight savings (eg: Eastern Standard Time). - - - virtual bool - True if zone uses daylight savings adjustments otherwise false. - - - virtual time_type - - year_type - - Local time that DST starts -- undefined if has_dst is false. - - - virtual time_type - - year_type - - Local time that DST ends -- undefined if has_dst is false. - - - virtual time_duration_type - Base offset from UTC for zone (eg: -07:30:00). - - - virtual time_duration_type - Adjustment forward or back made while DST is in effect. - - - virtual string_type - Returns a POSIX time_zone string for this object. - - - - - - - - Structure which holds the time offsets associated with daylight savings time. - - - - - - - - const time_duration_type & - - - const time_duration_type & - - - const time_duration_type & - - - - time_duration_type - Amount DST adjusts the clock eg: plus one hour. - - - time_duration_type - Time past midnight on start transition day that dst starts. - - - time_duration_type - Time past midnight on end transition day that dst ends. - - - - -
-
- - - - - Base type that holds various string names for timezone output. - - Class that holds various types of strings used for timezones. For example, for the western United States there is the full name: Pacific Standard Time and the abbreviated name: PST. During daylight savings there are additional names: Pacific Daylight Time and PDT. CharT Allows class to support different character types - - - std::basic_string< CharT > - - - - string_type - - - string_type - - - string_type - - - string_type - - - - - const string_type & - - - const string_type & - - - const string_type & - - - const string_type & - - - - - Specialization of timezone names for standard char. - time_zone_names_base< char > - - - -
-
- - - - - - - - const std::string & - - - - - - - - const std::string & - - - - - - Creates a database of time_zones from csv datafile. - - The csv file containing the zone_specs used by the tz_db_base is intended to be customized by the library user. When customizing this file (or creating your own) the file must follow a specific format. - This first line is expected to contain column headings and is therefore not processed by the tz_db_base. - Each record (line) must have eleven fields. Some of those fields can be empty. Every field (even empty ones) must be enclosed in double-quotes. Ex: "America/Phoenix" <- string enclosed in quotes - "" <- empty field - - Some fields represent a length of time. The format of these fields must be: "{+|-}hh:mm[:ss]" <- length-of-time format -Where the plus or minus is mandatory and the seconds are optional. - Since some time zones do not use daylight savings it is not always necessary for every field in a zone_spec to contain a value. All zone_specs must have at least ID and GMT offset. Zones that use daylight savings must have all fields filled except: STD ABBR, STD NAME, DST NAME. You should take note that DST ABBR is mandatory for zones that use daylight savings (see field descriptions for further details). - ******* Fields and their description/details ********* - ID: Contains the identifying string for the zone_spec. Any string will do as long as it's unique. No two ID's can be the same. - STD ABBR: STD NAME: DST ABBR: DST NAME: These four are all the names and abbreviations used by the time zone being described. While any string will do in these fields, care should be taken. These fields hold the strings that will be used in the output of many of the local_time classes. Ex: time_zone nyc = tz_db.time_zone_from_region("America/New_York"); - local_time ny_time(date(2004, Aug, 30), IS_DST, nyc); - cout << ny_time.to_long_string() << endl; - // 2004-Aug-30 00:00:00 Eastern Daylight Time - cout << ny_time.to_short_string() << endl; - // 2004-Aug-30 00:00:00 EDT - - NOTE: The exact format/function names may vary - see local_time documentation for further details. - GMT offset: This is the number of hours added to utc to get the local time before any daylight savings adjustments are made. Some examples are: America/New_York offset -5 hours, & Africa/Cairo offset +2 hours. The format must follow the length-of-time format described above. - DST adjustment: The amount of time added to gmt_offset when daylight savings is in effect. The format must follow the length-of-time format described above. - DST Start Date rule: This is a specially formatted string that describes the day of year in which the transition take place. It holds three fields of it's own, separated by semicolons. The first field indicates the "nth" weekday of the month. The possible values are: 1 (first), 2 (second), 3 (third), 4 (fourth), 5 (fifth), and -1 (last). The second field indicates the day-of-week from 0-6 (Sun=0). The third field indicates the month from 1-12 (Jan=1). - Examples are: "-1;5;9"="Last Friday of September", "2;1;3"="Second Monday of March" - Start time: Start time is the number of hours past midnight, on the day of the start transition, the transition takes place. More simply put, the time of day the transition is made (in 24 hours format). The format must follow the length-of-time format described above with the exception that it must always be positive. - DST End date rule: See DST Start date rule. The difference here is this is the day daylight savings ends (transition to STD). - End time: Same as Start time. - - - char - - - time_zone_type::base_type - - - time_zone_type::time_duration_type - - - time_zone_names_base< charT > - - - dst_adjustment_offsets< time_duration_type > - - - std::basic_string< charT > - - - - void - - const std::string & - - Process csv data file, may throw exceptions. - - May throw data_not_accessible, or bad_field_count exceptions - - - - bool - - const string_type & - - - boost::shared_ptr< time_zone_base_type > - - returns true if record successfully added to map - - Takes an id string in the form of "America/Phoenix", and a time_zone object for that region. The id string must be a unique name that does not already exist in the database. - - - - boost::shared_ptr< time_zone_base_type > - - const string_type & - - Returns a time_zone object built from the specs for the given region. - - Returns a time_zone object built from the specs for the given region. If region does not exist a local_time::record_not_found exception will be thrown - - - - std::vector< std::string > - Returns a vector of strings holding the time zone regions in the database. - - - - Constructs an empty database. - - - - rule_type * - - const string_type & - - - const string_type & - - parses rule specs for transition day rules - - - week_num - - int - - helper function for parse_rules() - - - void - - int & - - - int & - - - int & - - - string_type - - splits the [start|end]_date_rule string into 3 ints - - - bool - - string_type & - - Take a line from the csv, turn it into a time_zone_type. - - Take a line from the csv, turn it into a time_zone_type, and add it to the map. Zone_specs in csv file are expected to have eleven fields that describe the time zone. Returns true if zone_spec successfully added to database - - - - - - -
-
- - - - - A wrapping integer used to support time durations. - - In composite date and time types this type is used to wrap at the day boundary. - - - int_type_ - - - - int_type - Explicit converion method. - - - int_type - - - int_type - - int_type - - - - int_type - - int_type - - - - - - int_type - - Add, return true if wrapped. - - - - int_type - - - - - - A wrapping integer used to wrap around at the top. - - Bad name, quick impl to fix a bug -- fix later!! This allows the wrap to restart at a value other than 0. Currently this only works if wrap_min == 1 - - - int_type_ - - - - int_type - Explicit converion method. - - - int_type - - - int_type - - int_type - - Add, return number of wraps performed. - - - int_type - - int_type - - Subtract will return '-d' if wrapping took place ('d' is the number of wraps). - - - - - int_type - - - If initializing value is out of range of [wrap_min, wrap_max], value will be initialized to closest of min or max - - - - - unsigned long - - - unsigned long - - - - - -
-
- - - - - Allow rapid creation of ymd triples of different types. - - YearType - - - MonthType - - - DayType - - - - - YearType - - - MonthType - - - DayType - - A basic constructor. - - - YearType - - - MonthType - - - DayType - - - - -
-
diff --git a/xmldoc/gregorian_autodoc.boostbook b/xmldoc/gregorian_autodoc.boostbook deleted file mode 100644 index 969f035..0000000 --- a/xmldoc/gregorian_autodoc.boostbook +++ /dev/null @@ -1,1454 +0,0 @@ - - - -
-Gregorian Reference -
- - - - tm - - const date & - - Converts a date to a tm struct. Throws out_of_range exception if date is a special value. - - - - date - - - const tm & - - Converts a tm structure into a date dropping the any time values. - - - -
-
- - - - std::basic_string< charT > - - - const date & - - - - std::string - - const date & - - To YYYY-mmm-DD string where mmm 3 char month name. Example: 2002-Jan-01. - - - std::basic_string< charT > - - - const date_period & - - - - std::string - - const date_period & - - Convert date period to simple string. Example: [2002-Jan-01/2002-Jan-02]. - - - std::basic_string< charT > - - - const date_period & - - - - std::string - - const date_period & - - Date period to iso standard format CCYYMMDD/CCYYMMDD. Example: 20021225/20021231. - - - std::basic_string< charT > - - - const date & - - - - std::string - - const date & - - Convert to iso extended format string CCYY-MM-DD. Example 2002-12-31. - - - std::basic_string< charT > - - - const date & - - - - std::string - - const date & - - Convert to iso standard string YYYYMMDD. Example: 20021231. - - - std::basic_string< charT > - - - const date & - - - - std::string - - const date & - - - - std::wstring - - const date_period & - - Convert date period to simple string. Example: [2002-Jan-01/2002-Jan-02]. - - - std::wstring - - const date & - - To YYYY-mmm-DD string where mmm 3 char month name. Example: 2002-Jan-01. - - - std::wstring - - const date_period & - - Date period to iso standard format CCYYMMDD/CCYYMMDD. Example: 20021225/20021231. - - - std::wstring - - const date & - - Convert to iso extended format string CCYY-MM-DD. Example 2002-12-31. - - - std::wstring - - const date & - - Convert to iso standard string YYYYMMDD. Example: 20021231. - - - std::wstring - - const date & - - - - -
-
- - - -
-
- - - - Gregorian calendar for this implementation, hard work in the base. - - Type to hold a weekday (eg: Sunday, Monday,...). - - greg_weekday - - - - Counter type from 1 to 366 for gregorian dates. - greg_day_of_year_rep - - - Internal date representation that handles infinity, not a date. - fancy_date_rep - - - Date rep implements the traits stuff as well. - fancy_date_rep - - - - An internal date representation that includes infinities, not a date. - date_time::int_adapter< unsigned long > - - - -
-
- - - - A date type based on gregorian_calendar. - - This class is the primary interface for programming with greogorian dates. The is a lightweight type that can be freely passed by value. All comparison operators are supported. - - - gregorian_calendar::year_type - - - gregorian_calendar::month_type - - - gregorian_calendar::day_type - - - gregorian_calendar::day_of_year_type - - - gregorian_calendar::ymd_type - - - gregorian_calendar::date_rep_type - - - gregorian_calendar::date_int_type - - - date_duration - - - - date_int_type - Return the Julian Day number for the date. - - - day_of_year_type - Return the day of year 1..365 or 1..366 (for leap year). - - - long - Return the Modified Julian Day number for the date. - - - int - Return the iso 8601 week number 1..53. - - - date_int_type - Return the day number from the calendar. - - - - date - - Return the last day of the current month. - - - - Default constructor constructs with not_a_date_time. - - - - year_type - - - month_type - - - day_type - - Main constructor with year, month, day. - - - - const ymd_type & - - Constructor from a ymd_type structure. - - - - const date_int_type & - - Needed copy constructor. - - - - date_rep_type - - Needed copy constructor. - - - - special_values - - Constructor for infinities, not a date, max and min date. - - - - -
-
- - - - Exception type for gregorian day of month (1..31). - - - - - const std::string & - - Allow other classes to throw with unique string for bad day like Feb 29. - - - - Represent a day of the month (range 1 - 31). - - This small class allows for simple conversion an integer value into a day of the month for a standard gregorian calendar. The type is automatically range checked so values outside of the range 1-31 will cause a bad_day_of_month exception - - - - unsigned short - - - unsigned short - - - - - unsigned short - - - - - Policy class that declares error handling and day of month ranges. - CV::simple_exception_policy< unsigned short, 1, 31, bad_day_of_month > - - - Generated represetation for gregorian day of month. - CV::constrained_value< greg_day_policies > - - - -
-
- - - - Exception type for day of year (1..366). - - - - - A day of the year range (1..366). - CV::simple_exception_policy< unsigned short, 1, 366, bad_day_of_year > - - - Define a range representation type for the day of the year 1..366. - CV::constrained_value< greg_day_of_year_policies > - - - -
-
- - - - An internal date representation that includes infinities, not a date. - boost::date_time::duration_traits_adapted - - - Durations in days for gregorian system. - date_time::date_duration< date_duration_rep > - - - Shorthand for date_duration. - date_duration - - - -
-
- - - - config struct for additional duration types (ie months_duration<> & years_duration<>) - - - date - - - - date_time::int_adapter< int > - - - date_time::month_functor< date_type > - - - - date_time::months_duration< greg_durations_config > - - - date_time::years_duration< greg_durations_config > - - - date_time::weeks_duration< date_time::duration_traits_adapted > - - - -
-
- - - - Configuration of the output facet template. - - - boost::gregorian::greg_month - - - - boost::date_time::special_values - - - boost::gregorian::months_of_year - - - boost::date_time::weekdays - - - - Create the base facet type for gregorian::date. - boost::date_time::date_names_put< greg_facet_config > - - - std::basic_ostream< charT, traits > & - - - std::basic_ostream< charT, traits > & - - - const date & - - ostream operator for gregorian::date - - Uses the date facet to determine various output parameters including: -string values for the month (eg: Jan, Feb, Mar) (default: English)string values for special values (eg: not-a-date-time) (default: English)selection of long, short strings, or numerical month representation (default: short string)month day year order (default yyyy-mmm-dd) - - - - - std::basic_ostream< charT, traits > & - - - std::basic_ostream< charT, traits > & - - - const greg_month & - - operator<< for gregorian::greg_month typically streaming: Jan, Feb, Mar... - - Uses the date facet to determine output string as well as selection of long or short strings. Default if no facet is installed is to output a 2 wide numeric value for the month eg: 01 == Jan, 02 == Feb, ... 12 == Dec. - - - - std::basic_ostream< charT, traits > & - - - std::basic_ostream< charT, traits > & - - - const greg_weekday & - - operator<< for gregorian::greg_weekday typically streaming: Sun, Mon, Tue, ... - - Uses the date facet to determine output string as well as selection of long or short string. Default if no facet is installed is to output a 3 char english string for the day of the week. - - - - std::basic_ostream< charT, traits > & - - - std::basic_ostream< charT, traits > & - - - const date_period & - - operator<< for gregorian::date_period typical output: [2002-Jan-01/2002-Jan-31] - - Uses the date facet to determine output string as well as selection of long or short string fr dates. Default if no facet is installed is to output a 3 char english string for the day of the week. - - - - std::basic_ostream< charT, traits > & - - - std::basic_ostream< charT, traits > & - - - const date_duration & - - - - std::basic_ostream< charT, traits > & - - - std::basic_ostream< charT, traits > & - - - const partial_date & - - operator<< for gregorian::partial_date. Output: "Jan 1" - - - std::basic_ostream< charT, traits > & - - - std::basic_ostream< charT, traits > & - - - const nth_kday_of_month & - - operator<< for gregorian::nth_kday_of_month. Output: "first Mon of Jun" - - - std::basic_ostream< charT, traits > & - - - std::basic_ostream< charT, traits > & - - - const first_kday_of_month & - - operator<< for gregorian::first_kday_of_month. Output: "first Mon of Jun" - - - std::basic_ostream< charT, traits > & - - - std::basic_ostream< charT, traits > & - - - const last_kday_of_month & - - operator<< for gregorian::last_kday_of_month. Output: "last Mon of Jun" - - - std::basic_ostream< charT, traits > & - - - std::basic_ostream< charT, traits > & - - - const first_kday_after & - - operator<< for gregorian::first_kday_after. Output: "first Mon after" - - - std::basic_ostream< charT, traits > & - - - std::basic_ostream< charT, traits > & - - - const first_kday_before & - - operator<< for gregorian::first_kday_before. Output: "first Mon before" - - - std::basic_istream< charT > & - - - std::basic_istream< charT > & - - - date & - - operator>> for gregorian::date - - - std::basic_istream< charT > & - - - std::basic_istream< charT > & - - - date_duration & - - operator>> for gregorian::date_duration - - - std::basic_istream< charT > & - - - std::basic_istream< charT > & - - - date_period & - - operator>> for gregorian::date_period - - - BOOST_DATE_TIME_DECL std::locale - - std::locale & - - - char - - generates a locale with the set of gregorian name-strings of type char* - - - BOOST_DATE_TIME_DECL boost::date_time::all_date_names_put< greg_facet_config, char > * - - char - - Returns a pointer to a facet with a default set of names (English). - - - BOOST_DATE_TIME_DECL std::locale - - std::locale & - - - wchar_t - - generates a locale with the set of gregorian name-strings of type wchar_t* - - - BOOST_DATE_TIME_DECL boost::date_time::all_date_names_put< greg_facet_config, wchar_t > * - - wchar_t - - Returns a pointer to a facet with a default set of names (English). - - - std::basic_istream< charT > & - - - std::basic_istream< charT > & - - - greg_month & - - operator>> for gregorian::greg_month - throws exception if invalid month given - - - std::basic_istream< charT > & - - - std::basic_istream< charT > & - - - greg_weekday & - - operator>> for gregorian::greg_weekday - throws exception if invalid weekday given - - - -
-
- - - - Exception thrown if a greg_month is constructed with a value out of range. - - - - - Wrapper class to represent months in gregorian based calendar. - - date_time::months_of_year - - - std::map< std::string, unsigned short > - - - boost::shared_ptr< month_map_type > - - - - unsigned short - Convert the value back to a short. - - - unsigned short - Returns month as number from 1 to 12. - - - month_enum - - - const char * - - - const char * - - - const wchar_t * - - - const wchar_t * - - - const char * - - char - - - - const char * - - char - - - - const wchar_t * - - wchar_t - - - - const wchar_t * - - wchar_t - - - - - - month_enum - - Construct a month from the months_of_year enumeration. - - - - unsigned short - - Construct from a short value. - - - - month_map_ptr_type - Shared pointer to a map of Month strings (Names & Abbrev) & numbers. - - - - - date_time::months_of_year - - - Build a policy class for the greg_month_rep. - CV::simple_exception_policy< unsigned short, 1, 12, bad_month > - - - A constrained range that implements the gregorian_month rules. - CV::constrained_value< greg_month_policies > - - - -
-
-
- - - - Exception that flags that a weekday number is incorrect. - - - - - Represent a day within a week (range 0==Sun to 6==Sat). - - boost::date_time::weekdays - - - - unsigned short - - - const char * - - - const char * - - - const wchar_t * - - - const wchar_t * - - - weekday_enum - - - - - unsigned short - - - - - CV::simple_exception_policy< unsigned short, 0, 6, bad_weekday > - - - CV::constrained_value< greg_weekday_policies > - - - -
-
- - - - Exception type for gregorian year. - - - - - Represent a day of the month (range 1900 - 10000). - - This small class allows for simple conversion an integer value into a year for the gregorian calendar. This currently only allows a range of 1900 to 10000. Both ends of the range are a bit arbitrary at the moment, but they are the limits of current testing of the library. As such they may be increased in the future. - - - - unsigned short - - - - - unsigned short - - - - - Policy class that declares error handling gregorian year type. - CV::simple_exception_policy< unsigned short, 1400, 10000, bad_year > - - - Generated representation for gregorian year. - CV::constrained_value< greg_year_policies > - - - -
-
- - - - date_time::year_month_day_base< greg_year, greg_month, greg_day > - - - -
-
- Single file header that provides overall include for all elements of the gregorian date-time system. This includes the various types defined, but also other functions for formatting and parsing. -
-
- - - - boost::date_time::period_formatter< wchar_t > - - - boost::date_time::period_formatter< char > - - - boost::date_time::date_facet< date, wchar_t > - - - boost::date_time::date_facet< date, char > - - - boost::date_time::period_parser< date, char > - - - boost::date_time::period_parser< date, wchar_t > - - - boost::date_time::special_values_formatter< char > - - - boost::date_time::special_values_formatter< wchar_t > - - - boost::date_time::special_values_parser< date, char > - - - boost::date_time::special_values_parser< date, wchar_t > - - - boost::date_time::date_input_facet< date, char > - - - boost::date_time::date_input_facet< date, wchar_t > - - - std::basic_ostream< CharT, TraitsT > & - - - std::basic_ostream< CharT, TraitsT > & - - - const boost::gregorian::date & - - - - std::basic_istream< CharT, Traits > & - - - std::basic_istream< CharT, Traits > & - - - date & - - input operator for date - - - std::basic_ostream< CharT, TraitsT > & - - - std::basic_ostream< CharT, TraitsT > & - - - const boost::gregorian::date_duration & - - - - std::basic_istream< CharT, Traits > & - - - std::basic_istream< CharT, Traits > & - - - date_duration & - - input operator for date_duration - - - std::basic_ostream< CharT, TraitsT > & - - - std::basic_ostream< CharT, TraitsT > & - - - const boost::gregorian::date_period & - - - - std::basic_istream< CharT, Traits > & - - - std::basic_istream< CharT, Traits > & - - - date_period & - - input operator for date_period - - - std::basic_ostream< CharT, TraitsT > & - - - std::basic_ostream< CharT, TraitsT > & - - - const boost::gregorian::greg_month & - - - - std::basic_istream< CharT, Traits > & - - - std::basic_istream< CharT, Traits > & - - - greg_month & - - input operator for greg_month - - - std::basic_ostream< CharT, TraitsT > & - - - std::basic_ostream< CharT, TraitsT > & - - - const boost::gregorian::greg_weekday & - - - - std::basic_istream< CharT, Traits > & - - - std::basic_istream< CharT, Traits > & - - - greg_weekday & - - input operator for greg_weekday - - - std::basic_istream< CharT, Traits > & - - - std::basic_istream< CharT, Traits > & - - - greg_day & - - input operator for greg_day - - - std::basic_istream< CharT, Traits > & - - - std::basic_istream< CharT, Traits > & - - - greg_year & - - input operator for greg_year - - - std::basic_ostream< CharT, TraitsT > & - - - std::basic_ostream< CharT, TraitsT > & - - - const boost::gregorian::partial_date & - - - - std::basic_istream< CharT, Traits > & - - - std::basic_istream< CharT, Traits > & - - - partial_date & - - input operator for partial_date - - - std::basic_ostream< CharT, TraitsT > & - - - std::basic_ostream< CharT, TraitsT > & - - - const boost::gregorian::nth_day_of_the_week_in_month & - - - - std::basic_istream< CharT, Traits > & - - - std::basic_istream< CharT, Traits > & - - - nth_day_of_the_week_in_month & - - input operator for nth_day_of_the_week_in_month - - - std::basic_ostream< CharT, TraitsT > & - - - std::basic_ostream< CharT, TraitsT > & - - - const boost::gregorian::first_day_of_the_week_in_month & - - - - std::basic_istream< CharT, Traits > & - - - std::basic_istream< CharT, Traits > & - - - first_day_of_the_week_in_month & - - input operator for first_day_of_the_week_in_month - - - std::basic_ostream< CharT, TraitsT > & - - - std::basic_ostream< CharT, TraitsT > & - - - const boost::gregorian::last_day_of_the_week_in_month & - - - - std::basic_istream< CharT, Traits > & - - - std::basic_istream< CharT, Traits > & - - - last_day_of_the_week_in_month & - - input operator for last_day_of_the_week_in_month - - - std::basic_ostream< CharT, TraitsT > & - - - std::basic_ostream< CharT, TraitsT > & - - - const boost::gregorian::first_day_of_the_week_after & - - - - std::basic_istream< CharT, Traits > & - - - std::basic_istream< CharT, Traits > & - - - first_day_of_the_week_after & - - input operator for first_day_of_the_week_after - - - std::basic_ostream< CharT, TraitsT > & - - - std::basic_ostream< CharT, TraitsT > & - - - const boost::gregorian::first_day_of_the_week_before & - - - - std::basic_istream< CharT, Traits > & - - - std::basic_istream< CharT, Traits > & - - - first_day_of_the_week_before & - - input operator for first_day_of_the_week_before - - - -
-
- Single file header that defines most of the types for the gregorian date-time system. - - - - Date periods for the gregorian system. - date_time::period< date, date_duration > - - - A unifying date_generator base type. - - A unifying date_generator base type for: partial_date, nth_day_of_the_week_in_month, first_day_of_the_week_in_month, and last_day_of_the_week_in_month - - date_time::year_based_generator< date > - - - A date generation object type. - date_time::partial_date< date > - - - date_time::nth_kday_of_month< date > - - - nth_kday_of_month - - - date_time::first_kday_of_month< date > - - - first_kday_of_month - - - date_time::last_kday_of_month< date > - - - last_kday_of_month - - - date_time::first_kday_after< date > - - - first_kday_after - - - date_time::first_kday_before< date > - - - first_kday_before - - - A clock to get the current day from the local computer. - date_time::day_clock< date > - - - Base date_iterator type for gregorian types. - date_time::date_itr_base< date > - - - A day level iterator. - date_time::date_itr< date_time::day_functor< date >, date > - - - A week level iterator. - date_time::date_itr< date_time::week_functor< date >, date > - - - A month level iterator. - date_time::date_itr< date_time::month_functor< date >, date > - - - A year level iterator. - date_time::date_itr< date_time::year_functor< date >, date > - - - -
-
- - - - special_values - - const std::string & - - Return special_value from string argument. - - Return special_value from string argument. If argument is not one of the special value names (defined in src/gregorian/names.hpp), return 'not_special' - - - - - date - - - std::string - - Deprecated: Use from_simple_string. - - - - date - - - std::string - - From delimited date string where with order year-month-day eg: 2002-1-25 or 2003-Jan-25 (full month name is also accepted). - - - - date - - - std::string - - From delimited date string where with order year-month-day eg: 1-25-2003 or Jan-25-2003 (full month name is also accepted). - - - - date - - - std::string - - From delimited date string where with order day-month-year eg: 25-1-2002 or 25-Jan-2003 (full month name is also accepted). - - - - date - - - std::string - - From iso type date string where with order year-month-day eg: 20020125. - - - - date - - - const std::string & - - From iso type date string where with order year-month-day eg: 20020125. - - - - date - - - - iterator_type - - - iterator_type - - Stream should hold a date in the form of: 2002-1-25. Month number, abbrev, or name are accepted. - - - date_period - - const std::string & - - Function to parse a date_period from a string (eg: [2003-Oct-31/2003-Dec-25]). - - - date_period - - const std::wstring & - - Function to parse a date_period from a wstring (eg: [2003-Oct-31/2003-Dec-25]). - - - -
-
diff --git a/xmldoc/local_time_autodoc.boostbook b/xmldoc/local_time_autodoc.boostbook deleted file mode 100644 index 9069233..0000000 --- a/xmldoc/local_time_autodoc.boostbook +++ /dev/null @@ -1,1083 +0,0 @@ - - - -
-Local Time Reference -
- - - - tm - - const local_date_time & - - Function that creates a tm struct from a local_date_time. - - - -
-
- - - - boost::local_time::time_zone - A real time zone. - - boost::posix_time::time_duration - - - - time_zone - - - - base_type::string_type - - - base_type::stringstream_type - - - - virtual std::string - - - virtual std::string - - - virtual std::string - - - virtual std::string - - - virtual bool - True if zone uses daylight savings adjustments. - - - virtual posix_time::ptime - - gregorian::greg_year - - Local time that DST starts -- NADT if has_dst is false. - - - virtual posix_time::ptime - - gregorian::greg_year - - Local time that DST ends -- NADT if has_dst is false. - - - virtual time_duration_type - Base offset from UTC for zone (eg: -07:30:00). - - - virtual time_duration_type - Adjustment forward or back made while DST is in effect. - - - virtual string_type - Returns a POSIX time_zone string for this object. - - - - - const time_zone_names & - - - const time_duration_type & - - - const dst_adjustment_offsets & - - - boost::shared_ptr< dst_calc_rule > - - - - - - boost::shared_ptr< dst_calc_rule > - - - -
-
- Operators for local_date_time and optional gregorian types. Operators use snap-to-end-of-month behavior. Further details on this behavior can be found in reference for date_time/date_duration_types.hpp and documentation for month and year iterators. - - - - - local_date_time - - - const local_date_time & - - - const boost::gregorian::months & - - - Adds a months object and a local_date_time. Result will be same day-of-month as local_date_time unless original day was the last day of month. see date_time::months_duration for more details - - - - - local_date_time - - - local_date_time & - - - const boost::gregorian::months & - - - Adds a months object to a local_date_time. Result will be same day-of-month as local_date_time unless original day was the last day of month. see date_time::months_duration for more details - - - - - local_date_time - - - const local_date_time & - - - const boost::gregorian::months & - - - Subtracts a months object and a local_date_time. Result will be same day-of-month as local_date_time unless original day was the last day of month. see date_time::months_duration for more details - - - - - local_date_time - - - local_date_time & - - - const boost::gregorian::months & - - - Subtracts a months object from a local_date_time. Result will be same day-of-month as local_date_time unless original day was the last day of month. see date_time::months_duration for more details - - - - - local_date_time - - - const local_date_time & - - - const boost::gregorian::years & - - - Adds a years object and a local_date_time. Result will be same month and day-of-month as local_date_time unless original day was the last day of month. see date_time::years_duration for more details - - - - - local_date_time - - - local_date_time & - - - const boost::gregorian::years & - - - Adds a years object to a local_date_time. Result will be same month and day-of-month as local_date_time unless original day was the last day of month. see date_time::years_duration for more details - - - - - local_date_time - - - const local_date_time & - - - const boost::gregorian::years & - - - Subtracts a years object and a local_date_time. Result will be same month and day-of-month as local_date_time unless original day was the last day of month. see date_time::years_duration for more details - - - - - local_date_time - - - local_date_time & - - - const boost::gregorian::years & - - - Subtracts a years object from a local_date_time. Result will be same month and day-of-month as local_date_time unless original day was the last day of month. see date_time::years_duration for more details - - - - -
-
- - - - - gregorian::date - - - gregorian::partial_date - - - gregorian::partial_date - - - - - gregorian::date - - - gregorian::first_kday_of_month - - - gregorian::last_kday_of_month - - - - - gregorian::date - - - gregorian::last_kday_of_month - - - gregorian::last_kday_of_month - - - - - gregorian::date - - - gregorian::nth_kday_of_month - - - gregorian::last_kday_of_month - - - - - gregorian::date - - - gregorian::nth_kday_of_month - - - gregorian::nth_kday_of_month - - - - Provides rule of the form starting Apr 30 ending Oct 21. - date_time::dst_day_calc_rule< gregorian::date > - - - Provides rule of the form first Sunday in April, last Saturday in Oct. - date_time::day_calc_dst_rule< partial_date_rule_spec > - - - Provides rule of the form first Sunday in April, last Saturday in Oct. - date_time::day_calc_dst_rule< first_last_rule_spec > - - - Provides rule of the form last Sunday in April, last Saturday in Oct. - date_time::day_calc_dst_rule< last_last_rule_spec > - - - Provides rule in form of [1st|2nd|3rd|4th] Sunday in April, last Sunday in Oct. - date_time::day_calc_dst_rule< nth_last_rule_spec > - - - Provides rule in form of [1st|2nd|3rd|4th] Sunday in April/October. - date_time::day_calc_dst_rule< nth_kday_rule_spec > - - - Provides rule in form of [1st|2nd|3rd|4th] Sunday in April/October. - date_time::day_calc_dst_rule< nth_kday_rule_spec > - - - -
-
- - - - simple exception for reporting when STD or DST cannot be determined - - - - std::string - "" - - - - - simple exception for when time label given cannot exist - - - - std::string - "" - - - - - - - - std::string - "" - - - - - - Representation of "wall-clock" time in a particular time zone. - - Representation of "wall-clock" time in a particular time zone Local_date_time_base holds a time value (date and time offset from 00:00) along with a time zone. The time value is stored as UTC and conversions to wall clock time are made as needed. This approach allows for operations between wall-clock times in different time zones, and daylight savings time considerations, to be made. Time zones are required to be in the form of a boost::shared_ptr<time_zone_base>. - - - utc_time_ - - - utc_time_type::time_duration_type - - - utc_time_type::date_type - - - date_type::duration_type - - - utc_time_type::time_system_type - - - - - - - - boost::shared_ptr< tz_type > - returns time zone associated with calling instance - - - bool - returns false is time_zone is NULL and if time value is a special_value - - - utc_time_type - Returns object's time value as a utc representation. - - - utc_time_type - Returns object's time value as a local representation. - - - std::string - Returns string in the form "2003-Aug-20 05:00:00 EDT". - - Returns string in the form "2003-Aug-20 05:00:00 EDT". If time_zone is NULL the time zone abbreviation will be "UTC". The time zone abbrev will not be included if calling object is a special_value - - - - - local_date_time_base - - - boost::shared_ptr< tz_type > - - - time_duration_type - time_duration_type(0, 0, 0) - - - returns a local_date_time_base in the given time zone with the optional time_duration added. - - - - std::string - - bool - false - - Returns name of associated time zone or "Coordinated Universal Time". - - Optional bool parameter will return time zone as an offset (ie "+07:00" extended iso format). Empty string is returned for classes that do not use a time_zone - - - - std::string - - bool - false - - Returns abbreviation of associated time zone or "UTC". - - Optional bool parameter will return time zone as an offset (ie "+0700" iso format). Empty string is returned for classes that do not use a time_zone - - - - std::string - returns a posix_time_zone string for the associated time_zone. If no time_zone, "UTC+00" is returned. - - - bool - - const local_date_time_base & - - Equality comparison operator. - - - bool - - const local_date_time_base & - - Non-Equality comparison operator. - - - bool - - const local_date_time_base & - - Less than comparison operator. - - - bool - - const local_date_time_base & - - Less than or equal to comparison operator. - - - bool - - const local_date_time_base & - - Greater than comparison operator. - - - bool - - const local_date_time_base & - - Greater than or equal to comparison operator. - - - - local_date_time_base - - - const date_duration_type & - - Local_date_time + date_duration. - - - - local_date_time_base - - - const date_duration_type & - - Local_date_time += date_duration. - - - - local_date_time_base - - - const date_duration_type & - - Local_date_time - date_duration. - - - - local_date_time_base - - - const date_duration_type & - - Local_date_time -= date_duration. - - - - local_date_time_base - - - const time_duration_type & - - Local_date_time + time_duration. - - - - local_date_time_base - - - const time_duration_type & - - Local_date_time += time_duration. - - - - local_date_time_base - - - const time_duration_type & - - Local_date_time - time_duration. - - - - local_date_time_base - - - const time_duration_type & - - Local_date_time -= time_duration. - - - time_duration_type - - const local_date_time_base & - - local_date_time -= local_date_time --> time_duration_type - - - - - utc_time_type - - A UTC time - - - - boost::shared_ptr< tz_type > - - Timezone for to adjust the UTC time to. - - - - This constructor interprets the passed time as a UTC time. So, for example, if the passed timezone is UTC-5 then the time will be adjusted back 5 hours. The time zone allows for automatic calculation of whether the particular time is adjusted for daylight savings, etc. If the time zone shared pointer is null then time stays unadjusted. - - - - - - date_type - - - time_duration_type - - - boost::shared_ptr< tz_type > - - - bool - - - This constructs a local time -- the passed time information understood to be in the passed tz. The DST flag must be passed to indicate whether the time is in daylight savings or not. - - - - -- time_label_invalid if the time passed does not exist in the given locale. The non-existent case occurs typically during the shift-back from daylight savings time. When the clock is shifted forward a range of times (2 am to 3 am in the US) is skipped and hence is invalid. dst_not_valid if the DST flag is passed for a period where DST is not active. - - - - - date_type - - - time_duration_type - - - boost::shared_ptr< tz_type > - - - DST_CALC_OPTIONS - - - This constructs a local time -- the passed time information understood to be in the passed tz. The DST flag is calculated according to the specified rule. - - - - Simple destructor, releases time zone if last referrer. - - - - const local_date_time_base & - - Copy constructor. - - - - const boost::date_time::special_values - - - boost::shared_ptr< tz_type > - boost::shared_ptr< tz_type >() - - Special values constructor. - - - - time_is_dst_result - - date_type - - - time_duration_type - - - boost::shared_ptr< tz_type > - - Determines if given time label is in daylight savings for given zone. - - Determines if given time label is in daylight savings for given zone. Takes a date and time_duration representing a local time, along with time zone, and returns a time_is_dst_result object as result. - - - - - - utc_time_type - - utc_time_type - - - boost::shared_ptr< tz_type > - - - bool - - - Adjust the passed in time to UTC? - - - - std::string - - const time_duration_type & - - - const std::string & - - - Simple formatting code -- todo remove this? - - - - - - Use the default parameters to define local_date_time. - - local_date_time_base - - - - -
-
-
- - - - boost::date_time::time_facet< local_date_time, wchar_t > - - - boost::date_time::time_facet< local_date_time, char > - - - boost::date_time::time_input_facet< local_date_time::utc_time_type, wchar_t > - - - boost::date_time::time_input_facet< local_date_time::utc_time_type, char > - - - std::basic_ostream< CharT, TraitsT > & - - - std::basic_ostream< CharT, TraitsT > & - - - const local_date_time & - - operator<< for local_date_time - see local_time docs for formatting details - - - std::basic_istream< CharT, Traits > & - - - std::basic_istream< CharT, Traits > & - - - local_date_time & - - input operator for local_date_time - - - -
-
- - - - - - boost::date_time::time_zone_base - - - - const shared_ptr< date_time::time_zone_base< posix_time::ptime > > - - - -
-
- - - - boost::date_time::period< local_date_time, boost::posix_time::time_duration > - - - date_time::time_itr< local_date_time > - - - date_time::second_clock< local_date_time > - - - date_time::microsec_clock< local_date_time > - - - Shared Pointer for time_zone and posix_time_zone objects. - boost::shared_ptr< time_zone > - - - -
-
- - - - simple exception for UTC and Daylight savings start/end offsets - - - - std::string - "" - - - - - simple exception for UTC daylight savings adjustment - - - - std::string - "" - - - - - boost::local_time::time_zone - A time zone class constructed from a POSIX time zone string. - - A POSIX time zone string takes the form of:<br> "std offset dst [offset],start[/time],end[/time]" (w/no spaces) 'std' specifies the abbrev of the time zone. - 'offset' is the offset from UTC. - 'dst' specifies the abbrev of the time zone during daylight savings time. - The second offset is how many hours changed during DST. Default=1 - 'start' and'end' are the dates when DST goes into (and out of) effect. - 'offset' takes the form of: [+|-]hh[:mm[:ss]] {h=0-23, m/s=0-59} - 'time' and 'offset' take the same form. Time defaults=02:00:00 - 'start' and 'end' can be one of three forms:<br> Mm.w.d {month=1-12, week=1-5 (5 is always last), day=0-6} - Jn {n=1-365 Feb29 is never counted} - n {n=0-365 Feb29 is counted in leap years} - Example "PST-5PDT01:00:00,M4.1.0/02:00:00,M10.1.0/02:00:00" - Exceptions will be thrown under these conditions:<br> An invalid date spec (see date class) - A boost::local_time::bad_offset exception will be thrown for:<br> A DST start or end offset that is negative or more than 24 hours - A UTC zone that is greater than +12 or less than -12 hours - A boost::local_time::bad_adjustment exception will be thrown for:<br> A DST adjustment that is 24 hours or more (positive or negative) - - - - boost::posix_time::time_duration - - - boost::tokenizer< boost::char_separator< char > > - - - - time_zone - - - - base_type::string_type - - - base_type::stringstream_type - - - - virtual std::string - String for the zone when not in daylight savings (eg: EST). - - - virtual std::string - String for the timezone when in daylight savings (eg: EDT). - - For those time zones that have no DST, an empty string is used - - - - virtual std::string - String for the zone when not in daylight savings (eg: Eastern Standard Time). - - The full STD name is not extracted from the posix time zone string. Therefore, the STD abbreviation is used in it's place - - - - virtual std::string - String for the timezone when in daylight savings (eg: Eastern Daylight Time). - - The full DST name is not extracted from the posix time zone string. Therefore, the STD abbreviation is used in it's place. For time zones that have no DST, an empty string is used - - - - virtual bool - True if zone uses daylight savings adjustments otherwise false. - - - virtual posix_time::ptime - - gregorian::greg_year - - Local time that DST starts -- NADT if has_dst is false. - - - virtual posix_time::ptime - - gregorian::greg_year - - Local time that DST ends -- NADT if has_dst is false. - - - virtual time_duration_type - Base offset from UTC for zone (eg: -07:30:00). - - - virtual time_duration_type - Adjustment forward or back made while DST is in effect. - - - virtual string_type - Returns a POSIX time_zone string for this object. - - - - - const std::string & - - Construct from a POSIX time zone string. - - - - - void - - const std::string & - - - Extract time zone abbreviations for STD & DST as well as the offsets for the time the shift occurs and how much of a shift. At this time full time zone names are NOT extracted so the abbreviations are used in their place - - - - void - - const std::string & - - - const std::string & - - - - void - - const std::string & - - - const std::string & - - - - void - - const std::string & - - - const std::string & - - Julian day. Feb29 is never counted, even in leap years. - - - void - - const std::string & - - - const std::string & - - Julian day. Feb29 is always counted, but exception thrown in non-leap years. - - - - - std::string - - const time_duration_type & - - helper function used when throwing exceptions - - - - - boost::date_time::time_zone_names - - - boost::date_time::dst_adjustment_offsets< boost::posix_time::time_duration > - - - boost::date_time::time_zone_base< boost::posix_time::ptime > - - - -
-
- - - - A real time zone. - - boost::posix_time::time_duration - - - time_zone_base - - - base_type::string_type - - - base_type::stringstream_type - - - - virtual std::string - - - virtual std::string - - - virtual std::string - - - virtual std::string - - - virtual bool - True if zone uses daylight savings adjustments. - - - virtual posix_time::ptime - - gregorian::greg_year - - Local time that DST starts -- NADT if has_dst is false. - - - virtual posix_time::ptime - - gregorian::greg_year - - Local time that DST ends -- NADT if has_dst is false. - - - virtual time_duration_type - Base offset from UTC for zone (eg: -07:30:00). - - - virtual time_duration_type - Adjustment forward or back made while DST is in effect. - - - virtual string_type - Returns a POSIX time_zone string for this object. - - - - - const time_zone_names & - - - const time_duration_type & - - - const dst_adjustment_offsets & - - - boost::shared_ptr< dst_calc_rule > - - - - - - boost::date_time::time_zone_names - - - boost::date_time::dst_adjustment_offsets< boost::posix_time::time_duration > - - - boost::date_time::time_zone_base< boost::posix_time::ptime > - - - boost::shared_ptr< dst_calc_rule > - - - boost::date_time::time_zone_base< boost::posix_time::ptime > - - - -
-
- - - - Object populated with boost::shared_ptr<time_zone_base> objects. - - Object populated with boost::shared_ptr<time_zone_base> objects Database is populated from specs stored in external csv file. See date_time::tz_db_base for greater detail - - date_time::tz_db_base< custom_time_zone, nth_kday_dst_rule > - - - -
-
diff --git a/xmldoc/posix_time_autodoc.boostbook b/xmldoc/posix_time_autodoc.boostbook deleted file mode 100644 index 356d0f1..0000000 --- a/xmldoc/posix_time_autodoc.boostbook +++ /dev/null @@ -1,924 +0,0 @@ - - - -
-Posix Time Reference -
- - - - - ptime - - - std::time_t - - Function that converts a time_t into a ptime. - - - tm - - const boost::posix_time::ptime & - - Convert a time to a tm structure truncating any fractional seconds. - - - tm - - const boost::posix_time::time_duration & - - Convert a time_duration to a tm structure truncating any fractional seconds and zeroing fields for date components. - - - - ptime - - - const tm & - - Convert a tm struct to a ptime ignoring is_dst flag. - - - time_type - - - const FILETIME & - - Function to create a time object from an initialized FILETIME struct. - - Function to create a time object from an initialized FILETIME struct. A FILETIME struct holds 100-nanosecond units (0.0000001). When built with microsecond resolution the FILETIME's sub second value will be truncated. Nanosecond resolution has no truncation. - Note ftime is part of the Win32 API, so it is not portable to non-windows platforms. - - - - -
-
- Operators for ptime and optional gregorian types. Operators use snap-to-end-of-month behavior. Further details on this behavior can be found in reference for date_time/date_duration_types.hpp and documentation for month and year iterators. - - - - - ptime - - - const ptime & - - - const boost::gregorian::months & - - - Adds a months object and a ptime. Result will be same day-of-month as ptime unless original day was the last day of month. see date_time::months_duration for more details - - - - - ptime - - - ptime & - - - const boost::gregorian::months & - - - Adds a months object to a ptime. Result will be same day-of-month as ptime unless original day was the last day of month. see date_time::months_duration for more details - - - - - ptime - - - const ptime & - - - const boost::gregorian::months & - - - Subtracts a months object and a ptime. Result will be same day-of-month as ptime unless original day was the last day of month. see date_time::months_duration for more details - - - - - ptime - - - ptime & - - - const boost::gregorian::months & - - - Subtracts a months object from a ptime. Result will be same day-of-month as ptime unless original day was the last day of month. see date_time::months_duration for more details - - - - - ptime - - - const ptime & - - - const boost::gregorian::years & - - - Adds a years object and a ptime. Result will be same month and day-of-month as ptime unless original day was the last day of month. see date_time::years_duration for more details - - - - - ptime - - - ptime & - - - const boost::gregorian::years & - - - Adds a years object to a ptime. Result will be same month and day-of-month as ptime unless original day was the last day of month. see date_time::years_duration for more details - - - - - ptime - - - const ptime & - - - const boost::gregorian::years & - - - Subtracts a years object and a ptime. Result will be same month and day-of-month as ptime unless original day was the last day of month. see date_time::years_duration for more details - - - - - ptime - - - ptime & - - - const boost::gregorian::years & - - - Subtracts a years object from a ptime. Result will be same month and day-of-month as ptime unless original day was the last day of month. see date_time::years_duration for more details - - - - -
-
- Global header file to get all of posix time types -
-
- - - - Base time duration type. - - time_res_traits - - - time_res_traits::day_type - - - time_res_traits::hour_type - - - time_res_traits::min_type - - - time_res_traits::sec_type - - - time_res_traits::fractional_seconds_type - - - time_res_traits::tick_type - - - time_res_traits::impl_type - - - - - hour_type - - - min_type - - - sec_type - - - fractional_seconds_type - 0 - - - - - - boost::date_time::special_values - - Construct from special_values. - - - - - impl_type - - - - - Simple implementation for the time rep. - - gregorian::date - - - - time_duration - - - - - bool - - - bool - - - bool - - - bool - - - - - date_type - - - - time_duration_type - - - - - date_type - - - - time_duration_type - - - - - - - simple_time_rep - - - - gregorian::date - - - gregorian::date_duration - - - - time_duration - - - - time_res_traits::tick_type - - - time_res_traits - - - - - - boost::int64_t - - - tick_per_second - 1000000000 - - - - - - - boost::int64_t - - - gregorian::date - - - gregorian::date_duration - - - - time_duration - - - - time_res_traits::tick_type - - - time_res_traits::impl_type - - - time_res_traits - - - - - - boost::int64_t - - - tick_per_second - 1000000 - - - - - - date_time::time_resolution_traits< boost::date_time::time_resolution_traits_adapted64_impl, boost::date_time::nano, 1000000000, 9 > - - - -
-
- - - - boost::posix_time::time_duration - Allows expression of durations as an hour count. - - - - long - - - - - boost::posix_time::time_duration - Allows expression of durations as a minute count. - - - - long - - - - - boost::posix_time::time_duration - Allows expression of durations as a seconds count. - - - - long - - - - - Allows expression of durations as milli seconds. - date_time::subsecond_duration< time_duration, 1000 > - - - date_time::subsecond_duration< time_duration, 1000 > - - - Allows expression of durations as micro seconds. - date_time::subsecond_duration< time_duration, 1000000 > - - - date_time::subsecond_duration< time_duration, 1000000 > - - - Allows expression of durations as nano seconds. - date_time::subsecond_duration< time_duration, 1000000000 > - - - date_time::subsecond_duration< time_duration, 1000000000 > - - - -
-
- - - - ptime_input_facet is depricated and will be phased out. use time_input_facet instead - boost::date_time::time_facet< ptime, wchar_t > - - - boost::date_time::time_facet< ptime, char > - - - boost::date_time::time_input_facet< ptime, wchar_t > - - - boost::date_time::time_input_facet< ptime, char > - - - std::basic_ostream< CharT, TraitsT > & - - - std::basic_ostream< CharT, TraitsT > & - - - const ptime & - - - - std::basic_istream< CharT, Traits > & - - - std::basic_istream< CharT, Traits > & - - - ptime & - - input operator for ptime - - - std::basic_ostream< CharT, TraitsT > & - - - std::basic_ostream< CharT, TraitsT > & - - - const boost::posix_time::time_period & - - - - std::basic_istream< CharT, Traits > & - - - std::basic_istream< CharT, Traits > & - - - time_period & - - input operator for time_period - - - std::basic_ostream< CharT, Traits > & - - - std::basic_ostream< CharT, Traits > & - - - const time_duration & - - ostream operator for posix_time::time_duration - - - std::basic_istream< CharT, Traits > & - - - std::basic_istream< CharT, Traits > & - - - time_duration & - - input operator for time_duration - - - -
-
- - - - std::basic_ostream< charT, traits > & - - - std::basic_ostream< charT, traits > & - - - const time_duration & - - ostream operator for posix_time::time_duration - - - std::basic_ostream< charT, traits > & - - - std::basic_ostream< charT, traits > & - - - const ptime & - - ostream operator for posix_time::ptime - - - std::basic_ostream< charT, traits > & - - - std::basic_ostream< charT, traits > & - - - const time_period & - - ostream operator for posix_time::time_period - - - std::basic_istream< charT > & - - - std::basic_istream< charT > & - - - time_duration & - - - - std::basic_istream< charT > & - - - std::basic_istream< charT > & - - - ptime & - - - - std::basic_istream< charT > & - - - std::basic_istream< charT > & - - - time_period & - - - operator>> for time_period. time_period must be in "[date time_duration/date time_duration]" format. - - - - -
-
- - - - date_time::split_timedate_system< posix_time_system_config, 1000000000 > - - - date_time::counted_time_rep< millisec_posix_time_system_config > - - - -
-
- - - - Iterator over a defined time duration. - date_time::time_itr< ptime > - - - A time clock that has a resolution of one second. - date_time::second_clock< ptime > - - - A time clock that has a resolution of one microsecond. - date_time::microsec_clock< ptime > - - - Define a dst null dst rule for the posix_time system. - date_time::null_dst_rules< ptime::date_type, time_duration > - - - Define US dst rule calculator for the posix_time system. - date_time::us_dst_rules< ptime::date_type, time_duration > - - - -
-
- - - - Time type with no timezone or other adjustments. - - posix_time_system - - - time_system_type::time_rep_type - - - time_system_type::time_duration_type - - - - ptime - - - - - - gregorian::date - - - time_duration_type - - Construct with date and offset in day. - - - - gregorian::date - - Construct a time at start of the given day (midnight). - - - - const time_rep_type & - - Copy from time_rep. - - - - const special_values - - Construct from special value. - - - - - -
-
- - - - std::basic_string< charT > - - - - time_duration - - - - - std::basic_string< charT > - - - - time_duration - - - - - std::basic_string< charT > - - - - ptime - - - Time to simple format CCYY-mmm-dd hh:mm:ss.fffffff. - - - std::basic_string< charT > - - - time_period - - - - std::basic_string< charT > - - - - ptime - - - - - std::basic_string< charT > - - - - ptime - - - - - std::wstring - - - time_duration - - - Time duration to wstring -hh::mm::ss.fffffff. Example: 10:09:03.0123456. - - - std::wstring - - - time_duration - - - Time duration in iso format -hhmmss,fffffff Example: 10:09:03,0123456. - - - std::wstring - - - ptime - - - - - std::wstring - - time_period - - Convert to wstring of form [YYYY-mmm-DD HH:MM::SS.ffffff/YYYY-mmm-DD HH:MM::SS.fffffff]. - - - std::wstring - - - ptime - - - Convert iso short form YYYYMMDDTHHMMSS where T is the date-time separator. - - - std::wstring - - - ptime - - - Convert to form YYYY-MM-DDTHH:MM:SS where T is the date-time separator. - - - -
-
- - - - std::string - - - time_duration - - - Time duration to string -hh::mm::ss.fffffff. Example: 10:09:03.0123456. - - - std::string - - - time_duration - - - Time duration in iso format -hhmmss,fffffff Example: 10:09:03,0123456. - - - std::string - - - ptime - - - Time to simple format CCYY-mmm-dd hh:mm:ss.fffffff. - - - std::string - - time_period - - Convert to string of form [YYYY-mmm-DD HH:MM::SS.ffffff/YYYY-mmm-DD HH:MM::SS.fffffff]. - - - std::string - - - ptime - - - Convert iso short form YYYYMMDDTHHMMSS where T is the date-time separator. - - - std::string - - - ptime - - - Convert to form YYYY-MM-DDTHH:MM:SS where T is the date-time separator. - - - -
-
- - - - - time_duration - - - const std::string & - - Creates a time_duration object from a delimited string. - - Expected format for string is "[-]h[h][:mm][:ss][.fff]". A negative duration will be created if the first character in string is a '-', all other '-' will be treated as delimiters. Accepted delimiters are "-:,.". - - - - - ptime - - - const std::string & - - - - - ptime - - - const std::string & - - - - -
-
- - - - Time period type. - date_time::period< ptime, time_duration > - - - -
-
-