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

Represents the Analysis of a Layer. More...

Public Member Functions

 LayerView ()
 Default Constructor.
 
 LayerView (T layer, IReference< AnalysisProfile > analysis_profile, string target_currency)
 Construct a LayerView with all its modifiable properties.
 
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.
 
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< 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.
 

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.
 

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< AnalysisProfileanalysis_profile [get, set]
 The simulation's analysis profile.
 
override string collection_name [get]
 The collection endpoint at which resources of this type reside on the server.
 
string id [get, set]
 The resource's unique identifier. It will be used in the request URL when requesting the resource from the server.
 
T layer [get, set]
 The layer contained in this LayerView.
 
Type LayerType [get]
 Returns the runtime type of layer this layer_view refers to, or the generic type parameter T if unresolved.
 
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.
 
string type [get]
 Serialized to distinguish between other ILayerSource objects.
 
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

Represents the Analysis of a Layer.

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

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

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

Constructor & Destructor Documentation

◆ LayerView() [1/2]

Default Constructor.

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

◆ LayerView() [2/2]

AnalyzeRe.LayerView< T >.LayerView ( T  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 58 of file LayerView[T].cs.

Member Function Documentation

◆ AfterMembersCloned()

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

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

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.

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

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.

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

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.

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

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.

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

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

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

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

Member Data Documentation

◆ CLASS_COLLECTION_NAME

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 18 of file LayerView[T].cs.

Property Documentation

◆ analysis_profile

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

The simulation's analysis profile.

Implements AnalyzeRe.APITypes.IAPIAnalysis.

Definition at line 33 of file BaseAPIResourceView.cs.

◆ collection_name

override string AnalyzeRe.LayerView< T >.collection_name
get

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

Implements AnalyzeRe.IAPIResource.

Definition at line 22 of file LayerView[T].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.

◆ layer

T AnalyzeRe.LayerView< T >.layer
getset

The layer contained in this LayerView.

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

◆ LayerType

Type AnalyzeRe.LayerView< T >.LayerType
get

Returns the runtime type of layer this layer_view refers to, or the generic type parameter T if unresolved.

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

◆ Path

string AnalyzeRe.APIResource.Path
getinherited

The relative path to this endpoint from the root URL.

The relative path to this endpoint from the root URL.

Exceptions
System.ArgumentExceptionIf 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
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.

Implements AnalyzeRe.APITypes.IAPIAnalysis.

Definition at line 45 of file BaseAPIResourceView.cs.

◆ type

Serialized to distinguish between other ILayerSource objects.

Implements AnalyzeRe.APITypes.IAPI_Polymorphic.

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

◆ yelt

YELTSimulationResult AnalyzeRe.APIResourceView.BaseAPIResourceView.yelt
getinherited

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
getinherited

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
getsetinherited

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: