C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalyzeRe.Metrics.ExceedanceProbability.Context Class Reference

The context of a tail metrics request, indicating what parameters were used in the simulation that produced the associated metrics response. More...

Public Member Functions

 Context ()
 Construct a new TailMetrics Context object.
 
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

APIResourceView.AggregationMethod aggregation_method [get, set]
 The aggregation method (AEP or OEP) used to compute this distribution. The default is AEP (Aggregate Exceedance Probability) which computes a distribution using the sum of all occurrence losses in each trial year. OEP (Occurrence Exceedance Probability) computes a distribution that reports only the largest occurrence loss in each trial year.
 
string filter [get, set]
 The name of the predefined filter used to determine which event losses are included in the resulting distribution.
 
bool inclusive_threshold [get, set]
 Whether the threshold value is inclusive or not.
 
Perspective perspective [get, set]
 The loss perspective determining which outputs are included in the loss distribution.
 
DateTime? reporting_period_begin [get, set]
 The reporting period starting DateTime (if it was set), which restricts results to only include losses occurring on or after this DateTime.
 
DateTime? reporting_period_end [get, set]
 The reporting period ending DateTime (if it was set), which restricts results to only include losses occurring before this DateTime.
 
bool secondary_uncertainty [get, set]
 Whether or not to simulate using secondary uncertainty (if available). This is set to false only if secondary uncertainty was explicitly disabled.
 
double threshold [get, set]
 The threshold parameter.
 
string threshold_currency [get, set]
 The currency of the threshold parameter.
 
bool threshold_includes_participation [get, set]
 Whether or not participation have been included in threshold values.
 

Detailed Description

The context of a tail metrics request, indicating what parameters were used in the simulation that produced the associated metrics response.

Definition at line 12 of file ExceedanceProbability.Context.cs.

Inheritance diagram for AnalyzeRe.Metrics.ExceedanceProbability.Context:
AnalyzeRe.Metrics.Context AnalyzeRe.APIType AnalyzeRe.IAPIType

Constructor & Destructor Documentation

◆ Context()

AnalyzeRe.Metrics.ExceedanceProbability.Context.Context ( )
inline

Construct a new TailMetrics Context object.

Definition at line 32 of file ExceedanceProbability.Context.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.

◆ 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

◆ aggregation_method

APIResourceView.AggregationMethod AnalyzeRe.Metrics.Context.aggregation_method
getsetinherited

The aggregation method (AEP or OEP) used to compute this distribution. The default is AEP (Aggregate Exceedance Probability) which computes a distribution using the sum of all occurrence losses in each trial year. OEP (Occurrence Exceedance Probability) computes a distribution that reports only the largest occurrence loss in each trial year.

Definition at line 27 of file Context.cs.

◆ filter

string AnalyzeRe.Metrics.Context.filter
getsetinherited

The name of the predefined filter used to determine which event losses are included in the resulting distribution.

Definition at line 19 of file Context.cs.

◆ inclusive_threshold

bool AnalyzeRe.Metrics.ExceedanceProbability.Context.inclusive_threshold
getset

Whether the threshold value is inclusive or not.

Definition at line 24 of file ExceedanceProbability.Context.cs.

◆ perspective

Perspective AnalyzeRe.Metrics.Context.perspective
getsetinherited

The loss perspective determining which outputs are included in the loss distribution.

Definition at line 14 of file Context.cs.

◆ reporting_period_begin

DateTime? AnalyzeRe.Metrics.Context.reporting_period_begin
getsetinherited

The reporting period starting DateTime (if it was set), which restricts results to only include losses occurring on or after this DateTime.

Definition at line 37 of file Context.cs.

◆ reporting_period_end

DateTime? AnalyzeRe.Metrics.Context.reporting_period_end
getsetinherited

The reporting period ending DateTime (if it was set), which restricts results to only include losses occurring before this DateTime.

Definition at line 42 of file Context.cs.

◆ secondary_uncertainty

bool AnalyzeRe.Metrics.Context.secondary_uncertainty
getsetinherited

Whether or not to simulate using secondary uncertainty (if available). This is set to false only if secondary uncertainty was explicitly disabled.

Definition at line 32 of file Context.cs.

◆ threshold

double AnalyzeRe.Metrics.ExceedanceProbability.Context.threshold
getset

The threshold parameter.

Definition at line 16 of file ExceedanceProbability.Context.cs.

◆ threshold_currency

string AnalyzeRe.Metrics.ExceedanceProbability.Context.threshold_currency
getset

The currency of the threshold parameter.

Definition at line 20 of file ExceedanceProbability.Context.cs.

◆ threshold_includes_participation

bool AnalyzeRe.Metrics.ExceedanceProbability.Context.threshold_includes_participation
getset

Whether or not participation have been included in threshold values.

Definition at line 29 of file ExceedanceProbability.Context.cs.


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