StockAssistantModel Class Reference

available transaction types based on the state of the account, the collection and validation of input data from the StockAssistantView and conversion of the data into a GnuCash transaction. More...

Public Member Functions
	StockAssistantModel (Account *account)
bool	maybe_reset_txn_types ()
	Selects a TxnTypevec for the user to pick from depending on whether the account has a positive, negative, or zero share balance on the selected transaction date.
const std::optional< TxnTypeVec > &	get_txn_types ()
	Accessor function.
bool	set_txn_type (guint type_idx)
	Setter.
bool	txn_type_valid ()
	Accessor.
void	set_transaction_date (time64 date)
	Setter.
void	set_transaction_desc (const char *desc)
	Setter.
const std::optional< TxnTypeInfo > &	txn_type ()
	Accessor.
std::string	get_new_amount_str () const
	Accessor.
StockTransactionEntry *	stock_entry ()
	Accessor.
StockTransactionEntry *	cash_entry ()
	Accessor.
StockTransactionEntry *	fees_entry ()
	Accessor.
StockTransactionEntry *	dividend_entry ()
	Accessor.
StockTransactionEntry *	capgains_entry ()
	Accessor.
Logger &	logger ()
	Accessor.
std::tuple< bool, std::string, EntryVec >	generate_list_of_splits ()
	Generate the proposed list of splits.
std::tuple< bool, Transaction * >	create_transaction ()
	Generate a GnuCash transaction from the active entries.
Account *	account ()

Detailed Description

available transaction types based on the state of the account, the collection and validation of input data from the StockAssistantView and conversion of the data into a GnuCash transaction.

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

Constructor & Destructor Documentation

StockAssistantModel()

StockAssistantModel::StockAssistantModel ( Account *  account )

inline

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

      : m_acct{account}, m_currency{gnc_account_get_currency_or_parent(
                             account)},
        m_stock_entry{std::make_unique<StockTransactionStockEntry>(
            NC_("Stock Assistant: Page name", "Stock"))},
        m_cash_entry{std::make_unique<StockTransactionEntry>(
            NC_("Stock Assistant: Page name", "Cash"), PROCEEDS_KVP_TAG)},
        m_fees_entry{std::make_unique<StockTransactionFeesEntry>(
            NC_("Stock Assistant: Page name", "Fees"), FEES_KVP_TAG)},
        m_dividend_entry{std::make_unique<StockTransactionEntry>(
            NC_("Stock Assistant: Page name", "Dividend"), DIVIDEND_KVP_TAG)},
        m_capgains_entry{std::make_unique<StockTransactionEntry>(
            NC_("Stock Assistant: Page name", "Capital Gains"),
            CAPGAINS_KVP_TAG)} {
        DEBUG ("StockAssistantModel constructor\n");
        m_stock_entry->set_account(m_acct);
    };

~StockAssistantModel()

StockAssistantModel::~StockAssistantModel ( )

inline

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

    {
        DEBUG ("StockAssistantModel destructor\n");
    };

Member Function Documentation

account()

Account * StockAssistantModel::account ( )

inline

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

{ return m_acct; }

capgains_entry()

StockTransactionEntry * StockAssistantModel::capgains_entry ( )

inline

Accessor.

Returns

the Capital Gains entry.

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

{ return m_capgains_entry.get(); }

cash_entry()

StockTransactionEntry * StockAssistantModel::cash_entry ( )

inline

Accessor.

Returns

the Cash entry.

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

{ return m_cash_entry.get(); }

create_transaction()

std::tuple< bool, Transaction * > StockAssistantModel::create_transaction

(

)

Generate a GnuCash transaction from the active entries.

Returns

A tuple containing a boolean indicating that the transaction was created and a pointer to the new transaction.

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

{
    if (!m_ready_to_create)
    {
        PERR ("errors exist. cannot create transaction.");
        m_list_of_splits.clear();
        return {false, nullptr};
    }
    auto book = qof_instance_get_book (m_acct);
    auto trans = xaccMallocTransaction (book);
    xaccTransBeginEdit (trans);
    xaccTransSetCurrency (trans, m_currency);
    xaccTransSetDescription (trans, m_transaction_description);
    xaccTransSetDatePostedSecsNormalized (trans, m_transaction_date);
    AccountVec accounts;
    std::for_each (m_list_of_splits.begin(), m_list_of_splits.end(),
                   [&](auto& entry)
                   {
                       entry->create_split (trans, accounts);
                       if (entry->get_kvp_tag() && entry->account())
                           xaccAccountSetAssociatedAccount (m_acct, entry->get_kvp_tag(), entry->account());
                   });
    add_price (book);
    xaccTransCommitEdit (trans);
    std::for_each (accounts.begin(), accounts.end(), xaccAccountCommitEdit);
    m_list_of_splits.clear();
    m_ready_to_create = false;
    return {true, trans};
}

dividend_entry()

StockTransactionEntry * StockAssistantModel::dividend_entry ( )

inline

Accessor.

Returns

the Dividend entry.

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

{ return m_dividend_entry.get(); }

fees_entry()

StockTransactionEntry * StockAssistantModel::fees_entry ( )

inline

Accessor.

Returns

the Fees entry.

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

{ return m_fees_entry.get(); }

generate_list_of_splits()

std::tuple< bool, std::string, EntryVec > StockAssistantModel::generate_list_of_splits

(

)

Generate the proposed list of splits.

This is used to display the proposal to the user in the last page of the assistant and to select on which entries to call create_split.

Returns

A tuple containing a boolean indicating that the data passed validation, a string containing diagnostics, and a vector of the Entries to be used in the transacion.

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

                                             {
    if (!m_txn_types || !m_txn_type)
        return { false, "Error: txn_type not initialized", {} };
 
    m_logger.clear();
    m_list_of_splits.clear();
 
    GncNumeric debit{};
    GncNumeric credit{};
 
    // check the stock transaction date. If there are existing stock
    // transactions dated after the date specified, it is very likely
    // the later stock transactions will be invalidated. warn the user
    // to review them.
    if (const auto& splits = xaccAccountGetSplits (m_acct); !splits.empty())
        check_txn_date(splits.back(), m_transaction_date, m_logger);
 
    if (m_stock_entry->enabled()  || m_stock_entry->has_amount())
    {
        m_stock_entry->validate_amount(m_logger);
        m_list_of_splits.push_back(m_stock_entry.get());
 
        auto price{m_stock_entry->calculate_price()};
        if (!gnc_numeric_check(price))
        {
            // Translators: %s refer to: stock mnemonic, broker currency,
            // date of transaction.
            auto tmpl = N_("A price of 1 %s = %s on %s will be recorded.");
            auto date_str = qof_print_date (m_transaction_date);
            auto price_msg = g_strdup_printf
                (_(tmpl),
                 gnc_commodity_get_mnemonic (xaccAccountGetCommodity (m_acct)),
                 m_stock_entry->print_price(), date_str);
            m_logger.info(price_msg);
            g_free (date_str);
            g_free (price_msg);
        }
    }
 
    if (m_stock_entry->marker_split())
        m_list_of_splits.push_back(m_stock_entry.get());
 
    if (m_cash_entry->enabled())
    {
        m_cash_entry->validate_amount(m_logger);
        m_list_of_splits.push_back (m_cash_entry.get());
    }
 
    if (m_fees_entry->enabled())
    {
        m_fees_entry->validate_amount(m_logger);
        if (m_fees_entry->do_capitalize())
            m_fees_entry->set_account(m_acct);
        m_list_of_splits.push_back (m_fees_entry.get());
    }
 
    if (m_dividend_entry->enabled())
    {
        m_dividend_entry->validate_amount(m_logger);
        m_list_of_splits.push_back (m_dividend_entry.get());
    }
 
    if (m_capgains_entry->enabled())
    {
        m_stock_cg_entry =
            std::make_unique<StockTransactionStockCapGainsEntry>(m_capgains_entry.get(),
                                                                  m_stock_entry.get());
        m_stock_cg_entry->validate_amount(m_logger);
        m_capgains_entry->validate_amount(m_logger);
        m_list_of_splits.push_back(m_stock_cg_entry.get());
        m_list_of_splits.push_back (m_capgains_entry.get());
    }
 
    std::for_each(m_list_of_splits.begin(), m_list_of_splits.end(),
                    [&debit, &credit](auto& entry) {
                        if (entry->debit_side())
                            debit += entry->value();
                        else
                            credit += entry->value();
                    });
 
    if (gnc_numeric_check(debit) || gnc_numeric_check(credit) ||!gnc_numeric_equal (debit, credit))
    {
        const char *err_act = NULL, *err_reason = NULL;
        if (gnc_numeric_check(debit))
        {
            err_act = "debit";
            err_reason = gnc_numeric_errorCode_to_string(gnc_numeric_check(debit));
        }
        else if (gnc_numeric_check(credit))
        {
            err_act = "credit";
            err_reason = gnc_numeric_errorCode_to_string(gnc_numeric_check(credit));
        }
 
        if (err_act)
        {
            auto err_str = g_strdup_printf (N_("Transaction can't balance, %s is error value %s"), err_act, err_reason);
            m_logger.error(err_str);
            g_free (err_str);
        }
        else
        {
            auto imbalance_str = N_("Total Debits of %s does not balance with total Credits of %s.");
            auto pinfo{gnc_commodity_print_info (m_currency, true)};
            auto debit_str = g_strdup (xaccPrintAmount (debit, pinfo));
            auto credit_str = g_strdup (xaccPrintAmount (credit, pinfo));
            auto error_str = g_strdup_printf (_(imbalance_str), debit_str, credit_str);
            m_logger.error (error_str);
            g_free (error_str);
            g_free (credit_str);
            g_free (debit_str);
        }
    }
 
    // generate final summary message. Collates a header, the errors
    // and warnings. Then allow completion if errors is empty.
    m_ready_to_create = !m_logger.has_errors();
    return { m_ready_to_create, m_logger.report(), m_list_of_splits };
}

get_new_amount_str()

std::string StockAssistantModel::get_new_amount_str

(

)

const

Accessor.

return string representing the new balance in a split/reverse split transaction.

get_txn_types()

const std::optional< TxnTypeVec > & StockAssistantModel::get_txn_types ( )

inline

Accessor function.

Returns

The currently available transaction types or std::nullopt if it's unset.

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

{ return m_txn_types; }

logger()

Logger & StockAssistantModel::logger ( )

inline

Accessor.

Returns

the logger.

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

{ return m_logger; }

maybe_reset_txn_types()

bool StockAssistantModel::maybe_reset_txn_types

(

)

Selects a TxnTypevec for the user to pick from depending on whether the account has a positive, negative, or zero share balance on the selected transaction date.

Returns

true if the account balance had changed.

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

{
    auto old_bal = m_stock_entry->get_balance();
    auto new_bal = xaccAccountGetBalanceAsOfDate
        (m_acct, gnc_time64_get_day_end (m_transaction_date));
    if (m_txn_types_date && m_txn_types_date == m_transaction_date &&
        gnc_numeric_equal (old_bal, new_bal))
        return false;
    m_stock_entry->set_balance(new_bal);
    m_txn_types_date = m_transaction_date;
    m_txn_types = gnc_numeric_zero_p (new_bal) ? starting_types
        : gnc_numeric_positive_p (new_bal) ? long_types
        : short_types;
    return true;
};

set_transaction_date()

void StockAssistantModel::set_transaction_date ( time64  date )

inline

Setter.

Parameters

time64

for the transaction date.

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

{ m_transaction_date = date;}

set_transaction_desc()

void StockAssistantModel::set_transaction_desc ( const char *  desc )

inline

Setter.

Parameters

null-terminated

string containing the transaction description.

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

{ m_transaction_description = desc; }

set_txn_type()

bool StockAssistantModel::set_txn_type

(

guint

type_idx

)

Setter.

Parameters

the	index into the current Transaction Types indicating the selection.

Returns

true if the selection succeeded.

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

{
    if (!m_txn_types_date || m_txn_types_date != m_transaction_date)
    {
        PERR ("transaction_date has changed. rerun maybe_reset_txn_types!");
        return false;
    }
    try
    {
        m_txn_type = m_txn_types->at (type_idx);
    }
    catch (const std::out_of_range&)
    {
        PERR ("out of range type_idx=%d", type_idx);
        return false;
    }
 
    m_stock_entry->set_fieldmask(m_txn_type->stock_amount);
    m_fees_entry->set_fieldmask(m_txn_type->fees_value);
    m_capgains_entry->set_fieldmask(m_txn_type->capgains_value);
    m_dividend_entry->set_fieldmask(m_txn_type->dividend_value);
    m_cash_entry->set_fieldmask(m_txn_type->cash_value);
    return true;
};

stock_entry()

StockTransactionEntry * StockAssistantModel::stock_entry ( )

inline

Accessor.

Returns

the Stock entry.

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

{ return m_stock_entry.get(); }

txn_type()

const std::optional< TxnTypeInfo > & StockAssistantModel::txn_type ( )

inline

Accessor.

Returns

the selected transaction type or std::nullopt if it hasn't been set.

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

{ return m_txn_type; }

txn_type_valid()

bool StockAssistantModel::txn_type_valid ( )

inline

Accessor.

Returns

true if the transaction type has been set.

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

{ return m_txn_type.has_value(); }

---

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

• assistant-stock-transaction.cpp