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

A configuration of resources used to simulate a layer or portfolio. More...

Public Member Functions

 AnalysisProfile ()
 Construct a new AnalysisProfile with empty loss_filters and event_catalogs lists. More...
 
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

override string collection_name => CLASS_COLLECTION_NAME
 The collection endpoint at which resources of this type reside on the server. More...
 
string Path => API.GetResourcePath(this)
 The relative path to this endpoint from the root URL. More...
 

Static Public Attributes

static readonly string CLASS_COLLECTION_NAME = "analysis_profiles"
 The collection endpoint at which resources of this type reside on the server. 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

DateTime created [get, set]
 The date and time when the resource was created on the system. More...
 
string description [get, set]
 A user-friendly description of the resource. More...
 
List< IReference< EventCatalog > > event_catalogs [get, set]
 The EventCatalogs to use during this simulation. More...
 
IReference< ExchangeRates.ExchangeRateProfileexchange_rate_profile [get, set]
 The ExchangeRateProfile to use to get rates. 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...
 
List< IReference< LossFilter > > loss_filters [get, set]
 The LossFilters to bucket simulation results in. More...
 
Dictionary< string, object > meta_data [get, set]
 Any user-defined metadata for this layer. More...
 
DateTime modified [get, set]
 The date and time when the resource was last modified on the system. More...
 
double progress [get, set]
 The progress made in validating this resource. Usually a number between 0 and 1 (where 1 means 100% completion). Progress may not be available for certain resource types. More...
 
IReference< Simulationsimulation [get, set]
 The Simulation to run. More...
 
TaskStatus status [get, set]
 Status of the data file associated with this resource. More...
 
string status_message [get, set]
 Status message of the data file associated with this resource. More...
 

Detailed Description

A configuration of resources used to simulate a layer or portfolio.

Definition at line 10 of file AnalysisProfile.cs.

Inheritance diagram for AnalyzeRe.AnalysisProfile:
AnalyzeRe.APITypes.StoredAPIResource_WithStatus AnalyzeRe.APITypes.StoredAPIResource AnalyzeRe.APITypes.IStoredAPIResource_WithStatus AnalyzeRe.APIResource AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APIType AnalyzeRe.IAPIResource AnalyzeRe.IAPIResource AnalyzeRe.IAPIResource AnalyzeRe.IAPIType AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint

Constructor & Destructor Documentation

AnalyzeRe.AnalysisProfile.AnalysisProfile ( )
inline

Construct a new AnalysisProfile with empty loss_filters and event_catalogs lists.

Definition at line 44 of file AnalysisProfile.cs.

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

readonly string AnalyzeRe.AnalysisProfile.CLASS_COLLECTION_NAME = "analysis_profiles"
static

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

Definition at line 14 of file AnalysisProfile.cs.

override string AnalyzeRe.AnalysisProfile.collection_name => CLASS_COLLECTION_NAME

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

Definition at line 17 of file AnalysisProfile.cs.

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

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

DateTime AnalyzeRe.APITypes.StoredAPIResource.created
getsetinherited

The date and time when the resource was created on the system.

Definition at line 19 of file StoredAPIResource.cs.

string AnalyzeRe.APITypes.StoredAPIResource.description
getsetinherited

A user-friendly description of the resource.

Definition at line 14 of file StoredAPIResource.cs.

List<IReference<EventCatalog> > AnalyzeRe.AnalysisProfile.event_catalogs
getset

The EventCatalogs to use during this simulation.

Definition at line 34 of file AnalysisProfile.cs.

IReference<ExchangeRates.ExchangeRateProfile> AnalyzeRe.AnalysisProfile.exchange_rate_profile
getset

The ExchangeRateProfile to use to get rates.

Definition at line 28 of file AnalysisProfile.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.

List<IReference<LossFilter> > AnalyzeRe.AnalysisProfile.loss_filters
getset

The LossFilters to bucket simulation results in.

Definition at line 39 of file AnalysisProfile.cs.

Dictionary<string, object> AnalyzeRe.APITypes.StoredAPIResource.meta_data
getsetinherited

Any user-defined metadata for this layer.

Definition at line 30 of file StoredAPIResource.cs.

DateTime AnalyzeRe.APITypes.StoredAPIResource.modified
getsetinherited

The date and time when the resource was last modified on the system.

Definition at line 24 of file StoredAPIResource.cs.

double AnalyzeRe.APITypes.StoredAPIResource_WithStatus.progress
getsetinherited

The progress made in validating this resource. Usually a number between 0 and 1 (where 1 means 100% completion). Progress may not be available for certain resource types.

Definition at line 28 of file StoredAPIResource_WithStatus.cs.

IReference<Simulation> AnalyzeRe.AnalysisProfile.simulation
getset

The Simulation to run.

Definition at line 24 of file AnalysisProfile.cs.

TaskStatus AnalyzeRe.APITypes.StoredAPIResource_WithStatus.status
getsetinherited

Status of the data file associated with this resource.

Definition at line 16 of file StoredAPIResource_WithStatus.cs.

string AnalyzeRe.APITypes.StoredAPIResource_WithStatus.status_message
getsetinherited

Status message of the data file associated with this resource.

Definition at line 21 of file StoredAPIResource_WithStatus.cs.


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