CashFlowCharge class
Represents the movement of money, specifically non-interest bearing cash in-flows to the lender, for example cash-based charges or fees. The value of these cash flows must be specified i.e. they cannot be null or unknown.
The inclusion of charge cash flows in a profile or series has no effect on the calculation of unknown interest-bearing cash flow values, they are skipped over. However they may optionally be included in the calculation of the implicit interest rate in a cash flow series, for example the calculation on an Annual Percentage Rate (APR) of charge.
Constructors
- CashFlowCharge({required DateTime postDate, required double value, String label = '', DayCountFactor? periodFactor})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- isKnown → bool
-
Flag indicating if the cash flow value is known, or is to be computed.
finalinherited
- label → String
-
Localised free text description of the cash flow e.g. Loan, Payment,
Fee, etc.
finalinherited
- periodFactor → DayCountFactor?
-
finalinherited
- postDate → DateTime
-
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- value → double
-
The positive or negative cash flow value.
finalinherited
- valueDate → DateTime
-
The settlement date of the cashflow value. It should not predate
the post date.
finalinherited
- weighting → double
-
Weighting determines the scale of an unknown cash flow value relative
to other unknown cash flows in a cash flow series. Note, the weighting
has no effect when applied to cash flows with known values.
Default value is 1.0
finalinherited
Methods
-
copyWith(
{DateTime? postDate, double? value, String? label, DayCountFactor? periodFactor}) → CashFlowCharge -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited