C# Client Library
A C# Client Library for the AnalyzeRe REST API
AnalyzeRe.Metrics.CoMetrics Class Reference

The structure returned when requesting Co-Metrics for a view. More...

Classes

class  Context
 The context of a co-metrics request, indicating what parameters were used in the simulation that produced the associated metrics response. More...
 

Public Member Functions

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

See also
ExtensionMethods.DeepCopy<T>

for a serializer-based copy method. More...

 

Protected Member Functions

virtual void AfterMembersCloned (APIType originalResource)
 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

ConditionalDistributionMetrics component_metrics [get, set]
 The co-metrics computed for the requested component. More...
 
Context context [get, set]
 The context of a co-metrics request, indicating what parameters were used in the simulation that produced the associated metrics response. More...
 
TailDistributionMetrics primary_metrics [get, set]
 The tail metrics of the primary distribution (if requested). More...
 

Detailed Description

The structure returned when requesting Co-Metrics for a view.

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

Definition at line 8 of file CoMetrics.Context.cs.

Inheritance diagram for AnalyzeRe.Metrics.CoMetrics:
AnalyzeRe.APIType AnalyzeRe.Metrics.IMetricsResponse< CoMetrics.Context > AnalyzeRe.IAPIType

Member Function Documentation

virtual void AnalyzeRe.APIType.AfterMembersCloned ( APIType  originalResource)
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().

A sane question for a code reviewer to ask might be: "Why not avoid copying those members in the first place?" The answer is that there is no framework-supported method of excluding members from a MemberwiseClone. The only officially supported solution is to not use the object.MemberwiseClone method at all and instead have each class implement it's own Copy method. In our case, most objects have no need to specialize their copy implementation (even though they could - the ShallowCopy<T> method is marked virtual). It's simpler to simply "correct" any special-case members after the fact, and requires less error-prone code than if the code were responsible for ensuring no members were missed in a copy. It's also faster than any reflection-based approach, even though such an approach could benefit from custom attributes meant to exclude certain members from copying.

Reimplemented in AnalyzeRe.APIResourceView.BaseAPIResourceView, AnalyzeRe.Optimization.OptimizationView, AnalyzeRe.Optimization.Candidate, AnalyzeRe.StaticSimulation, AnalyzeRe.Distributions.CustomDistribution, AnalyzeRe.LossSets.LossSet_WithData, and AnalyzeRe.APITypes.APIResource_WithDataEndpoint.

Definition at line 37 of file APIType.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.

Property Documentation

ConditionalDistributionMetrics AnalyzeRe.Metrics.CoMetrics.component_metrics
getset

The co-metrics computed for the requested component.

Definition at line 20 of file CoMetrics.cs.

Context AnalyzeRe.Metrics.CoMetrics.context
getset

The context of a co-metrics request, indicating what parameters were used in the simulation that produced the associated metrics response.

Definition at line 12 of file CoMetrics.cs.

TailDistributionMetrics AnalyzeRe.Metrics.CoMetrics.primary_metrics
getset

The tail metrics of the primary distribution (if requested).

Definition at line 16 of file CoMetrics.cs.


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