C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
CoMetricsOptions.cs
Go to the documentation of this file.
1using System;
4
5namespace AnalyzeRe.Metrics
6{
9 public class CoMetricsOptions : MetricsOptions, IEquatable<CoMetricsOptions>
10 {
12 public new static CoMetricsOptions Default => new CoMetricsOptions();
13
17 public string component_filter { get; set; }
18
23
30
35 public bool? include_primary_metrics { get; set; }
36
37 #region Constructors
60 public CoMetricsOptions(string component_filter = null,
63 bool? include_primary_metrics = null,
64 string currency = null, AggregationMethod? aggregation_method = null,
65 Perspective perspective = null, string filter = null,
67 bool? apply_participation = null)
70 {
71 this.component_filter = component_filter;
72 this.component_perspective = component_perspective;
73 this.component_reporting_period = component_reporting_period;
74 this.include_primary_metrics = include_primary_metrics;
75 }
76
92 AggregationMethod? aggregation_method = null, string currency = null,
95 bool? include_primary_metrics = null)
96 : base(toCopy, aggregation_method, currency)
97 {
98 this.component_filter = component_filter;
99 this.component_perspective = component_perspective;
100 this.component_reporting_period = component_reporting_period;
101 this.include_primary_metrics = include_primary_metrics;
102 }
103
116 public CoMetricsOptions(AggregationOptions toCopy, string currency = null,
119 bool? include_primary_metrics = null)
120 : base(toCopy, currency)
121 {
122 this.component_filter = component_filter;
123 this.component_perspective = component_perspective;
124 this.component_reporting_period = component_reporting_period;
125 this.include_primary_metrics = include_primary_metrics;
126 }
127
142 bool? include_primary_metrics = null) : base(toCopy)
143 {
144 this.component_filter = component_filter;
145 this.component_perspective = component_perspective;
146 this.component_reporting_period = component_reporting_period;
147 this.include_primary_metrics = include_primary_metrics;
148 }
149
160 #endregion Constructors
161
162 #region Public Overrides
176
182 public bool Equals(CoMetricsOptions other)
183 {
184 return base.Equals(other) &&
185 BothNullOrEqual(component_filter, other.component_filter) &&
186 BothNullOrEqual(component_perspective, other.component_perspective) &&
188 BothNullOrEqual(include_primary_metrics, other.include_primary_metrics);
189 }
190 #endregion Public Overrides
191 }
192}
API methods / requests made available to the user.
static readonly string DateTimeFormat
The format used when transmitting DateTime information to Analyze Re servers.
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 co-metrics requests.
string component_filter
The filter to use for the component co_metrics calculation. If unset, defaults to SimulationOptions....
CoMetricsOptions(MetricsOptions toCopy, string component_filter=null, Perspective component_perspective=null, ReportingPeriod component_reporting_period=null, bool? include_primary_metrics=null)
Construct a new set of CoMetricsOptions from an existing set of MetricsOptions.
CoMetricsOptions(AggregationOptions toCopy, string currency=null, string component_filter=null, Perspective component_perspective=null, ReportingPeriod component_reporting_period=null, bool? include_primary_metrics=null)
Construct a new set of CoMetricsOptions from an existing set of AggregationOptions.
Perspective component_perspective
The perspective determining which component metrics to return. If unset, defaults to SimulationOption...
override RequestParameters GetParameters()
Get the REST request parameters corresponding to this configuration.
bool? include_primary_metrics
By default, only the component's metrics are computed and returned. The primary distribution is only ...
CoMetricsOptions(CoMetricsOptions toCopy)
Construct a new set of CoMetricsOptions from another.
CoMetricsOptions(SimulationOptions toCopy, AggregationMethod? aggregation_method=null, string currency=null, string component_filter=null, Perspective component_perspective=null, ReportingPeriod component_reporting_period=null, bool? include_primary_metrics=null)
Construct a new set of CoMetricsOptions from an existing set of SimulationOptions.
ReportingPeriod component_reporting_period
A reporting period which dictates optional begin and end dates to constrain what event losses are inc...
bool Equals(CoMetricsOptions other)
Indicates whether the current object is equal to another object of the same type.
CoMetricsOptions(string component_filter=null, Perspective component_perspective=null, ReportingPeriod component_reporting_period=null, bool? include_primary_metrics=null, string currency=null, AggregationMethod? aggregation_method=null, Perspective perspective=null, string filter=null, bool? secondary_uncertainty=null, ReportingPeriod reporting_period=null, bool? apply_participation=null)
Configure one or more optional co-metrics request parameters.
static new CoMetricsOptions Default
The default co-metrics request options used when none are specified.
The context of a co-metrics request, indicating what parameters were used in the simulation that prod...
DateTime? component_reporting_period_begin
The reporting period starting DateTime (if it was set), which restricts component results to only inc...
DateTime? component_reporting_period_end
The reporting period ending DateTime (if it was set), which restricts component results to only inclu...
The structure returned when requesting Co-Metrics for a view.
Optional parameters which can be specified for all metrics requests.
string currency
The currency to convert metrics results to. If not specified, the metrics will be returned in APIType...
bool? apply_participation
Whether or not participation should be applied to results.
A reporting period which dictates optional begin and end dates to constrain what event losses are inc...
DateTime? end
(Optional) The exclusive end date of the reporting period. If specified, event losses occurring on or...
DateTime? begin
(Optional) The inclusive start date of the reporting period. If specified, event losses occurring bef...
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...