C# Client Library
A C# Client Library for the AnalyzeRe REST API
|
A structure that can be used to change the currency of a loss stream from one currency to another at a fixed rate. Loss sets can be converted from one currency to another directly using this structure. Other layers whose losses are output in a currency that needs to be converted at a fixed rate can also be converted by using this structure as the sink of a NestedLayer. This is a unique structure that cannot be saved to the layers endpoint, it can only be inlined within a LayerView. More...
Public Member Functions | |
virtual T | ShallowCopy< T > () |
Create a shallow copy of this object.
for a serializer-based copy method. | |
Static Public Attributes | |
static readonly string | CLASS_COLLECTION_NAME = "layers" |
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 | |
static string | APITypeName [get] |
Can be used to get the API type name in a static context. | |
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. | |
string | id [get, set] |
The resource's unique identifier. It will be used in the request URL when requesting the resource from the server. | |
string | in_currency [get, set] |
The currency this converter will convert from. Warning: All input Layer_WithLossSets.loss_sets that are not already in in_currency will be converted to in_currency before they are processed (using the default AnalysisProfile.exchange_rate_profile rules). To avoid unintended consequences, you should only attach loss sets to this converter that are already in in_currency. | |
List< IReference< LossSet > > | loss_sets [get, set] |
The list of LossSet references that is associated with the specific layer. | |
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 | out_currency [get, set] |
The currency this converter will convert to at a fixed rate. | |
string | Path [get] |
The relative path to this endpoint from the root URL. | |
Policy | policy [get, set] |
The Policy that overrides the default layer behaviour for forwarding and transforming loss records. | |
double | rate [get, set] |
The fixed rate to use in converting losses from in_currency to out_currency. All input losses will be multiplied by this rate, and then have their currency set to out_currency. | |
string | type [get] |
The server name for this type of resource. | |
A structure that can be used to change the currency of a loss stream from one currency to another at a fixed rate. Loss sets can be converted from one currency to another directly using this structure. Other layers whose losses are output in a currency that needs to be converted at a fixed rate can also be converted by using this structure as the sink of a NestedLayer. This is a unique structure that cannot be saved to the layers endpoint, it can only be inlined within a LayerView.
Definition at line 15 of file FixedRateCurrencyConverter.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.
|
staticgetinherited |
Can be used to get the API type name in a static context.
Definition at line 17 of file StoredAPIResource_Polymorphic.cs.
The collection endpoint at which resources of this type reside on the server.
Implements AnalyzeRe.IAPIResource.
|
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.
|
getsetinherited |
A user-friendly description of the resource.
Implements AnalyzeRe.APITypes.IStoredAPIResource.
Definition at line 14 of file StoredAPIResource.cs.
|
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.
|
getset |
The currency this converter will convert from. Warning: All input Layer_WithLossSets.loss_sets that are not already in in_currency will be converted to in_currency before they are processed (using the default AnalysisProfile.exchange_rate_profile rules). To avoid unintended consequences, you should only attach loss sets to this converter that are already in in_currency.
Definition at line 28 of file FixedRateCurrencyConverter.cs.
|
getsetinherited |
The list of LossSet references that is associated with the specific layer.
Implements AnalyzeRe.Layers.ILayer_WithLossSets.
Definition at line 15 of file Layer_WithLossSets.cs.
|
getsetinherited |
Any user-defined metadata for this layer.
Implements AnalyzeRe.APITypes.IStoredAPIResource.
Definition at line 30 of file StoredAPIResource.cs.
|
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.
|
getset |
The currency this converter will convert to at a fixed rate.
Definition at line 34 of file FixedRateCurrencyConverter.cs.
|
getinherited |
The relative path to this endpoint from the root URL.
The relative path to this endpoint from the root URL.
System.ArgumentException | If this resource does not have an id. |
Implements AnalyzeRe.APITypes.IEndpoint.
Definition at line 27 of file APIResource.cs.
|
getsetinherited |
The Policy that overrides the default layer behaviour for forwarding and transforming loss records.
Implements AnalyzeRe.Layers.ILayer_WithLossSets.
Definition at line 20 of file Layer_WithLossSets.cs.
|
getset |
The fixed rate to use in converting losses from in_currency to out_currency. All input losses will be multiplied by this rate, and then have their currency set to out_currency.
Definition at line 40 of file FixedRateCurrencyConverter.cs.
|
getinherited |
The server name for this type of resource.
Implements AnalyzeRe.APITypes.IAPI_Polymorphic.
Definition at line 13 of file StoredAPIResource_Polymorphic.cs.