Optional parameters which can be specified for yelt download requests. More...

Public Types
enum	AdditionalColumns { RecordType = 1 , ReinstatementPremium = 2 , ReinstatementBrokerage = 4 }
	Extra columns that may be selected for inclusion in the YELT file. More...

Public Member Functions
	YELTOptions (SimulationOptions toCopy, string currency=null, bool? apply_participation=null, int? start_trial=null, int? end_trial=null, AdditionalColumns? additional_columns=null)
	Construct a new set of YELTOptions from an existing set of SimulationOptions.

	YELTOptions (string currency=null, Perspective perspective=null, string filter=null, bool? secondary_uncertainty=null, ReportingPeriod reporting_period=null, bool? apply_participation=null, int? start_trial=null, int? end_trial=null, AdditionalColumns? additional_columns=null)
	Configure one or more optional metrics request parameters.

	YELTOptions (YELTOptions toCopy)
	Construct a new set of YELTOptions from another.

bool	Equals (SimulationOptions other)
	Indicates whether the current object is equal to another object of the same type.

bool	Equals (YELTOptions 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
AdditionalColumns?	additional_columns `[get, set]`
	Additional columns that should be included in the YELT file.

bool?	apply_participation `[get, set]`
	Whether or not participation should be applied to results.

string	currency `[get, set]`
	The currency to convert event losses to. If not specified, the losses will be returned in APITypes.IAPIAnalysis.target_currency of the structure on which these metrics are requested.

static new YELTOptions	Default `[get]`
	The default yelt request options used when none are specified.

int?	end_trial `[get, set]`
	The end range of trials to download.

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.

int?	start_trial `[get, set]`
	The starting range of trials to download.

Detailed Description

Optional parameters which can be specified for yelt download requests.

See also: IAPIResourceView.yelt

Definition at line 8 of file YELTOptions.cs.

Inheritance diagram for AnalyzeRe.Metrics.YELTOptions:

Member Enumeration Documentation

◆ AdditionalColumns

enum AnalyzeRe.Metrics.YELTOptions.AdditionalColumns

Extra columns that may be selected for inclusion in the YELT file.

Enumerator
RecordType	The Record Type column.
ReinstatementPremium	The Reinstatement Premium column.
ReinstatementBrokerage	The Reinstatement Brokerage column.

Definition at line 12 of file YELTOptions.cs.

Constructor & Destructor Documentation

◆ YELTOptions() [1/3]

AnalyzeRe.Metrics.YELTOptions.YELTOptions	(	string	currency = `null`,
		Perspective	perspective = `null`,
		string	filter = `null`,
		bool?	secondary_uncertainty = `null`,
		ReportingPeriod	reporting_period = `null`,
		bool?	apply_participation = `null`,
		int?	start_trial = `null`,
		int?	end_trial = `null`,
		AdditionalColumns?	additional_columns = `null`
	)

inline

Configure one or more optional metrics request parameters.

Parameters

currency	The currency to convert the YELT losses to.
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.
start_trial	The starting range of trials to download.
end_trial	The end range of trials to download.
additional_columns	Additional columns to include in the YELT file.

Definition at line 60 of file YELTOptions.cs.

◆ YELTOptions() [2/3]

AnalyzeRe.Metrics.YELTOptions.YELTOptions	(	SimulationOptions	toCopy,
		string	currency = `null`,
		bool?	apply_participation = `null`,
		int?	start_trial = `null`,
		int?	end_trial = `null`,
		AdditionalColumns?	additional_columns = `null`
	)

inline

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

Parameters

toCopy	The base SimulationOptions to copy.
currency	The currency to convert the YELT losses to.
apply_participation	Whether or not participation should be applied to results.
start_trial	The starting range of trials to download.
end_trial	The end range of trials to download.
additional_columns	Additional columns to include in the YELT file.

Definition at line 83 of file YELTOptions.cs.

◆ YELTOptions() [3/3]

AnalyzeRe.Metrics.YELTOptions.YELTOptions ( YELTOptions toCopy )

inline

Construct a new set of YELTOptions from another.

Parameters

toCopy The YELTOptions to copy.

Definition at line 97 of file YELTOptions.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 >	(	T	first,
		T	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.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

other An object to compare with this object.

Definition at line 83 of file SimulationOptions.cs.

◆ Equals() [2/2]

bool AnalyzeRe.Metrics.YELTOptions.Equals ( YELTOptions 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

other An object to compare with this object.

Definition at line 126 of file YELTOptions.cs.

◆ GetParameters()

override RequestParameters AnalyzeRe.Metrics.YELTOptions.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.

Definition at line 111 of file YELTOptions.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

◆ additional_columns

AdditionalColumns? AnalyzeRe.Metrics.YELTOptions.additional_columns

getset

Additional columns that should be included in the YELT file.

Definition at line 42 of file YELTOptions.cs.

◆ apply_participation

bool? AnalyzeRe.Metrics.YELTOptions.apply_participation

getset

Whether or not participation should be applied to results.

Definition at line 33 of file YELTOptions.cs.

◆ currency

string AnalyzeRe.Metrics.YELTOptions.currency

getset

The currency to convert event losses to. If not specified, the losses will be returned in APITypes.IAPIAnalysis.target_currency of the structure on which these metrics are requested.

Definition at line 30 of file YELTOptions.cs.

◆ Default

new YELTOptions AnalyzeRe.Metrics.YELTOptions.Default

staticget

The default yelt request options used when none are specified.

Definition at line 25 of file YELTOptions.cs.

◆ end_trial

int? AnalyzeRe.Metrics.YELTOptions.end_trial

getset

The end range of trials to download.

Definition at line 39 of file YELTOptions.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.

◆ start_trial

int? AnalyzeRe.Metrics.YELTOptions.start_trial

getset

The starting range of trials to download.

Definition at line 36 of file YELTOptions.cs.

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

YELTOptions.cs

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ AdditionalColumns

Constructor & Destructor Documentation

◆ YELTOptions() [1/3]

◆ YELTOptions() [2/3]

◆ YELTOptions() [3/3]

Member Function Documentation

◆ AfterMembersCloned()

◆ BothNullOrEqual< T >() [1/2]

◆ BothNullOrEqual< T >() [2/2]

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetParameters()

◆ ShallowCopy< T >()

Property Documentation

◆ additional_columns

◆ apply_participation

◆ currency

◆ Default

◆ end_trial

◆ filter

◆ perspective

◆ reporting_period

◆ secondary_uncertainty

◆ start_trial