C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
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.
 
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 = "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.
 
Dictionary< string, string > attributes [get, set]
 Loss attributes generated by this LossSet.
 
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.
 
UInt64? event_id [get, set]
 Optional event id that will be associated with all occurrences generated.
 
IReference< IDiscreteDistributionfrequency [get, set]
 The frequency distribution associated with this loss set. Can be any DiscreteDistribution, a single value (DiracDistribution), or a CustomFrequencyDistribution.
 
string id [get, set]
 The resource's unique identifier. It will be used in the request URL when requesting the resource from the server.
 
LossTypeloss_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.
 
IReference< IContinuousDistributionseasonality [get, set]
 The seasonality distribution associated with this loss set. Can be any ContinuousDistribution, a single value (DiracDistribution), or a CustomSeasonalityDistribution.
 
IReference< IContinuousDistributionseverity [get, set]
 The severity distribution associated with this loss set. Can be any ContinuousDistribution, a single value (DiracDistribution), or a CustomSeverityDistribution.
 
DateTime start_date [get, set]
 The date and time represented when the seasonality distribution generates a value of 0.
 
string type [get]
 The server name for this type of resource.
 

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.LossSets.ILossSet AnalyzeRe.APITypes.StoredAPIResource_Polymorphic AnalyzeRe.LossSets.ILossSet AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APITypes.IAPI_Polymorphic AnalyzeRe.APITypes.StoredAPIResource AnalyzeRe.APITypes.IAPI_Polymorphic AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APITypes.IAPI_Polymorphic AnalyzeRe.IAPIResource AnalyzeRe.APIResource AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.IAPIResource AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.APIType AnalyzeRe.IAPIResource AnalyzeRe.IAPIResource AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint

Constructor & Destructor Documentation

◆ ParametricLossSet()

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

◆ 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.LossSet.CLASS_COLLECTION_NAME = "loss_sets"
staticinherited

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

Definition at line 41 of file LossSet.cs.

Property Documentation

◆ APITypeName

string AnalyzeRe.APITypes.StoredAPIResource_Polymorphic.APITypeName
staticgetinherited

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

Definition at line 17 of file StoredAPIResource_Polymorphic.cs.

◆ attributes

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

Loss attributes generated by this LossSet.

Definition at line 40 of file ParametricLossSet.cs.

◆ collection_name

override string AnalyzeRe.LossSet.collection_name
getinherited

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

Implements AnalyzeRe.IAPIResource.

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

◆ currency

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.

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

◆ event_id

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.

◆ frequency

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.

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

◆ loss_type

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.

Implements AnalyzeRe.LossSets.ILossSet.

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

◆ profile

LossSetProfile AnalyzeRe.LossSet.profile
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.

◆ seasonality

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.

◆ severity

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.

◆ start_date

DateTime AnalyzeRe.LossSets.ParametricLossSet.start_date
getset

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

Implements AnalyzeRe.LossSets.ILossSet_WithSeasonality.

Definition at line 35 of file ParametricLossSet.cs.

◆ type

string AnalyzeRe.APITypes.StoredAPIResource_Polymorphic.type
getinherited

The server name for this type of resource.

Implements AnalyzeRe.APITypes.IAPI_Polymorphic.

Definition at line 13 of file StoredAPIResource_Polymorphic.cs.


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