Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::chrono::time_point_units< CharT > Class Template Referenceabstract

time_point_units facet gives useful information about the time_point pattern, the text associated to a time_point's epoch, More...

#include <time_point_units.hpp>

Inheritance diagram for boost::chrono::time_point_units< CharT >:
Collaboration diagram for boost::chrono::time_point_units< CharT >:

Public Types

typedef CharT char_type
 Type of character the facet is instantiated on. More...
 
typedef std::basic_string
< char_type
string_type
 Type of character string used by member functions. More...
 

Public Member Functions

 time_point_units (size_t refs=0)
 Construct a time_point_units facet. More...
 
virtual string_type get_pattern () const =0
 
template<typename Clock >
string_type get_epoch () const
 

Static Public Attributes

static std::locale::id id
 Unique identifier for this type of facet. More...
 

Protected Member Functions

virtual ~time_point_units ()
 Destroy the facet. More...
 
virtual string_type do_get_epoch (system_clock) const =0
 
virtual string_type do_get_epoch (steady_clock) const =0
 

Detailed Description

template<typename CharT = char>
class boost::chrono::time_point_units< CharT >

time_point_units facet gives useful information about the time_point pattern, the text associated to a time_point's epoch,

Member Typedef Documentation

template<typename CharT = char>
typedef CharT boost::chrono::time_point_units< CharT >::char_type

Type of character the facet is instantiated on.

template<typename CharT = char>
typedef std::basic_string<char_type> boost::chrono::time_point_units< CharT >::string_type

Type of character string used by member functions.

Constructor & Destructor Documentation

template<typename CharT = char>
boost::chrono::time_point_units< CharT >::time_point_units ( size_t  refs = 0)
inlineexplicit

Construct a time_point_units facet.

Parameters
refsConstruct a time_point_units facet. If the refs argument is 0 then destruction of the object is delegated to the locale, or locales, containing it. This allows the user to ignore lifetime management issues. On the other had, if refs is 1 then the object must be explicitly deleted; the locale will not do so. In this case, the object can be maintained across the lifetime of multiple locales.
template<typename CharT = char>
virtual boost::chrono::time_point_units< CharT >::~time_point_units ( )
inlineprotectedvirtual

Destroy the facet.

Member Function Documentation

template<typename CharT = char>
virtual string_type boost::chrono::time_point_units< CharT >::do_get_epoch ( system_clock  ) const
protectedpure virtual
Parameters
ca dummy instance of system_clock.
Returns
The epoch string associated to the system_clock.

Implemented in boost::chrono::time_point_units_default< CharT >.

Referenced by boost::chrono::time_point_units< CharT >::get_epoch().

template<typename CharT = char>
virtual string_type boost::chrono::time_point_units< CharT >::do_get_epoch ( steady_clock  ) const
protectedpure virtual
Parameters
ca dummy instance of steady_clock.
Returns
The epoch string associated to the steady_clock.

Implemented in boost::chrono::time_point_units_default< CharT >.

template<typename CharT = char>
template<typename Clock >
string_type boost::chrono::time_point_units< CharT >::get_epoch ( ) const
inline
Returns
the epoch associated to the clock Clock calling do_get_epoch(Clock())

References boost::chrono::time_point_units< CharT >::do_get_epoch().

template<typename CharT = char>
virtual string_type boost::chrono::time_point_units< CharT >::get_pattern ( ) const
pure virtual
Returns
the pattern to be used by default.

Implemented in boost::chrono::time_point_units_default< CharT >.

Referenced by boost::chrono::time_point_put< CharT, OutputIterator >::put().

Member Data Documentation

template<typename CharT = char>
std::locale::id boost::chrono::time_point_units< CharT >::id
static

Unique identifier for this type of facet.


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