C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalyzeRe.Metrics.AggregationOptions Class Reference

Optional parameters which can be specified for all aggregated simulation result requests. More...

Public Member Functions

 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.
 
 AggregationOptions (AggregationOptions toCopy)
 Construct a new set of AggregationOptions from another.
 
 AggregationOptions (SimulationOptions toCopy, AggregationMethod? aggregation_method=null)
 Construct a new set of AggregationOptions from an existing set of SimulationOptions.
 
bool Equals (AggregationOptions 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.

 

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

AggregationMethodaggregation_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.
 
static new AggregationOptions Default [get]
 The default aggregated simulation 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.
 

Detailed Description

Optional parameters which can be specified for all aggregated simulation result requests.

Definition at line 9 of file AggregationOptions.cs.

Inheritance diagram for AnalyzeRe.Metrics.AggregationOptions:
AnalyzeRe.Metrics.SimulationOptions AnalyzeRe.APIType AnalyzeRe.IAPIType AnalyzeRe.Metrics.ExceedanceProbabilityOptions AnalyzeRe.Metrics.MetricsOptions AnalyzeRe.Metrics.CoMetricsOptions

Constructor & Destructor Documentation

◆ AggregationOptions() [1/3]

AnalyzeRe.Metrics.AggregationOptions.AggregationOptions ( AggregationMethod aggregation_method = null,
Perspective  perspective = null,
string  filter = null,
bool?  secondary_uncertainty = null,
ReportingPeriod  reporting_period = null 
)
inline

Configure one or more optional aggregated simulation request parameters.

Parameters
aggregation_methodThe aggregation method (AEP or OEP) used to compute this distribution. aggregation_method
perspectiveThe requested Perspective, which determines which factors are included in the loss distribution.
filterThe name of the predefined filter used to determine which event losses are included in the resulting distribution.
secondary_uncertaintyWhether or not to simulate using secondary uncertainty (if available).
reporting_periodA ReportingPeriod, which restricts the distribution to only include event losses in the specified DateTime range.

Definition at line 33 of file AggregationOptions.cs.

◆ AggregationOptions() [2/3]

AnalyzeRe.Metrics.AggregationOptions.AggregationOptions ( SimulationOptions  toCopy,
AggregationMethod aggregation_method = null 
)
inline

Construct a new set of AggregationOptions from an existing set of SimulationOptions.

Parameters
toCopyThe base SimulationOptions to copy.
aggregation_methodThe aggregation method (AEP or OEP) used to compute this distribution. aggregation_method

Definition at line 46 of file AggregationOptions.cs.

◆ AggregationOptions() [3/3]

AnalyzeRe.Metrics.AggregationOptions.AggregationOptions ( AggregationOptions  toCopy)
inline

Construct a new set of AggregationOptions from another.

Parameters
toCopyThe other AggregationOptions to copy.

Definition at line 55 of file AggregationOptions.cs.

Member Function Documentation

◆ 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 > ( first,
second 
)
inlineprotectedinherited

Helper method to determine if two classes are equal, or both null.

Type Constraints
T :class 

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.

Type Constraints
T :struct 

Definition at line 100 of file SimulationOptions.cs.

◆ Equals() [1/2]

bool AnalyzeRe.Metrics.AggregationOptions.Equals ( AggregationOptions  other)
inline

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
otherAn object to compare with this object.

Definition at line 76 of file AggregationOptions.cs.

◆ Equals() [2/2]

bool AnalyzeRe.Metrics.SimulationOptions.Equals ( SimulationOptions  other)
inlineinherited

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
otherAn object to compare with this object.

Definition at line 83 of file SimulationOptions.cs.

◆ GetParameters()

override RequestParameters AnalyzeRe.Metrics.AggregationOptions.GetParameters ( )
inlinevirtual

Get the REST request parameters corresponding to this configuration.

Returns
A new RequestParameters collection containing the configured parameters.

Reimplemented from AnalyzeRe.Metrics.SimulationOptions.

Reimplemented in AnalyzeRe.Metrics.CoMetricsOptions, AnalyzeRe.Metrics.ExceedanceProbabilityOptions, and AnalyzeRe.Metrics.MetricsOptions.

Definition at line 65 of file AggregationOptions.cs.

◆ 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.

Type Constraints
T :IAPIType 

Definition at line 14 of file APIType.cs.

Property Documentation

◆ aggregation_method

AggregationMethod? AnalyzeRe.Metrics.AggregationOptions.aggregation_method
getset

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.

◆ Default

new AggregationOptions AnalyzeRe.Metrics.AggregationOptions.Default
staticget

The default aggregated simulation request options used when none are specified.

Definition at line 12 of file AggregationOptions.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

ReportingPeriod AnalyzeRe.Metrics.SimulationOptions.reporting_period = new ReportingPeriod()
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.

◆ 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: