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

Representation of a loss set with an associated year-event-loss table. More...

Public Types

enum  DataType { csv , binary }
 The format of the data uploaded against this YELT. More...
 

Public Member Functions

 YELTLossSet ()
 Construct a new YELTLossSet with an empty event_catalogs 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

override void AfterMembersCloned (APIType _)
 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().
 

Properties

bool adjust_leap_years [get, set]
 Allows to skip 29 of Feb in the leap years in case if simulation has 365 days.
 
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.
 
LargeDataSubResource data [get]
 An endpoint for accessing or modifying the data file attached to this resource.
 
IReference< DataFiledata_file [get, set]
 A reference to the data attached to this resource. This field will automatically be created if you initiate an upload using the data property, or this can be set to reference an existing file on the server to immediately initiate the commit phase of this resource.
 
DataTypedata_type [get, set]
 The format of the data uploaded against this YELT (default CSV).
 
string description [get, set]
 A user-friendly description of the resource.
 
List< IReference< EventCatalog > > event_catalogs [get, set]
 A list of event catalog for which the loss set contains event losses.
 
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.
 
bool one_based_sequencing [get, set]
 By default event sequences start with 0. This parameter can be set to "true" if sequences in csv start with 1.
 
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.
 
ReinstatementsDataTypereinstatements_data_type [get, set]
 Dictates whether any reinstatement information associated with the loss set should be interpreted as a fixed dollar amount. (ReinstatementsDataType.currency) or as a percentage of the premium of the layer this loss set gets attached to (ReinstatementsDataType.percentage).
 
DateTime start_date [get, set]
 The date and time represented by a sequence value of 0 in the YELT data.
 
TaskStatus status [get, set]
 Status of the data file associated with this resource.
 
string status_message [get, set]
 Status message of the data file associated with this resource.
 
int trial_count [get, set]
 Number of trials in these simulated losses.
 
string type [get]
 The server name for this type of resource.
 

Detailed Description

Representation of a loss set with an associated year-event-loss table.

Definition at line 10 of file YELTLossSet.cs.

Inheritance diagram for AnalyzeRe.LossSets.YELTLossSet:
AnalyzeRe.LossSets.LossSet_WithData AnalyzeRe.LossSets.ILossSet_Simulated AnalyzeRe.LossSets.ILossSet_WithEventCatalog AnalyzeRe.LossSets.LossSet_WithCurrency AnalyzeRe.LossSets.ILossSet_WithData AnalyzeRe.LossSets.ILossSet_WithSeasonality AnalyzeRe.LossSets.ILossSet_WithData AnalyzeRe.LossSets.ILossSet AnalyzeRe.APITypes.IAPI_Polymorphic AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint AnalyzeRe.LossSets.ILossSet AnalyzeRe.LossSets.ILossSet AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint AnalyzeRe.LossSets.ILossSet AnalyzeRe.LossSet

Member Enumeration Documentation

◆ DataType

The format of the data uploaded against this YELT.

Enumerator
csv 

The file is in a text/csv format.

binary 

The file is in a binary format.

Definition at line 13 of file YELTLossSet.DataType.cs.

Constructor & Destructor Documentation

◆ YELTLossSet()

AnalyzeRe.LossSets.YELTLossSet.YELTLossSet ( )
inline

Construct a new YELTLossSet with an empty event_catalogs list.

Definition at line 60 of file YELTLossSet.cs.

Member Function Documentation

◆ AfterMembersCloned()

override void AnalyzeRe.LossSets.LossSet_WithData.AfterMembersCloned ( APIType  _)
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().

Reimplemented from AnalyzeRe.APIType.

Definition at line 42 of file LossSet_WithData.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

◆ adjust_leap_years

bool AnalyzeRe.LossSets.YELTLossSet.adjust_leap_years
getset

Allows to skip 29 of Feb in the leap years in case if simulation has 365 days.

Definition at line 55 of file YELTLossSet.cs.

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

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

◆ data

LargeDataSubResource AnalyzeRe.LossSets.LossSet_WithData.data
getinherited

An endpoint for accessing or modifying the data file attached to this resource.

Implements AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint.

Definition at line 17 of file LossSet_WithData.cs.

◆ data_file

IReference<DataFile> AnalyzeRe.LossSets.LossSet_WithData.data_file
getsetinherited

A reference to the data attached to this resource. This field will automatically be created if you initiate an upload using the data property, or this can be set to reference an existing file on the server to immediately initiate the commit phase of this resource.

Implements AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint.

Definition at line 26 of file LossSet_WithData.cs.

◆ data_type

DataType? AnalyzeRe.LossSets.YELTLossSet.data_type
getset

The format of the data uploaded against this YELT (default CSV).

Definition at line 36 of file YELTLossSet.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_catalogs

List<IReference<EventCatalog> > AnalyzeRe.LossSets.YELTLossSet.event_catalogs
getset

A list of event catalog for which the loss set contains event losses.

Implements AnalyzeRe.LossSets.ILossSet_WithEventCatalog.

Definition at line 17 of file YELTLossSet.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.

◆ one_based_sequencing

bool AnalyzeRe.LossSets.YELTLossSet.one_based_sequencing
getset

By default event sequences start with 0. This parameter can be set to "true" if sequences in csv start with 1.

Definition at line 50 of file YELTLossSet.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.

◆ reinstatements_data_type

ReinstatementsDataType? AnalyzeRe.LossSets.YELTLossSet.reinstatements_data_type
getset

Dictates whether any reinstatement information associated with the loss set should be interpreted as a fixed dollar amount. (ReinstatementsDataType.currency) or as a percentage of the premium of the layer this loss set gets attached to (ReinstatementsDataType.percentage).

Implements AnalyzeRe.LossSets.ILossSet_Simulated.

Definition at line 44 of file YELTLossSet.cs.

◆ start_date

DateTime AnalyzeRe.LossSets.YELTLossSet.start_date
getset

The date and time represented by a sequence value of 0 in the YELT data.

Implements AnalyzeRe.LossSets.ILossSet_WithSeasonality.

Definition at line 26 of file YELTLossSet.cs.

◆ status

TaskStatus AnalyzeRe.LossSets.LossSet_WithData.status
getsetinherited

Status of the data file associated with this resource.

For details about an upload in progress, you may retrieve the APIResource_WithDataEndpoint.data endpoint's LargeDataSubResource.status response.

Implements AnalyzeRe.APITypes.IStoredAPIResource_WithStatus.

Definition at line 34 of file LossSet_WithData.cs.

◆ status_message

string AnalyzeRe.LossSets.LossSet_WithData.status_message
getsetinherited

Status message of the data file associated with this resource.

Implements AnalyzeRe.APITypes.IStoredAPIResource_WithStatus.

Definition at line 39 of file LossSet_WithData.cs.

◆ trial_count

int AnalyzeRe.LossSets.YELTLossSet.trial_count
getset

Number of trials in these simulated losses.

Implements AnalyzeRe.LossSets.ILossSet_Simulated.

Definition at line 21 of file YELTLossSet.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: