MetricComputation.cs

Go to the documentation of this file.

// TraceLab Component Library
// Copyright © 2012-2013 SEMERU
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

using TraceLabSDK;
using TraceLabSDK.Types.Contests;

namespace TraceLab.Components.DevelopmentKit.Metrics
{
    public abstract class MetricComputation : IMetricComputation
    {
        public abstract string Name
        {
            get;
        }

        public abstract string Description
        {
            get;
        }

        public SerializableDictionary<string, double> Results
        {
            get;
            protected set;
        }

        public bool HasRun
        {
            get;
            private set;
        }

        public MetricComputation()
        {
            HasRun = false;
        }

        public void Compute()
        {
            ComputeImplementation();
            HasRun = true;
        }

        protected abstract void ComputeImplementation();

        public Metric GenerateSummary()
        {
            if (!HasRun)
            {
                throw new DevelopmentKitException("Compute() method has not been run.");
            }
            return GenerateSummaryImplementation();
        }

        protected abstract Metric GenerateSummaryImplementation();
    }
}