C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AggregationOptions.cs
Go to the documentation of this file.
1using System;
4
6{
9 public class AggregationOptions : SimulationOptions, IEquatable<AggregationOptions>
10 {
12 public new static AggregationOptions Default => new AggregationOptions();
13
20
21 #region Constructors
40
48 : base(toCopy)
49 {
50 this.aggregation_method = aggregation_method;
51 }
52
56 {
57 if (toCopy == null) return;
59 }
60 #endregion Constructors
61
62 #region Public Overrides
66 {
67 return base.GetParameters()
69 }
70
76 public bool Equals(AggregationOptions other)
77 {
78 return base.Equals(other) &&
79 BothNullOrEqual(aggregation_method, other.aggregation_method);
80 }
81 #endregion Public Overrides
82 }
83}
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 ...
AggregationOptions(AggregationOptions toCopy)
Construct a new set of AggregationOptions from another.
bool Equals(AggregationOptions other)
Indicates whether the current object is equal to another object of the same type.
static new AggregationOptions Default
The default aggregated simulation request options used when none are specified.
AggregationOptions(SimulationOptions toCopy, AggregationMethod? aggregation_method=null)
Construct a new set of AggregationOptions from an existing set of SimulationOptions.
override RequestParameters GetParameters()
Get the REST request parameters corresponding to this configuration.
AggregationOptions(AggregationMethod? aggregation_method=null, Perspective perspective=null, string filter=null, bool? secondary_uncertainty=null, ReportingPeriod reporting_period=null)
Configure one or more optional aggregated simulation request parameters.
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...