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

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

Public Member Functions

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.
 
bool apply_participation [get, set]
 Whether or not participation was applied to the results. If this is false, then the metrics returned for layers are at 100% (i.e. layer participation has not been applied).
 
IReference< IAPIResourceViewcomponent [get, set]
 The Component LayerView or PortfolioView that generated these metrics.
 
string component_filter [get, set]
 The name of the filter when filtering component losses.
 
Perspective component_perspective [get, set]
 The perspective determining which component losses to return.
 
DateTime? component_reporting_period_begin [get, set]
 The reporting period starting DateTime (if it was set), which restricts component results to only include component losses occurring on or after this DateTime.
 
DateTime? component_reporting_period_end [get, set]
 The reporting period ending DateTime (if it was set), which restricts component results to only include component losses occurring before this DateTime.
 
string currency [get, set]
 The currency of any monetary amounts in the context or results.
 
string filter [get, set]
 The name of the predefined filter used to determine which event losses are included in the resulting distribution.
 
bool? include_primary_metrics [get, set]
 Whether primary metrics are included in the response.
 
double max_probability = Double.NaN [get, set]
 The probability determining where the window distribution ends.
 
double min_probability = Double.NaN [get, set]
 The probability determining where the window distribution begins.
 
Perspective perspective [get, set]
 The loss perspective determining which outputs are included in the loss distribution.
 
new double probability [get, set]
 Obsolete: The CoMetrics object used to represent only the tail-co-metrics, but now more flexibly supports co-metrics for a

See also
ProbabilityWindow

. This property actually returns the WindowMetrics.Context.max_probability value, which corresponds to the probability for a given tail 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.
 

Detailed Description

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

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

Inheritance diagram for AnalyzeRe.Metrics.CoMetrics.Context:
AnalyzeRe.Metrics.TailMetrics.Context AnalyzeRe.Metrics.WindowMetrics.Context AnalyzeRe.Metrics.Context AnalyzeRe.APIType AnalyzeRe.IAPIType

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.

◆ apply_participation

bool AnalyzeRe.Metrics.WindowMetrics.Context.apply_participation
getsetinherited

Whether or not participation was applied to the results. If this is false, then the metrics returned for layers are at 100% (i.e. layer participation has not been applied).

Definition at line 28 of file WindowMetrics.Context.cs.

◆ component

IReference<IAPIResourceView> AnalyzeRe.Metrics.CoMetrics.Context.component
getset

The Component LayerView or PortfolioView that generated these metrics.

Definition at line 23 of file CoMetrics.Context.cs.

◆ component_filter

string AnalyzeRe.Metrics.CoMetrics.Context.component_filter
getset

The name of the filter when filtering component losses.

Definition at line 27 of file CoMetrics.Context.cs.

◆ component_perspective

Perspective AnalyzeRe.Metrics.CoMetrics.Context.component_perspective
getset

The perspective determining which component losses to return.

Definition at line 31 of file CoMetrics.Context.cs.

◆ component_reporting_period_begin

DateTime? AnalyzeRe.Metrics.CoMetrics.Context.component_reporting_period_begin
getset

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

Definition at line 36 of file CoMetrics.Context.cs.

◆ component_reporting_period_end

DateTime? AnalyzeRe.Metrics.CoMetrics.Context.component_reporting_period_end
getset

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

Definition at line 41 of file CoMetrics.Context.cs.

◆ currency

string AnalyzeRe.Metrics.WindowMetrics.Context.currency
getsetinherited

The currency of any monetary amounts in the context or results.

Definition at line 22 of file WindowMetrics.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.

◆ include_primary_metrics

bool? AnalyzeRe.Metrics.CoMetrics.Context.include_primary_metrics
getset

Whether primary metrics are included in the response.

Definition at line 45 of file CoMetrics.Context.cs.

◆ max_probability

double AnalyzeRe.Metrics.WindowMetrics.Context.max_probability = Double.NaN
getsetinherited

The probability determining where the window distribution ends.

Definition at line 18 of file WindowMetrics.Context.cs.

◆ min_probability

double AnalyzeRe.Metrics.WindowMetrics.Context.min_probability = Double.NaN
getsetinherited

The probability determining where the window distribution begins.

Definition at line 14 of file WindowMetrics.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.

◆ probability

new double AnalyzeRe.Metrics.CoMetrics.Context.probability
getset

Obsolete: The CoMetrics object used to represent only the tail-co-metrics, but now more flexibly supports co-metrics for a

See also
ProbabilityWindow

. This property actually returns the WindowMetrics.Context.max_probability value, which corresponds to the probability for a given tail distribution.

Definition at line 19 of file CoMetrics.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.


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