Skip to content

NPV Parameters View Model

View model for computation of financial NPV values.

NpvFinancialModel 

NpvFinancialModel(parent=None)

Bases: QStandardItemModel

View model for costs and revenues used in NPV computation.

Source code in src/cplus_plugin/gui/financials/npv_financial_model.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
def __init__(self, parent=None):
    super().__init__(parent)
    self.setColumnCount(4)

    # Headers
    self.setHorizontalHeaderLabels(
        [
            tr(YEAR_HEADER),
            tr(TOTAL_PROJECTED_REVENUES_HEADER),
            tr(TOTAL_PROJECTED_COSTS_HEADER),
            tr(DISCOUNTED_VALUE_HEADER),
        ]
    )

add_year_row 

add_year_row()

Adds a new row for the year.

The year number is automatically set.

Returns:

Type Description
int

The newly added row number, or -1 if the row was not added.
Source code in src/cplus_plugin/gui/financials/npv_financial_model.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def add_year_row(self) -> int:
    """Adds a new row for the year.

    The year number is automatically set.

    :returns: The newly added row number, or
    -1 if the row was not added.
    :rtype: int
    """
    if self.rowCount() >= MAX_YEARS:
        return -1

    year_number = self.rowCount() + 1
    year_item = QtGui.QStandardItem(str(year_number))
    year_item.setEditable(False)
    year_item.setTextAlignment(QtCore.Qt.AlignCenter)
    year_background = year_item.background()
    year_background.setColor(QtCore.Qt.lightGray)
    year_background.setStyle(QtCore.Qt.SolidPattern)
    year_item.setBackground(year_background)

    revenue_item = QtGui.QStandardItem()
    revenue_item.setEditable(True)
    revenue_item.setTextAlignment(QtCore.Qt.AlignCenter)

    cost_item = QtGui.QStandardItem()
    cost_item.setEditable(True)
    cost_item.setTextAlignment(QtCore.Qt.AlignCenter)

    discount_item = QtGui.QStandardItem()
    discount_item.setEditable(False)
    discount_item.setTextAlignment(QtCore.Qt.AlignCenter)
    discount_background = discount_item.background()
    discount_background.setColor(QtCore.Qt.lightGray)
    discount_background.setStyle(QtCore.Qt.SolidPattern)
    discount_item.setBackground(discount_background)

    self.appendRow([year_item, revenue_item, cost_item, discount_item])

    return year_number

append_years 

append_years(number_years)

Appends new rows based on the number of years specified.

Parameters:

Name Type Description Default
number_years int

Number of rows to be added.

 required
Source code in src/cplus_plugin/gui/financials/npv_financial_model.py 
79
80
81
82
83
84
85
86
87
88
def append_years(self, number_years: int):
    """Appends new rows based on the number of years specified.

    :param number_years: Number of rows to be added.
    :type number_years: int
    """
    for i in range(number_years):
        row_number = self.add_year_row()
        if row_number == -1:
            break

set_number_of_years 

set_number_of_years(number_years)

Sets the number of years by adding or removing rows to match the number of years.

Parameters:

Name Type Description Default
number_years int

Number of years to be used in the computation.

 required
Source code in src/cplus_plugin/gui/financials/npv_financial_model.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
def set_number_of_years(self, number_years: int):
    """Sets the number of years by adding or removing rows to
    match the number of years.

    :param number_years: Number of years to be used in
    the computation.
    :type number_years: int
    """
    if self.rowCount() < number_years:
        # Append additional years
        additional_years = number_years - self.rowCount()
        self.append_years(additional_years)
    elif self.rowCount() > number_years:
        # Remove extra years
        remove_years = self.rowCount() - number_years
        self.removeRows(self.rowCount() - remove_years, remove_years)
Last update: November 25, 2024
Back to top