A representation of financial institutions mapped to their names. More...

#include <BankMap.hpp>

Inheritance diagram for drn::banking::BankMap:

Collaboration diagram for drn::banking::BankMap:

Public Member Functions
	BankMap ()=default
	Constructs a default instance.
	BankMap (std::map< BankName, Bank > banks)
	Full initialisation constructor.
void	add (Bank b)
	Adds a new financial institution to the container.
void	add (const BankName &name, const accounting::AccountNumber &number, const BankAccountTypes type)
	Adds an associated account to the financial institution.
const Bank &	bank (const BankName &bn) const
	An accessor to the bank via its financial institution name.
void	close (const BankName &name)
	Marks the financial institution as closed for usage.
std::optional< Bank >	find (const accounting::AccountNumber &number) const
	Finds the bank that is associated with a given account number.
bool	hasBank (const BankName &name) const
	Determines if a financial institution is in a container.
std::set< BankName >	names () const
	Collects all the known bank names.
void	open (const BankName &name)
	Marks the financial institution as opened for usage.
void	remove (const BankName &name)
	Removes the financial institution from the container.
void	remove (const BankName &name, const accounting::AccountNumber &number)
	Removes an associated account from the financial institution.
void	rename (const BankName &original, const BankName &changed)
	Renames the financial institution in the container.
void	update (Bank b)
	Updates the financial institution information.

Friends
DRN_BANKING_EXPORT std::ostream &	operator<< (std::ostream &o, const BankMap &bm)
DRN_BANKING_EXPORT bool	operator== (const BankMap &lhs, const BankMap &rhs)

Detailed Description

A representation of financial institutions mapped to their names.

Constructor & Destructor Documentation

◆ BankMap() [1/2]

drn::banking::BankMap::BankMap ( )

default

Constructs a default instance.

This constructor initializes it with default values, ensuring it is ready to be used without prior setup.

Here is the caller graph for this function:

◆ BankMap() [2/2]

drn::banking::BankMap::BankMap ( std::map< BankName, Bank > banks )

explicit

Full initialisation constructor.

Exceptions

BankError	When a financial institution name key does not match its name.
BankError	When a financial institution uses a general ledger account number used by another financial institution.
BankError	When a financial institution uses the a default ledger account.

Parameters

banks The financial institutions.

Member Function Documentation

◆ add() [1/2]

void drn::banking::BankMap::add ( Bank b )

Adds a new financial institution to the container.

Exceptions

BankError	When the financial institution is already closed.
BankError	When the financial institution is already present in the container.

Parameters

b	The financial institution to add.

◆ add() [2/2]

void drn::banking::BankMap::add	(	const BankName &	name,
		const accounting::AccountNumber &	number,
		const BankAccountTypes	type )

Adds an associated account to the financial institution.

Exceptions

BankError	When the financial institution does not exist.
BankError	When the account number is already associated with another financial institution.

Parameters

name	The name of the financial institution.
number	The account number to add the association.

◆ bank()

const Bank & drn::banking::BankMap::bank ( const BankName & bn ) const

nodiscard

An accessor to the bank via its financial institution name.

Exceptions

BankError When the financial institution name does not exist.

Parameters

bn	The name of the financial institution to look-up.

Returns: The requested financial institution.

◆ close()

void drn::banking::BankMap::close ( const BankName & name )

Marks the financial institution as closed for usage.

Exceptions

BankError When the financial institution does not exist.

Parameters

name	The name of the financial institution.

◆ find()

std::optional< Bank > drn::banking::BankMap::find ( const accounting::AccountNumber & number ) const

nodiscard

Finds the bank that is associated with a given account number.

Parameters

number The account number to find the associated bank.

Returns: Gives the found associated bank, or an empty optional.

◆ hasBank()

bool drn::banking::BankMap::hasBank ( const BankName & name ) const

nodiscard

Determines if a financial institution is in a container.

Parameters

name	The name of the financial institution to check.

Returns: Gives true when the institution is present, false otherwise.

◆ names()

std::set< BankName > drn::banking::BankMap::names ( ) const

nodiscard

Collects all the known bank names.

◆ open()

void drn::banking::BankMap::open ( const BankName & name )

Marks the financial institution as opened for usage.

Exceptions

BankError When the financial institution does not exist.

Parameters

name	The name of the financial institution.

◆ remove() [1/2]

void drn::banking::BankMap::remove ( const BankName & name )

Removes the financial institution from the container.

Exceptions

BankError When the financial institution does not exist.

Parameters

name	The name of the financial institution.

◆ remove() [2/2]

void drn::banking::BankMap::remove	(	const BankName &	name,
		const accounting::AccountNumber &	number )

Removes an associated account from the financial institution.

Exceptions

BankError	When the financial institution does not exist.
BankError	When the financial institution does not have the account.

Parameters

name	The name of the financial institution.
number	The account number to remove the association.

◆ rename()

void drn::banking::BankMap::rename	(	const BankName &	original,
		const BankName &	changed )

Renames the financial institution in the container.

Exceptions

BankError	When the financial institution name to be changed does not exist.
BankError	When the financial institution name to be changed and to be changed into are the same.
BankError	When the financial institution name to change to already exists.

Parameters

original	The name of the financial institution.
changed	The changed name of the financial institution.

◆ update()

void drn::banking::BankMap::update ( Bank b )

Updates the financial institution information.

Exceptions

BankError	When the financial institution does not exist.
BankError	When the financial institution to update is closed.
BankError	When the financial institution's associated account ledger is already associated with another financial institution.

Parameters

b	The financial institution to update.

◆ operator<<

DRN_BANKING_EXPORT std::ostream & operator<<	(	std::ostream &	o,
		const BankMap &	bm )

friend

◆ operator==

DRN_BANKING_EXPORT bool operator==	(	const BankMap &	lhs,
		const BankMap &	rhs )

friend

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ BankMap() [1/2]

◆ BankMap() [2/2]

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ bank()

◆ close()

◆ find()

◆ hasBank()

◆ names()

◆ open()

◆ remove() [1/2]

◆ remove() [2/2]

◆ rename()

◆ update()

Friends And Related Symbol Documentation

◆ operator<<

◆ operator==