/*****************************************************************************
 * Open MCT, Copyright (c) 2014-2016, United States Government
 * as represented by the Administrator of the National Aeronautics and Space
 * Administration. All rights reserved.
 *
 * Open MCT is licensed under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0.
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 * Open MCT includes source code licensed under additional open source
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 * this source code distribution or the Licensing information page available
 * at runtime from the About dialog for additional information.
 *****************************************************************************/

define(
    [],
    function () {

        /**
         * Tracks the limit state of telemetry objects being plotted.
         * @memberof platform/features/plot
         * @constructor
         * @param {platform/telemetry.TelemetryHandle} handle the handle
         *        to telemetry access
         * @param {string} range the key to use when looking up range values
         */
        function PlotLimitTracker(handle, range) {
            this.handle = handle;
            this.range = range;
            this.legendClasses = {};
        }

        /**
         * Update limit states to reflect the latest data.
         */
        PlotLimitTracker.prototype.update = function () {
            var legendClasses = {},
                range = this.range,
                handle = this.handle;

            function updateLimit(telemetryObject) {
                var limit = telemetryObject.getCapability('limit'),
                    datum = handle.getDatum(telemetryObject);

                if (limit && datum) {
                    legendClasses[telemetryObject.getId()] =
                        (limit.evaluate(datum, range) || {}).cssClass;
                }
            }

            handle.getTelemetryObjects().forEach(updateLimit);

            this.legendClasses = legendClasses;
        };

        /**
         * Get the CSS class associated with any limit violations for this
         * telemetry object.
         * @param {DomainObject} domainObject the telemetry object to check
         * @returns {string} the CSS class name, if any
         */
        PlotLimitTracker.prototype.getLegendClass = function (domainObject) {
            var id = domainObject && domainObject.getId();
            return id && this.legendClasses[id];
        };

        return PlotLimitTracker;

    }
);