diff options
Diffstat (limited to 'doc/html/boost/date_time/tz_db_base.html')
| -rw-r--r-- | doc/html/boost/date_time/tz_db_base.html | 57 |
1 files changed, 29 insertions, 28 deletions
diff --git a/doc/html/boost/date_time/tz_db_base.html b/doc/html/boost/date_time/tz_db_base.html index 6b6e83bdcd..d7a10a4892 100644 --- a/doc/html/boost/date_time/tz_db_base.html +++ b/doc/html/boost/date_time/tz_db_base.html @@ -1,3 +1,4 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> @@ -43,25 +44,25 @@ <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">char_type</span> <span class="special">></span> <a name="boost.date_time.tz_db_base.string_type"></a><span class="identifier">string_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="tz_db_base.html#boost.date_time.tz_db_baseconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="tz_db_base.html#idp101047600-bb"><span class="identifier">tz_db_base</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="tz_db_base.html#idp93356496-bb"><span class="identifier">tz_db_base</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="tz_db_base.html#idp94605520-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="tz_db_base.html#idp94606080-bb"><span class="identifier">load_from_stream</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">istream</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="tz_db_base.html#idp65556032-bb"><span class="identifier">load_from_file</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="tz_db_base.html#idp105648352-bb"><span class="identifier">add_record</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> + <span class="comment">// <a class="link" href="tz_db_base.html#idp44732640-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="tz_db_base.html#idp44733200-bb"><span class="identifier">load_from_stream</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">istream</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="tz_db_base.html#idp40247376-bb"><span class="identifier">load_from_file</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="tz_db_base.html#idp40251056-bb"><span class="identifier">add_record</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">shared_ptr</span><span class="special"><</span> <span class="identifier">time_zone_base_type</span> <span class="special">></span><span class="special">)</span><span class="special">;</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">shared_ptr</span><span class="special"><</span> <span class="identifier">time_zone_base_type</span> <span class="special">></span> - <a class="link" href="tz_db_base.html#idp61588432-bb"><span class="identifier">time_zone_from_region</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">></span> <a class="link" href="tz_db_base.html#idp61767184-bb"><span class="identifier">region_list</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="tz_db_base.html#idp93352480-bb"><span class="identifier">time_zone_from_region</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">></span> <a class="link" href="tz_db_base.html#idp93354944-bb"><span class="identifier">region_list</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="comment">// <a class="link" href="tz_db_base.html#idp101048192-bb">private member functions</a></span> - <span class="identifier">rule_type</span> <span class="special">*</span> <a class="link" href="tz_db_base.html#idp101048768-bb"><span class="identifier">parse_rules</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">week_num</span> <a class="link" href="tz_db_base.html#idp107379776-bb"><span class="identifier">get_week_num</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="tz_db_base.html#idp104938416-bb"><span class="identifier">split_rule_spec</span></a><span class="special">(</span><span class="keyword">int</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">string_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="tz_db_base.html#idp34482768-bb"><span class="identifier">parse_string</span></a><span class="special">(</span><span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="tz_db_base.html#idp93357088-bb">private member functions</a></span> + <span class="identifier">rule_type</span> <span class="special">*</span> <a class="link" href="tz_db_base.html#idp93357664-bb"><span class="identifier">parse_rules</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">week_num</span> <a class="link" href="tz_db_base.html#idp41878960-bb"><span class="identifier">get_week_num</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="tz_db_base.html#idp41881072-bb"><span class="identifier">split_rule_spec</span></a><span class="special">(</span><span class="keyword">int</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">string_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="tz_db_base.html#idp41885200-bb"><span class="identifier">parse_string</span></a><span class="special">(</span><span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp193113584"></a><h2>Description</h2> +<a name="idp201049408"></a><h2>Description</h2> <p>The csv file containing the zone_specs used by the <a class="link" href="tz_db_base.html" title="Class template tz_db_base">tz_db_base</a> is intended to be customized by the library user. When customizing this file (or creating your own) the file must follow a specific format.</p> <p>This first line is expected to contain column headings and is therefore not processed by the <a class="link" href="tz_db_base.html" title="Class template tz_db_base">tz_db_base</a>.</p> <p>Each record (line) must have eleven fields. Some of those fields can be empty. Every field (even empty ones) must be enclosed in double-quotes. Ex: </p> @@ -92,47 +93,47 @@ <p>DST End date rule: See DST Start date rule. The difference here is this is the day daylight savings ends (transition to STD).</p> <p>End time: Same as Start time. </p> <div class="refsect2"> -<a name="idp193167264"></a><h3> +<a name="idp201099264"></a><h3> <a name="boost.date_time.tz_db_baseconstruct-copy-destruct"></a><code class="computeroutput">tz_db_base</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><a name="idp101047600-bb"></a><span class="identifier">tz_db_base</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Constructs an empty database. </li></ol></div> +<pre class="literallayout"><a name="idp93356496-bb"></a><span class="identifier">tz_db_base</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Constructs an empty database. </li></ol></div> </div> <div class="refsect2"> -<a name="idp193173376"></a><h3> -<a name="idp94605520-bb"></a><code class="computeroutput">tz_db_base</code> public member functions</h3> +<a name="idp201104464"></a><h3> +<a name="idp44732640-bb"></a><code class="computeroutput">tz_db_base</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp94606080-bb"></a><span class="identifier">load_from_stream</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">istream</span> <span class="special">&</span> in<span class="special">)</span><span class="special">;</span></pre>Process csv data file, may throw exceptions. <p>May throw <code class="computeroutput"><a class="link" href="bad_field_count.html" title="Class bad_field_count">bad_field_count</a></code> exceptions </p> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp44733200-bb"></a><span class="identifier">load_from_stream</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">istream</span> <span class="special">&</span> in<span class="special">)</span><span class="special">;</span></pre>Process csv data file, may throw exceptions. <p>May throw <code class="computeroutput"><a class="link" href="bad_field_count.html" title="Class bad_field_count">bad_field_count</a></code> exceptions </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp65556032-bb"></a><span class="identifier">load_from_file</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> pathspec<span class="special">)</span><span class="special">;</span></pre>Process csv data file, may throw exceptions. <p>May throw <code class="computeroutput"><a class="link" href="data_not_accessible.html" title="Class data_not_accessible">data_not_accessible</a></code>, or <code class="computeroutput"><a class="link" href="bad_field_count.html" title="Class bad_field_count">bad_field_count</a></code> exceptions </p> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp40247376-bb"></a><span class="identifier">load_from_file</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> pathspec<span class="special">)</span><span class="special">;</span></pre>Process csv data file, may throw exceptions. <p>May throw <code class="computeroutput"><a class="link" href="data_not_accessible.html" title="Class data_not_accessible">data_not_accessible</a></code>, or <code class="computeroutput"><a class="link" href="bad_field_count.html" title="Class bad_field_count">bad_field_count</a></code> exceptions </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp105648352-bb"></a><span class="identifier">add_record</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> region<span class="special">,</span> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp40251056-bb"></a><span class="identifier">add_record</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> region<span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">shared_ptr</span><span class="special"><</span> <span class="identifier">time_zone_base_type</span> <span class="special">></span> tz<span class="special">)</span><span class="special">;</span></pre>returns true if record successfully added to map <p>Takes a region name in the form of "America/Phoenix", and a time_zone object for that region. The id string must be a unique name that does not already exist in the database. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">shared_ptr</span><span class="special"><</span> <span class="identifier">time_zone_base_type</span> <span class="special">></span> -<a name="idp61588432-bb"></a><span class="identifier">time_zone_from_region</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> region<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns a time_zone object built from the specs for the given region. <p>Returns a time_zone object built from the specs for the given region. If region does not exist a local_time::record_not_found exception will be thrown </p> +<a name="idp93352480-bb"></a><span class="identifier">time_zone_from_region</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> region<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns a time_zone object built from the specs for the given region. <p>Returns a time_zone object built from the specs for the given region. If region does not exist a local_time::record_not_found exception will be thrown </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">></span> <a name="idp61767184-bb"></a><span class="identifier">region_list</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns a vector of strings holding the time zone regions in the database. </li> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">></span> <a name="idp93354944-bb"></a><span class="identifier">region_list</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns a vector of strings holding the time zone regions in the database. </li> </ol></div> </div> <div class="refsect2"> -<a name="idp193226080"></a><h3> -<a name="idp101048192-bb"></a><code class="computeroutput">tz_db_base</code> private member functions</h3> +<a name="idp201151232"></a><h3> +<a name="idp93357088-bb"></a><code class="computeroutput">tz_db_base</code> private member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="identifier">rule_type</span> <span class="special">*</span> <a name="idp101048768-bb"></a><span class="identifier">parse_rules</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> sr<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> er<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>parses rule specs for transition day rules </li> +<pre class="literallayout"><span class="identifier">rule_type</span> <span class="special">*</span> <a name="idp93357664-bb"></a><span class="identifier">parse_rules</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> sr<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> er<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>parses rule specs for transition day rules </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">week_num</span> <a name="idp107379776-bb"></a><span class="identifier">get_week_num</span><span class="special">(</span><span class="keyword">int</span> nth<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>helper function for parse_rules() </li> +<pre class="literallayout"><span class="identifier">week_num</span> <a name="idp41878960-bb"></a><span class="identifier">get_week_num</span><span class="special">(</span><span class="keyword">int</span> nth<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>helper function for parse_rules() </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp104938416-bb"></a><span class="identifier">split_rule_spec</span><span class="special">(</span><span class="keyword">int</span> <span class="special">&</span> nth<span class="special">,</span> <span class="keyword">int</span> <span class="special">&</span> d<span class="special">,</span> <span class="keyword">int</span> <span class="special">&</span> m<span class="special">,</span> <span class="identifier">string_type</span> rule<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>splits the [start|end]_date_rule string into 3 ints </li> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp41881072-bb"></a><span class="identifier">split_rule_spec</span><span class="special">(</span><span class="keyword">int</span> <span class="special">&</span> nth<span class="special">,</span> <span class="keyword">int</span> <span class="special">&</span> d<span class="special">,</span> <span class="keyword">int</span> <span class="special">&</span> m<span class="special">,</span> <span class="identifier">string_type</span> rule<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>splits the [start|end]_date_rule string into 3 ints </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp34482768-bb"></a><span class="identifier">parse_string</span><span class="special">(</span><span class="identifier">string_type</span> <span class="special">&</span> s<span class="special">)</span><span class="special">;</span></pre>Take a line from the csv, turn it into a time_zone_type. <p>Take a line from the csv, turn it into a time_zone_type, and add it to the map. Zone_specs in csv file are expected to have eleven fields that describe the time zone. Returns true if zone_spec successfully added to database </p> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp41885200-bb"></a><span class="identifier">parse_string</span><span class="special">(</span><span class="identifier">string_type</span> <span class="special">&</span> s<span class="special">)</span><span class="special">;</span></pre>Take a line from the csv, turn it into a time_zone_type. <p>Take a line from the csv, turn it into a time_zone_type, and add it to the map. Zone_specs in csv file are expected to have eleven fields that describe the time zone. Returns true if zone_spec successfully added to database </p> </li> </ol></div> </div> |