Represents the amount of money that is owed and how often it occurs. More...

#include <Bill.h>

Inheritance diagram for drn::budgeting::Bill:

Collaboration diagram for drn::budgeting::Bill:

Public Member Functions
	BudgetedMoney ()
	Constructs all member variables to their empty state.

	BudgetedMoney (BudgetedMoney &&) noexcept=default

	BudgetedMoney (BudgetSource source)
	Constructs all member variables to their empty state apart from the source.

	BudgetedMoney (BudgetSource source, pecunia::Money amount, const EventFrequency &period, const ::QDate &nextOccurOn)
	Fully initialises all member variables to their supplied values.

	BudgetedMoney (const BudgetedMoney &)=default

Public Member Functions inherited from drn::budgeting::BudgetedMoney
	BudgetedMoney ()
	Constructs all member variables to their empty state.

	BudgetedMoney (BudgetedMoney &&) noexcept=default

	BudgetedMoney (BudgetSource source)
	Constructs all member variables to their empty state apart from the source.

	BudgetedMoney (BudgetSource source, pecunia::Money amount, const EventFrequency &period, const ::QDate &nextOccurOn)
	Fully initialises all member variables to their supplied values.

	BudgetedMoney (const BudgetedMoney &)=default

virtual	~BudgetedMoney ()=default

const pecunia::Money &	amount () const noexcept
	The amount expected per period for the money.

const ::QDate &	nextOccurOn () const noexcept
	The date the budgeted money item occurs on next.

bool	operator!= (const BudgetedMoney &other) const
	Inequality operator compares all members.

std::strong_ordering	operator<=> (const BudgetedMoney &) const noexcept=default

BudgetedMoney &	operator= (BudgetedMoney &&) noexcept=default

BudgetedMoney &	operator= (const BudgetedMoney &)=default

bool	operator== (const BudgetedMoney &other) const
	Equality operator compares all members.

const EventFrequency &	period () const noexcept
	The frequency at which the money event occurs.

void	rename (BudgetSource source)
	Changes the source of the money.

const BudgetSource &	source () const noexcept
	The identifier of the source for the money.

void	updateNextOccurOn ()
	Updates the next occur on date by the event frequency period.

Detailed Description

Represents the amount of money that is owed and how often it occurs.

Member Function Documentation

◆ BudgetedMoney() [1/5]

drn::budgeting::BudgetedMoney::BudgetedMoney ( )

Constructs all member variables to their empty state.

◆ BudgetedMoney() [2/5]

drn::budgeting::BudgetedMoney::BudgetedMoney ( BudgetedMoney && )

defaultnoexcept

◆ BudgetedMoney() [3/5]

drn::budgeting::BudgetedMoney::BudgetedMoney ( BudgetSource source )

explicit

Constructs all member variables to their empty state apart from the source.

Exceptions

BudgetItemError When the source is empty.

Parameters

source The source of the money budget item.

◆ BudgetedMoney() [4/5]

drn::budgeting::BudgetedMoney::BudgetedMoney	(	BudgetSource	source,
		pecunia::Money	amount,
		const EventFrequency &	period,
		const ::QDate &	nextOccurOn )

Fully initialises all member variables to their supplied values.

Exceptions

BudgetItemError	When the source is empty.
BudgetItemError	When the amount is less then zero.
BudgetItemError	When the amount is not issued in a known currency.
BudgetItemError	When the period is not known.
BudgetItemError	When the next occur date is invalid.

Parameters

source	The source of the money budget item.
amount	The amount the money is for every period.
period	The frequency period of the event for the money.
nextOccurOn	The date the money budget item last occurred on.

◆ BudgetedMoney() [5/5]

drn::budgeting::BudgetedMoney::BudgetedMoney ( const BudgetedMoney & )

default