Struct SimpleCashFlow 

pub struct SimpleCashFlow { /* private fields */ }

A payment of a predetermined amount on a given date.

Implementations

impl SimpleCashFlow

pub fn new(amount: Real, date: Date) -> QlResult<Self>

Creates a flow paying amount on date.

Both guards are QuantLib’s, verbatim, from the SimpleCashFlow constructor body (simplecashflow.cpp:29 and :31), error strings included. They were omitted when this type was first ported.

Errors

Errors if date is the null date or amount is the null Real.

Trait Implementations

impl AsObservable for SimpleCashFlow

fn observable(&self) -> &Observable

Access to the embedded observable for registering observers.

impl CashFlow for SimpleCashFlow

fn amount(&self) -> QlResult<Real>

The amount paid at date, undiscounted.

fn ex_coupon_date(&self) -> Option<Date>

The date from which the flow trades ex-coupon, when it has one.

fn as_coupon(&self) -> Option<&dyn Coupon>

The Coupon view of this flow, when it is one.

fn trading_ex_coupon( &self, settings: &Settings<Date>, ref_date: Option<Date>, ) -> QlResult<bool>

Whether the flow trades ex-coupon as of ref_date (the evaluation date when None).

impl Event for SimpleCashFlow

fn date(&self) -> Date

The date at which the event occurs.

fn has_occurred( &self, settings: &Settings<Date>, ref_date: Option<Date>, include_ref_date: Option<bool>, ) -> QlResult<bool>

Whether the event has already occurred as of ref_date.