GncPreTrans Class Reference

Public Member Functions
	GncPreTrans (int date_format, bool multi_split)
void	set (GncTransPropType prop_type, const std::string &value)
void	set_date_format (int date_format)
void	set_multi_split (bool multi_split)
void	reset (GncTransPropType prop_type)
StrVec	verify_essentials (void)
std::shared_ptr< DraftTransaction >	create_trans (QofBook *book, gnc_commodity *currency)
bool	is_part_of (std::shared_ptr< GncPreTrans > parent)
	Check whether the harvested transaction properties for this instance match those of another one (the "parent").
std::optional< std::string >	get_void_reason ()
ErrMap	errors ()
void	reset_cross_split_counters ()
bool	is_multi_currency ()

Friends
class	GncPreSplit

Detailed Description

Definition at line 154 of file gnc-imp-props-tx.hpp.

Constructor & Destructor Documentation

GncPreTrans()

GncPreTrans::GncPreTrans ( int  date_format, bool  multi_split  )

inline

Definition at line 157 of file gnc-imp-props-tx.hpp.

        : m_date_format{date_format}, m_multi_split{multi_split}, m_currency{nullptr} {};

Member Function Documentation

create_trans()

std::shared_ptr< DraftTransaction > GncPreTrans::create_trans	(	QofBook *	book,
		gnc_commodity *	currency
	)

Definition at line 323 of file gnc-imp-props-tx.cpp.

{
    if (created)
        return nullptr;
 
    /* Gently refuse to create the transaction if the basics are not set correctly
     * This should have been tested before calling this function though!
     */
    auto check = verify_essentials();
    if (!check.empty())
    {
        auto err_msg = std::string("Not creating transaction because essentials not set properly:");
        auto add_bullet_item = [](std::string& a, std::string& b)->std::string { return std::move(a) + "\n• " + b; };
        err_msg = std::accumulate (check.begin(), check.end(), std::move (err_msg), add_bullet_item);
        PWARN ("%s", err_msg.c_str());
        return nullptr;
    }
 
    auto trans = xaccMallocTransaction (book);
    xaccTransBeginEdit (trans);
 
    if (gnc_commodity_is_currency(m_currency))
        xaccTransSetCurrency (trans, m_currency);
    else
        xaccTransSetCurrency (trans, currency);
    xaccTransSetDatePostedSecsNormalized (trans,
                        static_cast<time64>(GncDateTime(*m_date, DayPart::neutral)));
 
    if (m_num)
        xaccTransSetNum (trans, m_num->c_str());
 
    if (m_desc)
        xaccTransSetDescription (trans, m_desc->c_str());
 
    if (m_notes)
        xaccTransSetNotes (trans, m_notes->c_str());
 
    created = true;
    return std::make_shared<DraftTransaction>(trans);
}

errors()

ErrMap GncPreTrans::errors

(

)

Definition at line 379 of file gnc-imp-props-tx.cpp.

{
    return m_errors;
}

get_void_reason()

std::optional< std::string > GncPreTrans::get_void_reason ( )

inline

Definition at line 182 of file gnc-imp-props-tx.hpp.

{ return m_void_reason; }

is_multi_currency()

bool GncPreTrans::is_multi_currency

(

)

Definition at line 391 of file gnc-imp-props-tx.cpp.

{
    auto num_comm = m_acct_commodities.size() + m_alt_currencies.size();
    if (m_currency && (std::find (m_alt_currencies.cbegin(),m_alt_currencies.cend(), m_currency) == m_alt_currencies.cend()))
        num_comm++;
    return (num_comm > 1);
}

is_part_of()

bool GncPreTrans::is_part_of

(

std::shared_ptr< GncPreTrans >

parent

)

Check whether the harvested transaction properties for this instance match those of another one (the "parent").

Note this function is not symmetrical. This instance can have empty properties and still be considered part of the parent if the other properties match the parent's. A fully empty instance will equally be considered part of the parent.

This function is intended to discover multi-split transaction lines in an import file where the first line defines the transaction (with a first split) and subsequent lines add splits. These subsequent lines can either have all transaction related columns be empty or the same as the first line.

Parameters

parent

the parent transaction property object to test against

Returns

true if this object is considered to be part of the parent, false otherwise.

Definition at line 364 of file gnc-imp-props-tx.cpp.

{
    if (!parent)
        return false;
 
    return (!m_differ || m_differ == parent->m_differ) &&
            (!m_date || m_date == parent->m_date) &&
            (!m_num || m_num == parent->m_num) &&
            (!m_desc || m_desc == parent->m_desc) &&
            (!m_notes || m_notes == parent->m_notes) &&
            (!m_currency || m_currency == parent->m_currency) &&
            (!m_void_reason || m_void_reason == parent->m_void_reason) &&
            parent->m_errors.empty(); // A GncPreTrans with errors can never be a parent
}

reset()

void GncPreTrans::reset

(

GncTransPropType

prop_type

)

Definition at line 302 of file gnc-imp-props-tx.cpp.

{
        set (prop_type, std::string());
        // Set with an empty string will effectively clear the property
        // but can also set an error for the property. Clear that error here.
        m_errors.erase(prop_type);
}

reset_cross_split_counters()

void GncPreTrans::reset_cross_split_counters

(

)

Definition at line 384 of file gnc-imp-props-tx.cpp.

{
    m_alt_currencies.clear();
    m_acct_commodities.clear();
}

set()

void GncPreTrans::set	(	GncTransPropType	prop_type,
		const std::string &	value
	)

Definition at line 228 of file gnc-imp-props-tx.cpp.

{
    try
    {
        // Drop any existing error for the prop_type we're about to set
        m_errors.erase(prop_type);
 
        switch (prop_type)
        {
            case GncTransPropType::UNIQUE_ID:
                m_differ.reset();
                if (!value.empty())
                    m_differ = value;
                break;
 
            case GncTransPropType::DATE:
                m_date.reset();
                if (!value.empty())
                    m_date = GncDate(value, GncDate::c_formats[m_date_format].m_fmt); // Throws if parsing fails
                else if (!m_multi_split)
                    throw std::invalid_argument (
                        (bl::format (std::string{_("Date field can not be empty if 'Multi-split' option is unset.\n")}) %
                                     std::string{_(gnc_csv_col_type_strs[prop_type])}).str());
                break;
 
            case GncTransPropType::NUM:
                m_num.reset();
                if (!value.empty())
                    m_num = value;
                break;
 
            case GncTransPropType::DESCRIPTION:
                m_desc.reset();
                if (!value.empty())
                    m_desc = value;
                else if (!m_multi_split)
                    throw std::invalid_argument (
                        (bl::format (std::string{_("Description field can not be empty if 'Multi-split' option is unset.\n")}) %
                                     std::string{_(gnc_csv_col_type_strs[prop_type])}).str());
                break;
 
            case GncTransPropType::NOTES:
                m_notes.reset();
                if (!value.empty())
                    m_notes = value;
                break;
 
            case GncTransPropType::COMMODITY:
                m_currency = nullptr;
                m_currency = parse_commodity (value);
                break;
 
            case GncTransPropType::VOID_REASON:
                m_void_reason.reset();
                if (!value.empty())
                    m_void_reason = value;
                break;
 
            default:
                /* Issue a warning for all other prop_types. */
                PWARN ("%d is an invalid property for a transaction", static_cast<int>(prop_type));
                break;
        }
    }
    catch (const std::exception& e)
    {
        auto err_str = (bl::format (std::string{_("{1}: {2}")}) %
                        std::string{_(gnc_csv_col_type_strs[prop_type])} %
                        e.what()).str();
        m_errors.emplace(prop_type, err_str);
    }
 
}

set_date_format()

void GncPreTrans::set_date_format ( int  date_format )

inline

Definition at line 161 of file gnc-imp-props-tx.hpp.

{ m_date_format = date_format ;}

set_multi_split()

void GncPreTrans::set_multi_split ( bool  multi_split )

inline

Definition at line 162 of file gnc-imp-props-tx.hpp.

{ m_multi_split = multi_split ;}

verify_essentials()

StrVec GncPreTrans::verify_essentials

(

void

)

Definition at line 310 of file gnc-imp-props-tx.cpp.

{
    auto errors = StrVec();
 
    if (!m_date)
        errors.emplace_back(_("No valid date."));
 
    if (!m_desc)
        errors.emplace_back(_("No valid description."));
 
    return errors;
}

Friends And Related Symbol Documentation

GncPreSplit

friend class GncPreSplit

friend

Definition at line 218 of file gnc-imp-props-tx.hpp.

---

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

• gnc-imp-props-tx.hpp
• gnc-imp-props-tx.cpp