]> git.proxmox.com Git - ceph.git/blame - ceph/src/boost/libs/date_time/xmldoc/gregorian_autodoc.xml
import quincy beta 17.1.0
[ceph.git] / ceph / src / boost / libs / date_time / xmldoc / gregorian_autodoc.xml
CommitLineData
b32b8144
FG
1<?xml version="1.0" standalone="yes"?>
2<library-reference id="gregorian_reference"><title>Gregorian Reference</title><header name="boost/date_time/gregorian/conversion.hpp">
3<namespace name="boost">
4<namespace name="gregorian">
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
20effc67
TL
74
75
76
b32b8144 77
f67539c2 78
b32b8144
FG
79
80
81<function name="to_tm"><type>std::tm</type><parameter name="d"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter><purpose>Converts a date to a tm struct. Throws out_of_range exception if date is a special value. </purpose></function>
82<function name="date_from_tm"><type><classname>date</classname></type><parameter name="datetm"><paramtype>const std::tm &amp;</paramtype></parameter><purpose>Converts a tm structure into a date dropping the any time values. </purpose></function>
83</namespace>
84</namespace>
85</header>
86<header name="boost/date_time/gregorian/formatters.hpp">
87<namespace name="boost">
88<namespace name="gregorian">
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
20effc67
TL
146
147
148
b32b8144 149
f67539c2 150
b32b8144
FG
151
152
153<function name="to_simple_string_type"><type>std::basic_string&lt; charT &gt;</type><template>
154 <template-type-parameter name="charT"/>
155 </template><parameter name="d"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter></function>
156<function name="to_simple_string_type"><type>std::basic_string&lt; charT &gt;</type><template>
157 <template-type-parameter name="charT"/>
158 </template><parameter name="d"><paramtype>const date_period &amp;</paramtype></parameter></function>
159<function name="to_iso_string_type"><type>std::basic_string&lt; charT &gt;</type><template>
160 <template-type-parameter name="charT"/>
161 </template><parameter name="d"><paramtype>const date_period &amp;</paramtype></parameter></function>
162<function name="to_iso_extended_string_type"><type>std::basic_string&lt; charT &gt;</type><template>
163 <template-type-parameter name="charT"/>
164 </template><parameter name="d"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter></function>
165<function name="to_iso_string_type"><type>std::basic_string&lt; charT &gt;</type><template>
166 <template-type-parameter name="charT"/>
167 </template><parameter name="d"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter></function>
168<function name="to_sql_string_type"><type>std::basic_string&lt; charT &gt;</type><template>
169 <template-type-parameter name="charT"/>
170 </template><parameter name="d"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter></function>
171<function name="to_simple_wstring"><type>std::wstring</type><parameter name="d"><paramtype>const date_period &amp;</paramtype></parameter><purpose>Convert date period to simple string. Example: [2002-Jan-01/2002-Jan-02]. </purpose></function>
172<function name="to_simple_wstring"><type>std::wstring</type><parameter name="d"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter><purpose>To YYYY-mmm-DD string where mmm 3 char month name. Example: 2002-Jan-01. </purpose></function>
173<function name="to_iso_wstring"><type>std::wstring</type><parameter name="d"><paramtype>const date_period &amp;</paramtype></parameter><purpose>Date period to iso standard format CCYYMMDD/CCYYMMDD. Example: 20021225/20021231. </purpose></function>
174<function name="to_iso_extended_wstring"><type>std::wstring</type><parameter name="d"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter><purpose>Convert to iso extended format string CCYY-MM-DD. Example 2002-12-31. </purpose></function>
175<function name="to_iso_wstring"><type>std::wstring</type><parameter name="d"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter><purpose>Convert to iso standard string YYYYMMDD. Example: 20021231. </purpose></function>
176<function name="to_sql_wstring"><type>std::wstring</type><parameter name="d"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter></function>
177
178
179</namespace>
180</namespace>
181</header>
182<header name="boost/date_time/gregorian/formatters_limited.hpp">
183<namespace name="boost">
184<namespace name="gregorian">
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
20effc67
TL
235
236
237
238
b32b8144
FG
239
240
f67539c2 241
b32b8144
FG
242
243
244<function name="to_simple_string"><type>std::string</type><parameter name="d"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter><purpose>To YYYY-mmm-DD string where mmm 3 char month name. Example: 2002-Jan-01. </purpose></function>
245<function name="to_simple_string"><type>std::string</type><parameter name="d"><paramtype>const date_period &amp;</paramtype></parameter><purpose>Convert date period to simple string. Example: [2002-Jan-01/2002-Jan-02]. </purpose></function>
246<function name="to_iso_string"><type>std::string</type><parameter name="d"><paramtype>const date_period &amp;</paramtype></parameter><purpose>Date period to iso standard format CCYYMMDD/CCYYMMDD. Example: 20021225/20021231. </purpose></function>
247<function name="to_iso_extended_string"><type>std::string</type><parameter name="d"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter><purpose>Convert to iso extended format string CCYY-MM-DD. Example 2002-12-31. </purpose></function>
b32b8144
FG
248<function name="to_sql_string"><type>std::string</type><parameter name="d"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter></function>
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263</namespace>
264</namespace>
265</header>
266<header name="boost/date_time/gregorian/greg_calendar.hpp">
267<namespace name="boost">
268<namespace name="gregorian">
269<class name="gregorian_calendar"><inherit access="public">date_time::gregorian_calendar_base&lt; greg_year_month_day, fancy_date_rep::int_type &gt;</inherit><purpose>Gregorian calendar for this implementation, hard work in the base. </purpose><typedef name="day_of_week_type"><purpose>Type to hold a weekday (eg: Sunday, Monday,...) </purpose><type><classname>greg_weekday</classname></type></typedef>
270<typedef name="day_of_year_type"><purpose>Counter type from 1 to 366 for gregorian dates. </purpose><type>greg_day_of_year_rep</type></typedef>
271<typedef name="date_rep_type"><purpose>Internal date representation that handles infinity, not a date. </purpose><type>fancy_date_rep</type></typedef>
272<typedef name="date_traits_type"><purpose>Date rep implements the traits stuff as well. </purpose><type>fancy_date_rep</type></typedef>
273</class><typedef name="fancy_date_rep"><purpose>An internal date representation that includes infinities, not a date. </purpose><type>date_time::int_adapter&lt; uint32_t &gt;</type></typedef>
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
20effc67
TL
345
346
347
b32b8144 348
f67539c2 349
b32b8144
FG
350
351
352</namespace>
353</namespace>
354</header>
355<header name="boost/date_time/gregorian/greg_date.hpp">
356<namespace name="boost">
357<namespace name="gregorian">
358<class name="date"><inherit access="public">date_time::date&lt; date, gregorian_calendar, date_duration &gt;</inherit><purpose>A date type based on <classname alt="boost::gregorian::gregorian_calendar">gregorian_calendar</classname>. </purpose><description><para>This class is the primary interface for programming with greogorian dates. The is a lightweight type that can be freely passed by value. All comparison operators are supported. </para></description><typedef name="year_type"><type>gregorian_calendar::year_type</type></typedef>
359<typedef name="month_type"><type>gregorian_calendar::month_type</type></typedef>
360<typedef name="day_type"><type>gregorian_calendar::day_type</type></typedef>
361<typedef name="day_of_year_type"><type>gregorian_calendar::day_of_year_type</type></typedef>
362<typedef name="ymd_type"><type>gregorian_calendar::ymd_type</type></typedef>
363<typedef name="date_rep_type"><type>gregorian_calendar::date_rep_type</type></typedef>
364<typedef name="date_int_type"><type>gregorian_calendar::date_int_type</type></typedef>
365<typedef name="duration_type"><type><classname>date_duration</classname></type></typedef>
366<method-group name="public member functions">
f67539c2
TL
367<method name="julian_day" cv="const"><type>BOOST_CXX14_CONSTEXPR date_int_type</type><purpose>Return the Julian Day number for the date. </purpose></method>
368<method name="day_of_year" cv="const"><type>BOOST_CXX14_CONSTEXPR day_of_year_type</type><purpose>Return the day of year 1..365 or 1..366 (for leap year) </purpose></method>
369<method name="modjulian_day" cv="const"><type>BOOST_CXX14_CONSTEXPR date_int_type</type><purpose>Return the Modified Julian Day number for the date. </purpose></method>
370<method name="week_number" cv="const"><type>BOOST_CXX14_CONSTEXPR int</type><purpose>Return the iso 8601 week number 1..53. </purpose></method>
371<method name="day_number" cv="const"><type>BOOST_CXX14_CONSTEXPR date_int_type</type><purpose>Return the day number from the calendar. </purpose></method>
372<method name="end_of_month" cv="const"><type>BOOST_CXX14_CONSTEXPR <classname>date</classname></type><purpose>Return the last day of the current month. </purpose></method>
b32b8144
FG
373</method-group>
374<constructor><purpose>Default constructor constructs with not_a_date_time. </purpose></constructor>
375<constructor><parameter name="y"><paramtype>year_type</paramtype></parameter><parameter name="m"><paramtype>month_type</paramtype></parameter><parameter name="d"><paramtype>day_type</paramtype></parameter><purpose>Main constructor with year, month, day. </purpose></constructor>
376<constructor specifiers="explicit"><parameter name="ymd"><paramtype>const ymd_type &amp;</paramtype></parameter><purpose>Constructor from a ymd_type structure. </purpose></constructor>
377<constructor specifiers="explicit"><parameter name="rhs"><paramtype>const date_int_type &amp;</paramtype></parameter><purpose>Needed copy constructor. </purpose></constructor>
378<constructor specifiers="explicit"><parameter name="rhs"><paramtype>date_rep_type</paramtype></parameter><purpose>Needed copy constructor. </purpose></constructor>
379<constructor specifiers="explicit"><parameter name="sv"><paramtype>special_values</paramtype></parameter><purpose>Constructor for infinities, not a date, max and min date. </purpose></constructor>
380</class>
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
20effc67
TL
435
436
437
438<function name="operator=="><type>BOOST_CXX14_CONSTEXPR bool</type><parameter name="lhs"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter></function>
b32b8144
FG
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458</namespace>
459</namespace>
460</header>
461<header name="boost/date_time/gregorian/greg_day.hpp">
462<namespace name="boost">
463<namespace name="gregorian">
464<struct name="bad_day_of_month"><inherit access="public">out_of_range</inherit><purpose>Exception type for gregorian day of month (1..31) </purpose><method-group name="public member functions">
465</method-group>
466<constructor/>
467<constructor><parameter name="s"><paramtype>const std::string &amp;</paramtype></parameter><purpose>Allow other classes to throw with unique string for bad day like Feb 29. </purpose></constructor>
468</struct><class name="greg_day"><inherit access="public">greg_day_rep</inherit><purpose>Represent a day of the month (range 1 - 31) </purpose><description><para>This small class allows for simple conversion an integer value into a day of the month for a standard gregorian calendar. The type is automatically range checked so values outside of the range 1-31 will cause a <classname alt="boost::gregorian::bad_day_of_month">bad_day_of_month</classname> exception </para></description><method-group name="public member functions">
f67539c2
TL
469<method name="as_number" cv="const"><type>BOOST_CXX14_CONSTEXPR value_type</type></method>
470<method name="operator value_type" cv="const"><type>BOOST_CXX14_CONSTEXPR</type></method>
b32b8144
FG
471</method-group>
472<constructor><parameter name="day_of_month"><paramtype>value_type</paramtype></parameter></constructor>
473</class><typedef name="greg_day_policies"><purpose>Policy class that declares error handling and day of month ranges. </purpose><type>CV::simple_exception_policy&lt; unsigned short, 1, 31, <classname>bad_day_of_month</classname> &gt;</type></typedef>
474<typedef name="greg_day_rep"><purpose>Generated represetation for gregorian day of month. </purpose><type>CV::constrained_value&lt; greg_day_policies &gt;</type></typedef>
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
20effc67
TL
546
547
548
b32b8144 549
f67539c2 550
b32b8144
FG
551
552
553</namespace>
554</namespace>
555</header>
556<header name="boost/date_time/gregorian/greg_day_of_year.hpp">
557<namespace name="boost">
558<namespace name="gregorian">
559<struct name="bad_day_of_year"><inherit access="public">out_of_range</inherit><purpose>Exception type for day of year (1..366) </purpose><method-group name="public member functions">
560</method-group>
561<constructor/>
562</struct><typedef name="greg_day_of_year_policies"><purpose>A day of the year range (1..366) </purpose><type>CV::simple_exception_policy&lt; unsigned short, 1, 366, <classname>bad_day_of_year</classname> &gt;</type></typedef>
563<typedef name="greg_day_of_year_rep"><purpose>Define a range representation type for the day of the year 1..366. </purpose><type>CV::constrained_value&lt; greg_day_of_year_policies &gt;</type></typedef>
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
20effc67
TL
635
636
637
b32b8144 638
f67539c2 639
b32b8144
FG
640
641
642</namespace>
643</namespace>
644</header>
645<header name="boost/date_time/gregorian/greg_duration.hpp">
646<namespace name="boost">
647<namespace name="gregorian">
648<class name="date_duration"><inherit access="public">boost::date_time::date_duration&lt; date_duration_rep &gt;</inherit><purpose>Durations in days for gregorian system. </purpose><typedef name="duration_rep"><type>base_type::duration_rep</type></typedef>
649<method-group name="public member functions">
f67539c2
TL
650<method name="operator==" cv="const"><type>BOOST_CXX14_CONSTEXPR bool</type><parameter name="rhs"><paramtype>const <classname>date_duration</classname> &amp;</paramtype></parameter></method>
651<method name="operator!=" cv="const"><type>BOOST_CXX14_CONSTEXPR bool</type><parameter name="rhs"><paramtype>const <classname>date_duration</classname> &amp;</paramtype></parameter></method>
652<method name="operator&lt;" cv="const"><type>BOOST_CXX14_CONSTEXPR bool</type><parameter name="rhs"><paramtype>const <classname>date_duration</classname> &amp;</paramtype></parameter></method>
653<method name="operator&gt;" cv="const"><type>BOOST_CXX14_CONSTEXPR bool</type><parameter name="rhs"><paramtype>const <classname>date_duration</classname> &amp;</paramtype></parameter></method>
654<method name="operator&lt;=" cv="const"><type>BOOST_CXX14_CONSTEXPR bool</type><parameter name="rhs"><paramtype>const <classname>date_duration</classname> &amp;</paramtype></parameter></method>
655<method name="operator&gt;=" cv="const"><type>BOOST_CXX14_CONSTEXPR bool</type><parameter name="rhs"><paramtype>const <classname>date_duration</classname> &amp;</paramtype></parameter></method>
656<method name="operator-="><type>BOOST_CXX14_CONSTEXPR <classname>date_duration</classname> &amp;</type><parameter name="rhs"><paramtype>const <classname>date_duration</classname> &amp;</paramtype></parameter><purpose>Subtract another duration – result is signed. </purpose></method>
657<method name="operator+="><type>BOOST_CXX14_CONSTEXPR <classname>date_duration</classname> &amp;</type><parameter name="rhs"><paramtype>const <classname>date_duration</classname> &amp;</paramtype></parameter><purpose>Add a duration – result is signed. </purpose></method>
658<method name="operator-" cv="const"><type>BOOST_CXX14_CONSTEXPR <classname>date_duration</classname></type><purpose>unary- Allows for dd = -date_duration(2); -&gt; dd == -2 </purpose></method>
659<method name="operator/="><type>BOOST_CXX14_CONSTEXPR <classname>date_duration</classname> &amp;</type><parameter name="divisor"><paramtype>int</paramtype></parameter><purpose>Division operations on a duration with an integer. </purpose></method>
b32b8144
FG
660</method-group>
661<constructor specifiers="explicit"><parameter name="day_count"><paramtype>duration_rep</paramtype><default>0</default></parameter><purpose>Construct from a day count. </purpose></constructor>
662<constructor><parameter name="sv"><paramtype>date_time::special_values</paramtype></parameter><purpose>construct from special_values </purpose></constructor>
b32b8144
FG
663<constructor><parameter name="other"><paramtype>const base_type &amp;</paramtype></parameter><purpose>Construct from another <classname alt="boost::gregorian::date_duration">date_duration</classname>. </purpose></constructor>
664<method-group name="public static functions">
f67539c2 665<method name="unit" specifiers="static"><type>BOOST_CXX14_CONSTEXPR <classname>date_duration</classname></type><purpose>Returns the smallest duration – used by to calculate 'end'. </purpose></method>
b32b8144
FG
666</method-group>
667</class><typedef name="date_duration_rep"><purpose>An internal date representation that includes infinities, not a date. </purpose><type>boost::date_time::duration_traits_adapted</type></typedef>
668<typedef name="days"><purpose>Shorthand for <classname alt="boost::gregorian::date_duration">date_duration</classname>. </purpose><type><classname>date_duration</classname></type></typedef>
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
20effc67
TL
724<function name="operator-"><type>BOOST_CXX14_CONSTEXPR <classname>date_duration</classname></type><parameter name="rhs"><paramtype><classname>date_duration</classname></paramtype></parameter><parameter name="lhs"><paramtype><classname>date_duration</classname> const &amp;</paramtype></parameter></function>
725<function name="operator+"><type>BOOST_CXX14_CONSTEXPR <classname>date_duration</classname></type><parameter name="rhs"><paramtype><classname>date_duration</classname></paramtype></parameter><parameter name="lhs"><paramtype><classname>date_duration</classname> const &amp;</paramtype></parameter></function>
726<function name="operator/"><type>BOOST_CXX14_CONSTEXPR <classname>date_duration</classname></type><parameter name="rhs"><paramtype><classname>date_duration</classname></paramtype></parameter><parameter name="lhs"><paramtype>int</paramtype></parameter></function>
b32b8144
FG
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
f67539c2 744
b32b8144
FG
745
746
747</namespace>
748</namespace>
749</header>
750<header name="boost/date_time/gregorian/greg_duration_types.hpp">
751<namespace name="boost">
752<namespace name="gregorian">
753<struct name="greg_durations_config"><purpose>config struct for additional duration types (ie months_duration&lt;&gt; &amp; years_duration&lt;&gt;) </purpose><typedef name="date_type"><type><classname>date</classname></type></typedef>
754<typedef name="int_rep"><type>date_time::int_adapter&lt; int &gt;</type></typedef>
755<typedef name="month_adjustor_type"><type>date_time::month_functor&lt; <classname>date_type</classname> &gt;</type></typedef>
756</struct><class name="weeks_duration"><inherit access="public">boost::gregorian::date_duration</inherit><method-group name="public member functions">
757</method-group>
758<constructor><parameter name="w"><paramtype>duration_rep</paramtype></parameter></constructor>
759<constructor><parameter name="sv"><paramtype>date_time::special_values</paramtype></parameter></constructor>
760</class><typedef name="months"><type>date_time::months_duration&lt; <classname>greg_durations_config</classname> &gt;</type></typedef>
761<typedef name="years"><type>date_time::years_duration&lt; <classname>greg_durations_config</classname> &gt;</type></typedef>
762<typedef name="weeks"><type><classname>weeks_duration</classname></type></typedef>
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
20effc67
TL
834
835
836
b32b8144 837
f67539c2 838
b32b8144
FG
839
840
841</namespace>
842</namespace>
843</header>
844<header name="boost/date_time/gregorian/greg_facet.hpp">
845<namespace name="boost">
846<namespace name="gregorian">
847<struct name="greg_facet_config"><purpose>Configuration of the output facet template. </purpose><typedef name="month_type"><type><classname>boost::gregorian::greg_month</classname></type></typedef>
848<typedef name="special_value_enum"><type>boost::date_time::special_values</type></typedef>
849<typedef name="month_enum"><type>boost::gregorian::months_of_year</type></typedef>
850<typedef name="weekday_enum"><type>boost::date_time::weekdays</type></typedef>
851</struct><typedef name="greg_base_facet"><purpose>Create the base facet type for <classname alt="boost::gregorian::date">gregorian::date</classname>. </purpose><type>boost::date_time::date_names_put&lt; <classname>greg_facet_config</classname> &gt;</type></typedef>
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
20effc67 884
b32b8144
FG
885
886
887<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
888 <template-type-parameter name="charT"/>
889 <template-type-parameter name="traits"/>
890 </template><parameter name="os"><paramtype>std::basic_ostream&lt; charT, traits &gt; &amp;</paramtype></parameter><parameter name="d"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter><purpose>ostream operator for <classname alt="boost::gregorian::date">gregorian::date</classname> </purpose><description><para>Uses the date facet to determine various output parameters including:<itemizedlist>
92f5a8d4
TL
891<listitem><para>string values for the month (eg: Jan, Feb, Mar) (default: English)</para>
892</listitem><listitem><para>string values for special values (eg: not-a-date-time) (default: English)</para>
893</listitem><listitem><para>selection of long, short strings, or numerical month representation (default: short string)</para>
894</listitem><listitem><para>month day year order (default yyyy-mmm-dd) </para>
895</listitem></itemizedlist>
b32b8144
FG
896</para></description></function>
897<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
898 <template-type-parameter name="charT"/>
899 <template-type-parameter name="traits"/>
900 </template><parameter name="os"><paramtype>std::basic_ostream&lt; charT, traits &gt; &amp;</paramtype></parameter><parameter name="m"><paramtype>const <classname>greg_month</classname> &amp;</paramtype></parameter><purpose>operator&lt;&lt; for <classname alt="boost::gregorian::greg_month">gregorian::greg_month</classname> typically streaming: Jan, Feb, Mar... </purpose><description><para>Uses the date facet to determine output string as well as selection of long or short strings. Default if no facet is installed is to output a 2 wide numeric value for the month eg: 01 == Jan, 02 == Feb, ... 12 == Dec. </para></description></function>
901<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
902 <template-type-parameter name="charT"/>
903 <template-type-parameter name="traits"/>
904 </template><parameter name="os"><paramtype>std::basic_ostream&lt; charT, traits &gt; &amp;</paramtype></parameter><parameter name="wd"><paramtype>const <classname>greg_weekday</classname> &amp;</paramtype></parameter><purpose>operator&lt;&lt; for <classname alt="boost::gregorian::greg_weekday">gregorian::greg_weekday</classname> typically streaming: Sun, Mon, Tue, ... </purpose><description><para>Uses the date facet to determine output string as well as selection of long or short string. Default if no facet is installed is to output a 3 char english string for the day of the week. </para></description></function>
905<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
906 <template-type-parameter name="charT"/>
907 <template-type-parameter name="traits"/>
908 </template><parameter name="os"><paramtype>std::basic_ostream&lt; charT, traits &gt; &amp;</paramtype></parameter><parameter name="dp"><paramtype>const date_period &amp;</paramtype></parameter><purpose>operator&lt;&lt; for gregorian::date_period typical output: [2002-Jan-01/2002-Jan-31] </purpose><description><para>Uses the date facet to determine output string as well as selection of long or short string fr dates. Default if no facet is installed is to output a 3 char english string for the day of the week. </para></description></function>
909<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
910 <template-type-parameter name="charT"/>
911 <template-type-parameter name="traits"/>
912 </template><parameter name="os"><paramtype>std::basic_ostream&lt; charT, traits &gt; &amp;</paramtype></parameter><parameter name="dd"><paramtype>const <classname>date_duration</classname> &amp;</paramtype></parameter></function>
913<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
914 <template-type-parameter name="charT"/>
915 <template-type-parameter name="traits"/>
916 </template><parameter name="os"><paramtype>std::basic_ostream&lt; charT, traits &gt; &amp;</paramtype></parameter><parameter name="pd"><paramtype>const partial_date &amp;</paramtype></parameter><purpose>operator&lt;&lt; for gregorian::partial_date. Output: "Jan 1" </purpose></function>
917<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
918 <template-type-parameter name="charT"/>
919 <template-type-parameter name="traits"/>
920 </template><parameter name="os"><paramtype>std::basic_ostream&lt; charT, traits &gt; &amp;</paramtype></parameter><parameter name="nkd"><paramtype>const nth_kday_of_month &amp;</paramtype></parameter><purpose>operator&lt;&lt; for gregorian::nth_kday_of_month. Output: "first Mon of Jun" </purpose></function>
921<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
922 <template-type-parameter name="charT"/>
923 <template-type-parameter name="traits"/>
924 </template><parameter name="os"><paramtype>std::basic_ostream&lt; charT, traits &gt; &amp;</paramtype></parameter><parameter name="fkd"><paramtype>const first_kday_of_month &amp;</paramtype></parameter><purpose>operator&lt;&lt; for gregorian::first_kday_of_month. Output: "first Mon of Jun" </purpose></function>
925<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
926 <template-type-parameter name="charT"/>
927 <template-type-parameter name="traits"/>
928 </template><parameter name="os"><paramtype>std::basic_ostream&lt; charT, traits &gt; &amp;</paramtype></parameter><parameter name="lkd"><paramtype>const last_kday_of_month &amp;</paramtype></parameter><purpose>operator&lt;&lt; for gregorian::last_kday_of_month. Output: "last Mon of Jun" </purpose></function>
929<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
930 <template-type-parameter name="charT"/>
931 <template-type-parameter name="traits"/>
932 </template><parameter name="os"><paramtype>std::basic_ostream&lt; charT, traits &gt; &amp;</paramtype></parameter><parameter name="fka"><paramtype>const first_kday_after &amp;</paramtype></parameter><purpose>operator&lt;&lt; for gregorian::first_kday_after. Output: "first Mon after" </purpose></function>
933<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
934 <template-type-parameter name="charT"/>
935 <template-type-parameter name="traits"/>
936 </template><parameter name="os"><paramtype>std::basic_ostream&lt; charT, traits &gt; &amp;</paramtype></parameter><parameter name="fkb"><paramtype>const first_kday_before &amp;</paramtype></parameter><purpose>operator&lt;&lt; for gregorian::first_kday_before. Output: "first Mon before" </purpose></function>
937<function name="operator&gt;&gt;"><type>std::basic_istream&lt; charT &gt; &amp;</type><template>
938 <template-type-parameter name="charT"/>
939 </template><parameter name="is"><paramtype>std::basic_istream&lt; charT &gt; &amp;</paramtype></parameter><parameter name="d"><paramtype><classname>date</classname> &amp;</paramtype></parameter><purpose>operator&gt;&gt; for <classname alt="boost::gregorian::date">gregorian::date</classname> </purpose></function>
940<function name="operator&gt;&gt;"><type>std::basic_istream&lt; charT &gt; &amp;</type><template>
941 <template-type-parameter name="charT"/>
942 </template><parameter name="is"><paramtype>std::basic_istream&lt; charT &gt; &amp;</paramtype></parameter><parameter name="dd"><paramtype><classname>date_duration</classname> &amp;</paramtype></parameter><purpose>operator&gt;&gt; for <classname alt="boost::gregorian::date_duration">gregorian::date_duration</classname> </purpose></function>
943<function name="operator&gt;&gt;"><type>std::basic_istream&lt; charT &gt; &amp;</type><template>
944 <template-type-parameter name="charT"/>
945 </template><parameter name="is"><paramtype>std::basic_istream&lt; charT &gt; &amp;</paramtype></parameter><parameter name="dp"><paramtype>date_period &amp;</paramtype></parameter><purpose>operator&gt;&gt; for gregorian::date_period </purpose></function>
946<function name="generate_locale"><type>BOOST_DATE_TIME_DECL std::locale</type><parameter name="loc"><paramtype>std::locale &amp;</paramtype></parameter><parameter name="type"><paramtype>char</paramtype></parameter><purpose>generates a locale with the set of gregorian name-strings of type char* </purpose></function>
947<function name="create_facet_def"><type>BOOST_DATE_TIME_DECL boost::date_time::all_date_names_put&lt; <classname>greg_facet_config</classname>, char &gt; *</type><parameter name="type"><paramtype>char</paramtype></parameter><purpose>Returns a pointer to a facet with a default set of names (English) </purpose></function>
948<function name="generate_locale"><type>BOOST_DATE_TIME_DECL std::locale</type><parameter name="loc"><paramtype>std::locale &amp;</paramtype></parameter><parameter name="type"><paramtype>wchar_t</paramtype></parameter><purpose>generates a locale with the set of gregorian name-strings of type wchar_t* </purpose></function>
949<function name="create_facet_def"><type>BOOST_DATE_TIME_DECL boost::date_time::all_date_names_put&lt; <classname>greg_facet_config</classname>, wchar_t &gt; *</type><parameter name="type"><paramtype>wchar_t</paramtype></parameter><purpose>Returns a pointer to a facet with a default set of names (English) </purpose></function>
950<function name="operator&gt;&gt;"><type>std::basic_istream&lt; charT &gt; &amp;</type><template>
951 <template-type-parameter name="charT"/>
952 </template><parameter name="is"><paramtype>std::basic_istream&lt; charT &gt; &amp;</paramtype></parameter><parameter name="m"><paramtype><classname>greg_month</classname> &amp;</paramtype></parameter><purpose>operator&gt;&gt; for <classname alt="boost::gregorian::greg_month">gregorian::greg_month</classname> - throws exception if invalid month given </purpose></function>
953<function name="operator&gt;&gt;"><type>std::basic_istream&lt; charT &gt; &amp;</type><template>
954 <template-type-parameter name="charT"/>
955 </template><parameter name="is"><paramtype>std::basic_istream&lt; charT &gt; &amp;</paramtype></parameter><parameter name="wd"><paramtype><classname>greg_weekday</classname> &amp;</paramtype></parameter><purpose>operator&gt;&gt; for <classname alt="boost::gregorian::greg_weekday">gregorian::greg_weekday</classname> - throws exception if invalid weekday given </purpose></function>
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
20effc67
TL
974
975
b32b8144 976
f67539c2 977
b32b8144
FG
978
979</namespace>
980</namespace>
981</header>
982<header name="boost/date_time/gregorian/greg_month.hpp">
983<namespace name="boost">
984<namespace name="gregorian">
985<struct name="bad_month"><inherit access="public">out_of_range</inherit><purpose>Exception thrown if a <classname alt="boost::gregorian::greg_month">greg_month</classname> is constructed with a value out of range. </purpose><method-group name="public member functions">
986</method-group>
987<constructor/>
988</struct><class name="greg_month"><inherit access="public">greg_month_rep</inherit><purpose>Wrapper class to represent months in gregorian based calendar. </purpose><typedef name="month_enum"><type>date_time::months_of_year</type></typedef>
b32b8144 989<method-group name="public member functions">
f67539c2
TL
990<method name="operator value_type" cv="const"><type>BOOST_CXX14_CONSTEXPR</type><purpose>Convert the value back to a short. </purpose></method>
991<method name="as_number" cv="const"><type>BOOST_CXX14_CONSTEXPR value_type</type><purpose>Returns month as number from 1 to 12. </purpose></method>
992<method name="as_enum" cv="const"><type>BOOST_CXX14_CONSTEXPR month_enum</type></method>
993<method name="as_short_string" cv="const"><type>const char *</type><purpose>Returns 3 char english string for the month ex: Jan, Feb, Mar, Apr. </purpose></method>
994<method name="as_long_string" cv="const"><type>const char *</type><purpose>Returns full name of month as string in english ex: January, February. </purpose></method>
995<method name="as_short_wstring" cv="const"><type>const wchar_t *</type><purpose>Returns 3 wchar_t english string for the month ex: Jan, Feb, Mar, Apr. </purpose></method>
996<method name="as_long_wstring" cv="const"><type>const wchar_t *</type><purpose>Returns full name of month as wchar_t string in english ex: January, February. </purpose></method>
b32b8144
FG
997<method name="as_short_string" cv="const"><type>const char *</type><parameter name=""><paramtype>char</paramtype></parameter></method>
998<method name="as_long_string" cv="const"><type>const char *</type><parameter name=""><paramtype>char</paramtype></parameter></method>
999<method name="as_short_string" cv="const"><type>const wchar_t *</type><parameter name=""><paramtype>wchar_t</paramtype></parameter></method>
1000<method name="as_long_string" cv="const"><type>const wchar_t *</type><parameter name=""><paramtype>wchar_t</paramtype></parameter></method>
1001</method-group>
1002<constructor><parameter name="theMonth"><paramtype>month_enum</paramtype></parameter><purpose>Construct a month from the months_of_year enumeration. </purpose></constructor>
1003<constructor><parameter name="theMonth"><paramtype>value_type</paramtype></parameter><purpose>Construct from a short value. </purpose></constructor>
b32b8144
FG
1004</class><typedef name="months_of_year"><type>date_time::months_of_year</type></typedef>
1005<typedef name="greg_month_policies"><purpose>Build a policy class for the greg_month_rep. </purpose><type>CV::simple_exception_policy&lt; unsigned short, 1, 12, <classname>bad_month</classname> &gt;</type></typedef>
1006<typedef name="greg_month_rep"><purpose>A constrained range that implements the gregorian_month rules. </purpose><type>CV::constrained_value&lt; greg_month_policies &gt;</type></typedef>
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
20effc67
TL
1078
1079
1080
b32b8144 1081
f67539c2 1082
b32b8144
FG
1083
1084
1085</namespace>
1086</namespace>
1087</header>
1088<header name="boost/date_time/gregorian/greg_serialize.hpp">
20effc67
TL
1089<namespace name="boost">
1090<namespace name="gregorian">
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125<function name="to_iso_string"><type>std::string</type><parameter name=""><paramtype>const <classname>date</classname> &amp;</paramtype></parameter><purpose>Convert to iso standard string YYYYMMDD. Example: 20021231. </purpose></function>
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169</namespace>
1170<namespace name="serialization">
1171<function name="BOOST_DATE_TIME_SPLIT_FREE"><type/><parameter name=""><paramtype>::<classname>boost::gregorian::date</classname></paramtype></parameter><description><para>Method that does serialization for <classname alt="boost::gregorian::date">gregorian::date</classname> – splits to load/save</para><para>Dates are serialized into a string for transport and storage. While it would be more efficient to store the internal integer used to manipulate the dates, it is an unstable solution. </para></description></function>
1172<function name="load"><type>void</type><template>
1173 <template-type-parameter name="Archive"/>
1174 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="d"><paramtype>::<classname>boost::gregorian::date</classname> &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to load <classname alt="boost::gregorian::date">gregorian::date</classname> objects using serialization lib. </purpose><description><para>Dates are serialized into a string for transport and storage. While it would be more efficient to store the internal integer used to manipulate the dates, it is an unstable solution. </para></description></function>
1175<function name="load_construct_data"><type>void</type><template>
1176 <template-type-parameter name="Archive"/>
1177 </template><parameter name=""><paramtype>Archive &amp;</paramtype></parameter><parameter name="dp"><paramtype>::<classname>boost::gregorian::date</classname> *</paramtype></parameter><parameter name=""><paramtype>const unsigned int</paramtype></parameter><purpose>override needed b/c no default constructor </purpose></function>
1178<function name="save"><type>void</type><template>
1179 <template-type-parameter name="Archive"/>
1180 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="dd"><paramtype>const <classname>gregorian::date_duration</classname> &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to save <classname alt="boost::gregorian::date_duration">gregorian::date_duration</classname> objects using serialization lib. </purpose></function>
1181<function name="load"><type>void</type><template>
1182 <template-type-parameter name="Archive"/>
1183 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="dd"><paramtype><classname>gregorian::date_duration</classname> &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to load <classname alt="boost::gregorian::date_duration">gregorian::date_duration</classname> objects using serialization lib. </purpose></function>
1184<function name="load_construct_data"><type>void</type><template>
1185 <template-type-parameter name="Archive"/>
1186 </template><parameter name=""><paramtype>Archive &amp;</paramtype></parameter><parameter name="dd"><paramtype><classname>gregorian::date_duration</classname> *</paramtype></parameter><parameter name=""><paramtype>const unsigned int</paramtype></parameter><purpose>override needed b/c no default constructor </purpose></function>
1187<function name="save"><type>void</type><template>
1188 <template-type-parameter name="Archive"/>
1189 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="dr"><paramtype>const gregorian::date_duration::duration_rep &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>helper unction to save date_duration objects using serialization lib </purpose></function>
1190<function name="load"><type>void</type><template>
1191 <template-type-parameter name="Archive"/>
1192 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="dr"><paramtype>gregorian::date_duration::duration_rep &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>helper function to load date_duration objects using serialization lib </purpose></function>
1193<function name="load_construct_data"><type>void</type><template>
1194 <template-type-parameter name="Archive"/>
1195 </template><parameter name=""><paramtype>Archive &amp;</paramtype></parameter><parameter name="dr"><paramtype>gregorian::date_duration::duration_rep *</paramtype></parameter><parameter name=""><paramtype>const unsigned int</paramtype></parameter><purpose>override needed b/c no default constructor </purpose></function>
1196<function name="save"><type>void</type><template>
1197 <template-type-parameter name="Archive"/>
1198 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="dp"><paramtype>const gregorian::date_period &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to save gregorian::date_period objects using serialization lib. </purpose><description><para>date_period objects are broken down into 2 parts for serialization: the begining date object and the end date object </para></description></function>
1199<function name="load"><type>void</type><template>
1200 <template-type-parameter name="Archive"/>
1201 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="dp"><paramtype>gregorian::date_period &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to load gregorian::date_period objects using serialization lib. </purpose><description><para>date_period objects are broken down into 2 parts for serialization: the begining date object and the end date object </para></description></function>
1202<function name="load_construct_data"><type>void</type><template>
1203 <template-type-parameter name="Archive"/>
1204 </template><parameter name=""><paramtype>Archive &amp;</paramtype></parameter><parameter name="dp"><paramtype>gregorian::date_period *</paramtype></parameter><parameter name=""><paramtype>const unsigned int</paramtype></parameter><purpose>override needed b/c no default constructor </purpose></function>
1205<function name="save"><type>void</type><template>
1206 <template-type-parameter name="Archive"/>
1207 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="gy"><paramtype>const <classname>gregorian::greg_year</classname> &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to save <classname alt="boost::gregorian::greg_year">gregorian::greg_year</classname> objects using serialization lib. </purpose></function>
1208<function name="load"><type>void</type><template>
1209 <template-type-parameter name="Archive"/>
1210 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="gy"><paramtype><classname>gregorian::greg_year</classname> &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to load <classname alt="boost::gregorian::greg_year">gregorian::greg_year</classname> objects using serialization lib. </purpose></function>
1211<function name="load_construct_data"><type>void</type><template>
1212 <template-type-parameter name="Archive"/>
1213 </template><parameter name=""><paramtype>Archive &amp;</paramtype></parameter><parameter name="gy"><paramtype><classname>gregorian::greg_year</classname> *</paramtype></parameter><parameter name=""><paramtype>const unsigned int</paramtype></parameter><purpose>override needed b/c no default constructor </purpose></function>
1214<function name="save"><type>void</type><template>
1215 <template-type-parameter name="Archive"/>
1216 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="gm"><paramtype>const <classname>gregorian::greg_month</classname> &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to save <classname alt="boost::gregorian::greg_month">gregorian::greg_month</classname> objects using serialization lib. </purpose></function>
1217<function name="load"><type>void</type><template>
1218 <template-type-parameter name="Archive"/>
1219 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="gm"><paramtype><classname>gregorian::greg_month</classname> &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to load <classname alt="boost::gregorian::greg_month">gregorian::greg_month</classname> objects using serialization lib. </purpose></function>
1220<function name="load_construct_data"><type>void</type><template>
1221 <template-type-parameter name="Archive"/>
1222 </template><parameter name=""><paramtype>Archive &amp;</paramtype></parameter><parameter name="gm"><paramtype><classname>gregorian::greg_month</classname> *</paramtype></parameter><parameter name=""><paramtype>const unsigned int</paramtype></parameter><purpose>override needed b/c no default constructor </purpose></function>
1223<function name="save"><type>void</type><template>
1224 <template-type-parameter name="Archive"/>
1225 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="gd"><paramtype>const <classname>gregorian::greg_day</classname> &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to save <classname alt="boost::gregorian::greg_day">gregorian::greg_day</classname> objects using serialization lib. </purpose></function>
1226<function name="load"><type>void</type><template>
1227 <template-type-parameter name="Archive"/>
1228 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="gd"><paramtype><classname>gregorian::greg_day</classname> &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to load <classname alt="boost::gregorian::greg_day">gregorian::greg_day</classname> objects using serialization lib. </purpose></function>
1229<function name="load_construct_data"><type>void</type><template>
1230 <template-type-parameter name="Archive"/>
1231 </template><parameter name=""><paramtype>Archive &amp;</paramtype></parameter><parameter name="gd"><paramtype><classname>gregorian::greg_day</classname> *</paramtype></parameter><parameter name=""><paramtype>const unsigned int</paramtype></parameter><purpose>override needed b/c no default constructor </purpose></function>
1232<function name="save"><type>void</type><template>
1233 <template-type-parameter name="Archive"/>
1234 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="gd"><paramtype>const <classname>gregorian::greg_weekday</classname> &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to save <classname alt="boost::gregorian::greg_weekday">gregorian::greg_weekday</classname> objects using serialization lib. </purpose></function>
1235<function name="load"><type>void</type><template>
1236 <template-type-parameter name="Archive"/>
1237 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="gd"><paramtype><classname>gregorian::greg_weekday</classname> &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to load <classname alt="boost::gregorian::greg_weekday">gregorian::greg_weekday</classname> objects using serialization lib. </purpose></function>
1238<function name="load_construct_data"><type>void</type><template>
1239 <template-type-parameter name="Archive"/>
1240 </template><parameter name=""><paramtype>Archive &amp;</paramtype></parameter><parameter name="gd"><paramtype><classname>gregorian::greg_weekday</classname> *</paramtype></parameter><parameter name=""><paramtype>const unsigned int</paramtype></parameter><purpose>override needed b/c no default constructor </purpose></function>
1241<function name="save"><type>void</type><template>
1242 <template-type-parameter name="Archive"/>
1243 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="pd"><paramtype>const gregorian::partial_date &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to save gregorian::partial_date objects using serialization lib. </purpose><description><para>partial_date objects are broken down into 2 parts for serialization: the day (typically greg_day) and month (typically greg_month) objects </para></description></function>
1244<function name="load"><type>void</type><template>
1245 <template-type-parameter name="Archive"/>
1246 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="pd"><paramtype>gregorian::partial_date &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to load gregorian::partial_date objects using serialization lib. </purpose><description><para>partial_date objects are broken down into 2 parts for serialization: the day (greg_day) and month (greg_month) objects </para></description></function>
1247<function name="load_construct_data"><type>void</type><template>
1248 <template-type-parameter name="Archive"/>
1249 </template><parameter name=""><paramtype>Archive &amp;</paramtype></parameter><parameter name="pd"><paramtype>gregorian::partial_date *</paramtype></parameter><parameter name=""><paramtype>const unsigned int</paramtype></parameter><purpose>override needed b/c no default constructor </purpose></function>
1250<function name="save"><type>void</type><template>
1251 <template-type-parameter name="Archive"/>
1252 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="nkd"><paramtype>const gregorian::nth_kday_of_month &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to save nth_day_of_the_week_in_month objects using serialization lib. </purpose><description><para>nth_day_of_the_week_in_month objects are broken down into 3 parts for serialization: the week number, the day of the week, and the month </para></description></function>
1253<function name="load"><type>void</type><template>
1254 <template-type-parameter name="Archive"/>
1255 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="nkd"><paramtype>gregorian::nth_kday_of_month &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to load nth_day_of_the_week_in_month objects using serialization lib. </purpose><description><para>nth_day_of_the_week_in_month objects are broken down into 3 parts for serialization: the week number, the day of the week, and the month </para></description></function>
1256<function name="load_construct_data"><type>void</type><template>
1257 <template-type-parameter name="Archive"/>
1258 </template><parameter name=""><paramtype>Archive &amp;</paramtype></parameter><parameter name="nkd"><paramtype>gregorian::nth_kday_of_month *</paramtype></parameter><parameter name=""><paramtype>const unsigned int</paramtype></parameter><purpose>override needed b/c no default constructor </purpose></function>
1259<function name="save"><type>void</type><template>
1260 <template-type-parameter name="Archive"/>
1261 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="fkd"><paramtype>const gregorian::first_kday_of_month &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to save first_day_of_the_week_in_month objects using serialization lib. </purpose><description><para>first_day_of_the_week_in_month objects are broken down into 2 parts for serialization: the day of the week, and the month </para></description></function>
1262<function name="load"><type>void</type><template>
1263 <template-type-parameter name="Archive"/>
1264 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="fkd"><paramtype>gregorian::first_kday_of_month &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to load first_day_of_the_week_in_month objects using serialization lib. </purpose><description><para>first_day_of_the_week_in_month objects are broken down into 2 parts for serialization: the day of the week, and the month </para></description></function>
1265<function name="load_construct_data"><type>void</type><template>
1266 <template-type-parameter name="Archive"/>
1267 </template><parameter name=""><paramtype>Archive &amp;</paramtype></parameter><parameter name="fkd"><paramtype>gregorian::first_kday_of_month *</paramtype></parameter><parameter name=""><paramtype>const unsigned int</paramtype></parameter><purpose>override needed b/c no default constructor </purpose></function>
1268<function name="save"><type>void</type><template>
1269 <template-type-parameter name="Archive"/>
1270 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="lkd"><paramtype>const gregorian::last_kday_of_month &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to save last_day_of_the_week_in_month objects using serialization lib. </purpose><description><para>last_day_of_the_week_in_month objects are broken down into 2 parts for serialization: the day of the week, and the month </para></description></function>
1271<function name="load"><type>void</type><template>
1272 <template-type-parameter name="Archive"/>
1273 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="lkd"><paramtype>gregorian::last_kday_of_month &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to load last_day_of_the_week_in_month objects using serialization lib. </purpose><description><para>last_day_of_the_week_in_month objects are broken down into 2 parts for serialization: the day of the week, and the month </para></description></function>
1274<function name="load_construct_data"><type>void</type><template>
1275 <template-type-parameter name="Archive"/>
1276 </template><parameter name=""><paramtype>Archive &amp;</paramtype></parameter><parameter name="lkd"><paramtype>gregorian::last_kday_of_month *</paramtype></parameter><parameter name=""><paramtype>const unsigned int</paramtype></parameter><purpose>override needed b/c no default constructor </purpose></function>
1277<function name="save"><type>void</type><template>
1278 <template-type-parameter name="Archive"/>
1279 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="fkdb"><paramtype>const gregorian::first_kday_before &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to save first_day_of_the_week_before objects using serialization lib. </purpose></function>
1280<function name="load"><type>void</type><template>
1281 <template-type-parameter name="Archive"/>
1282 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="fkdb"><paramtype>gregorian::first_kday_before &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to load first_day_of_the_week_before objects using serialization lib. </purpose></function>
1283<function name="load_construct_data"><type>void</type><template>
1284 <template-type-parameter name="Archive"/>
1285 </template><parameter name=""><paramtype>Archive &amp;</paramtype></parameter><parameter name="fkdb"><paramtype>gregorian::first_kday_before *</paramtype></parameter><parameter name=""><paramtype>const unsigned int</paramtype></parameter><purpose>override needed b/c no default constructor </purpose></function>
1286<function name="save"><type>void</type><template>
1287 <template-type-parameter name="Archive"/>
1288 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="fkda"><paramtype>const gregorian::first_kday_after &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to save first_day_of_the_week_after objects using serialization lib. </purpose></function>
1289<function name="load"><type>void</type><template>
1290 <template-type-parameter name="Archive"/>
1291 </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="fkda"><paramtype>gregorian::first_kday_after &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned int</paramtype></parameter><purpose>Function to load first_day_of_the_week_after objects using serialization lib. </purpose></function>
1292<function name="load_construct_data"><type>void</type><template>
1293 <template-type-parameter name="Archive"/>
1294 </template><parameter name=""><paramtype>Archive &amp;</paramtype></parameter><parameter name="fkda"><paramtype>gregorian::first_kday_after *</paramtype></parameter><parameter name=""><paramtype>const unsigned int</paramtype></parameter><purpose>override needed b/c no default constructor </purpose></function>
1295</namespace>
1296</namespace>
b32b8144
FG
1297</header>
1298<header name="boost/date_time/gregorian/greg_weekday.hpp">
1299<namespace name="boost">
1300<namespace name="gregorian">
1301<struct name="bad_weekday"><inherit access="public">out_of_range</inherit><purpose>Exception that flags that a weekday number is incorrect. </purpose><method-group name="public member functions">
1302</method-group>
1303<constructor/>
1304</struct><class name="greg_weekday"><inherit access="public">greg_weekday_rep</inherit><purpose>Represent a day within a week (range 0==Sun to 6==Sat) </purpose><typedef name="weekday_enum"><type>boost::date_time::weekdays</type></typedef>
1305<method-group name="public member functions">
f67539c2
TL
1306<method name="as_number" cv="const"><type>BOOST_CXX14_CONSTEXPR value_type</type></method>
1307<method name="as_enum" cv="const"><type>BOOST_CXX14_CONSTEXPR weekday_enum</type></method>
1308<method name="as_short_string" cv="const"><type>const char *</type><purpose>Return a 3 digit english string of the day of week (eg: Sun) </purpose></method>
1309<method name="as_long_string" cv="const"><type>const char *</type><purpose>Return a point to a long english string representing day of week. </purpose></method>
1310<method name="as_short_wstring" cv="const"><type>const wchar_t *</type><purpose>Return a 3 digit english wchar_t string of the day of week (eg: Sun) </purpose></method>
1311<method name="as_long_wstring" cv="const"><type>const wchar_t *</type><purpose>Return a point to a long english wchar_t string representing day of week. </purpose></method>
b32b8144
FG
1312</method-group>
1313<constructor><parameter name="day_of_week_num"><paramtype>value_type</paramtype></parameter></constructor>
1314</class><typedef name="greg_weekday_policies"><type>CV::simple_exception_policy&lt; unsigned short, 0, 6, <classname>bad_weekday</classname> &gt;</type></typedef>
1315<typedef name="greg_weekday_rep"><type>CV::constrained_value&lt; greg_weekday_policies &gt;</type></typedef>
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
20effc67
TL
1387
1388
1389
b32b8144 1390
f67539c2 1391
b32b8144
FG
1392
1393
1394</namespace>
1395</namespace>
1396</header>
1397<header name="boost/date_time/gregorian/greg_year.hpp">
1398<namespace name="boost">
1399<namespace name="gregorian">
1400<struct name="bad_year"><inherit access="public">out_of_range</inherit><purpose>Exception type for gregorian year. </purpose><method-group name="public member functions">
1401</method-group>
1402<constructor/>
11fdf7f2 1403</struct><class name="greg_year"><inherit access="public">greg_year_rep</inherit><purpose>Represent a year (range 1400 - 9999) </purpose><description><para>This small class allows for simple conversion an integer value into a year for the gregorian calendar. This currently only allows a range of 1400 to 9999. Both ends of the range are a bit arbitrary at the moment, but they are the limits of current testing of the library. As such they may be increased in the future. </para></description><method-group name="public member functions">
f67539c2 1404<method name="operator value_type" cv="const"><type>BOOST_CXX14_CONSTEXPR</type></method>
b32b8144
FG
1405</method-group>
1406<constructor><parameter name="year"><paramtype>value_type</paramtype></parameter></constructor>
11fdf7f2 1407</class><typedef name="greg_year_policies"><purpose>Policy class that declares error handling gregorian year type. </purpose><type>CV::simple_exception_policy&lt; unsigned short, 1400, 9999, <classname>bad_year</classname> &gt;</type></typedef>
b32b8144
FG
1408<typedef name="greg_year_rep"><purpose>Generated representation for gregorian year. </purpose><type>CV::constrained_value&lt; greg_year_policies &gt;</type></typedef>
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
20effc67
TL
1480
1481
1482
b32b8144 1483
f67539c2 1484
b32b8144
FG
1485
1486
1487</namespace>
1488</namespace>
1489</header>
1490<header name="boost/date_time/gregorian/greg_ymd.hpp">
1491<namespace name="boost">
1492<namespace name="gregorian">
1493<typedef name="greg_year_month_day"><type>date_time::year_month_day_base&lt; <classname>greg_year</classname>, <classname>greg_month</classname>, <classname>greg_day</classname> &gt;</type></typedef>
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
20effc67
TL
1565
1566
1567
b32b8144 1568
f67539c2 1569
b32b8144
FG
1570
1571
1572</namespace>
1573</namespace>
1574</header>
1575<header name="boost/date_time/gregorian/gregorian.hpp">
1576<para>Single file header that provides overall include for all elements of the gregorian date-time system. This includes the various types defined, but also other functions for formatting and parsing. </para></header>
1577<header name="boost/date_time/gregorian/gregorian_io.hpp">
1578<namespace name="boost">
1579<namespace name="gregorian">
1580<typedef name="wperiod_formatter"><type>boost::date_time::period_formatter&lt; wchar_t &gt;</type></typedef>
1581<typedef name="period_formatter"><type>boost::date_time::period_formatter&lt; char &gt;</type></typedef>
1582<typedef name="wdate_facet"><type>boost::date_time::date_facet&lt; <classname>date</classname>, wchar_t &gt;</type></typedef>
1583<typedef name="date_facet"><type>boost::date_time::date_facet&lt; <classname>date</classname>, char &gt;</type></typedef>
1584<typedef name="period_parser"><type>boost::date_time::period_parser&lt; <classname>date</classname>, char &gt;</type></typedef>
1585<typedef name="wperiod_parser"><type>boost::date_time::period_parser&lt; <classname>date</classname>, wchar_t &gt;</type></typedef>
1586<typedef name="special_values_formatter"><type>boost::date_time::special_values_formatter&lt; char &gt;</type></typedef>
1587<typedef name="wspecial_values_formatter"><type>boost::date_time::special_values_formatter&lt; wchar_t &gt;</type></typedef>
1588<typedef name="special_values_parser"><type>boost::date_time::special_values_parser&lt; <classname>date</classname>, char &gt;</type></typedef>
1589<typedef name="wspecial_values_parser"><type>boost::date_time::special_values_parser&lt; <classname>date</classname>, wchar_t &gt;</type></typedef>
1590<typedef name="date_input_facet"><type>boost::date_time::date_input_facet&lt; <classname>date</classname>, char &gt;</type></typedef>
1591<typedef name="wdate_input_facet"><type>boost::date_time::date_input_facet&lt; <classname>date</classname>, wchar_t &gt;</type></typedef>
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
1603 <template-type-parameter name="CharT"/>
1604 <template-type-parameter name="TraitsT"/>
1605 </template><parameter name="os"><paramtype>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</paramtype></parameter><parameter name="d"><paramtype>const <classname>boost::gregorian::date</classname> &amp;</paramtype></parameter></function>
1606<function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
1607 <template-type-parameter name="CharT"/>
1608 <template-type-parameter name="Traits"/>
1609 </template><parameter name="is"><paramtype>std::basic_istream&lt; CharT, Traits &gt; &amp;</paramtype></parameter><parameter name="d"><paramtype><classname>date</classname> &amp;</paramtype></parameter><purpose>input operator for date </purpose></function>
1610<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
1611 <template-type-parameter name="CharT"/>
1612 <template-type-parameter name="TraitsT"/>
1613 </template><parameter name="os"><paramtype>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</paramtype></parameter><parameter name="dd"><paramtype>const <classname>boost::gregorian::date_duration</classname> &amp;</paramtype></parameter></function>
1614<function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
1615 <template-type-parameter name="CharT"/>
1616 <template-type-parameter name="Traits"/>
1617 </template><parameter name="is"><paramtype>std::basic_istream&lt; CharT, Traits &gt; &amp;</paramtype></parameter><parameter name="dd"><paramtype><classname>date_duration</classname> &amp;</paramtype></parameter><purpose>input operator for <classname alt="boost::gregorian::date_duration">date_duration</classname> </purpose></function>
1618<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
1619 <template-type-parameter name="CharT"/>
1620 <template-type-parameter name="TraitsT"/>
1621 </template><parameter name="os"><paramtype>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</paramtype></parameter><parameter name="dp"><paramtype>const boost::gregorian::date_period &amp;</paramtype></parameter></function>
1622<function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
1623 <template-type-parameter name="CharT"/>
1624 <template-type-parameter name="Traits"/>
1625 </template><parameter name="is"><paramtype>std::basic_istream&lt; CharT, Traits &gt; &amp;</paramtype></parameter><parameter name="dp"><paramtype>date_period &amp;</paramtype></parameter><purpose>input operator for date_period </purpose></function>
1626<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
1627 <template-type-parameter name="CharT"/>
1628 <template-type-parameter name="TraitsT"/>
1629 </template><parameter name="os"><paramtype>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</paramtype></parameter><parameter name="gm"><paramtype>const <classname>boost::gregorian::greg_month</classname> &amp;</paramtype></parameter></function>
1630<function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
1631 <template-type-parameter name="CharT"/>
1632 <template-type-parameter name="Traits"/>
1633 </template><parameter name="is"><paramtype>std::basic_istream&lt; CharT, Traits &gt; &amp;</paramtype></parameter><parameter name="m"><paramtype><classname>greg_month</classname> &amp;</paramtype></parameter><purpose>input operator for <classname alt="boost::gregorian::greg_month">greg_month</classname> </purpose></function>
1634<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
1635 <template-type-parameter name="CharT"/>
1636 <template-type-parameter name="TraitsT"/>
1637 </template><parameter name="os"><paramtype>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</paramtype></parameter><parameter name="gw"><paramtype>const <classname>boost::gregorian::greg_weekday</classname> &amp;</paramtype></parameter></function>
1638<function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
1639 <template-type-parameter name="CharT"/>
1640 <template-type-parameter name="Traits"/>
1641 </template><parameter name="is"><paramtype>std::basic_istream&lt; CharT, Traits &gt; &amp;</paramtype></parameter><parameter name="wd"><paramtype><classname>greg_weekday</classname> &amp;</paramtype></parameter><purpose>input operator for <classname alt="boost::gregorian::greg_weekday">greg_weekday</classname> </purpose></function>
1642<function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
1643 <template-type-parameter name="CharT"/>
1644 <template-type-parameter name="Traits"/>
1645 </template><parameter name="is"><paramtype>std::basic_istream&lt; CharT, Traits &gt; &amp;</paramtype></parameter><parameter name="gd"><paramtype><classname>greg_day</classname> &amp;</paramtype></parameter><purpose>input operator for <classname alt="boost::gregorian::greg_day">greg_day</classname> </purpose></function>
1646<function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
1647 <template-type-parameter name="CharT"/>
1648 <template-type-parameter name="Traits"/>
1649 </template><parameter name="is"><paramtype>std::basic_istream&lt; CharT, Traits &gt; &amp;</paramtype></parameter><parameter name="gy"><paramtype><classname>greg_year</classname> &amp;</paramtype></parameter><purpose>input operator for <classname alt="boost::gregorian::greg_year">greg_year</classname> </purpose></function>
1650<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
1651 <template-type-parameter name="CharT"/>
1652 <template-type-parameter name="TraitsT"/>
1653 </template><parameter name="os"><paramtype>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</paramtype></parameter><parameter name="pd"><paramtype>const boost::gregorian::partial_date &amp;</paramtype></parameter></function>
1654<function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
1655 <template-type-parameter name="CharT"/>
1656 <template-type-parameter name="Traits"/>
1657 </template><parameter name="is"><paramtype>std::basic_istream&lt; CharT, Traits &gt; &amp;</paramtype></parameter><parameter name="pd"><paramtype>partial_date &amp;</paramtype></parameter><purpose>input operator for partial_date </purpose></function>
1658<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
1659 <template-type-parameter name="CharT"/>
1660 <template-type-parameter name="TraitsT"/>
1661 </template><parameter name="os"><paramtype>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</paramtype></parameter><parameter name="nkd"><paramtype>const boost::gregorian::nth_day_of_the_week_in_month &amp;</paramtype></parameter></function>
1662<function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
1663 <template-type-parameter name="CharT"/>
1664 <template-type-parameter name="Traits"/>
1665 </template><parameter name="is"><paramtype>std::basic_istream&lt; CharT, Traits &gt; &amp;</paramtype></parameter><parameter name="nday"><paramtype>nth_day_of_the_week_in_month &amp;</paramtype></parameter><purpose>input operator for nth_day_of_the_week_in_month </purpose></function>
1666<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
1667 <template-type-parameter name="CharT"/>
1668 <template-type-parameter name="TraitsT"/>
1669 </template><parameter name="os"><paramtype>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</paramtype></parameter><parameter name="fkd"><paramtype>const boost::gregorian::first_day_of_the_week_in_month &amp;</paramtype></parameter></function>
1670<function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
1671 <template-type-parameter name="CharT"/>
1672 <template-type-parameter name="Traits"/>
1673 </template><parameter name="is"><paramtype>std::basic_istream&lt; CharT, Traits &gt; &amp;</paramtype></parameter><parameter name="fkd"><paramtype>first_day_of_the_week_in_month &amp;</paramtype></parameter><purpose>input operator for first_day_of_the_week_in_month </purpose></function>
1674<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
1675 <template-type-parameter name="CharT"/>
1676 <template-type-parameter name="TraitsT"/>
1677 </template><parameter name="os"><paramtype>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</paramtype></parameter><parameter name="lkd"><paramtype>const boost::gregorian::last_day_of_the_week_in_month &amp;</paramtype></parameter></function>
1678<function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
1679 <template-type-parameter name="CharT"/>
1680 <template-type-parameter name="Traits"/>
1681 </template><parameter name="is"><paramtype>std::basic_istream&lt; CharT, Traits &gt; &amp;</paramtype></parameter><parameter name="lkd"><paramtype>last_day_of_the_week_in_month &amp;</paramtype></parameter><purpose>input operator for last_day_of_the_week_in_month </purpose></function>
1682<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
1683 <template-type-parameter name="CharT"/>
1684 <template-type-parameter name="TraitsT"/>
1685 </template><parameter name="os"><paramtype>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</paramtype></parameter><parameter name="fda"><paramtype>const boost::gregorian::first_day_of_the_week_after &amp;</paramtype></parameter></function>
1686<function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
1687 <template-type-parameter name="CharT"/>
1688 <template-type-parameter name="Traits"/>
1689 </template><parameter name="is"><paramtype>std::basic_istream&lt; CharT, Traits &gt; &amp;</paramtype></parameter><parameter name="fka"><paramtype>first_day_of_the_week_after &amp;</paramtype></parameter><purpose>input operator for first_day_of_the_week_after </purpose></function>
1690<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
1691 <template-type-parameter name="CharT"/>
1692 <template-type-parameter name="TraitsT"/>
1693 </template><parameter name="os"><paramtype>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</paramtype></parameter><parameter name="fdb"><paramtype>const boost::gregorian::first_day_of_the_week_before &amp;</paramtype></parameter></function>
1694<function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
1695 <template-type-parameter name="CharT"/>
1696 <template-type-parameter name="Traits"/>
1697 </template><parameter name="is"><paramtype>std::basic_istream&lt; CharT, Traits &gt; &amp;</paramtype></parameter><parameter name="fkb"><paramtype>first_day_of_the_week_before &amp;</paramtype></parameter><purpose>input operator for first_day_of_the_week_before </purpose></function>
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
20effc67
TL
1735
1736
1737
b32b8144 1738
f67539c2 1739
b32b8144
FG
1740
1741
1742</namespace>
1743</namespace>
1744</header>
1745<header name="boost/date_time/gregorian/gregorian_types.hpp">
1746<para>Single file header that defines most of the types for the gregorian date-time system. </para><namespace name="boost">
1747<namespace name="gregorian">
1748<typedef name="date_period"><purpose>Date periods for the gregorian system. </purpose><type>date_time::period&lt; <classname>date</classname>, <classname>date_duration</classname> &gt;</type></typedef>
1749<typedef name="year_based_generator"><purpose>A unifying date_generator base type. </purpose><description><para>A unifying date_generator base type for: partial_date, nth_day_of_the_week_in_month, first_day_of_the_week_in_month, and last_day_of_the_week_in_month </para></description><type>date_time::year_based_generator&lt; <classname>date</classname> &gt;</type></typedef>
1750<typedef name="partial_date"><purpose>A date generation object type. </purpose><type>date_time::partial_date&lt; <classname>date</classname> &gt;</type></typedef>
1751<typedef name="nth_kday_of_month"><type>date_time::nth_kday_of_month&lt; <classname>date</classname> &gt;</type></typedef>
1752<typedef name="nth_day_of_the_week_in_month"><type>nth_kday_of_month</type></typedef>
1753<typedef name="first_kday_of_month"><type>date_time::first_kday_of_month&lt; <classname>date</classname> &gt;</type></typedef>
1754<typedef name="first_day_of_the_week_in_month"><type>first_kday_of_month</type></typedef>
1755<typedef name="last_kday_of_month"><type>date_time::last_kday_of_month&lt; <classname>date</classname> &gt;</type></typedef>
1756<typedef name="last_day_of_the_week_in_month"><type>last_kday_of_month</type></typedef>
1757<typedef name="first_kday_after"><type>date_time::first_kday_after&lt; <classname>date</classname> &gt;</type></typedef>
1758<typedef name="first_day_of_the_week_after"><type>first_kday_after</type></typedef>
1759<typedef name="first_kday_before"><type>date_time::first_kday_before&lt; <classname>date</classname> &gt;</type></typedef>
1760<typedef name="first_day_of_the_week_before"><type>first_kday_before</type></typedef>
1761<typedef name="day_clock"><purpose>A clock to get the current day from the local computer. </purpose><type>date_time::day_clock&lt; <classname>date</classname> &gt;</type></typedef>
1762<typedef name="date_iterator"><purpose>Base date_iterator type for gregorian types. </purpose><type>date_time::date_itr_base&lt; <classname>date</classname> &gt;</type></typedef>
1763<typedef name="day_iterator"><purpose>A day level iterator. </purpose><type>date_time::date_itr&lt; date_time::day_functor&lt; <classname>date</classname> &gt;, <classname>date</classname> &gt;</type></typedef>
1764<typedef name="week_iterator"><purpose>A week level iterator. </purpose><type>date_time::date_itr&lt; date_time::week_functor&lt; <classname>date</classname> &gt;, <classname>date</classname> &gt;</type></typedef>
1765<typedef name="month_iterator"><purpose>A month level iterator. </purpose><type>date_time::date_itr&lt; date_time::month_functor&lt; <classname>date</classname> &gt;, <classname>date</classname> &gt;</type></typedef>
1766<typedef name="year_iterator"><purpose>A year level iterator. </purpose><type>date_time::date_itr&lt; date_time::year_functor&lt; <classname>date</classname> &gt;, <classname>date</classname> &gt;</type></typedef>
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
20effc67
TL
1838
1839
1840
b32b8144 1841
f67539c2 1842
b32b8144
FG
1843
1844
1845</namespace>
1846</namespace>
1847</header>
1848<header name="boost/date_time/gregorian/parsers.hpp">
1849<namespace name="boost">
1850<namespace name="gregorian">
f67539c2
TL
1851<function name="special_value_from_string"><type>date_time::special_values</type><parameter name="s"><paramtype>const std::string &amp;</paramtype></parameter><purpose>Return special_value from string argument. </purpose><description><para>Return special_value from string argument. If argument is not one of the special value names (defined in names.hpp), return 'not_special' </para></description></function>
1852<function name="from_string"><type><classname>date</classname></type><parameter name="s"><paramtype>const std::string &amp;</paramtype></parameter><purpose>Deprecated: Use from_simple_string. </purpose></function>
1853<function name="from_simple_string"><type><classname>date</classname></type><parameter name="s"><paramtype>const std::string &amp;</paramtype></parameter><purpose>From delimited date string where with order year-month-day eg: 2002-1-25 or 2003-Jan-25 (full month name is also accepted) </purpose></function>
1854<function name="from_us_string"><type><classname>date</classname></type><parameter name="s"><paramtype>const std::string &amp;</paramtype></parameter><purpose>From delimited date string where with order year-month-day eg: 1-25-2003 or Jan-25-2003 (full month name is also accepted) </purpose></function>
1855<function name="from_uk_string"><type><classname>date</classname></type><parameter name="s"><paramtype>const std::string &amp;</paramtype></parameter><purpose>From delimited date string where with order day-month-year eg: 25-1-2002 or 25-Jan-2003 (full month name is also accepted) </purpose></function>
1856<function name="from_undelimited_string"><type><classname>date</classname></type><parameter name="s"><paramtype>const std::string &amp;</paramtype></parameter><purpose>From iso type date string where with order year-month-day eg: 20020125. </purpose></function>
b32b8144
FG
1857<function name="date_from_iso_string"><type><classname>date</classname></type><parameter name="s"><paramtype>const std::string &amp;</paramtype></parameter><purpose>From iso type date string where with order year-month-day eg: 20020125. </purpose></function>
1858<function name="from_stream"><type><classname>date</classname></type><template>
1859 <template-type-parameter name="iterator_type"/>
1860 </template><parameter name="beg"><paramtype>iterator_type</paramtype></parameter><parameter name="end"><paramtype>iterator_type</paramtype></parameter><purpose>Stream should hold a date in the form of: 2002-1-25. Month number, abbrev, or name are accepted. </purpose></function>
1861<function name="date_period_from_string"><type>date_period</type><parameter name="s"><paramtype>const std::string &amp;</paramtype></parameter><purpose>Function to parse a date_period from a string (eg: [2003-Oct-31/2003-Dec-25]) </purpose></function>
1862<function name="date_period_from_wstring"><type>date_period</type><parameter name="s"><paramtype>const std::wstring &amp;</paramtype></parameter><purpose>Function to parse a date_period from a wstring (eg: [2003-Oct-31/2003-Dec-25]) </purpose></function>
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
20effc67
TL
1924
1925
1926
b32b8144 1927
f67539c2 1928
b32b8144
FG
1929
1930
1931</namespace>
1932</namespace>
1933</header>
1934</library-reference>