C# Client Library
A C# Client Library for the AnalyzeRe REST API
AnalyzeRe.LayerView< T > Class Template Reference

Represents the Analysis of a Layer More...

Public Member Functions

 LayerView ()
 Default Constructor More...
 
 LayerView (T layer, IReference< AnalysisProfile > analysis_profile, string target_currency)
 Construct a LayerView with all its modifiable properties. More...
 
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 at a given probability. More...
 
List< CoMetricsco_metrics< T > (IEnumerable< ProbabilityWindow > ranges, IReference< T > component, CoMetricsOptions options)
 Returns the co-metrics of this view for a given probability. 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...

 
virtual T ShallowCopy< T > ()
 Create a shallow copy of this object.

See also
ExtensionMethods.DeepCopy<T>

for a serializer-based copy method. 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...
 

Public Attributes

override string collection_name => CLASS_COLLECTION_NAME
 The collection endpoint at which resources of this type reside on the server. More...
 
YELTSimulationResult yelt => _yelt ?? (_yelt = new YELTSimulationResult(this))
 Allows retrieval of the YELT (Year Event Loss Table) associated with this view once it has been simulated. More...
 
YLTSimulationResult ylt => _ylt ?? (_ylt = new YLTSimulationResult(this))
 Allows retrieval of the YLT (Year Loss Table) associated with this view once it has been simulated. More...
 

Static Public Attributes

static readonly string CLASS_COLLECTION_NAME = LayerViews.CLASS_COLLECTION_NAME
 The collection endpoint at which resources of this type reside on the server. More...
 

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

Properties

IReference< AnalysisProfileanalysis_profile [get, set]
 The simulation's analysis profile. 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...
 
layer [get, set]
 The immutable layer contained in this LayerView More...
 
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. More...
 
string ylt_id [get, set]
 The hash identifier for the simulation results of this view. More...
 

Detailed Description

Represents the Analysis of a Layer

Template Parameters
TThe type of Layer in this LayerView
Type Constraints
T :ILayer 

Definition at line 12 of file LayerView[T].cs.

Inheritance diagram for AnalyzeRe.LayerView< T >:
AnalyzeRe.APIResourceView.BaseAPIResourceView AnalyzeRe.ILayerView< T > AnalyzeRe.APIResource AnalyzeRe.IAPIResourceView AnalyzeRe.APIType AnalyzeRe.IAPIResource AnalyzeRe.APITypes.IAPIAnalysis AnalyzeRe.IAPIResource AnalyzeRe.IAPIType AnalyzeRe.IAPIType AnalyzeRe.IAPIType

Constructor & Destructor Documentation

AnalyzeRe.LayerView< T >.LayerView ( )
inline

Default Constructor

Definition at line 39 of file LayerView[T].cs.

AnalyzeRe.LayerView< T >.LayerView ( layer,
IReference< AnalysisProfile analysis_profile,
string  target_currency 
)
inline

Construct a LayerView with all its modifiable properties.

Parameters
layerThe inner layer.
analysis_profileThe analysis profile.
target_currencyThe target currency.

Definition at line 45 of file LayerView[T].cs.

Member Function Documentation

override void AnalyzeRe.APIResourceView.BaseAPIResourceView.AfterMembersCloned ( APIType  _)
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.

Reimplemented from AnalyzeRe.APIType.

Definition at line 248 of file BaseAPIResourceView.cs.

BackAllocations AnalyzeRe.APIResourceView.BaseAPIResourceView.back_allocations ( string  source_id)
inlineinherited

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.

Implements AnalyzeRe.IAPIResourceView.

Definition at line 237 of file BaseAPIResourceView.cs.

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

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

Template Parameters
TThe type of the component referenced.
Parameters
rangeThe probability range 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 probability.

TODO: Make options optional once deprecated methods are deleted

Implements AnalyzeRe.IAPIResourceView.

Type Constraints
T :IAPIResourceView 

Definition at line 126 of file BaseAPIResourceView.cs.

List<CoMetrics> AnalyzeRe.APIResourceView.BaseAPIResourceView.co_metrics< T > ( IEnumerable< ProbabilityWindow ranges,
IReference< T >  component,
CoMetricsOptions  options 
)
inlineinherited

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

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

Implements AnalyzeRe.IAPIResourceView.

Type Constraints
T :IAPIResourceView 

Definition at line 143 of file BaseAPIResourceView.cs.

CoMetrics AnalyzeRe.APIResourceView.BaseAPIResourceView.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 
)
inlineinherited

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.

Implements AnalyzeRe.IAPIResourceView.

Type Constraints
T :IAPIResourceView 

Definition at line 430 of file BaseAPIResourceView.cs.

List<CoMetrics> AnalyzeRe.APIResourceView.BaseAPIResourceView.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 
)
inlineinherited

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.

Implements AnalyzeRe.IAPIResourceView.

Type Constraints
T :IAPIResourceView 

Definition at line 476 of file BaseAPIResourceView.cs.

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

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.

Implements AnalyzeRe.IAPIResourceView.

Type Constraints
T :IAPIResourceView 

Definition at line 505 of file BaseAPIResourceView.cs.

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

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.

Implements AnalyzeRe.IAPIResourceView.

Type Constraints
T :IAPIResourceView 

Definition at line 523 of file BaseAPIResourceView.cs.

ExceedanceProbability AnalyzeRe.APIResourceView.BaseAPIResourceView.exceedance_probability ( double  threshold,
ExceedanceProbabilityOptions  options 
)
inlineinherited

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

Implements AnalyzeRe.IAPIResourceView.

Definition at line 207 of file BaseAPIResourceView.cs.

List<ExceedanceProbability> AnalyzeRe.APIResourceView.BaseAPIResourceView.exceedance_probability ( IEnumerable< double >  thresholds,
ExceedanceProbabilityOptions  options 
)
inlineinherited

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

Implements AnalyzeRe.IAPIResourceView.

Definition at line 222 of file BaseAPIResourceView.cs.

ExceedanceProbability AnalyzeRe.APIResourceView.BaseAPIResourceView.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 
)
inlineinherited

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.

Implements AnalyzeRe.IAPIResourceView.

Definition at line 553 of file BaseAPIResourceView.cs.

List<ExceedanceProbability> AnalyzeRe.APIResourceView.BaseAPIResourceView.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 
)
inlineinherited

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.

Implements AnalyzeRe.IAPIResourceView.

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

TailMetrics AnalyzeRe.APIResourceView.BaseAPIResourceView.tail_metrics ( double  probability,
MetricsOptions  options 
)
inlineinherited

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

Implements AnalyzeRe.IAPIResourceView.

Definition at line 66 of file BaseAPIResourceView.cs.

List<TailMetrics> AnalyzeRe.APIResourceView.BaseAPIResourceView.tail_metrics ( IEnumerable< double >  probabilities,
MetricsOptions  options 
)
inlineinherited

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

Implements AnalyzeRe.IAPIResourceView.

Definition at line 80 of file BaseAPIResourceView.cs.

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

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.

Implements AnalyzeRe.IAPIResourceView.

Definition at line 356 of file BaseAPIResourceView.cs.

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

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.

Implements AnalyzeRe.IAPIResourceView.

Definition at line 388 of file BaseAPIResourceView.cs.

WindowMetrics AnalyzeRe.APIResourceView.BaseAPIResourceView.window_metrics ( ProbabilityWindow  range,
MetricsOptions  options 
)
inlineinherited

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

Implements AnalyzeRe.IAPIResourceView.

Definition at line 95 of file BaseAPIResourceView.cs.

List<WindowMetrics> AnalyzeRe.APIResourceView.BaseAPIResourceView.window_metrics ( IEnumerable< ProbabilityWindow ranges,
MetricsOptions  options 
)
inlineinherited

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

Implements AnalyzeRe.IAPIResourceView.

Definition at line 108 of file BaseAPIResourceView.cs.

Member Data Documentation

readonly string AnalyzeRe.LayerView< T >.CLASS_COLLECTION_NAME = LayerViews.CLASS_COLLECTION_NAME
static

The collection endpoint at which resources of this type reside on the server.

Definition at line 16 of file LayerView[T].cs.

override string AnalyzeRe.LayerView< T >.collection_name => CLASS_COLLECTION_NAME

The collection endpoint at which resources of this type reside on the server.

Definition at line 20 of file LayerView[T].cs.

YELTSimulationResult AnalyzeRe.APIResourceView.BaseAPIResourceView.yelt => _yelt ?? (_yelt = new YELTSimulationResult(this))
inherited

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

Definition at line 55 of file BaseAPIResourceView.cs.

YLTSimulationResult AnalyzeRe.APIResourceView.BaseAPIResourceView.ylt => _ylt ?? (_ylt = new YLTSimulationResult(this))
inherited

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

Definition at line 50 of file BaseAPIResourceView.cs.

Property Documentation

IReference<AnalysisProfile> AnalyzeRe.APIResourceView.BaseAPIResourceView.analysis_profile
getsetinherited

The simulation's analysis profile.

Definition at line 33 of file BaseAPIResourceView.cs.

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.

Definition at line 16 of file APIResource.cs.

T AnalyzeRe.LayerView< T >.layer
getset

The immutable layer contained in this LayerView

Definition at line 35 of file LayerView[T].cs.

string AnalyzeRe.APIResourceView.BaseAPIResourceView.target_currency
getsetinherited

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.

Definition at line 45 of file BaseAPIResourceView.cs.

string AnalyzeRe.APIResourceView.BaseAPIResourceView.ylt_id
getsetinherited

The hash identifier for the simulation results of this view.

Definition at line 38 of file BaseAPIResourceView.cs.


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