Boost.Locale
boost::locale::period Namespace Reference

Namespace that contains various types for manipulation with dates. More...

Namespaces

namespace  marks
 This namespace holds a enum of various period types like era, year, month, etc..
 

Classes

class  period_type
 This class holds a type that represents certain period of time like year, hour, second and so on. More...
 

Functions

period_type invalid ()
 Get period_type for: special invalid value, should not be used directly.
 
period_type era ()
 Get period_type for: Era i.e. AC, BC in Gregorian and Julian calendar, range [0,1].
 
period_type year ()
 Get period_type for: Year, it is calendar specific, for example 2011 in Gregorian calendar.
 
period_type extended_year ()
 Get period_type for: Extended year for Gregorian/Julian calendars, where 1 BC == 0, 2 BC == -1.
 
period_type month ()
 Get period_type for: The month of year, calendar specific, in Gregorian [0..11].
 
period_type day ()
 Get period_type for: The day of month, calendar specific, in Gregorian [1..31].
 
period_type day_of_year ()
 Get period_type for: The number of day in year, starting from 1, in Gregorian [1..366].
 
period_type day_of_week ()
 
period_type day_of_week_in_month ()
 
period_type day_of_week_local ()
 Get period_type for: Local day of week, for example in France Monday is 1, in US Sunday is 1, [1..7].
 
period_type hour ()
 Get period_type for: 24 clock hour [0..23].
 
period_type hour_12 ()
 Get period_type for: 12 clock hour [0..11].
 
period_type am_pm ()
 Get period_type for: am or pm marker [0..1].
 
period_type minute ()
 Get period_type for: minute [0..59].
 
period_type second ()
 Get period_type for: second [0..59].
 
period_type week_of_year ()
 Get period_type for: The week number in the year.
 
period_type week_of_month ()
 Get period_type for: The week number within current month.
 
period_type first_day_of_week ()
 Get period_type for: First day of week, constant, for example Sunday in US = 1, Monday in France = 2.
 
date_time_period era (int v)
 Get date_time_period for: Era i.e. AC, BC in Gregorian and Julian calendar, range [0,1].
 
date_time_period year (int v)
 Get date_time_period for: Year, it is calendar specific, for example 2011 in Gregorian calendar.
 
date_time_period extended_year (int v)
 Get date_time_period for: Extended year for Gregorian/Julian calendars, where 1 BC == 0, 2 BC == -1.
 
date_time_period month (int v)
 Get date_time_period for: The month of year, calendar specific, in Gregorian [0..11].
 
date_time_period day (int v)
 Get date_time_period for: The day of month, calendar specific, in Gregorian [1..31].
 
date_time_period day_of_year (int v)
 Get date_time_period for: The number of day in year, starting from 1, in Gregorian [1..366].
 
date_time_period day_of_week (int v)
 
date_time_period day_of_week_in_month (int v)
 
date_time_period day_of_week_local (int v)
 Get date_time_period for: Local day of week, for example in France Monday is 1, in US Sunday is 1, [1..7].
 
date_time_period hour (int v)
 Get date_time_period for: 24 clock hour [0..23].
 
date_time_period hour_12 (int v)
 Get date_time_period for: 12 clock hour [0..11].
 
date_time_period am_pm (int v)
 Get date_time_period for: am or pm marker [0..1].
 
date_time_period minute (int v)
 Get date_time_period for: minute [0..59].
 
date_time_period second (int v)
 Get date_time_period for: second [0..59].
 
date_time_period week_of_year (int v)
 Get date_time_period for: The week number in the year.
 
date_time_period week_of_month (int v)
 Get date_time_period for: The week number within current month.
 
date_time_period first_day_of_week (int v)
 Get date_time_period for: First day of week, constant, for example Sunday in US = 1, Monday in France = 2.
 
date_time_period january ()
 Get predefined constant for January.
 
date_time_period february ()
 Get predefined constant for February.
 
date_time_period march ()
 Get predefined constant for March.
 
date_time_period april ()
 Get predefined constant for April.
 
date_time_period may ()
 Get predefined constant for May.
 
date_time_period june ()
 Get predefined constant for June.
 
date_time_period july ()
 Get predefined constant for July.
 
date_time_period august ()
 Get predefined constant for August.
 
date_time_period september ()
 Get predefined constant for September.
 
date_time_period october ()
 Get predefined constant for October.
 
date_time_period november ()
 Get predefined constant for November.
 
date_time_period december ()
 Get predefined constant for December.
 
date_time_period sunday ()
 Get predefined constant for Sunday.
 
date_time_period monday ()
 Get predefined constant for Monday.
 
date_time_period tuesday ()
 Get predefined constant for Tuesday.
 
date_time_period wednesday ()
 Get predefined constant for Wednesday.
 
date_time_period thursday ()
 Get predefined constant for Thursday.
 
date_time_period friday ()
 Get predefined constant for Friday.
 
date_time_period saturday ()
 Get predefined constant for Saturday.
 
date_time_period am ()
 Get predefined constant for AM (Ante Meridiem)
 
date_time_period pm ()
 Get predefined constant for PM (Post Meridiem)
 
date_time_period operator+ (period::period_type f)
 convert period_type to date_time_period(f,1)
 
date_time_period operator- (period::period_type f)
 convert period_type to date_time_period(f,-1)
 
template<typename T >
date_time_period operator* (period::period_type f, T v)
 Create date_time_period of type f with value v.
 
template<typename T >
date_time_period operator* (T v, period::period_type f)
 Create date_time_period of type f with value v.
 
template<typename T >
date_time_period operator* (T v, date_time_period f)
 Create date_time_period of type f with value v.
 
template<typename T >
date_time_period operator* (date_time_period f, T v)
 Create date_time_period of type f with value v.
 
int era (const date_time &dt)
 Extract from date_time numerical value of Era i.e. AC, BC in Gregorian and Julian calendar, range [0,1].
 
int year (const date_time &dt)
 
int extended_year (const date_time &dt)
 
int month (const date_time &dt)
 Extract from date_time numerical value of The month of year, calendar specific, in Gregorian [0..11].
 
int day (const date_time &dt)
 Extract from date_time numerical value of The day of month, calendar specific, in Gregorian [1..31].
 
int day_of_year (const date_time &dt)
 Extract from date_time numerical value of The number of day in year, starting from 1, in Gregorian [1..366].
 
int day_of_week (const date_time &dt)
 
int day_of_week_in_month (const date_time &dt)
 
int day_of_week_local (const date_time &dt)
 
int hour (const date_time &dt)
 Extract from date_time numerical value of 24 clock hour [0..23].
 
int hour_12 (const date_time &dt)
 Extract from date_time numerical value of 12 clock hour [0..11].
 
int am_pm (const date_time &dt)
 Extract from date_time numerical value of am or pm marker [0..1].
 
int minute (const date_time &dt)
 Extract from date_time numerical value of minute [0..59].
 
int second (const date_time &dt)
 Extract from date_time numerical value of second [0..59].
 
int week_of_year (const date_time &dt)
 Extract from date_time numerical value of The week number in the year.
 
int week_of_month (const date_time &dt)
 Extract from date_time numerical value of The week number within current month.
 
int first_day_of_week (const date_time &dt)
 
int era (const date_time_duration &dt)
 
int year (const date_time_duration &dt)
 Extract from date_time_duration numerical value of duration in years.
 
int extended_year (const date_time_duration &dt)
 
int month (const date_time_duration &dt)
 Extract from date_time_duration numerical value of duration in months.
 
int day (const date_time_duration &dt)
 Extract from date_time_duration numerical value of duration in days of month.
 
int day_of_year (const date_time_duration &dt)
 Extract from date_time_duration numerical value of duration in days of year.
 
int day_of_week (const date_time_duration &dt)
 Extract from date_time_duration numerical value of duration in days of week.
 
int day_of_week_in_month (const date_time_duration &dt)
 
int day_of_week_local (const date_time_duration &dt)
 Extract from date_time_duration numerical value of duration in local day of week.
 
int hour (const date_time_duration &dt)
 Extract from date_time_duration numerical value of duration in hours.
 
int hour_12 (const date_time_duration &dt)
 Extract from date_time_duration numerical value of duration in 12 clock hours.
 
int am_pm (const date_time_duration &dt)
 Extract from date_time_duration numerical value of duration in am or pm markers.
 
int minute (const date_time_duration &dt)
 Extract from date_time_duration numerical value of duration in minutes.
 
int second (const date_time_duration &dt)
 Extract from date_time_duration numerical value of duration in seconds.
 
int week_of_year (const date_time_duration &dt)
 Extract from date_time_duration numerical value of duration in the week number in the year.
 
int week_of_month (const date_time_duration &dt)
 Extract from date_time_duration numerical value of duration in The week number within current month.
 
int first_day_of_week (const date_time_duration &dt)
 Extract from date_time_duration numerical value of duration in the first day of week.
 

Detailed Description

Namespace that contains various types for manipulation with dates.

Function Documentation

◆ day_of_week() [1/3]

period_type boost::locale::period::day_of_week ( )
inline

Get period_type for: Day of week, Sunday=1, Monday=2,..., Saturday=7.

Note that updating this value respects local day of week, so for example, If first day of week is Monday and the current day is Tuesday then setting the value to Sunday (1) would forward the date by 5 days forward and not backward by two days as it could be expected if the numbers were taken as is.

◆ day_of_week() [2/3]

int boost::locale::period::day_of_week ( const date_time dt)
inline

Extract from date_time numerical value of Day of week, Sunday=1, Monday=2,..., Saturday=7.

Note that updating this value respects local day of week, so for example, If first day of week is Monday and the current day is Tuesday then setting the value to Sunday (1) would forward the date by 5 days forward and not backward by two days as it could be expected if the numbers were taken as is.

◆ day_of_week() [3/3]

date_time_period boost::locale::period::day_of_week ( int  v)
inline

Get date_time_period for: Day of week, Sunday=1, Monday=2,..., Saturday=7.

Note that updating this value respects local day of week, so for example, If first day of week is Monday and the current day is Tuesday then setting the value to Sunday (1) would forward the date by 5 days forward and not backward by two days as it could be expected if the numbers were taken as is.

◆ day_of_week_in_month() [1/4]

period_type boost::locale::period::day_of_week_in_month ( )
inline

Get period_type for: Original number of the day of the week in month. For example 1st Sunday, 2nd Sunday, etc. in Gregorian [1..5]

◆ day_of_week_in_month() [2/4]

int boost::locale::period::day_of_week_in_month ( const date_time dt)
inline

Extract from date_time numerical value of Original number of the day of the week in month. For example 1st Sunday, 2nd Sunday, etc. in Gregorian [1..5]

◆ day_of_week_in_month() [3/4]

int boost::locale::period::day_of_week_in_month ( const date_time_duration dt)
inline

Extract from date_time_duration numerical value of duration in original number of the day of the week in month

◆ day_of_week_in_month() [4/4]

date_time_period boost::locale::period::day_of_week_in_month ( int  v)
inline

Get date_time_period for: Original number of the day of the week in month. For example 1st Sunday, 2nd Sunday, etc. in Gregorian [1..5]

◆ day_of_week_local()

int boost::locale::period::day_of_week_local ( const date_time dt)
inline

Extract from date_time numerical value of Local day of week, for example in France Monday is 1, in US Sunday is 1, [1..7]

◆ era()

int boost::locale::period::era ( const date_time_duration dt)
inline

Extract from date_time_duration numerical value of duration in Era i.e. AC, BC in Gregorian and Julian calendar, range [0,1]

◆ extended_year() [1/2]

int boost::locale::period::extended_year ( const date_time dt)
inline

Extract from date_time numerical value of Extended year for Gregorian/Julian calendars, where 1 BC == 0, 2 BC == -1.

◆ extended_year() [2/2]

int boost::locale::period::extended_year ( const date_time_duration dt)
inline

Extract from date_time_duration numerical value of duration in extended years (for Gregorian/Julian calendars, where 1 BC == 0, 2 BC == -1).

◆ first_day_of_week()

int boost::locale::period::first_day_of_week ( const date_time dt)
inline

Extract from date_time numerical value of First day of week, constant, for example Sunday in US = 1, Monday in France = 2

◆ year()

int boost::locale::period::year ( const date_time dt)
inline

Extract from date_time numerical value of Year, it is calendar specific, for example 2011 in Gregorian calendar.