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

Describes a distribution that always returns the same value. This distribution can be used as either a discrete or a 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.

 

Static Public Attributes

static readonly string CLASS_COLLECTION_NAME = "distributions"
 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.
 
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 description [get, set]
 A user-friendly description of the resource.
 
string id [get, set]
 The resource's unique identifier. It will be used in the request URL when requesting the resource from the server.
 
doublemax_val [get, set]
 The server calculated maximum value of this distribution (if available)
 
doublemean_val [get, set]
 The server calculated mean value of this distribution (if available)
 
Dictionary< string, object > meta_data = new Dictionary<string, object>() [get, set]
 Any user-defined metadata for this layer.
 
doublemin_val [get, set]
 The server calculated minimum value of this distribution (if available)
 
DateTime? modified [get, set]
 The date and time when the resource was last modified on the system.
 
doublemodulo [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.
 
string Path [get]
 The relative path to this endpoint from the root URL.
 
string type [get]
 The server name for this type of resource.
 
double value [get, set]
 The constant value to return when this distribution is used. Can be any real number.
 

Detailed Description

Describes a distribution that always returns the same value. This distribution can be used as either a discrete or a continuous distribution.

Definition at line 7 of file DiracDistribution.cs.

Inheritance diagram for AnalyzeRe.Distributions.DiracDistribution:
AnalyzeRe.Distribution AnalyzeRe.Distributions.IDiscreteDistribution AnalyzeRe.Distributions.IContinuousDistribution AnalyzeRe.APITypes.StoredAPIResource_Polymorphic AnalyzeRe.Distributions.IDistribution AnalyzeRe.Distributions.IDistribution AnalyzeRe.Distributions.IDistribution 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

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

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.

◆ collection_name

override string AnalyzeRe.Distribution.collection_name
getinherited

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

Implements AnalyzeRe.IAPIResource.

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

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

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

◆ max_val

double? AnalyzeRe.Distribution.max_val
getsetinherited

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

Implements AnalyzeRe.Distributions.IDistribution.

Definition at line 45 of file Distribution.cs.

◆ mean_val

double? AnalyzeRe.Distribution.mean_val
getsetinherited

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

Implements AnalyzeRe.Distributions.IDistribution.

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

◆ min_val

double? AnalyzeRe.Distribution.min_val
getsetinherited

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

Implements AnalyzeRe.Distributions.IDistribution.

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

◆ modulo

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.

Implements AnalyzeRe.Distributions.IDistribution.

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

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

◆ value

double AnalyzeRe.Distributions.DiracDistribution.value
getset

The constant value to return when this distribution is used. Can be any real number.

Definition at line 12 of file DiracDistribution.cs.


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