Provided by: libstdc++6-4.5-doc_4.5.3-12ubuntu2_all bug

NAME

       std::time_get< _CharT, _InIter > -

SYNOPSIS

       Inherits std::locale::facet, and std::time_base.

       Inherited by std::time_get_byname< _CharT, _InIter >.

   Public Types
       typedef basic_string< _CharT > __string_type
       enum dateorder { no_order, dmy, mdy, ymd, ydm }

           typedef _CharT char_type
           typedef _InIter iter_type

   Public Member Functions
       time_get (size_t __refs=0)
       dateorder date_order () const
       iter_type get_date (iter_type __beg, iter_type __end, ios_base &__io, ios_base::iostate
           &__err, tm *__tm) const
       iter_type get_monthname (iter_type __beg, iter_type __end, ios_base &__io,
           ios_base::iostate &__err, tm *__tm) const
       iter_type get_time (iter_type __beg, iter_type __end, ios_base &__io, ios_base::iostate
           &__err, tm *__tm) const
       iter_type get_weekday (iter_type __beg, iter_type __end, ios_base &__io, ios_base::iostate
           &__err, tm *__tm) const
       iter_type get_year (iter_type __beg, iter_type __end, ios_base &__io, ios_base::iostate
           &__err, tm *__tm) const

   Static Public Attributes
       static locale::id id

   Protected Member Functions
       virtual ~time_get ()
       iter_type _M_extract_name (iter_type __beg, iter_type __end, int &__member, const _CharT
           **__names, size_t __indexlen, ios_base &__io, ios_base::iostate &__err) const
       iter_type _M_extract_num (iter_type __beg, iter_type __end, int &__member, int __min, int
           __max, size_t __len, ios_base &__io, ios_base::iostate &__err) const
       iter_type _M_extract_via_format (iter_type __beg, iter_type __end, ios_base &__io,
           ios_base::iostate &__err, tm *__tm, const _CharT *__format) const
       iter_type _M_extract_wday_or_month (iter_type __beg, iter_type __end, int &__member, const
           _CharT **__names, size_t __indexlen, ios_base &__io, ios_base::iostate &__err) const
       virtual dateorder do_date_order () const
       virtual iter_type do_get_date (iter_type __beg, iter_type __end, ios_base &__io,
           ios_base::iostate &__err, tm *__tm) const
       virtual iter_type do_get_monthname (iter_type __beg, iter_type __end, ios_base &,
           ios_base::iostate &__err, tm *__tm) const
       virtual iter_type do_get_time (iter_type __beg, iter_type __end, ios_base &__io,
           ios_base::iostate &__err, tm *__tm) const
       virtual iter_type do_get_weekday (iter_type __beg, iter_type __end, ios_base &,
           ios_base::iostate &__err, tm *__tm) const
       virtual iter_type do_get_year (iter_type __beg, iter_type __end, ios_base &__io,
           ios_base::iostate &__err, tm *__tm) const

   Static Protected Member Functions
       static __c_locale _S_clone_c_locale (__c_locale &__cloc)  throw ()
       static void _S_create_c_locale (__c_locale &__cloc, const char *__s, __c_locale __old=0)
       static void _S_destroy_c_locale (__c_locale &__cloc)
       static __c_locale _S_get_c_locale ()
       static _GLIBCXX_CONST const char * _S_get_c_name ()  throw ()
       static __c_locale _S_lc_ctype_c_locale (__c_locale __cloc, const char *__s)

   Friends
       class locale::_Impl

Detailed Description

   template<typename _CharT, typename _InIter>class std::time_get< _CharT, _InIter >
       Primary class template time_get.

       This facet encapsulates the code to parse and return a date or time from a string. It is
       used by the istream numeric extraction operators.

       The time_get template uses protected virtual functions to provide the actual results. The
       public accessors forward the call to the virtual functions. These virtual functions are
       hooks for developers to implement the behavior they require from the time_get facet.

       Definition at line 363 of file locale_facets_nonio.h.

Member Typedef Documentation

   template<typename _CharT , typename _InIter > typedef _CharT std::time_get< _CharT, _InIter
       >::char_type
       Public typedefs.

       Reimplemented in std::time_get_byname< _CharT, _InIter >.

       Definition at line 369 of file locale_facets_nonio.h.

   template<typename _CharT , typename _InIter > typedef _InIter std::time_get< _CharT, _InIter
       >::iter_type
       Public typedefs.

       Reimplemented in std::time_get_byname< _CharT, _InIter >.

       Definition at line 370 of file locale_facets_nonio.h.

Constructor & Destructor Documentation

   template<typename _CharT , typename _InIter > std::time_get< _CharT, _InIter >::time_get
       (size_t__refs = 0) [inline, explicit]
       Constructor performs initialization. This is the constructor provided by the standard.

       Parameters:
           refs Passed to the base facet class.

       Definition at line 385 of file locale_facets_nonio.h.

   template<typename _CharT , typename _InIter > virtual std::time_get< _CharT, _InIter
       >::~time_get () [inline, protected, virtual]
       Destructor.

       Definition at line 541 of file locale_facets_nonio.h.

Member Function Documentation

   template<typename _CharT , typename _InIter > dateorder std::time_get< _CharT, _InIter
       >::date_order () const [inline]
       Return preferred order of month, day, and year. This function returns an enum from
       timebase::dateorder giving the preferred ordering if the format x given to time_put::put()
       only uses month, day, and year. If the format x for the associated locale uses other
       fields, this function returns timebase::dateorder::noorder.

       NOTE: The library always returns noorder at the moment.

       Returns:
           A member of timebase::dateorder.

       Definition at line 402 of file locale_facets_nonio.h.

   template<typename _CharT , typename _InIter > _GLIBCXX_END_LDBL_NAMESPACE time_base::dateorder
       std::time_get< _CharT, _InIter >::do_date_order () const [protected, virtual]
       Return preferred order of month, day, and year. This function returns an enum from
       timebase::dateorder giving the preferred ordering if the format x given to time_put::put()
       only uses month, day, and year. This function is a hook for derived classes to change the
       value returned.

       Returns:
           A member of timebase::dateorder.

       Definition at line 618 of file locale_facets_nonio.tcc.

   template<typename _CharT , typename _InIter > _InIter std::time_get< _CharT, _InIter
       >::do_get_date (iter_type__beg, iter_type__end, ios_base &__io, ios_base::iostate &__err,
       tm *__tm) const [protected, virtual]
       Parse input date string. This function parses a date according to the format X and puts
       the results into a user-supplied struct tm. This function is a hook for derived classes to
       change the value returned.

       See also:
           get_date() for details.

       Parameters:
           beg Start of string to parse.
           end End of string to parse.
           io Source of the locale.
           err Error flags to set.
           tm Pointer to struct tm to fill in.

       Returns:
           Iterator to first char beyond date string.

       Definition at line 1044 of file locale_facets_nonio.tcc.

       References std::ios_base::_M_getloc().

   template<typename _CharT , typename _InIter > _InIter std::time_get< _CharT, _InIter
       >::do_get_monthname (iter_type__beg, iter_type__end, ios_base &__io, ios_base::iostate
       &__err, tm *__tm) const [protected, virtual]
       Parse input month string. This function parses a month name and puts the results into a
       user-supplied struct tm. This function is a hook for derived classes to change the value
       returned.

       See also:
           get_monthname() for details.

       Parameters:
           beg Start of string to parse.
           end End of string to parse.
           io Source of the locale.
           err Error flags to set.
           tm Pointer to struct tm to fill in.

       Returns:
           Iterator to first char beyond month name.

       Definition at line 1089 of file locale_facets_nonio.tcc.

       References std::ios_base::_M_getloc().

   template<typename _CharT , typename _InIter > _InIter std::time_get< _CharT, _InIter
       >::do_get_time (iter_type__beg, iter_type__end, ios_base &__io, ios_base::iostate &__err,
       tm *__tm) const [protected, virtual]
       Parse input time string. This function parses a time according to the format x and puts
       the results into a user-supplied struct tm. This function is a hook for derived classes to
       change the value returned.

       See also:
           get_time() for details.

       Parameters:
           beg Start of string to parse.
           end End of string to parse.
           io Source of the locale.
           err Error flags to set.
           tm Pointer to struct tm to fill in.

       Returns:
           Iterator to first char beyond time string.

       Definition at line 1027 of file locale_facets_nonio.tcc.

       References std::ios_base::_M_getloc().

   template<typename _CharT , typename _InIter > _InIter std::time_get< _CharT, _InIter
       >::do_get_weekday (iter_type__beg, iter_type__end, ios_base &__io, ios_base::iostate
       &__err, tm *__tm) const [protected, virtual]
       Parse input weekday string. This function parses a weekday name and puts the results into
       a user-supplied struct tm. This function is a hook for derived classes to change the value
       returned.

       See also:
           get_weekday() for details.

       Parameters:
           beg Start of string to parse.
           end End of string to parse.
           io Source of the locale.
           err Error flags to set.
           tm Pointer to struct tm to fill in.

       Returns:
           Iterator to first char beyond weekday name.

       Definition at line 1061 of file locale_facets_nonio.tcc.

       References std::ios_base::_M_getloc().

   template<typename _CharT , typename _InIter > _InIter std::time_get< _CharT, _InIter
       >::do_get_year (iter_type__beg, iter_type__end, ios_base &__io, ios_base::iostate &__err,
       tm *__tm) const [protected, virtual]
       Parse input year string. This function reads up to 4 characters to parse a year string and
       puts the results into a user-supplied struct tm. This function is a hook for derived
       classes to change the value returned.

       See also:
           get_year() for details.

       Parameters:
           beg Start of string to parse.
           end End of string to parse.
           io Source of the locale.
           err Error flags to set.
           tm Pointer to struct tm to fill in.

       Returns:
           Iterator to first char beyond year.

       Definition at line 1117 of file locale_facets_nonio.tcc.

       References std::ios_base::_M_getloc().

   template<typename _CharT , typename _InIter > iter_type std::time_get< _CharT, _InIter
       >::get_date (iter_type__beg, iter_type__end, ios_base &__io, ios_base::iostate &__err, tm
       *__tm) const [inline]
       Parse input date string. This function parses a date according to the format X and puts
       the results into a user-supplied struct tm. The result is returned by calling
       time_get::do_get_date().

       If there is a valid date string according to format X, tm will be filled in accordingly
       and the returned iterator will point to the first character beyond the date string. If an
       error occurs before the end, err |= ios_base::failbit. If parsing reads all the
       characters, err |= ios_base::eofbit.

       Parameters:
           beg Start of string to parse.
           end End of string to parse.
           io Source of the locale.
           err Error flags to set.
           tm Pointer to struct tm to fill in.

       Returns:
           Iterator to first char beyond date string.

       Definition at line 451 of file locale_facets_nonio.h.

   template<typename _CharT , typename _InIter > iter_type std::time_get< _CharT, _InIter
       >::get_monthname (iter_type__beg, iter_type__end, ios_base &__io, ios_base::iostate
       &__err, tm *__tm) const [inline]
       Parse input month string. This function parses a month name and puts the results into a
       user-supplied struct tm. The result is returned by calling time_get::do_get_monthname().

       Parsing starts by parsing an abbreviated month name. If a valid abbreviation is followed
       by a character that would lead to the full month name, parsing continues until the full
       name is found or an error occurs. Otherwise parsing finishes at the end of the abbreviated
       name.

       If an error occurs before the end, err |= ios_base::failbit. If parsing reads all the
       characters, err |= ios_base::eofbit.

       Parameters:
           beg Start of string to parse.
           end End of string to parse.
           io Source of the locale.
           err Error flags to set.
           tm Pointer to struct tm to fill in.

       Returns:
           Iterator to first char beyond month name.

       Definition at line 508 of file locale_facets_nonio.h.

   template<typename _CharT , typename _InIter > iter_type std::time_get< _CharT, _InIter
       >::get_time (iter_type__beg, iter_type__end, ios_base &__io, ios_base::iostate &__err, tm
       *__tm) const [inline]
       Parse input time string. This function parses a time according to the format x and puts
       the results into a user-supplied struct tm. The result is returned by calling
       time_get::do_get_time().

       If there is a valid time string according to format x, tm will be filled in accordingly
       and the returned iterator will point to the first character beyond the time string. If an
       error occurs before the end, err |= ios_base::failbit. If parsing reads all the
       characters, err |= ios_base::eofbit.

       Parameters:
           beg Start of string to parse.
           end End of string to parse.
           io Source of the locale.
           err Error flags to set.
           tm Pointer to struct tm to fill in.

       Returns:
           Iterator to first char beyond time string.

       Definition at line 426 of file locale_facets_nonio.h.

   template<typename _CharT , typename _InIter > iter_type std::time_get< _CharT, _InIter
       >::get_weekday (iter_type__beg, iter_type__end, ios_base &__io, ios_base::iostate &__err,
       tm *__tm) const [inline]
       Parse input weekday string. This function parses a weekday name and puts the results into
       a user-supplied struct tm. The result is returned by calling time_get::do_get_weekday().

       Parsing starts by parsing an abbreviated weekday name. If a valid abbreviation is followed
       by a character that would lead to the full weekday name, parsing continues until the full
       name is found or an error occurs. Otherwise parsing finishes at the end of the abbreviated
       name.

       If an error occurs before the end, err |= ios_base::failbit. If parsing reads all the
       characters, err |= ios_base::eofbit.

       Parameters:
           beg Start of string to parse.
           end End of string to parse.
           io Source of the locale.
           err Error flags to set.
           tm Pointer to struct tm to fill in.

       Returns:
           Iterator to first char beyond weekday name.

       Definition at line 479 of file locale_facets_nonio.h.

   template<typename _CharT , typename _InIter > iter_type std::time_get< _CharT, _InIter
       >::get_year (iter_type__beg, iter_type__end, ios_base &__io, ios_base::iostate &__err, tm
       *__tm) const [inline]
       Parse input year string. This function reads up to 4 characters to parse a year string and
       puts the results into a user-supplied struct tm. The result is returned by calling
       time_get::do_get_year().

       4 consecutive digits are interpreted as a full year. If there are exactly 2 consecutive
       digits, the library interprets this as the number of years since 1900.

       If an error occurs before the end, err |= ios_base::failbit. If parsing reads all the
       characters, err |= ios_base::eofbit.

       Parameters:
           beg Start of string to parse.
           end End of string to parse.
           io Source of the locale.
           err Error flags to set.
           tm Pointer to struct tm to fill in.

       Returns:
           Iterator to first char beyond year.

       Definition at line 534 of file locale_facets_nonio.h.

Member Data Documentation

   template<typename _CharT , typename _InIter > locale::id std::time_get< _CharT, _InIter >::id
       [static]
       Numpunct facet id.

       Definition at line 375 of file locale_facets_nonio.h.

Author

       Generated automatically by Doxygen for libstdc++ from the source code.