Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template time_input_facet

boost::date_time::time_input_facet — Facet for format-based input.

Synopsis

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

template<typename time_type, typename CharT, 
         typename InItrT> 
class time_input_facet : public  {
public:
  // types
  typedef                                                                ;                 
  typedef                                                       ;        
  typedef                                         ;    
  typedef boost::date_time::period<                           ;               
  typedef boost::date_time::date_input_facet<  ;                 
  typedef                                                            ;        
  typedef                                                                ;                 
  typedef                                                               ;                
  typedef                                                                 ;                  
  typedef                                                              ;               
  typedef                                                         ;                 
  typedef                                                                ;                 
  typedef base_type::format_date_parser_type                                                 ;   
  typedef base_type::period_parser_type                                                      ;        
  typedef base_type::special_values_parser_type                                              ;
  typedef base_type::date_gen_parser_type                                                    ;      
  typedef                                ;             

  // construct/copy/destruct
  (, :: = );
  (, 
                            format_date_parser_type &, 
                            special_values_parser_type &, 
                            period_parser_type &, 
                            date_gen_parser_type &, :: = );
  (:: = );

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

  // protected member functions
   (, , , , , 
             ) ;
  template<typename temporal_type> 
     (, , , 
                                = '\0') ;
   (, , ) ;

  // private member functions
  template<typename int_type> 
     (, ) ;

  // public data members
  static  fractional_seconds_format;
  static  fractional_seconds_or_none_format;
  static  seconds_with_fractional_seconds_format;
  static  seconds_format;
  static  standard_format;
  static  zone_abbrev_format;
  static  zone_name_format;
  static  zone_iso_format;
  static  zone_iso_extended_format;
  static  duration_seperator;
  static  iso_time_format_specifier;
  static  iso_time_format_extended_specifier;
  static  default_time_input_format;
  static  default_time_duration_format;
  static  id;
};

Description

time_input_facet public construct/copy/destruct

  1. ( format, :: ref_arg = );
    Constructor that takes a format string for a ptime.
  2. ( format, 
                              format_date_parser_type & date_parser, 
                              special_values_parser_type & sv_parser, 
                              period_parser_type & per_parser, 
                              date_gen_parser_type & date_gen_parser, 
                              :: ref_arg = );
  3. (:: ref_arg = );
    sets default formats for ptime, local_date_time, and time_duration

time_input_facet public member functions

  1.  ( format);
    Set the format for time_duration.
  2.  ();
  3.  ();
  4.  ( sitr,  stream_end,  ios_arg, 
               period_type & p) ;
  5.  ( sitr,  stream_end,  ios_arg, 
                td) ;
  6.  ( sitr,  stream_end,  ios_arg, 
                t) ;
    Parses a time object from the input stream.
  7.  ( sitr,  stream_end, 
                           ios_arg,  t, 
                           tz_str) ;
    Expects a time_zone in the input stream.

time_input_facet protected member functions

  1.  ( sitr,  stream_end,  ios_arg, 
                t,  tz_str,  time_is_local) ;
  2. template<typename temporal_type> 
       ( sitr,  stream_end, 
                                  tt,  c = '\0') ;
    Helper function to check for special_value.

    First character may have been consumed during original parse attempt. Parameter 'c' should be a copy of that character. Throws ios_base::failure if parse fails.

  3.  ( sitr,  stream_end, 
                          frac) ;
    Helper function for parsing a fractional second type from the stream.

time_input_facet private member functions

  1. template<typename int_type> 
       ( val,  places) ;
    Helper function to adjust trailing zeros when parsing fractional digits.

PrevUpHomeNext