amount_dcc.h File Reference

Description

DCC Amount.

Object type amount_dcc.

Functions
ta_e_result_code_t	ta_amount_dcc_get_value (ta_object_t amount, int64_t *value)
	DCC Amount in minor units. More...
ta_e_result_code_t	ta_amount_dcc_get_decimal_value (ta_object_t amount, double *value)
	DCC Amount in major units as double precision floating point value. More...
ta_e_result_code_t	ta_amount_dcc_get_currency (ta_object_t amount, ta_e_currency_t *currency)
	DCC Currency. More...
ta_e_result_code_t	ta_amount_dcc_get_exponent (ta_object_t amount, int *exponent)
	DCC Exponent. More...
ta_e_result_code_t	ta_amount_dcc_get_rate (ta_object_t amount, int *rate)
	DCC Rate in minor units. More...
ta_e_result_code_t	ta_amount_dcc_get_rate_exponent (ta_object_t amount, int *exponent)
	DCC rate exponent. More...
ta_e_result_code_t	ta_amount_dcc_get_rate_decimal (ta_object_t amount, double *rate)
	DCC Rate in major units as double precision floating point value. More...
ta_e_result_code_t	ta_amount_dcc_get_markup (ta_object_t amount, int *markup)
	DCC Markup in minor units. More...
ta_e_result_code_t	ta_amount_dcc_get_markup_exponent (ta_object_t amount, int *exponent)
	DCC Markup exponent. More...
ta_e_result_code_t	ta_amount_dcc_get_markup_decimal (ta_object_t amount, double *markup)
	DCC Markup in major units as double precision floating point value. More...
ta_e_result_code_t	ta_amount_dcc_get_rate_regulated (ta_object_t amount, int *rate)
	DCC Rate in minor units. More...
ta_e_result_code_t	ta_amount_dcc_get_rate_exponent_regulated (ta_object_t amount, int *exponent)
	DCC rate exponent. More...
ta_e_result_code_t	ta_amount_dcc_get_rate_decimal_regulated (ta_object_t amount, double *rate)
	DCC Rate in major units as double precision floating point value. More...
ta_e_result_code_t	ta_amount_dcc_get_markup_regulated (ta_object_t amount, int *markup)
	DCC Markup in minor units. More...
ta_e_result_code_t	ta_amount_dcc_get_markup_exponent_regulated (ta_object_t amount, int *exponent)
	DCC Markup exponent. More...
ta_e_result_code_t	ta_amount_dcc_get_markup_decimal_regulated (ta_object_t amount, double *markup)
	DCC Markup in major units as double precision floating point value. More...

Function Documentation

ta_amount_dcc_get_currency()

ta_e_result_code_t ta_amount_dcc_get_currency	(	ta_object_t	amount,
		ta_e_currency_t *	currency
	)

DCC Currency.

Parameters

[in]	amount	Object instance of type amount_dcc.
[out]	currency	Pointer to variable to write currency to.

Return values

ta_c_rc_ok	Value written to currency.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount is not of type amount_dcc.
ta_c_rc_invalid_argument	currency is null-pointer.

ta_amount_dcc_get_decimal_value()

ta_e_result_code_t ta_amount_dcc_get_decimal_value	(	ta_object_t	amount,
		double *	value
	)

DCC Amount in major units as double precision floating point value.

Note

Double precision floating point values can not provide the same level of numerical accuracy as int64_t. It is recommended to use the integer based methods.

Parameters

[in]	amount	Object instance of type amount_dcc.
[out]	value	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Value written to value.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount is not of type amount_dcc.
ta_c_rc_invalid_argument	value is null-pointer.

ta_amount_dcc_get_exponent()

ta_e_result_code_t ta_amount_dcc_get_exponent	(	ta_object_t	amount,
		int *	exponent
	)

DCC Exponent.

Parameters

[in]	amount	Object instance of type amount_dcc.
[out]	exponent	Pointer to variable to write exponent to.

Return values

ta_c_rc_ok	Value written to exponent.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount is not of type amount_dcc.
ta_c_rc_invalid_argument	exponent is null-pointer.

ta_amount_dcc_get_markup()

ta_e_result_code_t ta_amount_dcc_get_markup	(	ta_object_t	amount,
		int *	markup
	)

DCC Markup in minor units.

Parameters

[in]	amount	Object instance of type amount_dcc.
[out]	markup	Pointer to variable to write markup to.

Return values

ta_c_rc_ok	Value written to markup.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount is not of type amount_dcc.
ta_c_rc_invalid_argument	markup is null-pointer.

ta_amount_dcc_get_markup_decimal()

ta_e_result_code_t ta_amount_dcc_get_markup_decimal	(	ta_object_t	amount,
		double *	markup
	)

DCC Markup in major units as double precision floating point value.

DCC markup exponent has been applied already to the value. Returned value can be used as-is without the need to adjust for the exponent.

Note

Double precision floating point values can not provide the same level of numerical accuracy as int64_t. It is recommended to use the integer based methods.

Parameters

[in]	amount	Object instance of type amount_dcc.
[out]	markup	Pointer to variable to write markup to.

Return values

ta_c_rc_ok	Value written to markup.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount is not of type amount_dcc.
ta_c_rc_invalid_argument	markup is null-pointer.

ta_amount_dcc_get_markup_decimal_regulated()

ta_e_result_code_t ta_amount_dcc_get_markup_decimal_regulated	(	ta_object_t	amount,
		double *	markup
	)

DCC Markup in major units as double precision floating point value.

DCC markup exponent has been applied already to the value. Returned value can be used as-is without the need to adjust for the exponent.

Note

Double precision floating point values can not provide the same level of numerical accuracy as int64_t. It is recommended to use the integer based methods.

Parameters

[in]	amount	Object instance of type amount_dcc.
[out]	markup	Pointer to variable to write markup to.

Return values

ta_c_rc_ok	Value written to markup.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount is not of type amount_dcc.
ta_c_rc_invalid_argument	markup is null-pointer.

ta_amount_dcc_get_markup_exponent()

ta_e_result_code_t ta_amount_dcc_get_markup_exponent	(	ta_object_t	amount,
		int *	exponent
	)

DCC Markup exponent.

Parameters

[in]	amount	Object instance of type amount_dcc.
[out]	exponent	Pointer to variable to write markup exponent to.

Return values

ta_c_rc_ok	Value written to exponent.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount is not of type amount_dcc.
ta_c_rc_invalid_argument	exponent is null-pointer.

ta_amount_dcc_get_markup_exponent_regulated()

ta_e_result_code_t ta_amount_dcc_get_markup_exponent_regulated	(	ta_object_t	amount,
		int *	exponent
	)

DCC Markup exponent.

Parameters

[in]	amount	Object instance of type amount_dcc.
[out]	exponent	Pointer to variable to write markup exponent to.

Return values

ta_c_rc_ok	Value written to exponent.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount is not of type amount_dcc.
ta_c_rc_invalid_argument	exponent is null-pointer.

ta_amount_dcc_get_markup_regulated()

ta_e_result_code_t ta_amount_dcc_get_markup_regulated	(	ta_object_t	amount,
		int *	markup
	)

DCC Markup in minor units.

Parameters

[in]	amount	Object instance of type amount_dcc.
[out]	markup	Pointer to variable to write markup to.

Return values

ta_c_rc_ok	Value written to markup.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount is not of type amount_dcc.
ta_c_rc_invalid_argument	markup is null-pointer.

ta_amount_dcc_get_rate()

ta_e_result_code_t ta_amount_dcc_get_rate	(	ta_object_t	amount,
		int *	rate
	)

DCC Rate in minor units.

Parameters

[in]	amount	Object instance of type amount_dcc.
[out]	rate	Pointer to variable to write rate to.

Return values

ta_c_rc_ok	Value written to rate.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount is not of type amount_dcc.
ta_c_rc_invalid_argument	rate is null-pointer.

ta_amount_dcc_get_rate_decimal()

ta_e_result_code_t ta_amount_dcc_get_rate_decimal	(	ta_object_t	amount,
		double *	rate
	)

DCC Rate in major units as double precision floating point value.

DCC rate exponent has been applied already to the value. Returned value can be used as-is without the need to adjust for the exponent.

Note

Double precision floating point values can not provide the same level of numerical accuracy as int64_t. It is recommended to use the integer based methods.

Parameters

[in]	amount	Object instance of type amount_dcc.
[out]	rate	Pointer to variable to write rate to.

Return values

ta_c_rc_ok	Value written to rate.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount is not of type amount_dcc.
ta_c_rc_invalid_argument	rate is null-pointer.

ta_amount_dcc_get_rate_decimal_regulated()

ta_e_result_code_t ta_amount_dcc_get_rate_decimal_regulated	(	ta_object_t	amount,
		double *	rate
	)

DCC Rate in major units as double precision floating point value.

DCC rate exponent has been applied already to the value. Returned value can be used as-is without the need to adjust for the exponent.

Note

Double precision floating point values can not provide the same level of numerical accuracy as int64_t. It is recommended to use the integer based methods.

Parameters

[in]	amount	Object instance of type amount_dcc.
[out]	rate	Pointer to variable to write rate to.

Return values

ta_c_rc_ok	Value written to rate.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount is not of type amount_dcc.
ta_c_rc_invalid_argument	rate is null-pointer.

ta_amount_dcc_get_rate_exponent()

ta_e_result_code_t ta_amount_dcc_get_rate_exponent	(	ta_object_t	amount,
		int *	exponent
	)

DCC rate exponent.

Parameters

[in]	amount	Object instance of type amount_dcc.
[out]	exponent	Pointer to variable to write rate exponent to.

Return values

ta_c_rc_ok	Value written to exponent.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount is not of type amount_dcc.
ta_c_rc_invalid_argument	exponent is null-pointer.

ta_amount_dcc_get_rate_exponent_regulated()

ta_e_result_code_t ta_amount_dcc_get_rate_exponent_regulated	(	ta_object_t	amount,
		int *	exponent
	)

DCC rate exponent.

Parameters

[in]	amount	Object instance of type amount_dcc.
[out]	exponent	Pointer to variable to write rate exponent to.

Return values

ta_c_rc_ok	Value written to exponent.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount is not of type amount_dcc.
ta_c_rc_invalid_argument	exponent is null-pointer.

ta_amount_dcc_get_rate_regulated()

ta_e_result_code_t ta_amount_dcc_get_rate_regulated	(	ta_object_t	amount,
		int *	rate
	)

DCC Rate in minor units.

Parameters

[in]	amount	Object instance of type amount_dcc.
[out]	rate	Pointer to variable to write rate to.

Return values

ta_c_rc_ok	Value written to rate.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount is not of type amount_dcc.
ta_c_rc_invalid_argument	rate is null-pointer.

ta_amount_dcc_get_value()

ta_e_result_code_t ta_amount_dcc_get_value	(	ta_object_t	amount,
		int64_t *	value
	)

DCC Amount in minor units.

Parameters

[in]	amount	Object instance of type amount_dcc.
[out]	value	Pointer to variable to write value to. Use ta_amount_dcc_get_exponent to get the used exponent. This can be a different exponent than the one defined by the used currency.

Return values

ta_c_rc_ok	Value written to value.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount is not of type amount_dcc.
ta_c_rc_invalid_argument	value is null-pointer.