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

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

Public Types

enum  DataType { DataType.csv, DataType.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. 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...
 
LargeDataSubResource data
 An endpoint for accessing or modifying the data file attached to this resource. 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

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

Properties

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...
 
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. More...
 
DataType data_type [get, set]
 The format of the data uploaded against this YELT (default CSV). More...
 
string description [get, set]
 A user-friendly description of the resource. More...
 
List< IReference< EventCatalog > > event_catalogs [get, set]
 A list of event catalog for which the loss set contains event losses. 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...
 
ReinstatementsDataType reinstatements_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). More...
 
DateTime start_date [get, set]
 The date and time represented by a sequence value of 0 in the YELT data. More...
 
TaskStatus status [get, set]
 Status of the data file associated with this resource. More...
 
string status_message [get, set]
 Status message of the data file associated with this resource. More...
 
int trial_count [get, set]
 Number of trials in these simulated losses. More...
 

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.APITypes.IAPIResource_WithDataEndpoint AnalyzeRe.LossSets.ILossSet_WithSeasonality AnalyzeRe.LossSet AnalyzeRe.APITypes.IStoredAPIResource_WithStatus AnalyzeRe.APITypes.StoredAPIResource_Polymorphic AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APITypes.StoredAPIResource AnalyzeRe.APITypes.IAPI_Polymorphic AnalyzeRe.IAPIResource AnalyzeRe.APIResource AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.IAPIType AnalyzeRe.APIType AnalyzeRe.IAPIResource AnalyzeRe.IAPIResource AnalyzeRe.IAPIType AnalyzeRe.IAPIType AnalyzeRe.IAPIType

Member Enumeration Documentation

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

AnalyzeRe.LossSets.YELTLossSet.YELTLossSet ( )
inline

Construct a new YELTLossSet with an empty event_catalogs list.

Definition at line 48 of file YELTLossSet.cs.

Member Function Documentation

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.

Reimplemented from AnalyzeRe.APIType.

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

LargeDataSubResource AnalyzeRe.LossSets.LossSet_WithData.data
inherited
Initial value:
=> _dataEndpoint ??
(_dataEndpoint = new LargeDataSubResource(this, "data"))

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

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

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.

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.

Definition at line 26 of file LossSet_WithData.cs.

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.

string AnalyzeRe.APITypes.StoredAPIResource.description
getsetinherited

A user-friendly description of the resource.

Definition at line 14 of file StoredAPIResource.cs.

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

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

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

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

Definition at line 44 of file YELTLossSet.cs.

DateTime AnalyzeRe.LossSets.YELTLossSet.start_date
getset

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

Definition at line 26 of file YELTLossSet.cs.

TaskStatus AnalyzeRe.LossSets.LossSet_WithData.status
getsetinherited

Status of the data file associated with this resource.

Definition at line 31 of file LossSet_WithData.cs.

string AnalyzeRe.LossSets.LossSet_WithData.status_message
getsetinherited

Status message of the data file associated with this resource.

Definition at line 36 of file LossSet_WithData.cs.

int AnalyzeRe.LossSets.YELTLossSet.trial_count
getset

Number of trials in these simulated losses.

Definition at line 21 of file YELTLossSet.cs.


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