C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalyzeRe.Layers.DelayedPayment.Payment Class Reference

Describes a single payment, which consists of a delay and fracational amount. More...

Public Member Functions

 Payment ()
 Instantiate a default Payment instance.
 
 Payment (double delayInDays, double amountAsFraction)
 Instantiate a new Payment with the specified delay and amount.
 
override bool Equals (object obj)
 Determine if this Payment is equivalent to another.
 
bool Equals (Payment other)
 Determine if this Payment is equivalent to another.
 
override int GetHashCode ()
 Get the HashCode for this Payment.
 
virtual T ShallowCopy< T > ()
 Create a shallow copy of this object.

See also
ExtensionMethods.DeepCopy<T>

for a serializer-based copy method.

 

Protected Member Functions

virtual void AfterMembersCloned (APIType originalResource)
 Invoked following construction if the current instance has been created using a member-wise clone of some other instance. Override if your derived APIType class contains some members that should not be cloned.
 

Properties

double? amount [get, set]
 The payment amount (as a fraction of the original loss amount).
 
double? delay [get, set]
 The payment delay (in days since the original occurrence date-time).
 

Detailed Description

Describes a single payment, which consists of a delay and fracational amount.

Definition at line 37 of file DelayedPayment.cs.

Inheritance diagram for AnalyzeRe.Layers.DelayedPayment.Payment:
AnalyzeRe.APIType AnalyzeRe.IAPIType

Constructor & Destructor Documentation

◆ Payment() [1/2]

AnalyzeRe.Layers.DelayedPayment.Payment.Payment ( )
inline

Instantiate a default Payment instance.

Used by serializers and object initialization syntax.

Definition at line 55 of file DelayedPayment.cs.

◆ Payment() [2/2]

AnalyzeRe.Layers.DelayedPayment.Payment.Payment ( double  delayInDays,
double  amountAsFraction 
)
inline

Instantiate a new Payment with the specified delay and amount.

Parameters
delayInDaysThe payment delay (in days since the original occurrence date-time).
amountAsFractionThe payment amount (as a fraction of the original loss amount).

Definition at line 60 of file DelayedPayment.cs.

Member Function Documentation

◆ AfterMembersCloned()

virtual void AnalyzeRe.APIType.AfterMembersCloned ( APIType  originalResource)
inlineprotectedvirtualinherited

Invoked following construction if the current instance has been created using a member-wise clone of some other instance. Override if your derived APIType class contains some members that should not be cloned.

Overriding implementations should be sure to invoke base.AfterMembersCloned().

A sane question for a code reviewer to ask might be: "Why not avoid copying those members in the first place?" The answer is that there is no framework-supported method of excluding members from a MemberwiseClone. The only officially supported solution is to not use the object.MemberwiseClone method at all and instead have each class implement it's own Copy method. In our case, most objects have no need to specialize their copy implementation (even though they could - the ShallowCopy<T> method is marked virtual). It's simpler to simply "correct" any special-case members after the fact, and requires less error-prone code than if the code were responsible for ensuring no members were missed in a copy. It's also faster than any reflection-based approach, even though such an approach could benefit from custom attributes meant to exclude certain members from copying.

Reimplemented in AnalyzeRe.APITypes.APIResource_WithDataEndpoint, AnalyzeRe.APIResourceView.BaseAPIResourceView, AnalyzeRe.Distributions.CustomDistribution, AnalyzeRe.LossSets.LossSet_WithData, AnalyzeRe.Optimization.Candidate, AnalyzeRe.Optimization.OptimizationView, and AnalyzeRe.StaticSimulation.

Definition at line 37 of file APIType.cs.

◆ Equals() [1/2]

override bool AnalyzeRe.Layers.DelayedPayment.Payment.Equals ( object  obj)

Determine if this Payment is equivalent to another.

Parameters
objObject to compare to this.
Returns
True if the other object is a Payment and the premium and brokerage are the same.

◆ Equals() [2/2]

bool AnalyzeRe.Layers.DelayedPayment.Payment.Equals ( Payment  other)

Determine if this Payment is equivalent to another.

Parameters
otherThe Payment to compare to this one.
Returns
True if the other Payment is not null and the premium and brokerage are the same.

◆ GetHashCode()

override int AnalyzeRe.Layers.DelayedPayment.Payment.GetHashCode ( )
inline

Get the HashCode for this Payment.

Returns
A unique HashCode for this Payment

Definition at line 83 of file DelayedPayment.cs.

◆ ShallowCopy< T >()

virtual T AnalyzeRe.APIType.ShallowCopy< T > ( )
inlinevirtualinherited

Create a shallow copy of this object.

See also
ExtensionMethods.DeepCopy<T>

for a serializer-based copy method.

Returns
A shallow copy of this object.

If this object contains any members that reference the current object (this), the class should override this method to avoid cloning a reference to the old class.

Implements AnalyzeRe.IAPIType.

Type Constraints
T :IAPIType 

Definition at line 14 of file APIType.cs.

Property Documentation

◆ amount

double? AnalyzeRe.Layers.DelayedPayment.Payment.amount
getset

The payment amount (as a fraction of the original loss amount).

In accordance with ARE-1629, this property is nullable to avoid potential bugs stemming from silent initialization to the default value of 0.0.

Definition at line 51 of file DelayedPayment.cs.

◆ delay

double? AnalyzeRe.Layers.DelayedPayment.Payment.delay
getset

The payment delay (in days since the original occurrence date-time).

In accordance with ARE-1629, this property is nullable to avoid potential bugs stemming from silent initialization to the default value of 0.0.

Definition at line 44 of file DelayedPayment.cs.


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