C# Client Library
A C# Client Library for the AnalyzeRe REST API
AnalyzeRe.IAPIResourceView Interface Reference

PortfolioView and LayerView interface. More...

Public Member Functions

BackAllocations back_allocations (string source_id)
 Returns a URL to the YELT of this view back-allocated to some component loss source. More...
 
CoMetrics co_metrics< T > (ProbabilityWindow range, IReference< T > component, CoMetricsOptions options)
 Returns the co-metrics of this view for a given probability range. More...
 
List< CoMetricsco_metrics< T > (IEnumerable< ProbabilityWindow > ranges, IReference< T > component, CoMetricsOptions options)
 Returns the co-metrics of this view for multiple probability ranges. More...
 
CoMetrics co_metrics< T > (double probability, IReference< T > component, string filter=null, Perspective perspective=null, string currency=null, string component_filter=null, Perspective component_perspective=null, bool?include_primary_metrics=null, AggregationMethod?aggregation_method=null, bool?secondary_uncertainty=null)
 Obsolete.

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

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

 
List< CoMetricsco_metrics< T > (List< double > probabilities, IReference< T > component, string filter=null, Perspective perspective=null, string currency=null, string component_filter=null, Perspective component_perspective=null, bool?include_primary_metrics=null, AggregationMethod?aggregation_method=null, bool?secondary_uncertainty=null)
 Obsolete.

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

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

 
CoMetrics co_metrics< T > (double probability, IReference< T > component, CoMetricsOptions options)
 Obsolete.

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

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

 
List< CoMetricsco_metrics< T > (List< double > probabilities, IReference< T > component, CoMetricsOptions options)
 Obsolete.

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

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

 
ExceedanceProbability exceedance_probability (double threshold, ExceedanceProbabilityOptions options)
 Returns the exceedance probability for this view for the given loss. That is, the probability the specified loss (threshold) is exceeded. More...
 
List< ExceedanceProbabilityexceedance_probability (IEnumerable< double > thresholds, ExceedanceProbabilityOptions options)
 Returns the exceedance probability for this view for the given losses. That is, the probability the specified loss (threshold) is exceeded. More...
 
ExceedanceProbability exceedance_probability (double threshold, string filter=null, Perspective perspective=null, bool?inclusive_threshold=null, string threshold_currency=null, AggregationMethod?aggregation_method=null, bool?secondary_uncertainty=null)
 Obsolete.

See also
exceedance_probability(Double,ExceedanceProbabilityOptions)

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

 
List< ExceedanceProbabilityexceedance_probability (List< double > thresholds, string filter=null, Perspective perspective=null, bool?inclusive_threshold=null, string threshold_currency=null, AggregationMethod?aggregation_method=null, bool?secondary_uncertainty=null)
 Obsolete.

See also
exceedance_probability(IEnumerable<Double>,ExceedanceProbabilityOptions)

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

 
ShallowCopy< T > ()
 Create a shallow copy of this object. More...
 
TailMetrics tail_metrics (double probability, MetricsOptions options)
 Returns the tail metrics of this view at a given probability. More...
 
List< TailMetricstail_metrics (IEnumerable< double > probabilities, MetricsOptions options)
 Returns the tail metrics of this view at multiple probabilities. More...
 
TailMetrics tail_metrics (double probability, string filter=null, Perspective perspective=null, string currency=null, AggregationMethod?aggregation_method=null, bool?secondary_uncertainty=null)
 Obsolete.

See also
tail_metrics(Double,MetricsOptions)

Returns the tail metrics of this view for a given probability (and filter optionally). More...

 
List< TailMetricstail_metrics (List< double > probabilities, string filter=null, Perspective perspective=null, string currency=null, AggregationMethod?aggregation_method=null, bool?secondary_uncertainty=null)
 Obsolete.

See also
tail_metrics(IEnumerable<Double>,MetricsOptions)

Returns the tail metrics of this view for a given list of probabilities. More...

 
WindowMetrics window_metrics (ProbabilityWindow range, MetricsOptions options)
 Returns the window metrics of this view for a given probability range. More...
 
List< WindowMetricswindow_metrics (IEnumerable< ProbabilityWindow > ranges, MetricsOptions options)
 Returns the window metrics of this view for multiple probability ranges. More...
 

Properties

IReference< AnalysisProfileanalysis_profile [get, set]
 The analysis profile used to analyze the resource. More...
 
string collection_name [get]
 The relative path from the root of the API at which the collection of resources of this type reside. More...
 
string id [get, set]
 The resource's unique identifier. It will be used in the request URL when requesting the resource from the server. More...
 
string Path [get]
 The relative path to this endpoint from the root URL. More...
 
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. More...
 
YELTSimulationResult yelt [get]
 Allows retrieval of the YELT (Year Event Loss Table) associated with this view once it has been simulated. More...
 
YLTSimulationResult ylt [get]
 Allows retrieval of the YLT (Year Loss Table) associated with this view once it has been simulated. More...
 
string ylt_id [get, set]
 The hash identifier for the simulation results of this layer. More...
 

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.APIResourceView.BaseAPIResourceView AnalyzeRe.ILayerView< out out T > AnalyzeRe.LayerView< T > AnalyzeRe.PortfolioView

Member Function Documentation

BackAllocations AnalyzeRe.IAPIResourceView.back_allocations ( string  source_id)

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

CoMetrics AnalyzeRe.IAPIResourceView.co_metrics< T > ( ProbabilityWindow  range,
IReference< T >  component,
CoMetricsOptions  options 
)

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.
Returns
The co-metrics at the specified probability.

TODO: Make options optional once deprecated methods are deleted

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

Type Constraints
T :IAPIResourceView 
List<CoMetrics> AnalyzeRe.IAPIResourceView.co_metrics< T > ( IEnumerable< ProbabilityWindow ranges,
IReference< T >  component,
CoMetricsOptions  options 
)

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.
Returns
The co-metrics at the specified probabilities.

TODO: Make options optional once deprecated methods are deleted

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

Type Constraints
T :IAPIResourceView 
CoMetrics AnalyzeRe.IAPIResourceView.co_metrics< T > ( double  probability,
IReference< T >  component,
string  filter = null,
Perspective  perspective = null,
string  currency = null,
string  component_filter = null,
Perspective  component_perspective = null,
bool?  include_primary_metrics = null,
AggregationMethod aggregation_method = null,
bool?  secondary_uncertainty = null 
)

Obsolete.

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

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

Template Parameters
TThe type of the component referenced.
Parameters
probabilityThe probability (1 / return_period) at which to calculate the co-tail-metrics.
componentA reference to the component LayerView or PortfolioView to compute co-tail-metrics against.
filter(Optional - Default: null) The name of the loss filter to apply before computing metrics.
perspective(Optional - Default: null) The loss perspective for which metrics should be computed.
currency(Optional - Default: null) The currency to convert co-tail-metrics results to. If not specified, they will be returned in the view's target currency.
component_filter(Optional - Default: same as filter) The filter to use for the component co_metrics calculation.
component_perspective(Optional - Default: same as perspective) The perspective to use for the component co_metrics calculation.
include_primary_metrics(Optional - Default: false) Set to true to also compute and retrieve the primary metrics.
aggregation_method(Optional - Default: null) Specifies the method of aggregating event occurrences in a trial year for computing different types of metrics (AEP or OEP).
secondary_uncertainty(Optional - Default: null) Set to false to disable simulation with secondary uncertainty.
Returns
The co-tail-metrics at the specified probability.

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

Type Constraints
T :IAPIResourceView 
List<CoMetrics> AnalyzeRe.IAPIResourceView.co_metrics< T > ( List< double >  probabilities,
IReference< T >  component,
string  filter = null,
Perspective  perspective = null,
string  currency = null,
string  component_filter = null,
Perspective  component_perspective = null,
bool?  include_primary_metrics = null,
AggregationMethod aggregation_method = null,
bool?  secondary_uncertainty = null 
)

Obsolete.

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

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

Template Parameters
TThe type of the component referenced.
Parameters
probabilitiesThe probabilities at which to calculate the co-tail-metrics.
componentA reference to the component LayerView or PortfolioView to compute co-tail-metrics against.
filter(Optional - Default: null) The name of the loss filter to apply before computing metrics.
perspective(Optional - Default: null) The loss perspective for which metrics should be computed.
currency(Optional - Default: null) The currency to convert co-tail-metrics results to. If not specified, they will be returned in the view's target currency.
component_filter(Optional - Default: same as filter) The filter to use for the component co_metrics calculation.
component_perspective(Optional - Default: same as perspective) The perspective to use for the component co_metrics calculation.
include_primary_metrics(Optional - Default: false) Set to true to also compute and retrieve the primary metrics.
aggregation_method(Optional - Default: null) Specifies the method of aggregating event occurrences in a trial year for computing different types of metrics (AEP or OEP).
secondary_uncertainty(Optional - Default: null) Set to false to disable simulation with secondary uncertainty.
Returns
The co-tail-metrics at the specified probabilities.

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

Type Constraints
T :IAPIResourceView 
CoMetrics AnalyzeRe.IAPIResourceView.co_metrics< T > ( double  probability,
IReference< T >  component,
CoMetricsOptions  options 
)

Obsolete.

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

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

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 
ExceedanceProbability AnalyzeRe.IAPIResourceView.exceedance_probability ( double  threshold,
ExceedanceProbabilityOptions  options 
)

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.
Returns
The exceedance probability for the given loss.

TODO: Make options optional once deprecated methods are deleted

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

List<ExceedanceProbability> AnalyzeRe.IAPIResourceView.exceedance_probability ( IEnumerable< double >  thresholds,
ExceedanceProbabilityOptions  options 
)

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.
Returns
The exceedance probability for the given loss values.

TODO: Make options optional once deprecated methods are deleted

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

ExceedanceProbability AnalyzeRe.IAPIResourceView.exceedance_probability ( double  threshold,
string  filter = null,
Perspective  perspective = null,
bool?  inclusive_threshold = null,
string  threshold_currency = null,
AggregationMethod aggregation_method = null,
bool?  secondary_uncertainty = null 
)

Obsolete.

See also
exceedance_probability(Double,ExceedanceProbabilityOptions)

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.
filter(Optional - Default: null) The name of the loss filter to apply before computing metrics.
perspective(Optional - Default: null) The loss perspective for which metrics should be computed.
inclusive_threshold(Optional - Default: null) Set to true to calculate the probability that a loss is greater than OR EQUAL TO the threshold.
threshold_currency(Optional - Default: null) The currency that the threshold supplied is in. If not specified, the threshold is assumed to be in the target currency of this view.
aggregation_method(Optional - Default: null) Specifies the method of aggregating event occurrences in a trial year for computing different types of metrics (AEP or OEP).
secondary_uncertainty(Optional - Default: null) Set to false to disable simulation with secondary uncertainty.
Returns
The exceedance probability for the given loss.

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

List<ExceedanceProbability> AnalyzeRe.IAPIResourceView.exceedance_probability ( List< double >  thresholds,
string  filter = null,
Perspective  perspective = null,
bool?  inclusive_threshold = null,
string  threshold_currency = null,
AggregationMethod aggregation_method = null,
bool?  secondary_uncertainty = null 
)

Obsolete.

See also
exceedance_probability(IEnumerable<Double>,ExceedanceProbabilityOptions)

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.
filter(Optional - Default: null) The name of the loss filter to apply before computing metrics.
perspective(Optional - Default: null) The loss perspective for which metrics should be computed.
inclusive_threshold(Optional - Default: null) Set to true to calculate the probability that a loss is greater than OR EQUAL TO the threshold.
threshold_currency(Optional - Default: null) The currency that the threshold supplied is in. If not specified, the threshold is assumed to be in the target currency of this view.
aggregation_method(Optional - Default: null) Specifies the method of aggregating event occurrences in a trial year for computing different types of metrics (AEP or OEP).
secondary_uncertainty(Optional - Default: null) Set to false to disable simulation with secondary uncertainty.
Returns
The exceedance probability for the given loss.

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

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 
TailMetrics AnalyzeRe.IAPIResourceView.tail_metrics ( double  probability,
MetricsOptions  options 
)

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.
Returns
The tail_metrics at the specified probability.

TODO: Make options optional once deprecated methods are deleted

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

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

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.
Returns
The tail_metrics at the specified probabilities, as a list of TailMetrics responses in the same order as the probabilities supplied.

TODO: Make options optional once deprecated methods are deleted

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

TailMetrics AnalyzeRe.IAPIResourceView.tail_metrics ( double  probability,
string  filter = null,
Perspective  perspective = null,
string  currency = null,
AggregationMethod aggregation_method = null,
bool?  secondary_uncertainty = null 
)

Obsolete.

See also
tail_metrics(Double,MetricsOptions)

Returns the tail metrics of this view for a given probability (and filter optionally).

Parameters
probabilityThe probability (1 / return_period) at which to calculate the tail metrics.
filter(Optional - Default: null) The name of the loss filter to apply before computing metrics.
perspective(Optional - Default: null) The loss perspective for which metrics should be computed.
currency(Optional - Default: null) The currency to convert tail_metrics results to. If not specified, they will be returned in the view's target currency.
aggregation_method(Optional - Default: null) Specifies the method of aggregating event occurrences in a trial year for computing different types of metrics (AEP or OEP).
secondary_uncertainty(Optional - Default: null) Set to false to disable simulation with secondary uncertainty.
Returns
The tail_metrics at the specified probability, filtered, if a filter was provided.

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

List<TailMetrics> AnalyzeRe.IAPIResourceView.tail_metrics ( List< double >  probabilities,
string  filter = null,
Perspective  perspective = null,
string  currency = null,
AggregationMethod aggregation_method = null,
bool?  secondary_uncertainty = null 
)

Obsolete.

See also
tail_metrics(IEnumerable<Double>,MetricsOptions)

Returns the tail metrics of this view for a given list of probabilities.

Parameters
probabilitiesThe probabilities at which to calculate the tail metrics.
filter(Optional - Default: null) The name of the loss filter to apply before computing metrics.
perspective(Optional - Default: null) The loss perspective for which metrics should be computed.
currency(Optional - Default: null) The currency to convert tail_metrics results to. If not specified, they will be returned in the view's target currency.
aggregation_method(Optional - Default: null) Specifies the method of aggregating event occurrences in a trial year for computing different types of metrics (AEP or OEP).
secondary_uncertainty(Optional - Default: null) Set to false to disable simulation with secondary uncertainty.
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.

WindowMetrics AnalyzeRe.IAPIResourceView.window_metrics ( ProbabilityWindow  range,
MetricsOptions  options 
)

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.
Returns
The window_metrics at the specified probability.

TODO: Make options optional once deprecated methods are deleted

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

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

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.
Returns
The window_metrics at the specified probabilities, as a list of WindowMetrics responses in the same order as the probabilities supplied.

TODO: Make options optional once deprecated methods are deleted

Implemented in AnalyzeRe.APIResourceView.BaseAPIResourceView.

Property Documentation

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

The analysis profile used to analyze the resource.

Definition at line 13 of file IAPIAnalysis.cs.

string AnalyzeRe.IAPIResource.collection_name
getinherited

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

Definition at line 19 of file IAPIResource.cs.

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.

Definition at line 14 of file IAPIResource.cs.

string AnalyzeRe.APITypes.IEndpoint.Path
getinherited

The relative path to this endpoint from the root URL.

Definition at line 13 of file IEndpoint.cs.

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.

Definition at line 20 of file IAPIAnalysis.cs.

YELTSimulationResult AnalyzeRe.IAPIResourceView.yelt
get

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

Definition at line 33 of file IAPIResourceView.cs.

YLTSimulationResult AnalyzeRe.IAPIResourceView.ylt
get

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

Definition at line 28 of file IAPIResourceView.cs.

string AnalyzeRe.IAPIResourceView.ylt_id
getset

The hash identifier for the simulation results of this layer.

Definition at line 23 of file IAPIResourceView.cs.


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