Class BondConventions
- Namespace
- NanoQL.Instruments
- Assembly
- NanoQL.dll
A fixed-rate bond preset's conventions, which ResolveBond(string, Func<BondConventions>) returns: QuantLib's values for the preset (BTP), which its class builds itself on. The trade's terms (the maturity, the coupons, the dates and the redemption) are its constructor's arguments.
public sealed record BondConventions : IEquatable<BondConventions>
- Inheritance
-
BondConventions
- Implements
- Inherited Members
Constructors
BondConventions(int, Period, Calendar, BusinessDayConvention, BusinessDayConvention, DateGenerationRule, bool, DayCounter, BusinessDayConvention, Calendar?, Period, Calendar?, BusinessDayConvention, bool)
A fixed-rate bond preset's conventions, which ResolveBond(string, Func<BondConventions>) returns: QuantLib's values for the preset (BTP), which its class builds itself on. The trade's terms (the maturity, the coupons, the dates and the redemption) are its constructor's arguments.
public BondConventions(int SettlementDays, Period Tenor, Calendar Calendar, BusinessDayConvention Convention, BusinessDayConvention TerminationDateConvention, DateGenerationRule Rule, bool EndOfMonth, DayCounter AccrualDayCounter, BusinessDayConvention PaymentConvention, Calendar? PaymentCalendar, Period ExCouponPeriod, Calendar? ExCouponCalendar, BusinessDayConvention ExCouponConvention, bool ExCouponEndOfMonth)
Parameters
SettlementDaysintThe settlement days.
TenorPeriodThe schedule's tenor.
CalendarCalendarThe schedule's calendar.
ConventionBusinessDayConventionThe schedule's business-day convention.
TerminationDateConventionBusinessDayConventionThe schedule's termination-date convention.
RuleDateGenerationRuleThe schedule's date-generation rule.
EndOfMonthboolWhether the schedule's dates stay at month end.
AccrualDayCounterDayCounterThe coupons' accrual day counter.
PaymentConventionBusinessDayConventionThe payment dates' business-day convention.
PaymentCalendarCalendarThe payment calendar, or null for the schedule's.
ExCouponPeriodPeriodThe ex-coupon period, or the empty period for none.
ExCouponCalendarCalendarThe ex-coupon period's calendar, or null.
ExCouponConventionBusinessDayConventionThe ex-coupon dates' business-day convention.
ExCouponEndOfMonthboolWhether the ex-coupon dates stay at month end.
Properties
AccrualDayCounter
The coupons' accrual day counter.
public DayCounter AccrualDayCounter { get; init; }
Property Value
Calendar
The schedule's calendar.
public Calendar Calendar { get; init; }
Property Value
Convention
The schedule's business-day convention.
public BusinessDayConvention Convention { get; init; }
Property Value
EndOfMonth
Whether the schedule's dates stay at month end.
public bool EndOfMonth { get; init; }
Property Value
ExCouponCalendar
The ex-coupon period's calendar, or null.
public Calendar? ExCouponCalendar { get; init; }
Property Value
ExCouponConvention
The ex-coupon dates' business-day convention.
public BusinessDayConvention ExCouponConvention { get; init; }
Property Value
ExCouponEndOfMonth
Whether the ex-coupon dates stay at month end.
public bool ExCouponEndOfMonth { get; init; }
Property Value
ExCouponPeriod
The ex-coupon period, or the empty period for none.
public Period ExCouponPeriod { get; init; }
Property Value
PaymentCalendar
The payment calendar, or null for the schedule's.
public Calendar? PaymentCalendar { get; init; }
Property Value
PaymentConvention
The payment dates' business-day convention.
public BusinessDayConvention PaymentConvention { get; init; }
Property Value
Rule
The schedule's date-generation rule.
public DateGenerationRule Rule { get; init; }
Property Value
SettlementDays
The settlement days.
public int SettlementDays { get; init; }
Property Value
Tenor
The schedule's tenor.
public Period Tenor { get; init; }
Property Value
TerminationDateConvention
The schedule's termination-date convention.
public BusinessDayConvention TerminationDateConvention { get; init; }
Property Value
Methods
Deconstruct(out int, out Period, out Calendar, out BusinessDayConvention, out BusinessDayConvention, out DateGenerationRule, out bool, out DayCounter, out BusinessDayConvention, out Calendar?, out Period, out Calendar?, out BusinessDayConvention, out bool)
public void Deconstruct(out int SettlementDays, out Period Tenor, out Calendar Calendar, out BusinessDayConvention Convention, out BusinessDayConvention TerminationDateConvention, out DateGenerationRule Rule, out bool EndOfMonth, out DayCounter AccrualDayCounter, out BusinessDayConvention PaymentConvention, out Calendar? PaymentCalendar, out Period ExCouponPeriod, out Calendar? ExCouponCalendar, out BusinessDayConvention ExCouponConvention, out bool ExCouponEndOfMonth)
Parameters
SettlementDaysintTenorPeriodCalendarCalendarConventionBusinessDayConventionTerminationDateConventionBusinessDayConventionRuleDateGenerationRuleEndOfMonthboolAccrualDayCounterDayCounterPaymentConventionBusinessDayConventionPaymentCalendarCalendarExCouponPeriodPeriodExCouponCalendarCalendarExCouponConventionBusinessDayConventionExCouponEndOfMonthbool
Equals(BondConventions?)
public bool Equals(BondConventions? other)
Parameters
otherBondConventions
Returns
Equals(object?)
public override bool Equals(object? obj)
Parameters
objobject
Returns
GetHashCode()
public override int GetHashCode()
Returns
ToString()
public override string ToString()
Returns
Operators
operator ==(BondConventions?, BondConventions?)
public static bool operator ==(BondConventions? left, BondConventions? right)
Parameters
leftBondConventionsrightBondConventions
Returns
operator !=(BondConventions?, BondConventions?)
public static bool operator !=(BondConventions? left, BondConventions? right)
Parameters
leftBondConventionsrightBondConventions