PortfolioView and LayerView abstract base class. More...

Classes
class	BackAllocationsRequest
	Used to identify the server endpoint at which Back-Allocations requests are made.

class	CoMetricsRequest
	Used to identify the server endpoint at which Co-Metrics requests are made.

class	ExceedanceProbRequest
	Used to identify the server endpoint at which Exceedance Probability requests are made.

class	WindowMetricsRequest
	Used to identify the server endpoint at which Window Metrics requests are made.

Public Member Functions
BackAllocations	back_allocations (string source_id, int? timeout=null)
	Returns a URL to the YELT of this view back-allocated to some component loss source.

CoMetrics	co_metrics< T > (double probability, IReference< T > component, CoMetricsOptions options)
	Obsolete. See also co_metrics<T>(ProbabilityWindow,IReference<T>,CoMetricsOptions,Int32?) Returns the co-tail-metrics of this view for a given probability range.

List< CoMetrics >	co_metrics< T > (IEnumerable< ProbabilityWindow > ranges, IReference< T > component, CoMetricsOptions options=null, int? timeout=null)
	Returns the co-metrics of this view for multiple probability ranges.

List< CoMetrics >	co_metrics< T > (List< double > probabilities, IReference< T > component, CoMetricsOptions options)
	Obsolete. See also co_metrics<T>(IEnumerable<ProbabilityWindow>,IReference<T>,CoMetricsOptions,Int32?) Returns the co-tail-metrics of this view for multiple probability ranges.

CoMetrics	co_metrics< T > (ProbabilityWindow range, IReference< T > component, CoMetricsOptions options=null, int? timeout=null)
	Returns the co-metrics of this view for a given probability range.

ExceedanceProbability	exceedance_probability (double threshold, ExceedanceProbabilityOptions options=null, int? timeout=null)
	Returns the exceedance probability for this view for the given loss. That is, the probability the specified loss (threshold) is exceeded.

List< ExceedanceProbability >	exceedance_probability (IEnumerable< double > thresholds, ExceedanceProbabilityOptions options=null, int? timeout=null)
	Returns the exceedance probability for this view for the given losses. That is, the probability the specified loss (threshold) is exceeded.

virtual T	ShallowCopy< T > ()
	Create a shallow copy of this object. See also ExtensionMethods.DeepCopy<T> for a serializer-based copy method.

TailMetrics	tail_metrics (double probability, MetricsOptions options=null, int? timeout=null)
	Returns the tail metrics of this view at a given probability.

List< TailMetrics >	tail_metrics (IEnumerable< double > probabilities, MetricsOptions options=null, int? timeout=null)
	Returns the tail metrics of this view at multiple probabilities.

List< WindowMetrics >	window_metrics (IEnumerable< ProbabilityWindow > ranges, MetricsOptions options=null, int? timeout=null)
	Returns the window metrics of this view for multiple probability ranges.

WindowMetrics	window_metrics (ProbabilityWindow range, MetricsOptions options=null, int? timeout=null)
	Returns the window metrics of this view for a given probability range.

Protected Member Functions
override void	AfterMembersCloned (APIType _)
	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().

Properties
IReference< AnalysisProfile >	analysis_profile `[get, set]`
	The simulation's analysis profile.

string	collection_name `[get]`
	The relative path from the root of the API at which the collection of resources of this type reside.

string	id `[get, set]`
	The resource's unique identifier. It will be used in the request URL when requesting the resource from the server.

string	Path `[get]`
	The relative path to this endpoint from the root URL.

string	target_currency `[get, set]`
	The currency this view's YLTs are stored in, and the default currency results are returned in. If not specified, the server will automatically select a reasonable default currency based on the structure's terms.

YELTSimulationResult	yelt `[get]`
	Allows retrieval of the YELT (Year Event Loss Table) associated with this view once it has been simulated.

YLTSimulationResult	ylt `[get]`
	Allows retrieval of the YLT (Year Loss Table) associated with this view once it has been simulated.

string	ylt_id `[get, set]`
	The hash identifier for the simulation results of this view.

Detailed Description

PortfolioView and LayerView abstract base class.

Definition at line 19 of file BaseAPIResourceView.cs.

Inheritance diagram for AnalyzeRe.APIResourceView.BaseAPIResourceView:

Member Function Documentation

◆ AfterMembersCloned()

override void AnalyzeRe.APIResourceView.BaseAPIResourceView.AfterMembersCloned ( APIType _ )

inlineprotectedvirtual

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().

Reimplemented from AnalyzeRe.APIType.

Definition at line 262 of file BaseAPIResourceView.cs.

◆ back_allocations()

BackAllocations AnalyzeRe.APIResourceView.BaseAPIResourceView.back_allocations	(	string	source_id,
		int?	timeout = `null`
	)

inline

Returns a URL to the YELT of this view back-allocated to some component loss source.

Parameters

source_id	The id of the component loss source to back-allocate the YELT to.
timeout	Optional - The desired request timeout (in milliseconds).

Returns: The URL of the YELT back-allocated to the specified source.

POST a Layers.BackAllocatedLayer instead, using this resource as the Layers.BackAllocatedLayer.sink, to gain performance benefits and the ability to back-allocate beyond another back-allocation result.

This method should be considered obsolete, although note that portfolio's cannot be used directly as a Layers.BackAllocatedLayer.sink reference. If this resource is a portfolio, you will need to recreate it as a Nested layer in order to replace this call with a Layers.BackAllocatedLayer.

Implements AnalyzeRe.IAPIResourceView.

Definition at line 251 of file BaseAPIResourceView.cs.

◆ co_metrics< T >() [1/4]

CoMetrics AnalyzeRe.APIResourceView.BaseAPIResourceView.co_metrics< T >	(	double	probability,
		IReference< T >	component,
		CoMetricsOptions	options
	)

inline

Obsolete.

See also: co_metrics<T>(ProbabilityWindow,IReference<T>,CoMetricsOptions,Int32?)

Returns the co-tail-metrics of this view for a given probability range.

Template Parameters

T	The type of the component referenced.

Parameters

probability	The probability for which to compute co-tail-metrics.
component	A reference to the component LayerView or PortfolioView to compute co-tail-metrics against.
options	A set of options which can be used to compute metrics net of various filters, loss perspectives, etc.

Returns: The co-tail-metrics at the specified probability.

Implements AnalyzeRe.IAPIResourceView.

Type Constraints

T

:

IAPIResourceView

Definition at line 361 of file BaseAPIResourceView.cs.

◆ co_metrics< T >() [2/4]

List< CoMetrics > AnalyzeRe.APIResourceView.BaseAPIResourceView.co_metrics< T >	(	IEnumerable< ProbabilityWindow >	ranges,
		IReference< T >	component,
		CoMetricsOptions	options = `null`,
		int?	timeout = `null`
	)

inline

Returns the co-metrics of this view for multiple probability ranges.

Template Parameters

T	The type of the component referenced.

Parameters

ranges	The probability ranges at which to compute co-metrics.
component	A reference to the component LayerView or PortfolioView to compute co-metrics against.
options	A set of options which can be used to compute metrics net of various filters, loss perspectives, etc.
timeout	Optional - The desired request timeout (in milliseconds).

Returns: The co-metrics at the specified probabilities.

Implements AnalyzeRe.IAPIResourceView.

Type Constraints

T

:

IAPIResourceView

Definition at line 154 of file BaseAPIResourceView.cs.

◆ co_metrics< T >() [3/4]

List< CoMetrics > AnalyzeRe.APIResourceView.BaseAPIResourceView.co_metrics< T >	(	List< double >	probabilities,
		IReference< T >	component,
		CoMetricsOptions	options
	)

inline

Obsolete.

See also: co_metrics<T>(IEnumerable<ProbabilityWindow>,IReference<T>,CoMetricsOptions,Int32?)

Returns the co-tail-metrics of this view for multiple probability ranges.

Template Parameters

T	The type of the component referenced.

Parameters

probabilities	The probabilities at which to compute co-tail-metrics.
component	A reference to the component LayerView or PortfolioView to compute co-tail-metrics against.
options	A set of options which can be used to compute metrics net of various filters, loss perspectives, etc.

Returns: The co-tail-metrics at the specified probabilities.

Implements AnalyzeRe.IAPIResourceView.

Type Constraints

T

:

IAPIResourceView

Definition at line 380 of file BaseAPIResourceView.cs.

◆ co_metrics< T >() [4/4]

CoMetrics AnalyzeRe.APIResourceView.BaseAPIResourceView.co_metrics< T >	(	ProbabilityWindow	range,
		IReference< T >	component,
		CoMetricsOptions	options = `null`,
		int?	timeout = `null`
	)

inline

Returns the co-metrics of this view for a given probability range.

Template Parameters

T	The type of the component referenced.

Parameters

range	The probability range for which to compute co-metrics.
component	A reference to the component LayerView or PortfolioView to compute co-metrics against.
options	A set of options which can be used to compute metrics net of various filters, loss perspectives, etc.
timeout	Optional - The desired request timeout (in milliseconds).

Returns: The co-metrics at the specified probability.

Implements AnalyzeRe.IAPIResourceView.

Type Constraints

T

:

IAPIResourceView

Definition at line 136 of file BaseAPIResourceView.cs.

◆ exceedance_probability() [1/2]

ExceedanceProbability AnalyzeRe.APIResourceView.BaseAPIResourceView.exceedance_probability	(	double	threshold,
		ExceedanceProbabilityOptions	options = `null`,
		int?	timeout = `null`
	)

inline

Returns the exceedance probability for this view for the given loss. That is, the probability the specified loss (threshold) is exceeded.

Parameters

threshold	The threshold at which to calculate the exceedance probability.
options	A set of options which can be used to change the threshold behaviour or compute metrics net of various filters, loss perspectives, etc.
timeout	Optional - The desired request timeout (in milliseconds).

Returns: The exceedance probability for the given loss.

Implements AnalyzeRe.IAPIResourceView.

Definition at line 210 of file BaseAPIResourceView.cs.

◆ exceedance_probability() [2/2]

List< ExceedanceProbability > AnalyzeRe.APIResourceView.BaseAPIResourceView.exceedance_probability	(	IEnumerable< double >	thresholds,
		ExceedanceProbabilityOptions	options = `null`,
		int?	timeout = `null`
	)

inline

Returns the exceedance probability for this view for the given losses. That is, the probability the specified loss (threshold) is exceeded.

Parameters

thresholds	The thresholds at which to calculate the exceedance probability.
options	A set of options which can be used to change the threshold behaviour or compute metrics net of various filters, loss perspectives, etc.
timeout	Optional - The desired request timeout (in milliseconds).

Returns: The exceedance probability for the given loss values.

Implements AnalyzeRe.IAPIResourceView.

Definition at line 226 of file BaseAPIResourceView.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.

◆ tail_metrics() [1/2]

TailMetrics AnalyzeRe.APIResourceView.BaseAPIResourceView.tail_metrics	(	double	probability,
		MetricsOptions	options = `null`,
		int?	timeout = `null`
	)

inline

Returns the tail metrics of this view at a given probability.

Parameters

probability	The probability at which to compute tail metrics.
options	A set of options which can be used to compute metrics net of various filters, loss perspectives, etc.
timeout	Optional - The desired request timeout (in milliseconds).

Tail metrics functions are implemented as a shortcut - they are equivalent to requesting window_metrics(ProbabilityWindow,MetricsOptions,Int32?) with the ProbabilityWindow's minimum probability set to 0.

Returns: The tail_metrics at the specified probability.

Implements AnalyzeRe.IAPIResourceView.

Definition at line 69 of file BaseAPIResourceView.cs.

◆ tail_metrics() [2/2]

List< TailMetrics > AnalyzeRe.APIResourceView.BaseAPIResourceView.tail_metrics	(	IEnumerable< double >	probabilities,
		MetricsOptions	options = `null`,
		int?	timeout = `null`
	)

inline

Returns the tail metrics of this view at multiple probabilities.

Parameters

probabilities	The probabilities at which to compute tail metrics.
options	A set of options which can be used to compute metrics net of various filters, loss perspectives, etc.
timeout	Optional - The desired request timeout (in milliseconds).

Returns: The tail_metrics at the specified probabilities, as a list of TailMetrics responses in the same order as the probabilities supplied.

Implements AnalyzeRe.IAPIResourceView.

Definition at line 84 of file BaseAPIResourceView.cs.

◆ window_metrics() [1/2]

List< WindowMetrics > AnalyzeRe.APIResourceView.BaseAPIResourceView.window_metrics	(	IEnumerable< ProbabilityWindow >	ranges,
		MetricsOptions	options = `null`,
		int?	timeout = `null`
	)

inline

Returns the window metrics of this view for multiple probability ranges.

Parameters

ranges	The probability ranges for which to compute window metrics.
options	A set of options which can be used to compute metrics net of various filters, loss perspectives, etc.
timeout	Optional - The desired request timeout (in milliseconds).

Returns: The window_metrics at the specified probabilities, as a list of WindowMetrics responses in the same order as the probabilities supplied.

Implements AnalyzeRe.IAPIResourceView.

Definition at line 116 of file BaseAPIResourceView.cs.

◆ window_metrics() [2/2]

WindowMetrics AnalyzeRe.APIResourceView.BaseAPIResourceView.window_metrics	(	ProbabilityWindow	range,
		MetricsOptions	options = `null`,
		int?	timeout = `null`
	)

inline

Returns the window metrics of this view for a given probability range.

Parameters

range	The probability range for which to compute window metrics.
options	A set of options which can be used to compute metrics net of various filters, loss perspectives, etc.
timeout	Optional - The desired request timeout (in milliseconds).

Returns: The window_metrics at the specified probability.

Implements AnalyzeRe.IAPIResourceView.

Definition at line 101 of file BaseAPIResourceView.cs.

Property Documentation

◆ analysis_profile

IReference<AnalysisProfile> AnalyzeRe.APIResourceView.BaseAPIResourceView.analysis_profile

getset

The simulation's analysis profile.

Implements AnalyzeRe.APITypes.IAPIAnalysis.

Definition at line 33 of file BaseAPIResourceView.cs.

◆ collection_name

string AnalyzeRe.APIResource.collection_name

getabstractinherited

The relative path from the root of the API at which the collection of resources of this type reside.

Implements AnalyzeRe.IAPIResource.

Definition at line 21 of file APIResource.cs.

◆ id

string AnalyzeRe.APIResource.id

getsetinherited

The resource's unique identifier. It will be used in the request URL when requesting the resource from the server.

Implements AnalyzeRe.IAPIResource.

Definition at line 16 of file APIResource.cs.

◆ Path

string AnalyzeRe.APIResource.Path

getinherited

The relative path to this endpoint from the root URL.

Exceptions

System.ArgumentException If this resource does not have an id.

Implements AnalyzeRe.APITypes.IEndpoint.

Definition at line 27 of file APIResource.cs.

◆ target_currency

string AnalyzeRe.APIResourceView.BaseAPIResourceView.target_currency

getset

The currency this view's YLTs are stored in, and the default currency results are returned in. If not specified, the server will automatically select a reasonable default currency based on the structure's terms.

Implements AnalyzeRe.APITypes.IAPIAnalysis.

Definition at line 45 of file BaseAPIResourceView.cs.

◆ yelt

YELTSimulationResult AnalyzeRe.APIResourceView.BaseAPIResourceView.yelt

get

Allows retrieval of the YELT (Year Event Loss Table) associated with this view once it has been simulated.

Implements AnalyzeRe.IAPIResourceView.

Definition at line 55 of file BaseAPIResourceView.cs.

◆ ylt

YLTSimulationResult AnalyzeRe.APIResourceView.BaseAPIResourceView.ylt

get

Allows retrieval of the YLT (Year Loss Table) associated with this view once it has been simulated.

Implements AnalyzeRe.IAPIResourceView.

Definition at line 50 of file BaseAPIResourceView.cs.

◆ ylt_id

string AnalyzeRe.APIResourceView.BaseAPIResourceView.ylt_id

getset

The hash identifier for the simulation results of this view.

Implements AnalyzeRe.IAPIResourceView.

Definition at line 38 of file BaseAPIResourceView.cs.

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

BaseAPIResourceView.cs

Classes

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AfterMembersCloned()

◆ back_allocations()

◆ co_metrics< T >() [1/4]

◆ co_metrics< T >() [2/4]

◆ co_metrics< T >() [3/4]

◆ co_metrics< T >() [4/4]

◆ exceedance_probability() [1/2]

◆ exceedance_probability() [2/2]

◆ ShallowCopy< T >()

◆ tail_metrics() [1/2]

◆ tail_metrics() [2/2]

◆ window_metrics() [1/2]

◆ window_metrics() [2/2]

Property Documentation

◆ analysis_profile

◆ collection_name

◆ id

◆ Path

◆ target_currency

◆ yelt

◆ ylt

◆ ylt_id