IAPIResourceView.cs

Go to the documentation of this file.

using System;
using System.Collections.Generic;
using System.Runtime.Serialization;
 
using AnalyzeRe.APIResourceView;
using AnalyzeRe.APITypes;
using AnalyzeRe.Attributes;
using AnalyzeRe.Metrics;
 
// Disable warnings about snake_case function names in this method. While it goes against
// C# best-practice, it's done intentionally to follow the API conventions closely.
#pragma warning disable IDE1006
 
namespace AnalyzeRe
{
    public interface IAPIResourceView : IAPIAnalysis, IAPIResource
    {
        #region Public Properties
        [DataMember(Order = 12)]
        [ServerGenerated]
        string ylt_id { get; set; }
 
        [IgnoreDataMember]
        YLTSimulationResult ylt { get; }
 
        [IgnoreDataMember]
        YELTSimulationResult yelt { get; }
        #endregion Public Properties
 
        #region Public Methods
        TailMetrics tail_metrics(double probability, MetricsOptions options = null, int? timeout = null);
 
        List<TailMetrics> tail_metrics(IEnumerable<double> probabilities, MetricsOptions options = null, int? timeout = null);
 
        WindowMetrics window_metrics(ProbabilityWindow range, MetricsOptions options = null, int? timeout = null);
 
        List<WindowMetrics> window_metrics(IEnumerable<ProbabilityWindow> ranges, MetricsOptions options = null, int? timeout = null);
 
        CoMetrics co_metrics<T>(
            ProbabilityWindow range, IReference<T> component, CoMetricsOptions options = null, int? timeout = null)
            where T : IAPIResourceView;
 
        List<CoMetrics> co_metrics<T>(
            IEnumerable<ProbabilityWindow> ranges, IReference<T> component, CoMetricsOptions options = null, int? timeout = null)
            where T : IAPIResourceView;
 
        ExceedanceProbability exceedance_probability(
            double threshold, ExceedanceProbabilityOptions options = null, int? timeout = null);
 
        List<ExceedanceProbability> exceedance_probability(
            IEnumerable<double> thresholds, ExceedanceProbabilityOptions options = null, int? timeout = null);
 
        [Obsolete("POST a BackAllocatedLayer structure instead.")]
        BackAllocations back_allocations(string source_id, int? timeout = null);
        #endregion Public Methods
 
        // TODO: Delete Deprecated Methods after phase-out period.
        #region Deprecated
        [Obsolete("Please provide a ProbabilityWindow rather than a double tail-probability. " +
            "This legacy method was less flexible and only returned the co-tail-metrics.")]
        CoMetrics co_metrics<T>(
            double probability, IReference<T> component, CoMetricsOptions options)
            where T : IAPIResourceView;
 
        [Obsolete("Please provide a list of ProbabilityWindows rather than doubles. " +
            "This legacy method was less flexible and only returned the co-tail-metrics.")]
        List<CoMetrics> co_metrics<T>(
            List<double> probabilities, IReference<T> component, CoMetricsOptions options)
            where T : IAPIResourceView;
        #endregion Deprecated
    }
}