heron/api/src/cpp/metric/assignable-metric.h

/*
 * Copyright 2017 Twitter, Inc.
 *
 * 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.
 */

#ifndef HERON_API_METRIC_ASSIGNABLE_METRIC_H_
#define HERON_API_METRIC_ASSIGNABLE_METRIC_H_

#include <string>

#include "metric/imetric.h"

namespace heron {
namespace api {
namespace metric {

/**
 * Interface for a metric that can be tracked
 */
class AssignableMetric : public IMetric {
 public:
  AssignableMetric() { }
  virtual ~AssignableMetric() { }
  void set(const std::string& val) { value_ = val; }
  virtual const std::string getValueAndReset() {
    return value_;
  }
 private:
  std::string value_;
};

}  // namespace metric
}  // namespace api
}  // namespace heron

#endif  // HERON_API_METRIC_ASSIGNABLE_METRIC_H_