Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template time_facet

boost::date_time::time_facet

Synopsis

// In header: <boost/date_time/time_facet.hpp>

template<typename time_type, typename CharT, 
         typename OutItrT> 
class time_facet : public  {
public:
  // types
  typedef                                                           ;                    
  typedef                                                  ;           
  typedef boost::date_time::period<                      ;                  
  typedef boost::date_time::date_facet<  ;                    
  typedef                                                         ;                  
  typedef                                                           ;                    
  typedef base_type::period_formatter_type                                              ;        
  typedef base_type::special_values_formatter_type                                      ;
  typedef base_type::date_gen_formatter_type                                            ;      

  // construct/copy/destruct
  (:: = );
  (, 
                      period_formatter_type = period_formatter_type(), 
                      special_values_formatter_type & = special_values_formatter_type(), 
                      date_gen_formatter_type = date_gen_formatter_type(), 
                      :: = );

  // public member functions
   () ;
   ();
   ();
   ();
   (, , , ) ;
   (, , , ) ;
   (, , , period_type &) ;

  // protected static functions
   
  (, );
   (,  = );
  template<typename IntT>  (,  = );

  // public data members
  static  fractional_seconds_format;
  static  fractional_seconds_or_none_format;
  static  seconds_with_fractional_seconds_format;
  static  seconds_format;
  static  hours_format;
  static  unrestricted_hours_format;
  static  standard_format;
  static  zone_abbrev_format;
  static  zone_name_format;
  static  zone_iso_format;
  static  zone_iso_extended_format;
  static  posix_zone_string_format;
  static  duration_seperator;
  static  duration_sign_always;
  static  duration_sign_negative_only;
  static  negative_sign;
  static  positive_sign;
  static  iso_time_format_specifier;
  static  iso_time_format_extended_specifier;
  static  default_time_format;
  static  default_time_duration_format;
  static  id;
};

Description

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 == 0

  • s => 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_facet public construct/copy/destruct

  1. (:: ref_arg = );
    sets default formats for ptime, local_date_time, and time_duration
  2. ( format_arg, 
                        period_formatter_type period_formatter_arg = period_formatter_type(), 
                        special_values_formatter_type & special_value_formatter = special_values_formatter_type(), 
                        date_gen_formatter_type dg_formatter = date_gen_formatter_type(), 
                        :: ref_arg = );
    Construct the facet with an explicitly specified format.

time_facet public member functions

  1.  () ;
  2.  ( format);
    Changes format for time_duration.
  3.  ();
  4.  ();
  5.  ( next_arg,  ios_arg,  fill_arg, 
                 time_arg) ;
  6.  ( next_arg,  ios_arg,  fill_arg, 
                 time_dur_arg) ;
    put function for time_duration
  7.  ( next,  ios_arg,  fill, 
                period_type & p) ;

time_facet protected static functions

  1.  
    ( time_arg, 
                                  null_when_zero);
  2.  
    ( time_arg,  width = );
  3. template<typename IntT> 
       ( val,  width = );

PrevUpHomeNext