C# Client Library
A C# Client Library for the AnalyzeRe REST API
AnalyzeRe.Distributions.CustomDistribution Class Reference

Custom Distribution that allows the user to upload CSV data. Can be treated as a Discrete or Continuous distribution. More...

Public Member Functions

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 Path => API.GetResourcePath(this)
 The relative path to this endpoint from the root URL. 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 = "distributions"
 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...
 
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...
 
string description [get, set]
 A user-friendly description of the resource. 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...
 
bool interpolate [get, set]
 Determines whether linear interpolation should be used for probabilities between those that appear in the custom distribution. (Default: False) More...
 
double max_val [get, set]
 The server calculated maximum value of this distribution (if available) More...
 
double mean_val [get, set]
 The server calculated mean value of this distribution (if available) More...
 
Dictionary< string, object > meta_data [get, set]
 Any user-defined metadata for this layer. More...
 
double min_val [get, set]
 The server calculated minimum value of this distribution (if available) More...
 
DateTime modified [get, set]
 The date and time when the resource was last modified on the system. More...
 
double modulo [get, set]
 Sets a maximum value for the distribution. Any values greater than or equal to this will be wrapped back to zero. (For example, if modulo = 365, when the distribution produces a value of 370.5, the resulting value will be 5.5, and a value of exactly 365 would wrap to 0.) Similarly, negative numbers produced by the distribution will get wrapped up to a number between 0 and modulo. Leave modulo equal to null and distribution values will remain unmodified. 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...
 

Detailed Description

Custom Distribution that allows the user to upload CSV data. Can be treated as a Discrete or Continuous distribution.

Definition at line 10 of file CustomDistribution.cs.

Inheritance diagram for AnalyzeRe.Distributions.CustomDistribution:
AnalyzeRe.Distribution AnalyzeRe.Distributions.IContinuousDistribution AnalyzeRe.Distributions.IDiscreteDistribution AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint AnalyzeRe.APITypes.StoredAPIResource_Polymorphic AnalyzeRe.Distributions.IDistribution AnalyzeRe.Distributions.IDistribution AnalyzeRe.Distributions.IDistribution AnalyzeRe.APITypes.IStoredAPIResource_WithStatus AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APITypes.IAPI_Polymorphic AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APITypes.IAPI_Polymorphic AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APITypes.IAPI_Polymorphic AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APITypes.IAPI_Polymorphic AnalyzeRe.APITypes.StoredAPIResource AnalyzeRe.Distributions.CustomFrequencyDistribution AnalyzeRe.Distributions.CustomSeasonalityDistribution AnalyzeRe.Distributions.CustomSeverityDistribution

Member Function Documentation

override void AnalyzeRe.Distributions.CustomDistribution.AfterMembersCloned ( APIType  _)
inlineprotectedvirtual

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 46 of file CustomDistribution.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 17 of file StoredAPIResource_Polymorphic.cs.

readonly string AnalyzeRe.Distribution.CLASS_COLLECTION_NAME = "distributions"
staticinherited

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

Definition at line 15 of file Distribution.cs.

override string AnalyzeRe.Distribution.collection_name => CLASS_COLLECTION_NAME
inherited

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

Definition at line 18 of file Distribution.cs.

LargeDataSubResource AnalyzeRe.Distributions.CustomDistribution.data
Initial value:
=> _dataEndpoint ??
(_dataEndpoint = new LargeDataSubResource(this))

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

Definition at line 24 of file CustomDistribution.cs.

string AnalyzeRe.APIResource.Path => API.GetResourcePath(this)
inherited

The relative path to this endpoint from the root URL.

Exceptions
System.ArgumentExceptionIf this resource does not have an id.

Definition at line 27 of file APIResource.cs.

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

The server name for this type of resource.

Definition at line 13 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.

IReference<DataFile> AnalyzeRe.Distributions.CustomDistribution.data_file
getset

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 33 of file CustomDistribution.cs.

string AnalyzeRe.APITypes.StoredAPIResource.description
getsetinherited

A user-friendly description of the resource.

Definition at line 14 of file StoredAPIResource.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.

bool AnalyzeRe.Distributions.CustomDistribution.interpolate
getset

Determines whether linear interpolation should be used for probabilities between those that appear in the custom distribution. (Default: False)

Definition at line 16 of file CustomDistribution.cs.

double AnalyzeRe.Distribution.max_val
getsetinherited

The server calculated maximum value of this distribution (if available)

Definition at line 45 of file Distribution.cs.

double AnalyzeRe.Distribution.mean_val
getsetinherited

The server calculated mean value of this distribution (if available)

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

double AnalyzeRe.Distribution.min_val
getsetinherited

The server calculated minimum value of this distribution (if available)

Definition at line 35 of file Distribution.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.

double AnalyzeRe.Distribution.modulo
getsetinherited

Sets a maximum value for the distribution. Any values greater than or equal to this will be wrapped back to zero. (For example, if modulo = 365, when the distribution produces a value of 370.5, the resulting value will be 5.5, and a value of exactly 365 would wrap to 0.) Similarly, negative numbers produced by the distribution will get wrapped up to a number between 0 and modulo. Leave modulo equal to null and distribution values will remain unmodified.

Definition at line 30 of file Distribution.cs.

TaskStatus AnalyzeRe.Distributions.CustomDistribution.status
getset

Status of the data file associated with this resource.

Definition at line 38 of file CustomDistribution.cs.

string AnalyzeRe.Distributions.CustomDistribution.status_message
getset

Status message of the data file associated with this resource.

Definition at line 43 of file CustomDistribution.cs.


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