/*
 * Copyright 2014 Groupon.com
 *
 * 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.
 */

///<reference path='defs/metrics.d.ts'/>
import tsdDef = require("tsdDef");
import tsd = require("tsd-metrics-client");
import tsdUtils = require("./utils");

/**
 * Base class for metric sample. A metric sample is an object with a value and unit. The unit can be undefined,
 * to imply scalar values.
 *
 * @class
 * @alias MetricSample
 */
export class TsdMetricSample implements tsdDef.MetricSample {
    /**
     * Static factory
     *
     * @param {number} value The magnitude of the sample.
     * @param {Units} unit The unit that the magnitude is expressed in. Default = undefined (i.e. has not unit).
     * @ignore
     */
    public static of(value:number, unit:tsdDef.Unit = undefined):tsdDef.MetricSample {
        return new TsdMetricSample(value, unit);
    }

    /**
     * Constructor.
     *
     * @param {number} _value The magnitude of the sample.
     * @param {Units} _unit The unit that the magnitude is expressed in.
     * @ignore
     */
    constructor(private _value:number, private _unit:tsdDef.Unit) {
    }

    /**
     * Access the magnitude of the sample.
     *
     * @method
     * @return {number} The magnitude.
     */
    public getValue():number {
        return this._value;
    }

    /**
     * Access the units that the magnitude is expressed in.
     *
     * @method
     * @return {number} The units of the magnitude.
     */
    public getUnit():tsdDef.Unit {
        return this._unit;
    }
}