LUSID C# SDK
Public Member Functions | Protected Member Functions | Properties | List of all members
Lusid.Sdk.Model.DiscountingDependency Class Reference

For indicating a dependency on discounting for a given currency. E.g Valuing a Bond with the Discounting model will declare a DiscountingDependency for the domestic currency of the bond to account for the time-value of the future cashFlows of the bond. More...

Inheritance diagram for Lusid.Sdk.Model.DiscountingDependency:
Inheritance graph
[legend]

Public Member Functions

 DiscountingDependency (string currency=default(string), DateTimeOffset date=default(DateTimeOffset), DependencyTypeEnum dependencyType=default(DependencyTypeEnum))
 Initializes a new instance of the DiscountingDependency class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
override string ToJson ()
 Returns the JSON string presentation of the object More...
 
override bool Equals (object input)
 Returns true if objects are equal More...
 
bool Equals (DiscountingDependency input)
 Returns true if DiscountingDependency instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
- Public Member Functions inherited from Lusid.Sdk.Model.EconomicDependency
 EconomicDependency (DependencyTypeEnum dependencyType=default(DependencyTypeEnum))
 Initializes a new instance of the EconomicDependency class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
override bool Equals (object input)
 Returns true if objects are equal More...
 
bool Equals (EconomicDependency input)
 Returns true if EconomicDependency instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 DiscountingDependency ()
 Initializes a new instance of the DiscountingDependency class. More...
 
IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > BaseValidate (ValidationContext validationContext)
 To validate all properties of the instance More...
 
- Protected Member Functions inherited from Lusid.Sdk.Model.EconomicDependency
 EconomicDependency ()
 Initializes a new instance of the EconomicDependency class. More...
 
IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > BaseValidate (ValidationContext validationContext)
 To validate all properties of the instance More...
 

Properties

string Currency [get, set]
 The currency that needs to be discounted. More...
 
DateTimeOffset Date [get, set]
 The effectiveDate of the entity that this is a dependency for. Unless there is an obvious date this should be, like for a historic reset, then this is the valuation date. More...
 
- Properties inherited from Lusid.Sdk.Model.EconomicDependency
DependencyTypeEnum DependencyType [get, set]
 The available values are: OpaqueDependency, CashDependency, DiscountingDependency, EquityCurveDependency, EquityVolDependency, FxDependency, FxForwardsDependency, FxVolDependency, IndexProjectionDependency, IrVolDependency, QuoteDependency, Vendor, CalendarDependency, InflationFixingDependency More...
 

Additional Inherited Members

- Public Types inherited from Lusid.Sdk.Model.EconomicDependency
enum class  DependencyTypeEnum {
  OpaqueDependency = 1 , CashDependency = 2 , DiscountingDependency = 3 , EquityCurveDependency = 4 ,
  EquityVolDependency = 5 , FxDependency = 6 , FxForwardsDependency = 7 , FxVolDependency = 8 ,
  IndexProjectionDependency = 9 , IrVolDependency = 10 , QuoteDependency = 11 , Vendor = 12 ,
  CalendarDependency = 13 , InflationFixingDependency = 14
}
 The available values are: OpaqueDependency, CashDependency, DiscountingDependency, EquityCurveDependency, EquityVolDependency, FxDependency, FxForwardsDependency, FxVolDependency, IndexProjectionDependency, IrVolDependency, QuoteDependency, Vendor, CalendarDependency, InflationFixingDependency More...
 

Detailed Description

For indicating a dependency on discounting for a given currency. E.g Valuing a Bond with the Discounting model will declare a DiscountingDependency for the domestic currency of the bond to account for the time-value of the future cashFlows of the bond.

Constructor & Destructor Documentation

◆ DiscountingDependency() [1/2]

Lusid.Sdk.Model.DiscountingDependency.DiscountingDependency ( )
inlineprotected

Initializes a new instance of the DiscountingDependency class.

◆ DiscountingDependency() [2/2]

Lusid.Sdk.Model.DiscountingDependency.DiscountingDependency ( string  currency = default(string),
DateTimeOffset  date = default(DateTimeOffset),
DependencyTypeEnum  dependencyType = default(DependencyTypeEnum) 
)
inline

Initializes a new instance of the DiscountingDependency class.

Parameters
currencyThe currency that needs to be discounted. (required).
dateThe effectiveDate of the entity that this is a dependency for. Unless there is an obvious date this should be, like for a historic reset, then this is the valuation date. (required).
dependencyTypeThe available values are: OpaqueDependency, CashDependency, DiscountingDependency, EquityCurveDependency, EquityVolDependency, FxDependency, FxForwardsDependency, FxVolDependency, IndexProjectionDependency, IrVolDependency, QuoteDependency, Vendor, CalendarDependency, InflationFixingDependency (required) (default to "DiscountingDependency").

Member Function Documentation

◆ BaseValidate()

IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Lusid.Sdk.Model.DiscountingDependency.BaseValidate ( ValidationContext  validationContext)
inlineprotected

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

bool Lusid.Sdk.Model.DiscountingDependency.Equals ( DiscountingDependency  input)
inline

Returns true if DiscountingDependency instances are equal

Parameters
inputInstance of DiscountingDependency to be compared
Returns
Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.DiscountingDependency.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.DiscountingDependency.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

override string Lusid.Sdk.Model.DiscountingDependency.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.EconomicDependency.

◆ ToString()

override string Lusid.Sdk.Model.DiscountingDependency.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ Currency

string Lusid.Sdk.Model.DiscountingDependency.Currency
getset

The currency that needs to be discounted.

The currency that needs to be discounted.

◆ Date

DateTimeOffset Lusid.Sdk.Model.DiscountingDependency.Date
getset

The effectiveDate of the entity that this is a dependency for. Unless there is an obvious date this should be, like for a historic reset, then this is the valuation date.

The effectiveDate of the entity that this is a dependency for. Unless there is an obvious date this should be, like for a historic reset, then this is the valuation date.


The documentation for this class was generated from the following file: