C# Client Library
A C# Client Library for the AnalyzeRe REST API
|
Optional parameters which can be specified for co-metrics requests. More...
Public Member Functions | |
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. | |
CoMetricsOptions (CoMetricsOptions toCopy) | |
Construct a new set of CoMetricsOptions from another. | |
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 (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. | |
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. | |
bool | Equals (AggregationOptions other) |
Indicates whether the current object is equal to another object of the same type. | |
bool | Equals (CoMetricsOptions 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.
for a serializer-based copy method. | |
Protected Member Functions | |
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. | |
Properties | |
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 | component_filter [get, set] |
The filter to use for the component co_metrics calculation. If unset, defaults to SimulationOptions.filter, which is the filter used to generate the primary distribution. | |
Perspective | component_perspective [get, set] |
The perspective determining which component metrics to return. If unset, defaults to SimulationOptions.perspective, which is the perspective used to generate the primary distribution. | |
ReportingPeriod | component_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). If unset, defaults to SimulationOptions.reporting_period, which is the reporting period used to generate the primary distribution. | |
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 CoMetricsOptions | Default [get] |
The default co-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. | |
bool? | include_primary_metrics [get, set] |
By default, only the component's metrics are computed and returned. The primary distribution is only used to determine the correlated sort order. Set to true to also compute and include the primary distribution's corresponding metrics in the response object. | |
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 co-metrics requests.
Definition at line 9 of file CoMetricsOptions.cs.
|
inline |
Configure one or more optional co-metrics request parameters.
component_filter | component_filter The filter to use for the component co_metrics calculation. |
component_perspective | component_perspective The perspective to use for the component co_metrics calculation. |
component_reporting_period | component_reporting_period The reporting period to use for the component co_metrics calculation. |
include_primary_metrics | include_primary_metrics Whether to also compute and return primary metrics. |
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 60 of file CoMetricsOptions.cs.
|
inline |
Construct a new set of CoMetricsOptions from an existing set of SimulationOptions.
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. |
component_filter | component_filter The filter to use for the component co_metrics calculation. |
component_perspective | component_perspective The perspective to use for the component co_metrics calculation. |
component_reporting_period | component_reporting_period The reporting period to use for the component co_metrics calculation. |
include_primary_metrics | include_primary_metrics Whether to also compute and return primary metrics. |
Definition at line 91 of file CoMetricsOptions.cs.
|
inline |
Construct a new set of CoMetricsOptions from an existing set of AggregationOptions.
toCopy | The base AggregationOptions to copy. |
currency | The currency to convert metrics results to. |
component_filter | component_filter The filter to use for the component co_metrics calculation. |
component_perspective | component_perspective The perspective to use for the component co_metrics calculation. |
component_reporting_period | component_reporting_period The reporting period to use for the component co_metrics calculation. |
include_primary_metrics | include_primary_metrics Whether to also compute and return primary metrics. |
Definition at line 116 of file CoMetricsOptions.cs.
|
inline |
Construct a new set of CoMetricsOptions from an existing set of MetricsOptions.
toCopy | The base MetricsOptions to copy. |
component_filter | component_filter The filter to use for the component co_metrics calculation. |
component_perspective | component_perspective The perspective to use for the component co_metrics calculation. |
component_reporting_period | component_reporting_period The reporting period to use for the component co_metrics calculation. |
include_primary_metrics | include_primary_metrics Whether to also compute and return primary metrics. |
Definition at line 139 of file CoMetricsOptions.cs.
|
inline |
Construct a new set of CoMetricsOptions from another.
toCopy | The other CoMetricsOptions to copy. |
Definition at line 152 of file CoMetricsOptions.cs.
|
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.
|
inlineprotectedinherited |
Helper method to determine if two classes are equal, or both null.
T | : | class |
Definition at line 94 of file SimulationOptions.cs.
|
inlineprotectedinherited |
Helper method to determine if two nullable values are equal, or both null.
T | : | struct |
Definition at line 100 of file SimulationOptions.cs.
|
inlineinherited |
Indicates whether the current object is equal to another object of the same type.
other | An object to compare with this object. |
Definition at line 76 of file AggregationOptions.cs.
|
inline |
Indicates whether the current object is equal to another object of the same type.
other | An object to compare with this object. |
Definition at line 182 of file CoMetricsOptions.cs.
|
inlineinherited |
Indicates whether the current object is equal to another object of the same type.
other | An object to compare with this object. |
Definition at line 103 of file MetricsOptions.cs.
|
inlineinherited |
Indicates whether the current object is equal to another object of the same type.
other | An object to compare with this object. |
Definition at line 83 of file SimulationOptions.cs.
|
inlinevirtual |
Get the REST request parameters corresponding to this configuration.
Reimplemented from AnalyzeRe.Metrics.AggregationOptions.
Definition at line 165 of file CoMetricsOptions.cs.
|
inlinevirtualinherited |
Create a shallow copy of this object.
for a serializer-based copy method.
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.
T | : | IAPIType |
Definition at line 14 of file APIType.cs.
|
getsetinherited |
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.
|
getsetinherited |
Whether or not participation should be applied to results.
Definition at line 20 of file MetricsOptions.cs.
|
getset |
The filter to use for the component co_metrics calculation. If unset, defaults to SimulationOptions.filter, which is the filter used to generate the primary distribution.
Definition at line 17 of file CoMetricsOptions.cs.
|
getset |
The perspective determining which component metrics to return. If unset, defaults to SimulationOptions.perspective, which is the perspective used to generate the primary distribution.
Definition at line 22 of file CoMetricsOptions.cs.
|
getset |
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). If unset, defaults to SimulationOptions.reporting_period, which is the reporting period used to generate the primary distribution.
Definition at line 29 of file CoMetricsOptions.cs.
|
getsetinherited |
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.
|
staticget |
The default co-metrics request options used when none are specified.
Definition at line 12 of file CoMetricsOptions.cs.
|
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.
|
getset |
By default, only the component's metrics are computed and returned. The primary distribution is only used to determine the correlated sort order. Set to true to also compute and include the primary distribution's corresponding metrics in the response object.
Definition at line 35 of file CoMetricsOptions.cs.
|
getsetinherited |
The requested Perspective, which determines which factors are included in the loss distribution.
Definition at line 17 of file SimulationOptions.cs.
|
getsetinherited |
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.
|
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.