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

Base class used by all resources. 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...

 

Public Attributes

string Path => API.GetResourcePath(this)
 The relative path to this endpoint from the root URL. 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

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

Detailed Description

Base class used by all resources.

Definition at line 9 of file APIResource.cs.

Inheritance diagram for AnalyzeRe.APIResource:
AnalyzeRe.APIType AnalyzeRe.IAPIResource AnalyzeRe.IAPIType AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.API.PortfolioViewMarginals.MarginalPortfolioView AnalyzeRe.APIResourceView.BaseAPIResourceView AnalyzeRe.APITypes.StoredAPIResource AnalyzeRe.Authentication.OauthAccessToken AnalyzeRe.LayerView< T > AnalyzeRe.PortfolioView AnalyzeRe.Agent AnalyzeRe.APITypes.StoredAPIResource_Polymorphic AnalyzeRe.APITypes.StoredAPIResource_WithStatus AnalyzeRe.DataFile AnalyzeRe.ExchangeRates.ExchangeRateProfile AnalyzeRe.Optimization.Function

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.

Member Data Documentation

string AnalyzeRe.APIResource.Path => API.GetResourcePath(this)

The relative path to this endpoint from the root URL.

Exceptions
System.ArgumentExceptionIf this resource does not have an id.

Definition at line 27 of file APIResource.cs.

Property Documentation

abstract string AnalyzeRe.APIResource.collection_name
get

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

Definition at line 21 of file APIResource.cs.

string AnalyzeRe.APIResource.id
getset

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.


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