StockTransactionStockEntry Class Reference

Specialized StockTransactionEntry for the stock split. More...

Inheritance diagram for StockTransactionStockEntry:

Public Member Functions
	StockTransactionStockEntry (const char *action)
void	set_fieldmask (FieldMask mask) override
	Set up the state variables from the FieldMask. More...
void	set_amount (gnc_numeric amount) override
gnc_numeric	amount () const override
bool	has_amount () const override
void	validate_amount (Logger &logger) const override
void	create_split (Transaction *trans, AccountVec &account_commits) const override
std::string	amount_str_for_display () const override
	Generate a string representation of the value. More...
gnc_numeric	calculate_price () const override
	Calculate the price (amount/value) for non-currency accounts. More...
bool	marker_split () const override
Public Member Functions inherited from StockTransactionEntry
	StockTransactionEntry (const char *action, const char *kvp_tag)
	StockTransactionEntry (const StockTransactionEntry &)=default
virtual bool	enabled () const
virtual bool	debit_side () const
virtual void	set_capitalize (bool capitalize)
virtual bool	input_new_balance () const
virtual bool	do_capitalize () const
virtual void	set_account (Account *account)
virtual Account *	account () const
virtual const char *	print_account () const
virtual void	set_memo (const char *memo)
virtual const char *	get_kvp_tag ()
virtual const char *	memo () const
virtual void	set_value (gnc_numeric amount)
virtual GncNumeric	value ()
virtual void	set_balance (gnc_numeric balance)
virtual gnc_numeric	get_balance () const
virtual const char *	print_value () const
virtual const char *	print_amount (gnc_numeric amt) const
virtual const char *	print_price () const

Additional Inherited Members
Protected Attributes inherited from StockTransactionEntry
bool	m_enabled
bool	m_debit_side
bool	m_allow_zero
bool	m_allow_negative
bool	m_input_new_balance = false
Account *	m_account
gnc_numeric	m_value
const char *	m_memo
const char *	m_action
gnc_numeric	m_balance = gnc_numeric_zero()
const char *	m_kvp_tag
int	m_qof_event_handler

Detailed Description

Specialized StockTransactionEntry for the stock split.

Unlike the base class it has an amount separate from the value and set amount can optionally take a post-transaction balance, used to calculate the amount and split ratio for split and reverse-split transactions. Its validate_amount method first calls the base class member to validate the value then performs addtional checks on the amount and price.

Definition at line 785 of file assistant-stock-transaction.cpp.

Member Function Documentation

amount_str_for_display()

std::string StockTransactionStockEntry::amount_str_for_display ( ) const

overridevirtual

Generate a string representation of the value.

Internally uses xaccPrintAmount, which writes to a static string, so the result is copied to a std::string to prevent it being replaced by subsequent calls.

Returns

a std:sstring containing a representation of the value.

Reimplemented from StockTransactionEntry.

Definition at line 896 of file assistant-stock-transaction.cpp.

{
    std::string rv{""};

    if (gnc_numeric_check (m_amount))
        return rv;

    if (m_input_new_balance)
    {
        auto amount = gnc_numeric_add(m_debit_side ? m_amount : gnc_numeric_neg(m_amount), m_balance,
                                      GNC_DENOM_AUTO, GNC_HOW_DENOM_REDUCE);
        auto ratio = gnc_numeric_div (amount, m_balance,
                                      GNC_DENOM_AUTO, GNC_HOW_DENOM_REDUCE);
        PINFO("Computed ratio %" PRId64 "/%" PRId64 "; amount %" PRId64
              "/%" PRId64 " and balance %" PRId64 "/%" PRId64,
              ratio.num, ratio.denom, amount.num, amount.denom, m_balance.num, m_balance.denom);
        if (gnc_numeric_check (ratio) || !gnc_numeric_positive_p (ratio))
            return rv;

        std::ostringstream ret;
        ret << ratio.num << ':' << ratio.denom;
        rv = ret.str();
    }
    else
    {
        auto amount = m_debit_side ? m_amount : gnc_numeric_neg (m_amount);
        amount = gnc_numeric_add_fixed (amount, m_balance);
        rv = print_amount(amount);
    }

    return rv;
};

calculate_price()

gnc_numeric StockTransactionStockEntry::calculate_price ( ) const

overridevirtual

Calculate the price (amount/value) for non-currency accounts.

Note that multiple currencies in stock transaction s are not supported.

Returns

The calculated price for the Stock entry, GNC_ERROR_ARG otherwise.

Reimplemented from StockTransactionEntry.

Definition at line 960 of file assistant-stock-transaction.cpp.

{
    if (m_input_new_balance ||
        !m_amount_enabled || gnc_numeric_check(m_amount) ||
        !m_enabled || gnc_numeric_check(m_value) ||
        gnc_numeric_zero_p(m_amount) || gnc_numeric_zero_p(m_value))
        return gnc_numeric_error(GNC_ERROR_ARG);

    auto price = gnc_numeric_div(m_value, m_amount,
                                 GNC_DENOM_AUTO, GNC_HOW_DENOM_EXACT);

    auto comm{xaccAccountGetCommodity(m_account)};
    auto curr{gnc_account_get_currency_or_parent(m_account)};
    auto ainfo{gnc_commodity_print_info (comm, true)};
    auto pinfo{gnc_price_print_info (curr, true)};
    auto vinfo{gnc_commodity_print_info (curr, true)};

    PINFO("Calculated price %s from value %s and amount %s",
          xaccPrintAmount(price, pinfo), xaccPrintAmount(m_value, vinfo),
          xaccPrintAmount(m_amount, ainfo));
    return price;
}

set_fieldmask()

void StockTransactionStockEntry::set_fieldmask ( FieldMask  mask )

overridevirtual

Set up the state variables from the FieldMask.

Parameters

A	Fieldmast to configure the StockTransactionEntry.

Reimplemented from StockTransactionEntry.

Definition at line 813 of file assistant-stock-transaction.cpp.

{
    StockTransactionEntry::set_fieldmask(mask);
    m_enabled = mask & (FieldMask::ENABLED_CREDIT | FieldMask::ENABLED_DEBIT);
    m_amount_enabled = mask & (FieldMask::AMOUNT_CREDIT | FieldMask::AMOUNT_DEBIT);
    m_debit_side = mask & (FieldMask::ENABLED_DEBIT | FieldMask::AMOUNT_DEBIT);
    m_input_new_balance = mask & FieldMask::INPUT_NEW_BALANCE;
    m_marker = mask & FieldMask::MARKER_SPLIT;
}

---

The documentation for this class was generated from the following file:

• assistant-stock-transaction.cpp