C# Client Library
A C# Client Library for the AnalyzeRe REST API
|
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.
for a serializer-based copy method. | |
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. | |
Properties | |
ConditionalDistributionMetrics | component_metrics [get, set] |
The co-metrics computed for the requested component. | |
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. | |
TailDistributionMetrics | primary_metrics [get, set] |
The tail metrics of the primary distribution (if requested). | |
The structure returned when requesting Co-Metrics for a view.
Definition at line 8 of file CoMetrics.Context.cs.
|
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.APITypes.APIResource_WithDataEndpoint, AnalyzeRe.APIResourceView.BaseAPIResourceView, AnalyzeRe.Distributions.CustomDistribution, AnalyzeRe.LossSets.LossSet_WithData, AnalyzeRe.Optimization.Candidate, AnalyzeRe.Optimization.OptimizationView, and AnalyzeRe.StaticSimulation.
Definition at line 37 of file APIType.cs.
|
inlinevirtualinherited |
Create a shallow copy of this object.
for a serializer-based copy method.
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.
T | : | IAPIType |
Definition at line 14 of file APIType.cs.
|
getset |
The co-metrics computed for the requested component.
Definition at line 21 of file CoMetrics.cs.
|
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 13 of file CoMetrics.cs.
|
getset |
The tail metrics of the primary distribution (if requested).
Definition at line 17 of file CoMetrics.cs.