OptimizationView.cs

Go to the documentation of this file.

using System;
using System.Collections.Generic;
using System.Runtime.Serialization;
using System.ComponentModel;
 
using AnalyzeRe.APIResourceView;
using AnalyzeRe.APITypes;
using AnalyzeRe.Attributes;
using AnalyzeRe.Rest;
 
namespace AnalyzeRe.Optimization
{
    public class OptimizationView : StoredAPIResource_WithStatus, IAPIAnalysis
    {
        #region APIResource Interface Members
        public static readonly string CLASS_COLLECTION_NAME = "optimization_views";
 
        [IgnoreDataMember]
        public override string collection_name => CLASS_COLLECTION_NAME;
        #endregion APIResource Interface Members
 
        #region Public Properties
        [DataMember(Order = 12)]
        [GreaterThan(1, true)]
        [LessThan(10000, true)]
        public int iterations { get; set; }
 
        [DataMember(Order = 13)]
        [GreaterThan(1, true)]
        [LessThan(10000, true)]
        public int population_size { get; set; }
 
        [DataMember(Order = 14)]
        [NotNull]
        public IReference<AnalysisProfile> analysis_profile { get; set; }
 
        [DataMember(Order = 15)]
        [NotNull]
        [NotEmpty]
        public List<DomainEntry> domains { get; set; }
 
        [DataMember(Order = 16)]
        [NotNull]
        [NotEmpty]
        public Dictionary<string, object> custom_parameters { get; set; }
 
        [DataMember(Order = 17)]
        [TargetCurrencyDefault]
        public string target_currency { get; set; }
 
        [DataMember(Order = 99)]
        [ServerGenerated]
        [DisplayName("Run Time")]
        public RunTime runtime_seconds { get; set; }
        [DataMember(Order = 100)]
        [ServerGenerated]
        public double progress { get; set; }
 
        #region Endpoints and Sub-Resources
 
        #region Private Fields
        private Candidates _candidates;
 
        private DataSubResource _csv;
 
        private SubResource<OptimizationResult> _initialPortfolioResult;
 
        private SubResource<SensitivityAnalysis> _sensitivityAnalysis;
        #endregion Private Fields
 
        [IgnoreDataMember]
        public Candidates candidates => _candidates ?? (_candidates = new Candidates(this));
 
        [IgnoreDataMember]
        public DataSubResource csv => _csv ?? (_csv = new DataSubResource(this, "csv"));
 
        [IgnoreDataMember]
        public SubResource<OptimizationResult> initial_portfolio_result => _initialPortfolioResult ??
            (_initialPortfolioResult = new SubResource<OptimizationResult>(this, "initial_portfolio_metrics"));
 
        [IgnoreDataMember]
        public SubResource<SensitivityAnalysis> sensitivity_analysis => _sensitivityAnalysis ??
            (_sensitivityAnalysis = new SubResource<SensitivityAnalysis>(this, "sensitivity_analysis"));
        #endregion Endpoints and Sub-Resources
 
        #region Deprecated
        [Obsolete("2018-04-23: The initial_portfolio_metrics attribute is deprecated, " +
                  "please use initial_portfolio_result instead.")]
        [DataMember(Order = 18)]
        [ServerGenerated]
        public Dictionary<string, double> initial_portfolio_metrics { get; set; }
 
        [IgnoreDataMember]
        [Obsolete("2018-04-23: This endpoint is being deprecated because it isn't scalable. " +
                  "The preferred method is now to paginate the /candidates/ endpoint or to " +
                  "download the entire results set as a .csv file via the /csv/ endpoint.")]
        public SubResource<CandidateResultsList> result => new SubResource<CandidateResultsList>(this, "result")
        {
            DefaultTimeout = API.DefaultRequestTimeoutCollections
        };
        #endregion Deprecated
        #endregion Public Properties
 
        #region Constructor
        public OptimizationView()
        {
            domains = new List<DomainEntry>();
            custom_parameters = new Dictionary<string, object>();
        }
 
        protected override void AfterMembersCloned(APIType _)
        {
            base.AfterMembersCloned(_);
            _candidates = null;
            _csv = null;
            _initialPortfolioResult = null;
            _sensitivityAnalysis = null;
        }
        #endregion Constructor
 
        #region Public Methods
        public OptimizationResult GetInitialPortfolioMetrics(int? timeout_ms = null) =>
            initial_portfolio_result.Get(timeout: timeout_ms);
 
        public SensitivityAnalysis GetSensitivityAnalysis(IEnumerable<int> candidates = null, int? timeout_ms = null) =>
            sensitivity_analysis.Get(candidates == null ? null : new RequestParameters()
                .AddQueryParameter(nameof(candidates), String.Join(",", candidates)), timeout_ms);
 
        public Candidate GetCandidateResult(int candidateIndex, int? timeout_ms = null) =>
            candidates.GetItem($"{candidateIndex:0}", timeout: timeout_ms);
 
        public PortfolioView GetCandidatePortfolioView(int candidateIndex, int? timeout_ms = null)
        {
            // We don't need to retrieve the actual Candidate instance to get its portfolio_view,
            // just create one with the correct id so we can navigate to the sub-resource.
            return new Candidate
            {
                optimization_view = this.ToReference(),
                index = candidateIndex
            }.portfolio_view.Get(timeout: timeout_ms);
        }
 
        public long GetCandidateResultsCount(int? timeout_ms = null) =>
            candidates.Count(timeout: timeout_ms);
        #endregion Public Methods
    }
}