Optional parameters which can be specified for all metrics requests.
More...
|
| 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 (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.
|
|
| 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.
|
|
bool | Equals (AggregationOptions other) |
| Indicates whether the current object is equal to another object of the same type.
|
|
bool | Equals (MetricsOptions other) |
| Indicates whether the current object is equal to another object of the same type.
|
|
bool | Equals (SimulationOptions 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.
|
|
virtual T | ShallowCopy< T > () |
| Create a shallow copy of this object. - See also
- ExtensionMethods.DeepCopy<T>
for a serializer-based copy method.
|
|
|
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.
|
|
bool | BothNullOrEqual< T > (T first, T second) |
| Helper method to determine if two classes are equal, or both null.
|
|
bool | BothNullOrEqual< T > (T? first, T? second) |
| Helper method to determine if two nullable values are equal, or both null.
|
|
|
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 should be applied to results.
|
|
string | currency [get, set] |
| The currency to convert metrics results to. If not specified, the metrics will be returned in APITypes.IAPIAnalysis.target_currency of the structure on which these metrics are requested.
|
|
static new MetricsOptions | Default [get] |
| The default metrics request options used when none are specified.
|
|
string | filter [get, set] |
| The name of the predefined filter used to determine which event losses are included in the resulting distribution.
|
|
Perspective | perspective [get, set] |
| The requested Perspective, which determines which factors are included in the loss distribution.
|
|
ReportingPeriod | reporting_period = new ReportingPeriod() [get, set] |
| A reporting period which dictates optional begin and end dates to constrain what event losses are included in the distribution based on their occurrence date and time (sequence).
|
|
bool? | secondary_uncertainty [get, set] |
| Whether or not to simulate using secondary uncertainty (if available). Set this to false to explicitly disable secondary uncertainty.
|
|
Optional parameters which can be specified for all metrics requests.
- See also
- IAPIResourceView.tail_metrics(Double,MetricsOptions,Int32?)
Definition at line 9 of file MetricsOptions.cs.
◆ MetricsOptions() [1/4]
AnalyzeRe.Metrics.MetricsOptions.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 |
|
) |
| |
|
inline |
Configure one or more optional metrics request parameters.
- Parameters
-
currency | The currency to convert metrics results to. |
aggregation_method | The aggregation method (AEP or OEP) used to compute this distribution. AggregationOptions.aggregation_method |
perspective | The requested Perspective, which determines which factors are included in the loss distribution. |
filter | The name of the predefined filter used to determine which event losses are included in the resulting distribution. |
secondary_uncertainty | Whether or not to simulate using secondary uncertainty (if available). |
reporting_period | A ReportingPeriod, which restricts the distribution to only include event losses in the specified DateTime range. |
apply_participation | Whether or not participation should be applied to results. |
Definition at line 37 of file MetricsOptions.cs.
◆ MetricsOptions() [2/4]
AnalyzeRe.Metrics.MetricsOptions.MetricsOptions |
( |
SimulationOptions |
toCopy, |
|
|
AggregationMethod? |
aggregation_method = null , |
|
|
string |
currency = null , |
|
|
bool? |
apply_participation = null |
|
) |
| |
|
inline |
Construct a new set of MetricsOptions from an existing set of SimulationOptions.
- Parameters
-
toCopy | The base SimulationOptions to copy. |
aggregation_method | The aggregation method (AEP or OEP) used to compute this distribution. AggregationOptions.aggregation_method |
currency | The currency to convert metrics results to. |
apply_participation | Whether or not participation should be applied to results. |
Definition at line 55 of file MetricsOptions.cs.
◆ MetricsOptions() [3/4]
AnalyzeRe.Metrics.MetricsOptions.MetricsOptions |
( |
AggregationOptions |
toCopy, |
|
|
string |
currency = null , |
|
|
bool? |
apply_participation = null |
|
) |
| |
|
inline |
Construct a new set of MetricsOptions from an existing set of AggregationOptions.
- Parameters
-
toCopy | The base AggregationOptions to copy. |
currency | The currency to convert metrics results to. |
apply_participation | Whether or not participation should be applied to results. |
Definition at line 70 of file MetricsOptions.cs.
◆ MetricsOptions() [4/4]
AnalyzeRe.Metrics.MetricsOptions.MetricsOptions |
( |
MetricsOptions |
toCopy | ) |
|
|
inline |
Construct a new set of MetricsOptions from another.
- Parameters
-
toCopy | The other MetricsOptions to copy. |
Definition at line 80 of file MetricsOptions.cs.
◆ AfterMembersCloned()
virtual void AnalyzeRe.APIType.AfterMembersCloned |
( |
APIType |
originalResource | ) |
|
|
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.
◆ BothNullOrEqual< T >() [1/2]
bool AnalyzeRe.Metrics.SimulationOptions.BothNullOrEqual< T > |
( |
T |
first, |
|
|
T |
second |
|
) |
| |
|
inlineprotectedinherited |
Helper method to determine if two classes are equal, or both null.
Definition at line 94 of file SimulationOptions.cs.
◆ BothNullOrEqual< T >() [2/2]
bool AnalyzeRe.Metrics.SimulationOptions.BothNullOrEqual< T > |
( |
T? |
first, |
|
|
T? |
second |
|
) |
| |
|
inlineprotectedinherited |
Helper method to determine if two nullable values are equal, or both null.
Definition at line 100 of file SimulationOptions.cs.
◆ Equals() [1/3]
Indicates whether the current object is equal to another object of the same type.
- Returns
- true if the current object is equal to the other parameter; otherwise, false.
- Parameters
-
other | An object to compare with this object. |
Definition at line 76 of file AggregationOptions.cs.
◆ Equals() [2/3]
Indicates whether the current object is equal to another object of the same type.
- Returns
- true if the current object is equal to the other parameter; otherwise, false.
- Parameters
-
other | An object to compare with this object. |
Definition at line 103 of file MetricsOptions.cs.
◆ Equals() [3/3]
Indicates whether the current object is equal to another object of the same type.
- Returns
- true if the current object is equal to the other parameter; otherwise, false.
- Parameters
-
other | An object to compare with this object. |
Definition at line 83 of file SimulationOptions.cs.
◆ GetParameters()
◆ ShallowCopy< T >()
virtual T AnalyzeRe.APIType.ShallowCopy< T > |
( |
| ) |
|
|
inlinevirtualinherited |
Create a shallow copy of this object.
- See also
- ExtensionMethods.DeepCopy<T>
for a serializer-based copy method.
- Returns
- A shallow copy of this object.
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.
Definition at line 14 of file APIType.cs.
◆ aggregation_method
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 19 of file AggregationOptions.cs.
◆ apply_participation
bool? AnalyzeRe.Metrics.MetricsOptions.apply_participation |
|
getset |
Whether or not participation should be applied to results.
Definition at line 20 of file MetricsOptions.cs.
◆ currency
string AnalyzeRe.Metrics.MetricsOptions.currency |
|
getset |
The currency to convert metrics results to. If not specified, the metrics will be returned in APITypes.IAPIAnalysis.target_currency of the structure on which these metrics are requested.
Definition at line 17 of file MetricsOptions.cs.
◆ Default
The default metrics request options used when none are specified.
Definition at line 12 of file MetricsOptions.cs.
◆ filter
string AnalyzeRe.Metrics.SimulationOptions.filter |
|
getsetinherited |
The name of the predefined filter used to determine which event losses are included in the resulting distribution.
Definition at line 21 of file SimulationOptions.cs.
◆ perspective
Perspective AnalyzeRe.Metrics.SimulationOptions.perspective |
|
getsetinherited |
The requested Perspective, which determines which factors are included in the loss distribution.
Definition at line 17 of file SimulationOptions.cs.
◆ reporting_period
A reporting period which dictates optional begin and end dates to constrain what event losses are included in the distribution based on their occurrence date and time (sequence).
Definition at line 29 of file SimulationOptions.cs.
◆ secondary_uncertainty
bool? AnalyzeRe.Metrics.SimulationOptions.secondary_uncertainty |
|
getsetinherited |
Whether or not to simulate using secondary uncertainty (if available). Set this to false to explicitly disable secondary uncertainty.
Definition at line 25 of file SimulationOptions.cs.
The documentation for this class was generated from the following file: