#include <times.h>

Inherits equality_comparable< date_interval_t >.

Public Member Functions
optional< date_t >	begin () const
	date_interval_t ()
	date_interval_t (const date_interval_t &other)
	date_interval_t (const string &str)
void	dump (std::ostream &out)
optional< date_t >	end () const
bool	find_period (const date_t &date=(epoch ? epoch->date() :boost::gregorian::day_clock::local_day()), const bool align_intervals=false, const bool allow_shift=true)
	Find the current or next period containing date.
optional< date_t >	inclusive_end () const
bool	is_valid () const
	operator bool () const
date_interval_t &	operator++ ()
bool	operator< (const date_interval_t &other) const
bool	operator== (const date_interval_t &other) const
void	parse (const string &str)
void	resolve_end ()
void	stabilize (const optional< date_t > &date=none, bool align_intervals=false)
bool	within_period (const date_t &date=(epoch ? epoch->date() :boost::gregorian::day_clock::local_day()))
	~date_interval_t () throw ()

Static Public Member Functions
static date_t	add_duration (const date_t &date, const date_duration_t &duration)
static date_t	subtract_duration (const date_t &date, const date_duration_t &duration)

Public Attributes
bool	aligned
optional< date_duration_t >	duration
optional< date_t >	end_of_duration
optional< date_t >	finish
optional< date_t >	next
optional< date_specifier_or_range_t >	range
bool	since_specified = false
optional< date_t >	start

Detailed Description

Definition at line 439 of file times.h.

Constructor & Destructor Documentation

◆ date_interval_t() [1/3]

ledger::date_interval_t::date_interval_t ( )

inlineexplicit

Definition at line 457 of file times.h.

References aligned, date_interval_t(), and TRACE_CTOR.

Referenced by date_interval_t(), date_interval_t(), date_interval_t(), operator++(), operator<(), operator==(), and ~date_interval_t().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ date_interval_t() [2/3]

ledger::date_interval_t::date_interval_t ( const string & str )

inline

Definition at line 460 of file times.h.

References aligned, date_interval_t(), parse(), and TRACE_CTOR.

Here is the call graph for this function:

◆ date_interval_t() [3/3]

ledger::date_interval_t::date_interval_t ( const date_interval_t & other )

inline

Definition at line 464 of file times.h.

References aligned, date_interval_t(), duration, end_of_duration, finish, next, range, since_specified, start, and TRACE_CTOR.

Here is the call graph for this function:

◆ ~date_interval_t()

ledger::date_interval_t::~date_interval_t	(		)
throw	(	)

inline

Definition at line 475 of file times.h.

References date_interval_t(), and TRACE_DTOR.

Here is the call graph for this function:

Member Function Documentation

◆ add_duration()

date_t ledger::date_interval_t::add_duration	(	const date_t &	date,
		const date_duration_t &	duration )

static

References duration.

◆ begin()

optional< date_t > ledger::date_interval_t::begin ( ) const

inline

Definition at line 492 of file times.h.

References range, and start.

◆ dump()

void ledger::date_interval_t::dump ( std::ostream & out )

◆ end()

optional< date_t > ledger::date_interval_t::end ( ) const

inline

Definition at line 495 of file times.h.

References finish, and range.

◆ find_period()

bool ledger::date_interval_t::find_period	(	const date_t &	date = (epoch ? epoch->date() :boost::gregorian::day_clock::local_day()),
		const bool	align_intervals = false,
		const bool	allow_shift = true )

Find the current or next period containing date.

Returns false if no such period can be found. If allow_shift is true, the default, then the interval may be shifted in time to find the period.

Referenced by within_period().

Here is the caller graph for this function:

◆ inclusive_end()

optional< date_t > ledger::date_interval_t::inclusive_end ( ) const

inline

Definition at line 518 of file times.h.

References end_of_duration.

◆ is_valid()

bool ledger::date_interval_t::is_valid ( ) const

inline

Definition at line 504 of file times.h.

References start.

Referenced by operator bool().

Here is the caller graph for this function:

◆ operator bool()

ledger::date_interval_t::operator bool ( ) const

inline

Definition at line 488 of file times.h.

References is_valid().

Here is the call graph for this function:

◆ operator++()

date_interval_t & ledger::date_interval_t::operator++ ( )

References date_interval_t().

Here is the call graph for this function:

◆ operator<()

bool ledger::date_interval_t::operator< ( const date_interval_t & other ) const

inline

Definition at line 483 of file times.h.

References date_interval_t(), and start.

Here is the call graph for this function:

◆ operator==()

bool ledger::date_interval_t::operator== ( const date_interval_t & other ) const

inline

Definition at line 479 of file times.h.

References date_interval_t(), and start.

Here is the call graph for this function:

◆ parse()

void ledger::date_interval_t::parse ( const string & str )

Referenced by date_interval_t().

Here is the caller graph for this function:

◆ resolve_end()

void ledger::date_interval_t::resolve_end ( )

◆ stabilize()

void ledger::date_interval_t::stabilize	(	const optional< date_t > &	date = none,
		bool	align_intervals = false )

◆ subtract_duration()

date_t ledger::date_interval_t::subtract_duration	(	const date_t &	date,
		const date_duration_t &	duration )

static

References duration.

◆ within_period()

bool ledger::date_interval_t::within_period ( const date_t & date = (epoch ? epoch->date() : boost::gregorian::day_clock::local_day()) )

inline

Definition at line 514 of file times.h.

References find_period().

Here is the call graph for this function:

Member Data Documentation

◆ aligned

bool ledger::date_interval_t::aligned

Definition at line 451 of file times.h.

Referenced by date_interval_t(), date_interval_t(), and date_interval_t().

◆ duration

optional<date_duration_t> ledger::date_interval_t::duration

Definition at line 453 of file times.h.

Referenced by add_duration(), date_interval_t(), and subtract_duration().

◆ end_of_duration

optional<date_t> ledger::date_interval_t::end_of_duration

Definition at line 454 of file times.h.

Referenced by date_interval_t(), and inclusive_end().

◆ finish

optional<date_t> ledger::date_interval_t::finish

Definition at line 450 of file times.h.

Referenced by date_interval_t(), and end().

◆ next

optional<date_t> ledger::date_interval_t::next

Definition at line 452 of file times.h.

Referenced by date_interval_t().

◆ range

optional<date_specifier_or_range_t> ledger::date_interval_t::range

Definition at line 447 of file times.h.

Referenced by begin(), date_interval_t(), and end().

◆ since_specified

bool ledger::date_interval_t::since_specified = false

Definition at line 455 of file times.h.

Referenced by date_interval_t().

◆ start

optional<date_t> ledger::date_interval_t::start

Definition at line 449 of file times.h.

Referenced by begin(), date_interval_t(), is_valid(), operator<(), and operator==().

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

times.h

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ date_interval_t() [1/3]

◆ date_interval_t() [2/3]

◆ date_interval_t() [3/3]

◆ ~date_interval_t()

Member Function Documentation

◆ add_duration()

◆ begin()

◆ dump()

◆ end()

◆ find_period()

◆ inclusive_end()

◆ is_valid()

◆ operator bool()

◆ operator++()

◆ operator<()

◆ operator==()

◆ parse()

◆ resolve_end()

◆ stabilize()

◆ subtract_duration()

◆ within_period()

Member Data Documentation

◆ aligned

◆ duration

◆ end_of_duration

◆ finish

◆ next

◆ range

◆ since_specified

◆ start