C# Client Library
A C# Client Library for the AnalyzeRe REST API
|
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 | |
virtual T | ShallowCopy< T > () |
Create a shallow copy of this object.
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). | |
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. | |
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. | |
double | probability [get, set] |
The probability determining where the tail distribution begins. Note that this is equal to the WindowMetrics.Context.max_probability of a probability window where the WindowMetrics.Context.min_probability is zero. As such, this property is only meaningful for tail metrics results. | |
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. | |
The context of a tail metrics request, indicating what parameters were used in the simulation that produced the associated metrics response.
Definition at line 13 of file TailMetrics.Context.cs.
|
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.
|
inlinevirtualinherited |
Create a shallow copy of this object.
for a serializer-based copy method.
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.
T | : | IAPIType |
Definition at line 14 of file APIType.cs.
|
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.
|
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.
|
getsetinherited |
The currency of any monetary amounts in the context or results.
Definition at line 22 of file WindowMetrics.Context.cs.
|
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.
|
getsetinherited |
The probability determining where the window distribution ends.
Definition at line 18 of file WindowMetrics.Context.cs.
|
getsetinherited |
The probability determining where the window distribution begins.
Definition at line 14 of file WindowMetrics.Context.cs.
|
getsetinherited |
The loss perspective determining which outputs are included in the loss distribution.
Definition at line 14 of file Context.cs.
|
getset |
The probability determining where the tail distribution begins. Note that this is equal to the WindowMetrics.Context.max_probability of a probability window where the WindowMetrics.Context.min_probability is zero. As such, this property is only meaningful for tail metrics results.
This property exists for backwards compatibility purposes. Before WindowMetrics were created, there were no min/max probability attributes, only the one probability (which was treated as a max probability). Now the API works only in terms of min/max probability as a pair, and this tail metrics context exists as a simplification built on top of that.
Definition at line 25 of file TailMetrics.Context.cs.
|
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.
|
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.
|
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.