libstdc++
std::time_get Class Reference
Inheritance diagram for std::time_get:

List of all members.

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Friends


Detailed Description

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.


Member Typedef Documentation

typedef _CharT std::time_get::char_type

Public typedefs.

Reimplemented in std::time_get_byname.

Definition at line 374 of file locale_facets_nonio.h.

typedef _InIter std::time_get::iter_type

Public typedefs.

Reimplemented in std::time_get_byname.

Definition at line 375 of file locale_facets_nonio.h.


Constructor & Destructor Documentation

std::time_get::time_get ( size_t  __refs = 0) [inline, explicit]

Constructor performs initialization.

This is the constructor provided by the standard.

Parameters:
refsPassed to the base facet class.

Definition at line 390 of file locale_facets_nonio.h.

virtual std::time_get::~time_get ( ) [inline, protected, virtual]

Destructor.

Definition at line 546 of file locale_facets_nonio.h.


Member Function Documentation

dateorder std::time_get::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 407 of file locale_facets_nonio.h.

time_base::dateorder std::time_get::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 620 of file locale_facets_nonio.tcc.

Referenced by std::time_get< _CharT, _InIter >::date_order().

_InIter std::time_get::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:
begStart of string to parse.
endEnd of string to parse.
ioSource of the locale.
errError flags to set.
tmPointer to struct tm to fill in.
Returns:
Iterator to first char beyond date string.

Definition at line 1047 of file locale_facets_nonio.tcc.

References std::ios_base::_M_getloc().

Referenced by std::time_get< _CharT, _InIter >::get_date().

_InIter std::time_get::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:
begStart of string to parse.
endEnd of string to parse.
ioSource of the locale.
errError flags to set.
tmPointer to struct tm to fill in.
Returns:
Iterator to first char beyond month name.

Definition at line 1092 of file locale_facets_nonio.tcc.

References std::ios_base::_M_getloc().

Referenced by std::time_get< _CharT, _InIter >::get_monthname().

_InIter std::time_get::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:
begStart of string to parse.
endEnd of string to parse.
ioSource of the locale.
errError flags to set.
tmPointer to struct tm to fill in.
Returns:
Iterator to first char beyond time string.

Definition at line 1030 of file locale_facets_nonio.tcc.

References std::ios_base::_M_getloc().

Referenced by std::time_get< _CharT, _InIter >::get_time().

_InIter std::time_get::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:
begStart of string to parse.
endEnd of string to parse.
ioSource of the locale.
errError flags to set.
tmPointer to struct tm to fill in.
Returns:
Iterator to first char beyond weekday name.

Definition at line 1064 of file locale_facets_nonio.tcc.

References std::ios_base::_M_getloc().

Referenced by std::time_get< _CharT, _InIter >::get_weekday().

_InIter std::time_get::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:
begStart of string to parse.
endEnd of string to parse.
ioSource of the locale.
errError flags to set.
tmPointer to struct tm to fill in.
Returns:
Iterator to first char beyond year.

Definition at line 1120 of file locale_facets_nonio.tcc.

References std::ios_base::_M_getloc().

Referenced by std::time_get< _CharT, _InIter >::get_year().

iter_type std::time_get::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:
begStart of string to parse.
endEnd of string to parse.
ioSource of the locale.
errError flags to set.
tmPointer to struct tm to fill in.
Returns:
Iterator to first char beyond date string.

Definition at line 456 of file locale_facets_nonio.h.

iter_type std::time_get::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:
begStart of string to parse.
endEnd of string to parse.
ioSource of the locale.
errError flags to set.
tmPointer to struct tm to fill in.
Returns:
Iterator to first char beyond month name.

Definition at line 513 of file locale_facets_nonio.h.

iter_type std::time_get::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:
begStart of string to parse.
endEnd of string to parse.
ioSource of the locale.
errError flags to set.
tmPointer to struct tm to fill in.
Returns:
Iterator to first char beyond time string.

Definition at line 431 of file locale_facets_nonio.h.

iter_type std::time_get::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:
begStart of string to parse.
endEnd of string to parse.
ioSource of the locale.
errError flags to set.
tmPointer to struct tm to fill in.
Returns:
Iterator to first char beyond weekday name.

Definition at line 484 of file locale_facets_nonio.h.

iter_type std::time_get::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:
begStart of string to parse.
endEnd of string to parse.
ioSource of the locale.
errError flags to set.
tmPointer to struct tm to fill in.
Returns:
Iterator to first char beyond year.

Definition at line 539 of file locale_facets_nonio.h.


Member Data Documentation

Numpunct facet id.

Definition at line 380 of file locale_facets_nonio.h.


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