C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
ExceedanceProbabilityOptions.cs
Go to the documentation of this file.
1using System;
4
5namespace AnalyzeRe.Metrics
6{
10 IEquatable<ExceedanceProbabilityOptions>
11 {
14
20 public bool? inclusive_threshold { get; set; }
21
25 public string threshold_currency { get; set; }
26
28 public bool? threshold_includes_participation { get; set; }
29
30 #region Constructors
51 Perspective perspective = null, string filter = null,
55 {
56 this.inclusive_threshold = inclusive_threshold;
57 this.threshold_currency = threshold_currency;
58 this.threshold_includes_participation = threshold_includes_participation;
59 }
60
75 bool? inclusive_threshold = null, string threshold_currency = null,
77 : base(toCopy, aggregation_method)
78 {
79 this.inclusive_threshold = inclusive_threshold;
80 this.threshold_currency = threshold_currency;
81 this.threshold_includes_participation = threshold_includes_participation;
82 }
83
94 bool? inclusive_threshold = null, string threshold_currency = null,
96 : base(toCopy)
97 {
98 this.inclusive_threshold = inclusive_threshold;
99 this.threshold_currency = threshold_currency;
100 this.threshold_includes_participation = threshold_includes_participation;
101 }
102
114 #endregion Constructors
115
116 #region Public Overrides
127
134 {
135 return base.Equals(other) &&
136 BothNullOrEqual(inclusive_threshold, other.inclusive_threshold) &&
137 BothNullOrEqual(threshold_currency, other.threshold_currency) &&
139 }
140 #endregion Public Overrides
141 }
142}
Optional parameters which can be specified for all aggregated simulation result requests.
AggregationMethod? aggregation_method
The aggregation method (AEP or OEP) used to compute this distribution. The default is AEP (Aggregate ...
Optional parameters which can be specified for exceedance probability requests.
static new ExceedanceProbabilityOptions Default
The default exceedance probability request options used when none are specified.
string threshold_currency
The currency of the threshold parameter. If not specified, the threshold is assumed to be in the APIT...
bool Equals(ExceedanceProbabilityOptions other)
Indicates whether the current object is equal to another object of the same type.
override RequestParameters GetParameters()
Get the REST request parameters corresponding to this configuration.
ExceedanceProbabilityOptions(SimulationOptions toCopy, AggregationMethod? aggregation_method=null, bool? inclusive_threshold=null, string threshold_currency=null, bool? threshold_includes_participation=null)
Construct a new set of ExceedanceProbabilityOptions from an existing set of SimulationOptions.
ExceedanceProbabilityOptions(bool? inclusive_threshold=null, string threshold_currency=null, AggregationMethod? aggregation_method=null, Perspective perspective=null, string filter=null, bool? secondary_uncertainty=null, ReportingPeriod reporting_period=null, bool? threshold_includes_participation=null)
Configure one or more optional exceedance probability request parameters.
bool? threshold_includes_participation
Whether or not participation have been included in threshold values.
ExceedanceProbabilityOptions(AggregationOptions toCopy, bool? inclusive_threshold=null, string threshold_currency=null, bool? threshold_includes_participation=null)
Construct a new set of ExceedanceProbabilityOptions from an existing set of AggregationOptions.
bool? inclusive_threshold
Whether the threshold value is inclusive or not. If false (which is the default when unset),...
ExceedanceProbabilityOptions(ExceedanceProbabilityOptions toCopy)
Construct a new set of ExceedanceProbabilityOptions from another.
A reporting period which dictates optional begin and end dates to constrain what event losses are inc...
Optional parameters which can be specified for all simulation result requests. Includes a variety of ...
ReportingPeriod reporting_period
A reporting period which dictates optional begin and end dates to constrain what event losses are inc...
Perspective perspective
The requested Perspective, which determines which factors are included in the loss distribution.
string filter
The name of the predefined filter used to determine which event losses are included in the resulting ...
bool? secondary_uncertainty
Whether or not to simulate using secondary uncertainty (if available). Set this to false to explicitl...
The loss perspective determines what factors to include when computing a distribution.
Helper class which makes it easier to build a set of request parameters.
RequestParameters AddQueryParameter(string name, string value)
Adds the specified name/value pair as a new request parameter with the type ParameterType....
AggregationMethod
Specifies the method of aggregating event occurrences in a trial year for computing different types o...