C# Client Library
A C# Client Library for the AnalyzeRe REST API
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Properties | List of all members
AnalyzeRe.Distributions.ParetoDistribution Class Reference

Describes a Pareto Probability 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...
 
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

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

DateTime created [get, set]
 The date and time when the resource was created on the system. 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...
 
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...
 
double scale [get, set]
 Determines the "scale" or statistical dispersion of the Pareto probability distribution. Can be any real number greater than zero. In practice, it is the smallest number the distribution can return. More...
 
double shape [get, set]
 Affects the shape of the Pareto probability distribution. Can be any real number greater than zero. More...
 

Detailed Description

Describes a Pareto Probability Distribution.

Definition at line 7 of file ParetoDistribution.cs.

Inheritance diagram for AnalyzeRe.Distributions.ParetoDistribution:
AnalyzeRe.Distribution AnalyzeRe.Distributions.IContinuousDistribution AnalyzeRe.APITypes.StoredAPIResource_Polymorphic AnalyzeRe.Distributions.IDistribution AnalyzeRe.Distributions.IDistribution AnalyzeRe.APITypes.StoredAPIResource AnalyzeRe.APITypes.IAPI_Polymorphic AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APITypes.IAPI_Polymorphic AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APITypes.IAPI_Polymorphic AnalyzeRe.APIResource AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.IAPIResource AnalyzeRe.IAPIResource AnalyzeRe.APIType AnalyzeRe.IAPIResource AnalyzeRe.IAPIResource AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint

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

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.

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.

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.

double AnalyzeRe.Distributions.ParetoDistribution.scale
getset

Determines the "scale" or statistical dispersion of the Pareto probability distribution. Can be any real number greater than zero. In practice, it is the smallest number the distribution can return.

Definition at line 20 of file ParetoDistribution.cs.

double AnalyzeRe.Distributions.ParetoDistribution.shape
getset

Affects the shape of the Pareto probability distribution. Can be any real number greater than zero.

Definition at line 13 of file ParetoDistribution.cs.

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