Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template special_values_parser

boost::date_time::special_values_parser — Class for special_value parsing.

Synopsis

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

template<typename date_type, typename charT> 
class special_values_parser {
public:
  // types
  typedef                 ;      
  typedef           ;
  typedef          ;  
  typedef                   ;    
  typedef string_parse_tree<                 ;  
  typedef parse_tree_type::parse_match_result_type  ;    
  typedef  ;  
  typedef                                      ;        

  // construct/copy/destruct
  ();
  (, , 
                        , , 
                        );
  (, 
                        );

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

  // public static functions
   ();

  // public data members
  static  nadt_string;
  static  neg_inf_string;
  static  pos_inf_string;
  static  min_date_time_string;
  static  max_date_time_string;
};

Description

TODO: add doc-comments for which elements can be changed Parses input stream for strings representing special_values. Special values parsed are:

  • not_a_date_time

  • neg_infin

  • pod_infin

  • min_date_time

  • max_date_time

special_values_parser public construct/copy/destruct

  1. ();
    Creates a special_values_parser with the default set of "sv_strings".
  2. ( nadt_str, 
                           neg_inf_str, 
                           pos_inf_str, 
                           min_dt_str, 
                           max_dt_str);
    Creates a special_values_parser using a user defined set of element strings.
  3. ( beg, 
                           end);

special_values_parser public member functions

  1.  ( nadt_str,  neg_inf_str, 
                     pos_inf_str, 
                     min_dt_str, 
                     max_dt_str);
    Replace special value strings.
  2.  ( sitr,  str_end, 
               match_results & mr) ;

    Given an input iterator, attempt to match it to a known special value

    Parameters:

    mr

    the match result: mr.current_match is set to the corresponding special_value or -1

    sitr

    the start iterator

    str_end

    the end iterator

    Returns:

    whether something matched

special_values_parser public static functions

  1.  ( str);

    The parser is expensive to create, and not thread-safe so it cannot be static therefore given a string, determine if it is likely to be a special value. A negative response is a definite no, whereas a positive is only likely and match() should be called and return value checked.

    Parameters:

    str

    the string to check

    Returns:

    false if it is definitely not a special value


PrevUpHomeNext