gregorian_autodoc.xml 56 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664
  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. <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>
  6. <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>
  7. </namespace>
  8. </namespace>
  9. </header>
  10. <header name="boost/date_time/gregorian/formatters.hpp">
  11. <namespace name="boost">
  12. <namespace name="gregorian">
  13. <function name="to_simple_string_type"><type>std::basic_string&lt; charT &gt;</type><template>
  14. <template-type-parameter name="charT"/>
  15. </template><parameter name="d"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter></function>
  16. <function name="to_simple_string_type"><type>std::basic_string&lt; charT &gt;</type><template>
  17. <template-type-parameter name="charT"/>
  18. </template><parameter name="d"><paramtype>const date_period &amp;</paramtype></parameter></function>
  19. <function name="to_iso_string_type"><type>std::basic_string&lt; charT &gt;</type><template>
  20. <template-type-parameter name="charT"/>
  21. </template><parameter name="d"><paramtype>const date_period &amp;</paramtype></parameter></function>
  22. <function name="to_iso_extended_string_type"><type>std::basic_string&lt; charT &gt;</type><template>
  23. <template-type-parameter name="charT"/>
  24. </template><parameter name="d"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter></function>
  25. <function name="to_iso_string_type"><type>std::basic_string&lt; charT &gt;</type><template>
  26. <template-type-parameter name="charT"/>
  27. </template><parameter name="d"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter></function>
  28. <function name="to_sql_string_type"><type>std::basic_string&lt; charT &gt;</type><template>
  29. <template-type-parameter name="charT"/>
  30. </template><parameter name="d"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter></function>
  31. <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>
  32. <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>
  33. <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>
  34. <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>
  35. <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>
  36. <function name="to_sql_wstring"><type>std::wstring</type><parameter name="d"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter></function>
  37. </namespace>
  38. </namespace>
  39. </header>
  40. <header name="boost/date_time/gregorian/formatters_limited.hpp">
  41. <namespace name="boost">
  42. <namespace name="gregorian">
  43. <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>
  44. <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>
  45. <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>
  46. <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>
  47. <function name="to_iso_string"><type>std::string</type><parameter name="d"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter><purpose>Convert to iso standard string YYYYMMDD. Example: 20021231. </purpose></function>
  48. <function name="to_sql_string"><type>std::string</type><parameter name="d"><paramtype>const <classname>date</classname> &amp;</paramtype></parameter></function>
  49. </namespace>
  50. </namespace>
  51. </header>
  52. <header name="boost/date_time/gregorian/greg_calendar.hpp">
  53. <namespace name="boost">
  54. <namespace name="gregorian">
  55. <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>
  56. <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>
  57. <typedef name="date_rep_type"><purpose>Internal date representation that handles infinity, not a date. </purpose><type>fancy_date_rep</type></typedef>
  58. <typedef name="date_traits_type"><purpose>Date rep implements the traits stuff as well. </purpose><type>fancy_date_rep</type></typedef>
  59. </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>
  60. </namespace>
  61. </namespace>
  62. </header>
  63. <header name="boost/date_time/gregorian/greg_date.hpp">
  64. <namespace name="boost">
  65. <namespace name="gregorian">
  66. <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>
  67. <typedef name="month_type"><type>gregorian_calendar::month_type</type></typedef>
  68. <typedef name="day_type"><type>gregorian_calendar::day_type</type></typedef>
  69. <typedef name="day_of_year_type"><type>gregorian_calendar::day_of_year_type</type></typedef>
  70. <typedef name="ymd_type"><type>gregorian_calendar::ymd_type</type></typedef>
  71. <typedef name="date_rep_type"><type>gregorian_calendar::date_rep_type</type></typedef>
  72. <typedef name="date_int_type"><type>gregorian_calendar::date_int_type</type></typedef>
  73. <typedef name="duration_type"><type><classname>date_duration</classname></type></typedef>
  74. <method-group name="public member functions">
  75. <method name="julian_day" cv="const"><type>date_int_type</type><purpose>Return the Julian Day number for the date. </purpose></method>
  76. <method name="day_of_year" cv="const"><type>day_of_year_type</type><purpose>Return the day of year 1..365 or 1..366 (for leap year) </purpose></method>
  77. <method name="modjulian_day" cv="const"><type>date_int_type</type><purpose>Return the Modified Julian Day number for the date. </purpose></method>
  78. <method name="week_number" cv="const"><type>int</type><purpose>Return the iso 8601 week number 1..53. </purpose></method>
  79. <method name="day_number" cv="const"><type>date_int_type</type><purpose>Return the day number from the calendar. </purpose></method>
  80. <method name="end_of_month" cv="const"><type><classname>date</classname></type><purpose>Return the last day of the current month. </purpose></method>
  81. </method-group>
  82. <constructor><purpose>Default constructor constructs with not_a_date_time. </purpose></constructor>
  83. <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>
  84. <constructor specifiers="explicit"><parameter name="ymd"><paramtype>const ymd_type &amp;</paramtype></parameter><purpose>Constructor from a ymd_type structure. </purpose></constructor>
  85. <constructor specifiers="explicit"><parameter name="rhs"><paramtype>const date_int_type &amp;</paramtype></parameter><purpose>Needed copy constructor. </purpose></constructor>
  86. <constructor specifiers="explicit"><parameter name="rhs"><paramtype>date_rep_type</paramtype></parameter><purpose>Needed copy constructor. </purpose></constructor>
  87. <constructor specifiers="explicit"><parameter name="sv"><paramtype>special_values</paramtype></parameter><purpose>Constructor for infinities, not a date, max and min date. </purpose></constructor>
  88. </class>
  89. </namespace>
  90. </namespace>
  91. </header>
  92. <header name="boost/date_time/gregorian/greg_day.hpp">
  93. <namespace name="boost">
  94. <namespace name="gregorian">
  95. <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">
  96. </method-group>
  97. <constructor/>
  98. <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>
  99. </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">
  100. <method name="as_number" cv="const"><type>value_type</type></method>
  101. <method name="conversion-operator" cv="const"><type>value_type</type></method>
  102. </method-group>
  103. <constructor><parameter name="day_of_month"><paramtype>value_type</paramtype></parameter></constructor>
  104. </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>
  105. <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>
  106. </namespace>
  107. </namespace>
  108. </header>
  109. <header name="boost/date_time/gregorian/greg_day_of_year.hpp">
  110. <namespace name="boost">
  111. <namespace name="gregorian">
  112. <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">
  113. </method-group>
  114. <constructor/>
  115. </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>
  116. <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>
  117. </namespace>
  118. </namespace>
  119. </header>
  120. <header name="boost/date_time/gregorian/greg_duration.hpp">
  121. <namespace name="boost">
  122. <namespace name="gregorian">
  123. <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>
  124. <method-group name="public member functions">
  125. <method name="operator==" cv="const"><type>bool</type><parameter name="rhs"><paramtype>const <classname>date_duration</classname> &amp;</paramtype></parameter></method>
  126. <method name="operator!=" cv="const"><type>bool</type><parameter name="rhs"><paramtype>const <classname>date_duration</classname> &amp;</paramtype></parameter></method>
  127. <method name="operator&lt;" cv="const"><type>bool</type><parameter name="rhs"><paramtype>const <classname>date_duration</classname> &amp;</paramtype></parameter></method>
  128. <method name="operator&gt;" cv="const"><type>bool</type><parameter name="rhs"><paramtype>const <classname>date_duration</classname> &amp;</paramtype></parameter></method>
  129. <method name="operator&lt;=" cv="const"><type>bool</type><parameter name="rhs"><paramtype>const <classname>date_duration</classname> &amp;</paramtype></parameter></method>
  130. <method name="operator&gt;=" cv="const"><type>bool</type><parameter name="rhs"><paramtype>const <classname>date_duration</classname> &amp;</paramtype></parameter></method>
  131. <method name="operator-="><type><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>
  132. <method name="operator+="><type><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>
  133. <method name="operator-" cv="const"><type><classname>date_duration</classname></type><purpose>unary- Allows for dd = -date_duration(2); -&gt; dd == -2 </purpose></method>
  134. <method name="operator/="><type><classname>date_duration</classname> &amp;</type><parameter name="divisor"><paramtype>int</paramtype></parameter><purpose>Division operations on a duration with an integer. </purpose></method>
  135. </method-group>
  136. <constructor specifiers="explicit"><parameter name="day_count"><paramtype>duration_rep</paramtype><default>0</default></parameter><purpose>Construct from a day count. </purpose></constructor>
  137. <constructor><parameter name="sv"><paramtype>date_time::special_values</paramtype></parameter><purpose>construct from special_values </purpose></constructor>
  138. <constructor><parameter name="other"><paramtype>const <classname>date_duration</classname> &amp;</paramtype></parameter><purpose>Copy constructor. </purpose></constructor>
  139. <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>
  140. <method-group name="public static functions">
  141. <method name="unit" specifiers="static"><type><classname>date_duration</classname></type><purpose>Returns the smallest duration – used by to calculate 'end'. </purpose></method>
  142. </method-group>
  143. </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>
  144. <typedef name="days"><purpose>Shorthand for <classname alt="boost::gregorian::date_duration">date_duration</classname>. </purpose><type><classname>date_duration</classname></type></typedef>
  145. </namespace>
  146. </namespace>
  147. </header>
  148. <header name="boost/date_time/gregorian/greg_duration_types.hpp">
  149. <namespace name="boost">
  150. <namespace name="gregorian">
  151. <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>
  152. <typedef name="int_rep"><type>date_time::int_adapter&lt; int &gt;</type></typedef>
  153. <typedef name="month_adjustor_type"><type>date_time::month_functor&lt; <classname>date_type</classname> &gt;</type></typedef>
  154. </struct><class name="weeks_duration"><inherit access="public">boost::gregorian::date_duration</inherit><method-group name="public member functions">
  155. </method-group>
  156. <constructor><parameter name="w"><paramtype>duration_rep</paramtype></parameter></constructor>
  157. <constructor><parameter name="sv"><paramtype>date_time::special_values</paramtype></parameter></constructor>
  158. </class><typedef name="months"><type>date_time::months_duration&lt; <classname>greg_durations_config</classname> &gt;</type></typedef>
  159. <typedef name="years"><type>date_time::years_duration&lt; <classname>greg_durations_config</classname> &gt;</type></typedef>
  160. <typedef name="weeks"><type><classname>weeks_duration</classname></type></typedef>
  161. </namespace>
  162. </namespace>
  163. </header>
  164. <header name="boost/date_time/gregorian/greg_facet.hpp">
  165. <namespace name="boost">
  166. <namespace name="gregorian">
  167. <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>
  168. <typedef name="special_value_enum"><type>boost::date_time::special_values</type></typedef>
  169. <typedef name="month_enum"><type>boost::gregorian::months_of_year</type></typedef>
  170. <typedef name="weekday_enum"><type>boost::date_time::weekdays</type></typedef>
  171. </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>
  172. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
  173. <template-type-parameter name="charT"/>
  174. <template-type-parameter name="traits"/>
  175. </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>
  176. <listitem><para>string values for the month (eg: Jan, Feb, Mar) (default: English)</para>
  177. </listitem><listitem><para>string values for special values (eg: not-a-date-time) (default: English)</para>
  178. </listitem><listitem><para>selection of long, short strings, or numerical month representation (default: short string)</para>
  179. </listitem><listitem><para>month day year order (default yyyy-mmm-dd) </para>
  180. </listitem></itemizedlist>
  181. </para></description></function>
  182. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
  183. <template-type-parameter name="charT"/>
  184. <template-type-parameter name="traits"/>
  185. </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>
  186. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
  187. <template-type-parameter name="charT"/>
  188. <template-type-parameter name="traits"/>
  189. </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>
  190. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
  191. <template-type-parameter name="charT"/>
  192. <template-type-parameter name="traits"/>
  193. </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>
  194. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
  195. <template-type-parameter name="charT"/>
  196. <template-type-parameter name="traits"/>
  197. </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>
  198. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
  199. <template-type-parameter name="charT"/>
  200. <template-type-parameter name="traits"/>
  201. </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>
  202. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
  203. <template-type-parameter name="charT"/>
  204. <template-type-parameter name="traits"/>
  205. </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>
  206. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
  207. <template-type-parameter name="charT"/>
  208. <template-type-parameter name="traits"/>
  209. </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>
  210. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
  211. <template-type-parameter name="charT"/>
  212. <template-type-parameter name="traits"/>
  213. </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>
  214. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
  215. <template-type-parameter name="charT"/>
  216. <template-type-parameter name="traits"/>
  217. </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>
  218. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
  219. <template-type-parameter name="charT"/>
  220. <template-type-parameter name="traits"/>
  221. </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>
  222. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; charT &gt; &amp;</type><template>
  223. <template-type-parameter name="charT"/>
  224. </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>
  225. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; charT &gt; &amp;</type><template>
  226. <template-type-parameter name="charT"/>
  227. </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>
  228. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; charT &gt; &amp;</type><template>
  229. <template-type-parameter name="charT"/>
  230. </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>
  231. <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>
  232. <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>
  233. <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>
  234. <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>
  235. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; charT &gt; &amp;</type><template>
  236. <template-type-parameter name="charT"/>
  237. </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>
  238. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; charT &gt; &amp;</type><template>
  239. <template-type-parameter name="charT"/>
  240. </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>
  241. </namespace>
  242. </namespace>
  243. </header>
  244. <header name="boost/date_time/gregorian/greg_month.hpp">
  245. <namespace name="boost">
  246. <namespace name="gregorian">
  247. <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">
  248. </method-group>
  249. <constructor/>
  250. </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>
  251. <typedef name="month_map_type"><type>std::map&lt; std::string, unsigned short &gt;</type></typedef>
  252. <typedef name="month_map_ptr_type"><type>boost::shared_ptr&lt; month_map_type &gt;</type></typedef>
  253. <method-group name="public member functions">
  254. <method name="conversion-operator" cv="const"><type>value_type</type><purpose>Convert the value back to a short. </purpose></method>
  255. <method name="as_number" cv="const"><type>value_type</type><purpose>Returns month as number from 1 to 12. </purpose></method>
  256. <method name="as_enum" cv="const"><type>month_enum</type></method>
  257. <method name="as_short_string" cv="const"><type>const char *</type></method>
  258. <method name="as_long_string" cv="const"><type>const char *</type></method>
  259. <method name="as_short_wstring" cv="const"><type>const wchar_t *</type></method>
  260. <method name="as_long_wstring" cv="const"><type>const wchar_t *</type></method>
  261. <method name="as_short_string" cv="const"><type>const char *</type><parameter name=""><paramtype>char</paramtype></parameter></method>
  262. <method name="as_long_string" cv="const"><type>const char *</type><parameter name=""><paramtype>char</paramtype></parameter></method>
  263. <method name="as_short_string" cv="const"><type>const wchar_t *</type><parameter name=""><paramtype>wchar_t</paramtype></parameter></method>
  264. <method name="as_long_string" cv="const"><type>const wchar_t *</type><parameter name=""><paramtype>wchar_t</paramtype></parameter></method>
  265. </method-group>
  266. <constructor><parameter name="theMonth"><paramtype>month_enum</paramtype></parameter><purpose>Construct a month from the months_of_year enumeration. </purpose></constructor>
  267. <constructor><parameter name="theMonth"><paramtype>value_type</paramtype></parameter><purpose>Construct from a short value. </purpose></constructor>
  268. <method-group name="public static functions">
  269. <method name="get_month_map_ptr" specifiers="static"><type>month_map_ptr_type</type><purpose>Shared pointer to a map of Month strings (Names &amp; Abbrev) &amp; numbers. </purpose></method>
  270. </method-group>
  271. </class><typedef name="months_of_year"><type>date_time::months_of_year</type></typedef>
  272. <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>
  273. <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>
  274. </namespace>
  275. </namespace>
  276. </header>
  277. <header name="boost/date_time/gregorian/greg_serialize.hpp">
  278. </header>
  279. <header name="boost/date_time/gregorian/greg_weekday.hpp">
  280. <namespace name="boost">
  281. <namespace name="gregorian">
  282. <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">
  283. </method-group>
  284. <constructor/>
  285. </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>
  286. <method-group name="public member functions">
  287. <method name="as_number" cv="const"><type>value_type</type></method>
  288. <method name="as_short_string" cv="const"><type>const char *</type></method>
  289. <method name="as_long_string" cv="const"><type>const char *</type></method>
  290. <method name="as_short_wstring" cv="const"><type>const wchar_t *</type></method>
  291. <method name="as_long_wstring" cv="const"><type>const wchar_t *</type></method>
  292. <method name="as_enum" cv="const"><type>weekday_enum</type></method>
  293. </method-group>
  294. <constructor><parameter name="day_of_week_num"><paramtype>value_type</paramtype></parameter></constructor>
  295. </class><typedef name="greg_weekday_policies"><type>CV::simple_exception_policy&lt; unsigned short, 0, 6, <classname>bad_weekday</classname> &gt;</type></typedef>
  296. <typedef name="greg_weekday_rep"><type>CV::constrained_value&lt; greg_weekday_policies &gt;</type></typedef>
  297. </namespace>
  298. </namespace>
  299. </header>
  300. <header name="boost/date_time/gregorian/greg_year.hpp">
  301. <namespace name="boost">
  302. <namespace name="gregorian">
  303. <struct name="bad_year"><inherit access="public">out_of_range</inherit><purpose>Exception type for gregorian year. </purpose><method-group name="public member functions">
  304. </method-group>
  305. <constructor/>
  306. </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">
  307. <method name="conversion-operator" cv="const"><type>value_type</type></method>
  308. </method-group>
  309. <constructor><parameter name="year"><paramtype>value_type</paramtype></parameter></constructor>
  310. </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>
  311. <typedef name="greg_year_rep"><purpose>Generated representation for gregorian year. </purpose><type>CV::constrained_value&lt; greg_year_policies &gt;</type></typedef>
  312. </namespace>
  313. </namespace>
  314. </header>
  315. <header name="boost/date_time/gregorian/greg_ymd.hpp">
  316. <namespace name="boost">
  317. <namespace name="gregorian">
  318. <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>
  319. </namespace>
  320. </namespace>
  321. </header>
  322. <header name="boost/date_time/gregorian/gregorian.hpp">
  323. <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>
  324. <header name="boost/date_time/gregorian/gregorian_io.hpp">
  325. <namespace name="boost">
  326. <namespace name="gregorian">
  327. <typedef name="wperiod_formatter"><type>boost::date_time::period_formatter&lt; wchar_t &gt;</type></typedef>
  328. <typedef name="period_formatter"><type>boost::date_time::period_formatter&lt; char &gt;</type></typedef>
  329. <typedef name="wdate_facet"><type>boost::date_time::date_facet&lt; <classname>date</classname>, wchar_t &gt;</type></typedef>
  330. <typedef name="date_facet"><type>boost::date_time::date_facet&lt; <classname>date</classname>, char &gt;</type></typedef>
  331. <typedef name="period_parser"><type>boost::date_time::period_parser&lt; <classname>date</classname>, char &gt;</type></typedef>
  332. <typedef name="wperiod_parser"><type>boost::date_time::period_parser&lt; <classname>date</classname>, wchar_t &gt;</type></typedef>
  333. <typedef name="special_values_formatter"><type>boost::date_time::special_values_formatter&lt; char &gt;</type></typedef>
  334. <typedef name="wspecial_values_formatter"><type>boost::date_time::special_values_formatter&lt; wchar_t &gt;</type></typedef>
  335. <typedef name="special_values_parser"><type>boost::date_time::special_values_parser&lt; <classname>date</classname>, char &gt;</type></typedef>
  336. <typedef name="wspecial_values_parser"><type>boost::date_time::special_values_parser&lt; <classname>date</classname>, wchar_t &gt;</type></typedef>
  337. <typedef name="date_input_facet"><type>boost::date_time::date_input_facet&lt; <classname>date</classname>, char &gt;</type></typedef>
  338. <typedef name="wdate_input_facet"><type>boost::date_time::date_input_facet&lt; <classname>date</classname>, wchar_t &gt;</type></typedef>
  339. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
  340. <template-type-parameter name="CharT"/>
  341. <template-type-parameter name="TraitsT"/>
  342. </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>
  343. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
  344. <template-type-parameter name="CharT"/>
  345. <template-type-parameter name="Traits"/>
  346. </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>
  347. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
  348. <template-type-parameter name="CharT"/>
  349. <template-type-parameter name="TraitsT"/>
  350. </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>
  351. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
  352. <template-type-parameter name="CharT"/>
  353. <template-type-parameter name="Traits"/>
  354. </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>
  355. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
  356. <template-type-parameter name="CharT"/>
  357. <template-type-parameter name="TraitsT"/>
  358. </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>
  359. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
  360. <template-type-parameter name="CharT"/>
  361. <template-type-parameter name="Traits"/>
  362. </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>
  363. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
  364. <template-type-parameter name="CharT"/>
  365. <template-type-parameter name="TraitsT"/>
  366. </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>
  367. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
  368. <template-type-parameter name="CharT"/>
  369. <template-type-parameter name="Traits"/>
  370. </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>
  371. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
  372. <template-type-parameter name="CharT"/>
  373. <template-type-parameter name="TraitsT"/>
  374. </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>
  375. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
  376. <template-type-parameter name="CharT"/>
  377. <template-type-parameter name="Traits"/>
  378. </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>
  379. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
  380. <template-type-parameter name="CharT"/>
  381. <template-type-parameter name="Traits"/>
  382. </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>
  383. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
  384. <template-type-parameter name="CharT"/>
  385. <template-type-parameter name="Traits"/>
  386. </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>
  387. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
  388. <template-type-parameter name="CharT"/>
  389. <template-type-parameter name="TraitsT"/>
  390. </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>
  391. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
  392. <template-type-parameter name="CharT"/>
  393. <template-type-parameter name="Traits"/>
  394. </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>
  395. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
  396. <template-type-parameter name="CharT"/>
  397. <template-type-parameter name="TraitsT"/>
  398. </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>
  399. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
  400. <template-type-parameter name="CharT"/>
  401. <template-type-parameter name="Traits"/>
  402. </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>
  403. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
  404. <template-type-parameter name="CharT"/>
  405. <template-type-parameter name="TraitsT"/>
  406. </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>
  407. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
  408. <template-type-parameter name="CharT"/>
  409. <template-type-parameter name="Traits"/>
  410. </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>
  411. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
  412. <template-type-parameter name="CharT"/>
  413. <template-type-parameter name="TraitsT"/>
  414. </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>
  415. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
  416. <template-type-parameter name="CharT"/>
  417. <template-type-parameter name="Traits"/>
  418. </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>
  419. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
  420. <template-type-parameter name="CharT"/>
  421. <template-type-parameter name="TraitsT"/>
  422. </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>
  423. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
  424. <template-type-parameter name="CharT"/>
  425. <template-type-parameter name="Traits"/>
  426. </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>
  427. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
  428. <template-type-parameter name="CharT"/>
  429. <template-type-parameter name="TraitsT"/>
  430. </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>
  431. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
  432. <template-type-parameter name="CharT"/>
  433. <template-type-parameter name="Traits"/>
  434. </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>
  435. </namespace>
  436. </namespace>
  437. </header>
  438. <header name="boost/date_time/gregorian/gregorian_types.hpp">
  439. <para>Single file header that defines most of the types for the gregorian date-time system. </para><namespace name="boost">
  440. <namespace name="gregorian">
  441. <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>
  442. <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>
  443. <typedef name="partial_date"><purpose>A date generation object type. </purpose><type>date_time::partial_date&lt; <classname>date</classname> &gt;</type></typedef>
  444. <typedef name="nth_kday_of_month"><type>date_time::nth_kday_of_month&lt; <classname>date</classname> &gt;</type></typedef>
  445. <typedef name="nth_day_of_the_week_in_month"><type>nth_kday_of_month</type></typedef>
  446. <typedef name="first_kday_of_month"><type>date_time::first_kday_of_month&lt; <classname>date</classname> &gt;</type></typedef>
  447. <typedef name="first_day_of_the_week_in_month"><type>first_kday_of_month</type></typedef>
  448. <typedef name="last_kday_of_month"><type>date_time::last_kday_of_month&lt; <classname>date</classname> &gt;</type></typedef>
  449. <typedef name="last_day_of_the_week_in_month"><type>last_kday_of_month</type></typedef>
  450. <typedef name="first_kday_after"><type>date_time::first_kday_after&lt; <classname>date</classname> &gt;</type></typedef>
  451. <typedef name="first_day_of_the_week_after"><type>first_kday_after</type></typedef>
  452. <typedef name="first_kday_before"><type>date_time::first_kday_before&lt; <classname>date</classname> &gt;</type></typedef>
  453. <typedef name="first_day_of_the_week_before"><type>first_kday_before</type></typedef>
  454. <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>
  455. <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>
  456. <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>
  457. <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>
  458. <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>
  459. <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>
  460. </namespace>
  461. </namespace>
  462. </header>
  463. <header name="boost/date_time/gregorian/parsers.hpp">
  464. <namespace name="boost">
  465. <namespace name="gregorian">
  466. <function name="special_value_from_string"><type>BOOST_DATE_TIME_DECL 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 src/gregorian/names.hpp), return 'not_special' </para></description></function>
  467. <function name="from_string"><type><classname>date</classname></type><parameter name="s"><paramtype>std::string</paramtype></parameter><purpose>Deprecated: Use from_simple_string. </purpose></function>
  468. <function name="from_simple_string"><type><classname>date</classname></type><parameter name="s"><paramtype>std::string</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>
  469. <function name="from_us_string"><type><classname>date</classname></type><parameter name="s"><paramtype>std::string</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>
  470. <function name="from_uk_string"><type><classname>date</classname></type><parameter name="s"><paramtype>std::string</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>
  471. <function name="from_undelimited_string"><type><classname>date</classname></type><parameter name="s"><paramtype>std::string</paramtype></parameter><purpose>From iso type date string where with order year-month-day eg: 20020125. </purpose></function>
  472. <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>
  473. <function name="from_stream"><type><classname>date</classname></type><template>
  474. <template-type-parameter name="iterator_type"/>
  475. </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>
  476. <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>
  477. <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>
  478. </namespace>
  479. </namespace>
  480. </header>
  481. </library-reference>