C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalyzeRe.IAPIResourceView Interface Reference

PortfolioView and LayerView interface. More...

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< CoMetricsco_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< CoMetricsco_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< ExceedanceProbabilityexceedance_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.
 
ShallowCopy< T > ()
 Create a shallow copy of this object.
 
TailMetrics tail_metrics (double probability, MetricsOptions options=null, int? timeout=null)
 Returns the tail metrics of this view at a given probability.
 
List< TailMetricstail_metrics (IEnumerable< double > probabilities, MetricsOptions options=null, int? timeout=null)
 Returns the tail metrics of this view at multiple probabilities.
 
List< WindowMetricswindow_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.
 

Properties

IReference< AnalysisProfileanalysis_profile [get, set]
 The analysis profile used to analyze the resource.
 
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 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 layer.
 

Detailed Description

PortfolioView and LayerView interface.

Definition at line 17 of file IAPIResourceView.cs.

Inheritance diagram for AnalyzeRe.IAPIResourceView:
AnalyzeRe.APITypes.IAPIAnalysis AnalyzeRe.IAPIResource AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.ILayerView< T > AnalyzeRe.APIResourceView.BaseAPIResourceView AnalyzeRe.ILayerView< out T > AnalyzeRe.LayerView< T > AnalyzeRe.LayerView< T > AnalyzeRe.PortfolioView

Member Function Documentation

◆ back_allocations()

BackAllocations AnalyzeRe.IAPIResourceView.back_allocations ( string  source_id,
int timeout = null 
)

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

Parameters
source_idThe id of the component loss source to back-allocate the YELT to.
timeoutOptional - 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.

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

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

CoMetrics AnalyzeRe.IAPIResourceView.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.

Template Parameters
TThe type of the component referenced.
Parameters
probabilityThe probability for which to compute co-tail-metrics.
componentA reference to the component LayerView or PortfolioView to compute co-tail-metrics against.
optionsA 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.

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

Type Constraints
T :IAPIResourceView 

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

List< CoMetrics > AnalyzeRe.IAPIResourceView.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.

Template Parameters
TThe type of the component referenced.
Parameters
rangesThe probability ranges at which to compute co-metrics.
componentA reference to the component LayerView or PortfolioView to compute co-metrics against.
optionsA set of options which can be used to compute metrics net of various filters, loss perspectives, etc.
timeoutOptional - The desired request timeout (in milliseconds).
Returns
The co-metrics at the specified probabilities.

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

Type Constraints
T :IAPIResourceView 

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

List< CoMetrics > AnalyzeRe.IAPIResourceView.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.

Template Parameters
TThe type of the component referenced.
Parameters
probabilitiesThe probabilities at which to compute co-tail-metrics.
componentA reference to the component LayerView or PortfolioView to compute co-tail-metrics against.
optionsA 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.

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

Type Constraints
T :IAPIResourceView 

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

CoMetrics AnalyzeRe.IAPIResourceView.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.

Template Parameters
TThe type of the component referenced.
Parameters
rangeThe probability range for which to compute co-metrics.
componentA reference to the component LayerView or PortfolioView to compute co-metrics against.
optionsA set of options which can be used to compute metrics net of various filters, loss perspectives, etc.
timeoutOptional - The desired request timeout (in milliseconds).
Returns
The co-metrics at the specified probability.

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

Type Constraints
T :IAPIResourceView 

◆ exceedance_probability() [1/2]

ExceedanceProbability AnalyzeRe.IAPIResourceView.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.

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

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

◆ exceedance_probability() [2/2]

List< ExceedanceProbability > AnalyzeRe.IAPIResourceView.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.

Parameters
thresholdsThe thresholds at which to calculate the exceedance probability.
optionsA set of options which can be used to change the threshold behaviour or compute metrics net of various filters, loss perspectives, etc.
timeoutOptional - The desired request timeout (in milliseconds).
Returns
The exceedance probability for the given loss values.

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

◆ ShallowCopy< T >()

T AnalyzeRe.IAPIType.ShallowCopy< T > ( )
inherited

Create a shallow copy of this object.

Returns
A shallow copy of this object.

Implemented in AnalyzeRe.APIType.

Type Constraints
T :IAPIType 

◆ tail_metrics() [1/2]

TailMetrics AnalyzeRe.IAPIResourceView.tail_metrics ( double  probability,
MetricsOptions  options = null,
int timeout = null 
)

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

Parameters
probabilityThe probability at which to compute tail metrics.
optionsA set of options which can be used to compute metrics net of various filters, loss perspectives, etc.
timeoutOptional - 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.

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

◆ tail_metrics() [2/2]

List< TailMetrics > AnalyzeRe.IAPIResourceView.tail_metrics ( IEnumerable< double probabilities,
MetricsOptions  options = null,
int timeout = null 
)

Returns the tail metrics of this view at multiple probabilities.

Parameters
probabilitiesThe probabilities at which to compute tail metrics.
optionsA set of options which can be used to compute metrics net of various filters, loss perspectives, etc.
timeoutOptional - 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.

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

◆ window_metrics() [1/2]

List< WindowMetrics > AnalyzeRe.IAPIResourceView.window_metrics ( IEnumerable< ProbabilityWindow ranges,
MetricsOptions  options = null,
int timeout = null 
)

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

Parameters
rangesThe probability ranges for which to compute window metrics.
optionsA set of options which can be used to compute metrics net of various filters, loss perspectives, etc.
timeoutOptional - 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.

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

◆ window_metrics() [2/2]

WindowMetrics AnalyzeRe.IAPIResourceView.window_metrics ( ProbabilityWindow  range,
MetricsOptions  options = null,
int timeout = null 
)

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

Parameters
rangeThe probability range for which to compute window metrics.
optionsA set of options which can be used to compute metrics net of various filters, loss perspectives, etc.
timeoutOptional - The desired request timeout (in milliseconds).
Returns
The window_metrics at the specified probability.

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

Property Documentation

◆ analysis_profile

IReference<AnalysisProfile> AnalyzeRe.APITypes.IAPIAnalysis.analysis_profile
getsetinherited

The analysis profile used to analyze the resource.

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView, and AnalyzeRe.Optimization.OptimizationView.

Definition at line 13 of file IAPIAnalysis.cs.

◆ collection_name

◆ id

string AnalyzeRe.IAPIResource.id
getsetinherited

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

Implemented in AnalyzeRe.APIResource, and AnalyzeRe.Optimization.Candidate.

Definition at line 14 of file IAPIResource.cs.

◆ Path

string AnalyzeRe.APITypes.IEndpoint.Path
getinherited

The relative path to this endpoint from the root URL.

Implemented in AnalyzeRe.API.PortfolioViewMarginals, AnalyzeRe.APITypes.SubResourceEndpoint, AnalyzeRe.APIResource, and AnalyzeRe.Optimization.Candidate.

Definition at line 13 of file IEndpoint.cs.

◆ target_currency

string AnalyzeRe.APITypes.IAPIAnalysis.target_currency
getsetinherited

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.

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView, and AnalyzeRe.Optimization.OptimizationView.

Definition at line 20 of file IAPIAnalysis.cs.

◆ yelt

YELTSimulationResult AnalyzeRe.IAPIResourceView.yelt
get

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

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

Definition at line 33 of file IAPIResourceView.cs.

◆ ylt

YLTSimulationResult AnalyzeRe.IAPIResourceView.ylt
get

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

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

Definition at line 28 of file IAPIResourceView.cs.

◆ ylt_id

string AnalyzeRe.IAPIResourceView.ylt_id
getset

The hash identifier for the simulation results of this layer.

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

Definition at line 23 of file IAPIResourceView.cs.


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