Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::locale::date_time_period Struct Reference

This class represents a pair of period_type and the integer values that describes its amount. More...

#include <date_time.hpp>

Collaboration diagram for boost::locale::date_time_period:

Public Member Functions

date_time_period operator+ () const
 Operator + returns copy of itself. More...
 
date_time_period operator- () const
 Operator -, switches the sign of period. More...
 
 date_time_period (period::period_type f=period::period_type(), int v=1)
 Constructor that creates date_time_period from period_type f and a value v – default 1. More...
 

Public Attributes

period::period_type type
 The type of period, i.e. era, year, day etc. More...
 
int value
 The value the actual number of periods. More...
 

Detailed Description

This class represents a pair of period_type and the integer values that describes its amount.

For example 3 days or 4 years.

Usually obtained as product of period_type and integer or my calling a representative functions For example day()*3 == date_time_period(day(),3) == day(3)

Constructor & Destructor Documentation

boost::locale::date_time_period::date_time_period ( period::period_type  f = period::period_type(),
int  v = 1 
)
inline

Constructor that creates date_time_period from period_type f and a value v – default 1.

Referenced by operator-().

Member Function Documentation

date_time_period boost::locale::date_time_period::operator+ ( ) const
inline

Operator + returns copy of itself.

date_time_period boost::locale::date_time_period::operator- ( ) const
inline

Operator -, switches the sign of period.

References date_time_period().

Member Data Documentation

period::period_type boost::locale::date_time_period::type

The type of period, i.e. era, year, day etc.

Referenced by boost::locale::period::operator*().

int boost::locale::date_time_period::value

The value the actual number of periods.

Referenced by boost::locale::period::operator*().


The documentation for this struct was generated from the following file: