C# Client Library
A C# Client Library for the AnalyzeRe REST API
AnalyzeRe.Metrics.ExceedanceProbabilityOptions Class Reference

Optional parameters which can be specified for exceedance probability requests. More...

Public Member Functions

 ExceedanceProbabilityOptions (bool?inclusive_threshold=null, string threshold_currency=null, AggregationMethod?aggregation_method=null, Perspective perspective=null, string filter=null, bool?secondary_uncertainty=null, ReportingPeriod reporting_period=null, bool?threshold_includes_participation=null)
 Configure one or more optional exceedance probability request parameters. More...
 
 ExceedanceProbabilityOptions (SimulationOptions toCopy, AggregationMethod?aggregation_method=null, bool?inclusive_threshold=null, string threshold_currency=null, bool?threshold_includes_participation=null)
 Construct a new set of ExceedanceProbabilityOptions from an existing set of SimulationOptions. More...
 
 ExceedanceProbabilityOptions (AggregationOptions toCopy, bool?inclusive_threshold=null, string threshold_currency=null, bool?threshold_includes_participation=null)
 Construct a new set of ExceedanceProbabilityOptions from an existing set of AggregationOptions. More...
 
 ExceedanceProbabilityOptions (ExceedanceProbabilityOptions toCopy)
 Construct a new set of ExceedanceProbabilityOptions from another. More...
 
bool Equals (AggregationOptions other)
 Indicates whether the current object is equal to another object of the same type. More...
 
bool Equals (SimulationOptions other)
 Indicates whether the current object is equal to another object of the same type. More...
 
bool Equals (ExceedanceProbabilityOptions other)
 Indicates whether the current object is equal to another object of the same type. More...
 
override RequestParameters GetParameters ()
 Get the REST request parameters corresponding to this configuration. More...
 
virtual T ShallowCopy< T > ()
 Create a shallow copy of this object.

See also
ExtensionMethods.DeepCopy<T>

for a serializer-based copy method. More...

 

Static Public Attributes

static new ExceedanceProbabilityOptions Default => new ExceedanceProbabilityOptions()
 The default exceedance probability request options used when none are specified. More...
 

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. More...
 
bool BothNullOrEqual< T > (T first, T second)
 Helper method to determine if two classes are equal, or both null. More...
 
bool BothNullOrEqual< T > (T?first, T?second)
 Helper method to determine if two nullable values are equal, or both null. More...
 

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. More...
 
string filter [get, set]
 The name of the predefined filter used to determine which event losses are included in the resulting distribution. More...
 
bool inclusive_threshold [get, set]
 Whether the threshold value is inclusive or not. If false (which is the default when unset), the metrics returned will include the probability that the loss is greater than the threshold. If set to true, the results will be the probability that a loss is greater than OR EQUAL TO the threshold. More...
 
Perspective perspective [get, set]
 The requested Perspective, which determines which factors are included in the loss distribution. More...
 
ReportingPeriod reporting_period [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). More...
 
bool secondary_uncertainty [get, set]
 Whether or not to simulate using secondary uncertainty (if available). Set this to false to explicitly disable secondary uncertainty. More...
 
string threshold_currency [get, set]
 The currency of the threshold parameter. If not specified, the threshold is assumed to be in the APITypes.IAPIAnalysis.target_currency of structure on which these metrics are requested. More...
 
bool threshold_includes_participation [get, set]
 Whether or not participation have been included in threshold values. More...
 

Detailed Description

Optional parameters which can be specified for exceedance probability requests.

See also
IAPIResourceView.exceedance_probability(Double, ExceedanceProbabilityOptions)

Definition at line 9 of file ExceedanceProbabilityOptions.cs.

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

Constructor & Destructor Documentation

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

Configure one or more optional exceedance probability request parameters.

Parameters
inclusive_thresholdinclusive_threshold Whether the threshold value is inclusive or not.
threshold_currencythreshold_currency The currency of the threshold parameter.
aggregation_methodThe aggregation method (AEP or OEP) used to compute this distribution. AggregationOptions.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.
threshold_includes_participationWhether or not participation have been included in threshold values.

Definition at line 49 of file ExceedanceProbabilityOptions.cs.

AnalyzeRe.Metrics.ExceedanceProbabilityOptions.ExceedanceProbabilityOptions ( SimulationOptions  toCopy,
AggregationMethod aggregation_method = null,
bool?  inclusive_threshold = null,
string  threshold_currency = null,
bool?  threshold_includes_participation = null 
)
inline

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

Parameters
toCopyThe base SimulationOptions to copy.
aggregation_methodThe aggregation method (AEP or OEP) used to compute this distribution. AggregationOptions.aggregation_method
inclusive_thresholdinclusive_threshold Whether the threshold value is inclusive or not.
threshold_currencythreshold_currency The currency of the threshold parameter.
threshold_includes_participationWhether or not participation have been included in threshold values.

Definition at line 73 of file ExceedanceProbabilityOptions.cs.

AnalyzeRe.Metrics.ExceedanceProbabilityOptions.ExceedanceProbabilityOptions ( AggregationOptions  toCopy,
bool?  inclusive_threshold = null,
string  threshold_currency = null,
bool?  threshold_includes_participation = null 
)
inline

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

Parameters
toCopyThe base AggregationOptions to copy.
inclusive_thresholdinclusive_threshold Whether the threshold value is inclusive or not.
threshold_currencythreshold_currency The currency of the threshold parameter.
threshold_includes_participationWhether or not participation have been included in threshold values.

Definition at line 93 of file ExceedanceProbabilityOptions.cs.

AnalyzeRe.Metrics.ExceedanceProbabilityOptions.ExceedanceProbabilityOptions ( ExceedanceProbabilityOptions  toCopy)
inline

Construct a new set of ExceedanceProbabilityOptions from another.

Parameters
toCopyThe other ExceedanceProbabilityOptions to copy.

Definition at line 106 of file ExceedanceProbabilityOptions.cs.

Member Function Documentation

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.APIResourceView.BaseAPIResourceView, AnalyzeRe.Optimization.OptimizationView, AnalyzeRe.Optimization.Candidate, AnalyzeRe.StaticSimulation, AnalyzeRe.Distributions.CustomDistribution, AnalyzeRe.LossSets.LossSet_WithData, and AnalyzeRe.APITypes.APIResource_WithDataEndpoint.

Definition at line 37 of file APIType.cs.

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.

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.

bool AnalyzeRe.Metrics.AggregationOptions.Equals ( AggregationOptions  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 76 of file AggregationOptions.cs.

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.

bool AnalyzeRe.Metrics.ExceedanceProbabilityOptions.Equals ( ExceedanceProbabilityOptions  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 133 of file ExceedanceProbabilityOptions.cs.

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

Get the REST request parameters corresponding to this configuration.

Returns
A new RequestParameters collection containing the configured parameters.

Reimplemented from AnalyzeRe.Metrics.AggregationOptions.

Definition at line 119 of file ExceedanceProbabilityOptions.cs.

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.

Member Data Documentation

new ExceedanceProbabilityOptions AnalyzeRe.Metrics.ExceedanceProbabilityOptions.Default => new ExceedanceProbabilityOptions()
static

The default exceedance probability request options used when none are specified.

Definition at line 13 of file ExceedanceProbabilityOptions.cs.

Property Documentation

AggregationMethod AnalyzeRe.Metrics.AggregationOptions.aggregation_method
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.

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.

bool AnalyzeRe.Metrics.ExceedanceProbabilityOptions.inclusive_threshold
getset

Whether the threshold value is inclusive or not. If false (which is the default when unset), the metrics returned will include the probability that the loss is greater than the threshold. If set to true, the results will be the probability that a loss is greater than OR EQUAL TO the threshold.

Definition at line 20 of file ExceedanceProbabilityOptions.cs.

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.

ReportingPeriod AnalyzeRe.Metrics.SimulationOptions.reporting_period
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.

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.

string AnalyzeRe.Metrics.ExceedanceProbabilityOptions.threshold_currency
getset

The currency of the threshold parameter. If not specified, the threshold is assumed to be in the APITypes.IAPIAnalysis.target_currency of structure on which these metrics are requested.

Definition at line 25 of file ExceedanceProbabilityOptions.cs.

bool AnalyzeRe.Metrics.ExceedanceProbabilityOptions.threshold_includes_participation
getset

Whether or not participation have been included in threshold values.

Definition at line 28 of file ExceedanceProbabilityOptions.cs.


The documentation for this class was generated from the following file: