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

Representation of a Parametric loss set. More...

Public Member Functions

 ParametricLossSet ()
 Construct a new ParametricLossSet with an empty attributes list. 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 type => TypeResolver.GetTypeNameForAPIType(GetType())
 The server name for this type of resource. More...
 

Static Public Attributes

static string APITypeName
 Can be used to get the API type name in a static context. More...
 
static readonly string CLASS_COLLECTION_NAME = "loss_sets"
 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

Dictionary< string, string > attributes [get, set]
 Loss attributes generated by this LossSet. More...
 
DateTime created [get, set]
 The date and time when the resource was created on the system. More...
 
string currency [get, set]
 The currency of the losses in this loss set. More...
 
string description [get, set]
 A user-friendly description of the resource. More...
 
UInt64 event_id [get, set]
 Optional event id that will be associated with all occurrences generated. More...
 
IReference< IDiscreteDistributionfrequency [get, set]
 The frequency distribution associated with this loss set. Can be any DiscreteDistribution, a single value (DiracDistribution), or a CustomFrequencyDistribution. 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...
 
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. 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...
 
LossSetProfile profile [get, set]
 A profile of this loss set, generated by the server after post. More...
 
IReference< IContinuousDistributionseasonality [get, set]
 The seasonality distribution associated with this loss set. Can be any ContinuousDistribution, a single value (DiracDistribution), or a CustomSeasonalityDistribution. More...
 
IReference< IContinuousDistributionseverity [get, set]
 The severity distribution associated with this loss set. Can be any ContinuousDistribution, a single value (DiracDistribution), or a CustomSeverityDistribution. More...
 
DateTime start_date [get, set]
 The date and time represented when the seasonality distribution generates a value of 0. More...
 

Detailed Description

Representation of a Parametric loss set.

Definition at line 11 of file ParametricLossSet.cs.

Inheritance diagram for AnalyzeRe.LossSets.ParametricLossSet:
AnalyzeRe.LossSets.LossSet_WithCurrency AnalyzeRe.LossSets.ILossSet_WithSeasonality AnalyzeRe.LossSet AnalyzeRe.APITypes.StoredAPIResource_Polymorphic AnalyzeRe.APITypes.StoredAPIResource AnalyzeRe.APITypes.IAPI_Polymorphic AnalyzeRe.APIResource AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APIType AnalyzeRe.IAPIResource AnalyzeRe.IAPIResource AnalyzeRe.IAPIType AnalyzeRe.IAPIType AnalyzeRe.IAPIType

Constructor & Destructor Documentation

AnalyzeRe.LossSets.ParametricLossSet.ParametricLossSet ( )
inline

Construct a new ParametricLossSet with an empty attributes list.

Definition at line 52 of file ParametricLossSet.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

string AnalyzeRe.APITypes.StoredAPIResource_Polymorphic.APITypeName
staticinherited
Initial value:
=> TypeResolver.GetTypeNameForAPIType(
MethodBase.GetCurrentMethod().DeclaringType)

Can be used to get the API type name in a static context.

Definition at line 16 of file StoredAPIResource_Polymorphic.cs.

readonly string AnalyzeRe.LossSet.CLASS_COLLECTION_NAME = "loss_sets"
staticinherited

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

Definition at line 28 of file LossSet.cs.

override string AnalyzeRe.LossSet.collection_name => CLASS_COLLECTION_NAME
inherited

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

Definition at line 31 of file LossSet.cs.

string AnalyzeRe.APITypes.StoredAPIResource_Polymorphic.type => TypeResolver.GetTypeNameForAPIType(GetType())
inherited

The server name for this type of resource.

Definition at line 12 of file StoredAPIResource_Polymorphic.cs.

Property Documentation

Dictionary<string, string> AnalyzeRe.LossSets.ParametricLossSet.attributes
getset

Loss attributes generated by this LossSet.

Definition at line 40 of file ParametricLossSet.cs.

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.LossSets.LossSet_WithCurrency.currency
getsetinherited

The currency of the losses in this loss set.

Definition at line 14 of file LossSet_WithCurrency.cs.

string AnalyzeRe.APITypes.StoredAPIResource.description
getsetinherited

A user-friendly description of the resource.

Definition at line 14 of file StoredAPIResource.cs.

UInt64 AnalyzeRe.LossSets.ParametricLossSet.event_id
getset

Optional event id that will be associated with all occurrences generated.

Definition at line 48 of file ParametricLossSet.cs.

IReference<IDiscreteDistribution> AnalyzeRe.LossSets.ParametricLossSet.frequency
getset

The frequency distribution associated with this loss set. Can be any DiscreteDistribution, a single value (DiracDistribution), or a CustomFrequencyDistribution.

Definition at line 18 of file ParametricLossSet.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.

LossType AnalyzeRe.LossSet.loss_type
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.

Definition at line 40 of file LossSet.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.

LossSetProfile AnalyzeRe.LossSet.profile
getsetinherited

A profile of this loss set, generated by the server after post.

Definition at line 45 of file LossSet.cs.

IReference<IContinuousDistribution> AnalyzeRe.LossSets.ParametricLossSet.seasonality
getset

The seasonality distribution associated with this loss set. Can be any ContinuousDistribution, a single value (DiracDistribution), or a CustomSeasonalityDistribution.

Definition at line 30 of file ParametricLossSet.cs.

IReference<IContinuousDistribution> AnalyzeRe.LossSets.ParametricLossSet.severity
getset

The severity distribution associated with this loss set. Can be any ContinuousDistribution, a single value (DiracDistribution), or a CustomSeverityDistribution.

Definition at line 24 of file ParametricLossSet.cs.

DateTime AnalyzeRe.LossSets.ParametricLossSet.start_date
getset

The date and time represented when the seasonality distribution generates a value of 0.

Definition at line 35 of file ParametricLossSet.cs.


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