drn::budgeting::GoalMap Struct Reference

Maps all the savings goals to their source. More...

#include <GoalMap.hpp>

Inheritance diagram for drn::budgeting::GoalMap:

Collaboration diagram for drn::budgeting::GoalMap:

Additional Inherited Members
Public Member Functions inherited from drn::budgeting::BudgetedMoneyMap< Goal >
	BudgetedMoneyMap (std::map< BudgetSource, Goal > monies={})
	Full initialisation constructor using the provided budgeted monies.
void	add (Goal added)
	Places the new budgeted money into the budgeted monies indexed by its source.
const_iterator	begin () const
	Provides an iterator to the beginning of the budgeted monies map.
const_iterator	end () const
	Provides an iterator to the end of the budgeted monies map.
bool	has (const BudgetSource &source) const
	Determines if a specific budgeted money exists within the budgeted monies.
std::strong_ordering	operator<=> (const BudgetedMoneyMap &other) const noexcept
	Performs a three-way comparison between this BudgetedMoneyMap and another.
bool	operator== (const BudgetedMoneyMap &) const noexcept=default
void	remove (const BudgetSource &source)
	Removes an budgeted money from the budgeted monies.
void	rename (const BudgetSource &original, BudgetSource changed)
std::set< BudgetSource >	sources () const
	An accessor to all the known budgeted money sources.
pecunia::Money	total (const pecunia::Currency &code, const EventFrequency period) const
	Calculates the total amount of budgeted monies.
void	update (Goal updated)
	Changes the budgeted money to the newly supplied one indexed by the source of the budgeted money. When the new budgeted money is not in the same currency as the existing entry, the new budgeted money will replace the existing entry, i.e. no currency conversions will take place.

Detailed Description

Maps all the savings goals to their source.