std::time_put< _CharT, _OutIter > Class Template Reference

Facet for outputting dates and times. More...

#include <locale_facets.h>

Inheritance diagram for std::time_put< _CharT, _OutIter >:

std::locale::facet std::time_put_byname< _CharT, _OutIter > List of all members.

Public Types

typedef _CharT char_type
 Public typedefs.
typedef _OutIter iter_type

Public Member Functions

 time_put (size_t __refs=0)
 Constructor performs initialization.
iter_type put (iter_type __s, ios_base &__io, char_type __fill, const tm *__tm, const _CharT *__beg, const _CharT *__end) const
 Format and output a time or date.
iter_type put (iter_type __s, ios_base &__io, char_type __fill, const tm *__tm, char __format, char __mod=0) const
 Format and output a time or date.

Static Public Attributes

static locale::id id
 Numpunct facet id.

Protected Member Functions

virtual ~time_put ()
 Destructor.
virtual iter_type do_put (iter_type __s, ios_base &__io, char_type __fill, const tm *__tm, char __format, char __mod) const
 Format and output a time or date.

Detailed Description

template<typename _CharT, typename _OutIter>
class std::time_put< _CharT, _OutIter >

Facet for outputting dates and times.

This facet encapsulates the code to format and output dates and times according to formats used by strftime().

The time_put 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_put facet.

Definition at line 3351 of file locale_facets.h.


Member Typedef Documentation

template<typename _CharT, typename _OutIter>
typedef _CharT std::time_put< _CharT, _OutIter >::char_type

Public typedefs.

Reimplemented in std::time_put_byname< _CharT, _OutIter >.

Definition at line 3357 of file locale_facets.h.

template<typename _CharT, typename _OutIter>
typedef _OutIter std::time_put< _CharT, _OutIter >::iter_type

Reimplemented in std::time_put_byname< _CharT, _OutIter >.

Definition at line 3358 of file locale_facets.h.


Constructor & Destructor Documentation

template<typename _CharT, typename _OutIter>
std::time_put< _CharT, _OutIter >::time_put ( 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 3372 of file locale_facets.h.

template<typename _CharT, typename _OutIter>
virtual std::time_put< _CharT, _OutIter >::~time_put (  )  [inline, protected, virtual]

Destructor.

Definition at line 3418 of file locale_facets.h.


Member Function Documentation

template<typename _CharT, typename _OutIter>
_OutIter std::time_put< _CharT, _OutIter >::do_put ( iter_type  __s,
ios_base __io,
char_type  __fill,
const tm *  __tm,
char  __format,
char  __mod 
) const [protected, virtual]

Format and output a time or date.

This function formats the data in struct tm according to the provided format char and optional modifier. This function is a hook for derived classes to change the value returned.

See also:
put() for more details.
Parameters:
s The stream to write to.
io Source of locale.
fill char_type to use for padding.
tm Struct tm with date and time info to format.
format Format char.
mod Optional modifier char.
Returns:
Iterator after writing.

Definition at line 2313 of file locale_facets.tcc.

References std::__write(), std::ios_base::_M_getloc(), and std::__ctype_abstract_base< _CharT >::widen().

Referenced by std::time_put< _CharT, _OutIter >::put().

template<typename _CharT, typename _OutIter>
iter_type std::time_put< _CharT, _OutIter >::put ( iter_type  __s,
ios_base __io,
char_type  __fill,
const tm *  __tm,
char  __format,
char  __mod = 0 
) const [inline]

Format and output a time or date.

This function formats the data in struct tm according to the provided format char and optional modifier. The format and modifier are interpreted as by strftime(). It does so by returning time_put::do_put().

Parameters:
s The stream to write to.
io Source of locale.
fill char_type to use for padding.
tm Struct tm with date and time info to format.
format Format char.
mod Optional modifier char.
Returns:
Iterator after writing.

Definition at line 3411 of file locale_facets.h.

References std::time_put< _CharT, _OutIter >::do_put().

template<typename _CharT, typename _OutIter>
_OutIter std::time_put< _CharT, _OutIter >::put ( iter_type  __s,
ios_base __io,
char_type  __fill,
const tm *  __tm,
const _CharT *  __beg,
const _CharT *  __end 
) const

Format and output a time or date.

This function formats the data in struct tm according to the provided format string. The format string is interpreted as by strftime().

Parameters:
s The stream to write to.
io Source of locale.
fill char_type to use for padding.
tm Struct tm with date and time info to format.
beg Start of format string.
end End of format string.
Returns:
Iterator after writing.

Definition at line 2278 of file locale_facets.tcc.

References std::ios_base::_M_getloc(), std::time_put< _CharT, _OutIter >::do_put(), and std::__ctype_abstract_base< _CharT >::narrow().


Member Data Documentation

template<typename _CharT, typename _OutIter>
locale::id std::time_put< _CharT, _OutIter >::id [static]

Numpunct facet id.

Definition at line 3362 of file locale_facets.h.


The documentation for this class was generated from the following files:
Generated on Tue Feb 2 16:59:02 2010 for GNU C++ STL by  doxygen 1.4.7