C# Client Library
A C# Client Library for the AnalyzeRe REST API
|
A configuration of resources used to simulate a layer or portfolio. More...
Public Member Functions | |
AnalysisProfile () | |
Construct a new AnalysisProfile with empty loss_filters and event_catalogs lists. | |
virtual T | ShallowCopy< T > () |
Create a shallow copy of this object.
for a serializer-based copy method. | |
Static Public Attributes | |
static readonly string | CLASS_COLLECTION_NAME = "analysis_profiles" |
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 | |
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. | |
Perspective | default_perspective [get, set] |
Determines what the default Metrics.Context.perspective will be if no specific Perspective is requested. | |
string | description [get, set] |
A user-friendly description of the resource. | |
List< IReference< EventCatalog > > | event_catalogs [get, set] |
The EventCatalogs to use during this simulation. | |
IReference< ExchangeRates.ExchangeRateProfile > | exchange_rate_profile [get, set] |
The ExchangeRateProfile to use to get rates. | |
string | id [get, set] |
The resource's unique identifier. It will be used in the request URL when requesting the resource from the server. | |
List< IReference< LossFilter > > | loss_filters [get, set] |
The LossFilters to bucket simulation results in. | |
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. | |
double | progress [get, set] |
Obsolete - Maintained for backwards-compatibility purposes. Was meant to display the progress in processing a newly posted analysis profile but this is not part of the server model. | |
bool | round_sequences [get, set] |
Round sequences to the nearest second. | |
IReference< Simulation > | simulation [get, set] |
The Simulation to run. | |
TaskStatus | status [get, set] |
Status of the data file associated with this resource. | |
string | status_message [get, set] |
Status message of the data file associated with this resource. | |
bool | yelt_loss_set_simulation_filtering [get, set] |
Filter occurrences contained in a YELT Loss Set based on the occurrences defined in the SimGrid (ARE-7217). | |
A configuration of resources used to simulate a layer or portfolio.
Definition at line 10 of file AnalysisProfile.cs.
|
inline |
Construct a new AnalysisProfile with empty loss_filters and event_catalogs lists.
Definition at line 72 of file AnalysisProfile.cs.
|
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.
|
inlinevirtualinherited |
Create a shallow copy of this object.
for a serializer-based copy method.
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.
T | : | IAPIType |
Definition at line 14 of file APIType.cs.
The collection endpoint at which resources of this type reside on the server.
Definition at line 15 of file AnalysisProfile.cs.
The collection endpoint at which resources of this type reside on the server.
Implements AnalyzeRe.IAPIResource.
Definition at line 19 of file AnalysisProfile.cs.
|
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.
|
getset |
Determines what the default Metrics.Context.perspective will be if no specific Perspective is requested.
Definition at line 57 of file AnalysisProfile.cs.
|
getsetinherited |
A user-friendly description of the resource.
Implements AnalyzeRe.APITypes.IStoredAPIResource.
Definition at line 14 of file StoredAPIResource.cs.
|
getset |
The EventCatalogs to use during this simulation.
Definition at line 45 of file AnalysisProfile.cs.
|
getset |
The ExchangeRateProfile to use to get rates.
Definition at line 39 of file AnalysisProfile.cs.
|
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.
|
getset |
The LossFilters to bucket simulation results in.
Definition at line 50 of file AnalysisProfile.cs.
|
getsetinherited |
Any user-defined metadata for this layer.
Implements AnalyzeRe.APITypes.IStoredAPIResource.
Definition at line 30 of file StoredAPIResource.cs.
|
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.
|
getinherited |
The relative path to this endpoint from the root URL.
The relative path to this endpoint from the root URL.
System.ArgumentException | If this resource does not have an id. |
Implements AnalyzeRe.APITypes.IEndpoint.
Definition at line 27 of file APIResource.cs.
|
getset |
Obsolete - Maintained for backwards-compatibility purposes. Was meant to display the progress in processing a newly posted analysis profile but this is not part of the server model.
Definition at line 26 of file AnalysisProfile.cs.
|
getset |
Round sequences to the nearest second.
Definition at line 66 of file AnalysisProfile.cs.
|
getset |
The Simulation to run.
Definition at line 35 of file AnalysisProfile.cs.
|
getsetinherited |
Status of the data file associated with this resource.
Implements AnalyzeRe.APITypes.IStoredAPIResource_WithStatus.
Definition at line 16 of file StoredAPIResource_WithStatus.cs.
|
getsetinherited |
Status message of the data file associated with this resource.
Implements AnalyzeRe.APITypes.IStoredAPIResource_WithStatus.
Definition at line 21 of file StoredAPIResource_WithStatus.cs.
|
getset |
Filter occurrences contained in a YELT Loss Set based on the occurrences defined in the SimGrid (ARE-7217).
Definition at line 62 of file AnalysisProfile.cs.