drn::surveying Namespace Reference

Classes
struct	BalanceChange
	A representation of a balance change for an account. More...
class	CompletedSurvey
	Represents a completed survey of a reconciled bank account, including distributions and associated data. It is primarily designed to allow tracking and managing a bank account’s reconciled state with respect to budgeting and distribution of account balance amount. More...
class	CompletedSurveys
	Represents a collection of completed surveys identified by a bank account. It provides extended functionality built upon a map-like structure for efficient access and modification of surveys. More...
class	DistributedAmount
	This represents a budget item's amount distributed in a survey. More...
struct	IndexedIncreaseDecreases
	A container for indexing increases and decreases by a unique identifier. More...
class	MappingSurvey
	A representation of a survey account mapping before being completed. More...
struct	SurveyError

Functions
DRN_SURVEYING_EXPORT bool	isDistributable (const budgeting::BudgetItemTypes &type, const budgeting::EventFrequency &period)
	Determines if a budget item is distributable in a survey.
DRN_SURVEYING_EXPORT bool	operator!= (const CompletedSurveys &lhs, const CompletedSurveys &rhs)
	Compares two collections of completed surveys to determine if they are not equivalent. This function evaluates whether the sets of surveys are not identical based on the survey data and the associated bank accounts.
DRN_SURVEYING_EXPORT::QDebug	operator<< (::QDebug out, const CompletedSurvey &data)
	Full object Qt stream insertion operator.
DRN_SURVEYING_EXPORT::QDebug	operator<< (::QDebug out, const CompletedSurveys &data)
	Full object Qt stream insertion operator.
DRN_SURVEYING_EXPORT std::ostream &	operator<< (std::ostream &out, const BalanceChange &bc)
	Full object stream insertion operator.
DRN_SURVEYING_EXPORT std::ostream &	operator<< (std::ostream &out, const CompletedSurvey &data)
	Full object standard stream insertion operator.
DRN_SURVEYING_EXPORT std::ostream &	operator<< (std::ostream &out, const CompletedSurveys &data)
	Full object standard stream insertion operator.
DRN_SURVEYING_EXPORT std::ostream &	operator<< (std::ostream &out, const DistributedAmount &data)
	Full object stream insertion operator.
DRN_SURVEYING_EXPORT bool	operator== (const CompletedSurveys &lhs, const CompletedSurveys &rhs)
	Compares two collections of completed surveys to determine if they are equivalent. This function evaluates whether the sets of surveys are identical based on the survey data and the associated bank accounts.

Variables
constexpr double	maximumBalanceWindow {100.0}
	The maximum percentage rate for a survey balance window.
constexpr double	minimumBalanceWindow {0.0}
	The minimum percentage rate for a survey balance window.

Function Documentation

isDistributable()

DRN_SURVEYING_EXPORT bool drn::surveying::isDistributable	(	const budgeting::BudgetItemTypes &	type,
		const budgeting::EventFrequency &	period )

Determines if a budget item is distributable in a survey.

Parameters

type	The type of the budget item.
period	The frequency at which the budget item occurs.

Returns

Gives true when the budget item is distributable, otherwise false.

Here is the call graph for this function:

Here is the caller graph for this function:

operator!=()

DRN_SURVEYING_EXPORT bool drn::surveying::operator!=	(	const CompletedSurveys &	lhs,
		const CompletedSurveys &	rhs )

Compares two collections of completed surveys to determine if they are not equivalent. This function evaluates whether the sets of surveys are not identical based on the survey data and the associated bank accounts.

Parameters

lhs	The first collection of completed surveys for comparison.
rhs	The second collection of completed surveys for comparison.

Returns

Returns false if both collections are equivalent, meaning they contain the same surveys corresponding to the same bank accounts. Otherwise, returns true.

Here is the call graph for this function:

Here is the caller graph for this function:

operator<<() [1/6]

DRN_SURVEYING_EXPORT::QDebug drn::surveying::operator<<	(	::QDebug	out,
		const CompletedSurvey &	data )

Full object Qt stream insertion operator.

Parameters

out	The stream to place the data into.
data	The data to place into the stream.

Returns

The modified stream after insertion.

Here is the call graph for this function:

operator<<() [2/6]

DRN_SURVEYING_EXPORT::QDebug drn::surveying::operator<<	(	::QDebug	out,
		const CompletedSurveys &	data )

Full object Qt stream insertion operator.

Parameters

out	The stream to place the data into.
data	The data to place into the stream.

Returns

The modified stream after insertion.

Here is the call graph for this function:

operator<<() [3/6]

DRN_SURVEYING_EXPORT std::ostream & drn::surveying::operator<<	(	std::ostream &	out,
		const BalanceChange &	bc )

Full object stream insertion operator.

Parameters

out	The stream to place the data into.
bc	The data to place into the stream.

Returns

The modified stream after insertion.

operator<<() [4/6]

DRN_SURVEYING_EXPORT std::ostream & drn::surveying::operator<<	(	std::ostream &	out,
		const CompletedSurvey &	data )

Full object standard stream insertion operator.

Parameters

out	The stream to place the data into.
data	The data to place into the stream.

Returns

The modified stream after insertion.

Here is the call graph for this function:

Here is the caller graph for this function:

operator<<() [5/6]

DRN_SURVEYING_EXPORT std::ostream & drn::surveying::operator<<	(	std::ostream &	out,
		const CompletedSurveys &	data )

Full object standard stream insertion operator.

Parameters

out	The stream to place the data into.
data	The data to place into the stream.

Returns

The modified stream after insertion.

Here is the call graph for this function:

operator<<() [6/6]

DRN_SURVEYING_EXPORT std::ostream & drn::surveying::operator<<	(	std::ostream &	out,
		const DistributedAmount &	data )

Full object stream insertion operator.

Parameters

out	The stream to place the data into.
data	The data to place into the stream.

Returns

The modified stream after insertion.

operator==()

DRN_SURVEYING_EXPORT bool drn::surveying::operator==	(	const CompletedSurveys &	lhs,
		const CompletedSurveys &	rhs )

Compares two collections of completed surveys to determine if they are equivalent. This function evaluates whether the sets of surveys are identical based on the survey data and the associated bank accounts.

Parameters

lhs	The first collection of completed surveys for comparison.
rhs	The second collection of completed surveys for comparison.

Returns

Returns true if both collections are equivalent, meaning they contain the same surveys corresponding to the same bank accounts. Otherwise, returns false.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

maximumBalanceWindow

double drn::surveying::maximumBalanceWindow {100.0}

constexpr

The maximum percentage rate for a survey balance window.

minimumBalanceWindow

double drn::surveying::minimumBalanceWindow {0.0}

constexpr

The minimum percentage rate for a survey balance window.