C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalyzeRe.ExchangeRates.ExchangeRateProfile Class Reference

A profile describing how to apply exchange rates during an analysis. More...

Public Member Functions

 ExchangeRateProfile ()
 Construct a new CatXL Layer with an empty rate_selection_order list.
 
virtual T ShallowCopy< T > ()
 Create a shallow copy of this object.

See also
ExtensionMethods.DeepCopy<T>

for a serializer-based copy method.

 

Static Public Attributes

static readonly string CLASS_COLLECTION_NAME = "exchange_rate_profiles"
 The collection endpoint at which resources of this type reside on the server.
 

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

override string collection_name [get]
 The collection endpoint at which resources of this type reside on the server.
 
DateTime? created [get, set]
 The date and time when the resource was created on the system.
 
string description [get, set]
 A user-friendly description of the resource.
 
IReference< ExchangeRateTableexchange_rate_table [get, set]
 The ExchangeRateTable to get rates from.
 
string id [get, set]
 The resource's unique identifier. It will be used in the request URL when requesting the resource from the server.
 
Dictionary< string, object > meta_data = new Dictionary<string, object>() [get, set]
 Any user-defined metadata for this layer.
 
DateTime? modified [get, set]
 The date and time when the resource was last modified on the system.
 
string Path [get]
 The relative path to this endpoint from the root URL.
 
List< ExchangeRateSelectionRulerate_selection_order [get, set]
 The rate selection rules to apply, in the order that they should be applied.
 

Detailed Description

A profile describing how to apply exchange rates during an analysis.

Definition at line 11 of file ExchangeRateProfile.cs.

Inheritance diagram for AnalyzeRe.ExchangeRates.ExchangeRateProfile:
AnalyzeRe.APITypes.StoredAPIResource AnalyzeRe.APIResource AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APIType AnalyzeRe.IAPIResource AnalyzeRe.IAPIResource AnalyzeRe.IAPIType AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint

Constructor & Destructor Documentation

◆ ExchangeRateProfile()

AnalyzeRe.ExchangeRates.ExchangeRateProfile.ExchangeRateProfile ( )
inline

Construct a new CatXL Layer with an empty rate_selection_order list.

Definition at line 36 of file ExchangeRateProfile.cs.

Member Function Documentation

◆ AfterMembersCloned()

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

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

Member Data Documentation

◆ CLASS_COLLECTION_NAME

readonly string AnalyzeRe.ExchangeRates.ExchangeRateProfile.CLASS_COLLECTION_NAME = "exchange_rate_profiles"
static

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

Definition at line 15 of file ExchangeRateProfile.cs.

Property Documentation

◆ collection_name

override string AnalyzeRe.ExchangeRates.ExchangeRateProfile.collection_name
get

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

Implements AnalyzeRe.IAPIResource.

Definition at line 18 of file ExchangeRateProfile.cs.

◆ created

DateTime? AnalyzeRe.APITypes.StoredAPIResource.created
getsetinherited

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

Implements AnalyzeRe.APITypes.IStoredAPIResource.

Definition at line 19 of file StoredAPIResource.cs.

◆ description

string AnalyzeRe.APITypes.StoredAPIResource.description
getsetinherited

A user-friendly description of the resource.

Implements AnalyzeRe.APITypes.IStoredAPIResource.

Definition at line 14 of file StoredAPIResource.cs.

◆ exchange_rate_table

IReference<ExchangeRateTable> AnalyzeRe.ExchangeRates.ExchangeRateProfile.exchange_rate_table
getset

The ExchangeRateTable to get rates from.

Definition at line 25 of file ExchangeRateProfile.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.

◆ meta_data

Dictionary<string, object> AnalyzeRe.APITypes.StoredAPIResource.meta_data = new Dictionary<string, object>()
getsetinherited

Any user-defined metadata for this layer.

Implements AnalyzeRe.APITypes.IStoredAPIResource.

Definition at line 30 of file StoredAPIResource.cs.

◆ modified

DateTime? AnalyzeRe.APITypes.StoredAPIResource.modified
getsetinherited

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

Implements AnalyzeRe.APITypes.IStoredAPIResource.

Definition at line 24 of file StoredAPIResource.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.

◆ rate_selection_order

List<ExchangeRateSelectionRule> AnalyzeRe.ExchangeRates.ExchangeRateProfile.rate_selection_order
getset

The rate selection rules to apply, in the order that they should be applied.

Definition at line 31 of file ExchangeRateProfile.cs.


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