C# Client Library
A C# Client Library for the AnalyzeRe REST API
|
Base for all conventional loss sets, which generate losses, have a server-generated loss profile, and require a currency to be specified. 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 = "loss_sets" |
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 | currency [get, set] |
The currency of the losses in this loss set. | |
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. | |
LossType? | loss_type [get, set] |
Indicates what types of losses are generated by this loss set. If not specified the server will default to LossGross, except for YLTLossSets, which are assumed to be LossNetOfAggregateTerms by default. | |
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. | |
LossSetProfile | profile [get, set] |
A profile of this loss set, generated by the server after post. | |
string | type [get] |
The server name for this type of resource. | |
Base for all conventional loss sets, which generate losses, have a server-generated loss profile, and require a currency to be specified.
Definition at line 8 of file LossSet_WithCurrency.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.
The collection endpoint at which resources of this type reside on the server.
Definition at line 41 of file LossSet.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.
Definition at line 44 of file LossSet.cs.
|
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.
|
getset |
The currency of the losses in this loss set.
Definition at line 14 of file LossSet_WithCurrency.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.
|
getsetinherited |
Indicates what types of losses are generated by this loss set. If not specified the server will default to LossGross, except for YLTLossSets, which are assumed to be LossNetOfAggregateTerms by default.
Implements AnalyzeRe.LossSets.ILossSet.
Definition at line 53 of file LossSet.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.
|
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 |
A profile of this loss set, generated by the server after post.
Implements AnalyzeRe.LossSets.ILossSet.
Definition at line 58 of file LossSet.cs.
|
getinherited |
The server name for this type of resource.
Implements AnalyzeRe.APITypes.IAPI_Polymorphic.
Definition at line 13 of file StoredAPIResource_Polymorphic.cs.