Acts as a replacement for IAPIResourceView.back_allocations. Computes the proportion of some sink structure whose net losses should be attributed to the specified source. This is done on a per-event-occurrence basis, so the result is a new YELT. As such, this Back-Allocated structure can be used like any other layer when simulated. 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 = "layers"
	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.

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.

string	Path `[get]`
	The relative path to this endpoint from the root URL.

IReference< ILayerSource >	sink `[get, set]`
	A layer_view or layer reference, or inlined layer definition that is to be back-allocated.

string	source_id `[get, set]`
	The id of the nested resource to back-allocate to. This can either be the id of a loss set that acts as a source to the sink, or the id of a nested layer_view definition (when this BackAllocatedLayer is used in an analysis).

string	type `[get]`
	The server name for this type of resource.

Detailed Description

Acts as a replacement for IAPIResourceView.back_allocations. Computes the proportion of some sink structure whose net losses should be attributed to the specified source. This is done on a per-event-occurrence basis, so the result is a new YELT. As such, this Back-Allocated structure can be used like any other layer when simulated.

Replaces the legacy IAPIResourceView.back_allocations endpoint function - which would compute the same back-allocated result, but return in as a YELT Loss Set rather than a new layer. This new method has the benefit of allowing back-allocations to recurse on nested back-allocation results (i.e. sources are no longer "flattened").

Definition at line 16 of file BackAllocatedLayer.cs.

Inheritance diagram for AnalyzeRe.Layers.BackAllocatedLayer:

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.Layer.CLASS_COLLECTION_NAME = "layers"

staticinherited

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

Definition at line 15 of file Layer.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.Layer.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 Layer.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.

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

◆ Path

string AnalyzeRe.APIResource.Path

getinherited

The relative path to this endpoint from the root URL.

Exceptions

System.ArgumentException If this resource does not have an id.

Implements AnalyzeRe.APITypes.IEndpoint.

Definition at line 27 of file APIResource.cs.

◆ sink

IReference<ILayerSource> AnalyzeRe.Layers.BackAllocatedLayer.sink

getset

A layer_view or layer reference, or inlined layer definition that is to be back-allocated.

Definition at line 22 of file BackAllocatedLayer.cs.

◆ source_id

string AnalyzeRe.Layers.BackAllocatedLayer.source_id

getset

The id of the nested resource to back-allocate to. This can either be the id of a loss set that acts as a source to the sink, or the id of a nested layer_view definition (when this BackAllocatedLayer is used in an analysis).

This id cannot be that of a saved layer. If the desired source is a saved layer id or inlined layer definition, this must be the id generated by the system when that source layer is posted on its own as a ILayerView with the same APITypes.IAPIAnalysis.analysis_profile and APITypes.IAPIAnalysis.target_currency as the root.

Definition at line 37 of file BackAllocatedLayer.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:

BackAllocatedLayer.cs

Public Member Functions

Static Public Attributes

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AfterMembersCloned()

◆ ShallowCopy< T >()

Member Data Documentation

◆ CLASS_COLLECTION_NAME

Property Documentation

◆ APITypeName

◆ collection_name

◆ created

◆ description

◆ id

◆ meta_data

◆ modified

◆ Path

◆ sink

◆ source_id

◆ type