82 if (toCopy ==
null)
return;
86 #endregion Constructors
88 #region Public Overrides
93 return base.GetParameters()
105 return base.Equals(other) &&
109 #endregion Public Overrides
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 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.
MetricsOptions(AggregationOptions toCopy, string currency=null, bool? apply_participation=null)
Construct a new set of MetricsOptions from an existing set of AggregationOptions.
MetricsOptions(MetricsOptions toCopy)
Construct a new set of MetricsOptions from another.
MetricsOptions(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 metrics request parameters.
MetricsOptions(SimulationOptions toCopy, AggregationMethod? aggregation_method=null, string currency=null, bool? apply_participation=null)
Construct a new set of MetricsOptions from an existing set of SimulationOptions.
override RequestParameters GetParameters()
Get the REST request parameters corresponding to this configuration.
bool Equals(MetricsOptions other)
Indicates whether the current object is equal to another object of the same type.
static new MetricsOptions Default
The default metrics request options used when none are specified.
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...