DuxReiNummariae 1.0.0-alpha.23
Simple and powerful budgeting application
 
Loading...
Searching...
No Matches
drn::navigation::BankAccountCode Class Referencefinal

#include <BankAccountCode.hpp>

Collaboration diagram for drn::navigation::BankAccountCode:

Public Member Functions

 BankAccountCode ()
 Default constructor for the BankAccountCode class.
 
 BankAccountCode (banking::BankAccount bankAccount, accounting::AccountCode code, pecunia::Currency issuedIn)
 Full constructor for a bank account.
 
const accounting::AccountCodeaccount () const noexcept
 An accessor to the financial institution account.
 
const banking::BankNamebank () const noexcept
 An accessor to the name of the financial institution.
 
const banking::AccountNumberBankTypebankAccountType () const noexcept
 An accessor to the limited information about the bank account.
 
const pecunia::Currency & issuedIn () const noexcept
 An accessor to the currency used in the financial institution's account.
 
std::strong_ordering operator<=> (const BankAccountCode &other) const noexcept
 A three-way comparator based upon the financial institution's account and account currency.
 
const banking::BankAccountTypes & supportedAccountType () const noexcept
 An accessor to the financial institution's account type.
 

Detailed Description

Represents a bank account that allows showing account details, such as account number, balance currency, and account holder information.

Constructor & Destructor Documentation

◆ BankAccountCode() [1/2]

drn::navigation::BankAccountCode::BankAccountCode ( )

Default constructor for the BankAccountCode class.

This constructor initializes an instance of the BankAccountCode class with default values. No specific bank account, account code, or currency is assigned when this constructor is used.

Here is the caller graph for this function:

◆ BankAccountCode() [2/2]

drn::navigation::BankAccountCode::BankAccountCode ( banking::BankAccount bankAccount,
accounting::AccountCode code,
pecunia::Currency issuedIn )

Full constructor for a bank account.

Exceptions
ErrorIf the account number of the bank account does not match the account code.
Parameters
bankAccountThe bank account that is associated with the account code.
codeThe account code that is associated with the bank account.
issuedInThe currency in which the account is issued in.
Here is the call graph for this function:

Member Function Documentation

◆ account()

const accounting::AccountCode & drn::navigation::BankAccountCode::account ( ) const
nodiscardnoexcept

An accessor to the financial institution account.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ bank()

const banking::BankName & drn::navigation::BankAccountCode::bank ( ) const
nodiscardnoexcept

An accessor to the name of the financial institution.

◆ bankAccountType()

const banking::AccountNumberBankType & drn::navigation::BankAccountCode::bankAccountType ( ) const
nodiscardnoexcept

An accessor to the limited information about the bank account.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ issuedIn()

const pecunia::Currency & drn::navigation::BankAccountCode::issuedIn ( ) const
nodiscardnoexcept

An accessor to the currency used in the financial institution's account.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator<=>()

std::strong_ordering drn::navigation::BankAccountCode::operator<=> ( const BankAccountCode & other) const
nodiscardnoexcept

A three-way comparator based upon the financial institution's account and account currency.

Parameters
otherThe other object to compare against.
Returns
The relationship between the current object and the one supplied.
Here is the call graph for this function:

◆ supportedAccountType()

const banking::BankAccountTypes & drn::navigation::BankAccountCode::supportedAccountType ( ) const
nodiscardnoexcept

An accessor to the financial institution's account type.

Here is the call graph for this function:
Here is the caller graph for this function: