Financial Data Classes

Data models for the financial elements of the tool.

ActivityNpv dataclass

ActivityNpv(params, enabled, activity)

Mapping of the NPV parameters to the corresponding Activity model.

activity_id property

activity_id

Gets the identifier of the activity model.

Returns:

Type	Description
str	The unique identifier of the activity model else an empty string if no activity has been set.

base_name property

base_name

Returns a proposed name for the activity NPV.

An empty string will be return id the activity attribute is not set.

Returns:

Type	Description
str	Proposed base name for the activity NPV.

ActivityNpvCollection dataclass

ActivityNpvCollection(minimum_value, maximum_value, use_computed=True, remove_existing=False, mappings=list())

Collection for all ActivityNpvMapping configurations that have been specified by the user.

activity_npv

activity_npv(activity_identifier)

Gets the mapping of an activity's NPV mapping if defined.

Parameters:

Name	Type	Description	Default
activity_identifier	str	Unique identifier of an activity whose NPV mapping is to be retrieved.	required

Returns:

Type	Description
ActivityNpv	The activity's NPV mapping else None if not found.

Source code in src/cplus_plugin/models/financial.py

def activity_npv(self, activity_identifier: str) -> typing.Optional[ActivityNpv]:
    """Gets the mapping of an activity's NPV mapping if defined.

    :param activity_identifier: Unique identifier of an activity whose
    NPV mapping is to be retrieved.
    :type activity_identifier: str

    :returns: The activity's NPV mapping else None if not found.
    :rtype: ActivityNpv
    """
    matching_mapping = [
        activity_npv
        for activity_npv in self.mappings
        if activity_npv.activity_id == activity_identifier
    ]

    return None if len(matching_mapping) == 0 else matching_mapping[0]

normalize_npvs

normalize_npvs()

Normalize the NPV values of the activities using the specified normalization range.

If the absolute NPV values are less than or greater than the normalization range, then they will be truncated to 0.0 and 1.0 respectively. To avoid such a situation from occurring, it is recommended to make sure that the ranges are synchronized using the latest absolute NPV values hence call update_computed_normalization_range before normalizing the NPVs.

If there is only one NPV mapping, then assign a normalized value of 1.0.

Returns:

Type	Description
bool	True if the NPVs were successfully normalized else False due to various reasons such as if the minimum value is greater than the maximum value, if the min/max values are the same, or if there are no NPV mappings.

Source code in src/cplus_plugin/models/financial.py

def normalize_npvs(self) -> bool:
    """Normalize the NPV values of the activities using the specified
    normalization range.

    If the absolute NPV values are less than or greater than the
    normalization range, then they will be truncated to 0.0 and 1.0
    respectively. To avoid such a situation from occurring, it is recommended
    to make sure that the ranges are synchronized using the latest absolute
    NPV values hence call `update_computed_normalization_range` before
    normalizing the NPVs.

    If there is only one NPV mapping, then assign a normalized value of 1.0.

    :returns: True if the NPVs were successfully normalized else False due
    to various reasons such as if the minimum value is greater than the
    maximum value, if the min/max values are the same, or if there are no NPV
    mappings.
    """
    valid_npv_mappings = self._valid_npv_mappings()
    if len(valid_npv_mappings) == 0:
        return False

    if len(valid_npv_mappings) == 1:
        activity_npv = self.mappings[0]
        activity_npv.params.normalized_npv = 1.0
        return True

    if self.minimum_value > self.maximum_value:
        return False

    norm_range = float(self.maximum_value - self.minimum_value)

    if norm_range == 0.0:
        return False

    for activity_npv in valid_npv_mappings:
        absolute_npv = activity_npv.params.absolute_npv
        if not absolute_npv:
            continue

        if absolute_npv <= self.minimum_value:
            normalized_npv = 0.0
        elif absolute_npv >= self.maximum_value:
            normalized_npv = 1.0
        else:
            normalized_npv = (absolute_npv - self.minimum_value) / norm_range

        activity_npv.params.normalized_npv = normalized_npv

    return True

update_computed_normalization_range

update_computed_normalization_range()

Update the minimum and maximum normalization values based on the absolute values of the existing ActivityNpv objects.

Values for disabled activity NPVs will be excluded from the computation.

Returns:

Type	Description
bool	True if the min/max values were updated else False if there are no mappings or valid absolute NPV values defined.

Source code in src/cplus_plugin/models/financial.py

def update_computed_normalization_range(self) -> bool:
    """Update the minimum and maximum normalization values
    based on the absolute values of the existing ActivityNpv
    objects.

    Values for disabled activity NPVs will be excluded from
    the computation.

    :returns: True if the min/max values were updated else False if
    there are no mappings or valid absolute NPV values defined.
    """
    if len(self.mappings) == 0:
        return False

    valid_npv_values = [
        activity_npv.params.absolute_npv
        for activity_npv in self._valid_npv_mappings()
    ]

    if len(valid_npv_values) == 0:
        return False

    self.minimum_value = min(valid_npv_values)
    self.maximum_value = max(valid_npv_values)

    return True

ActivityNpvPwl dataclass

ActivityNpvPwl(npv, extent, crs, pixel_size)

Convenience class that contains parameters for creating a PWL raster layer.

NpvParameters dataclass

NpvParameters(years, discount, absolute_npv=0.0, normalized_npv=0.0, yearly_rates=list(), manual_npv=False)

Parameters for computing an activity's NPV.

__post_init__

__post_init__()

Set empty yearly rates for consistency.

Source code in src/cplus_plugin/models/financial.py

def __post_init__(self):
    """Set empty yearly rates for consistency."""
    for i in range(self.years):
        self.yearly_rates.append((None, None, None))

---

Last update: October 2, 2024