Scale Stack 0.3 Developer Documentation

scalestack/kernel/option.h

Go to the documentation of this file.

/*
 * Scale Stack
 *
 * Copyright 2010 Eric Day
 *
 * 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 SCALESTACK_KERNEL_OPTION_H
#define SCALESTACK_KERNEL_OPTION_H

#include <string>
#include <utility>
#include <vector>

#include <scalestack/kernel/macros.h>

namespace scalestack
{
namespace kernel
{

class module;

class SCALESTACK_API option
{
public:

  ~option();

  module& get_module(void) const;

  const std::string& get_name(void) const;

  const std::string& get_help(void) const;

  const std::string& get_value_name(void) const;

  const std::string& get_default_value(void) const;

  const std::string& get_value(void) const;

  int get_int_value(void) const;

  size_t get_size_value(void) const;

  bool get_bool_value(void) const;

  std::vector<std::string> get_list_value(void) const;

  bool is_valid(void) const;

private:

  SCALESTACK_LOCAL
  option(module& module, const std::string& name);

  SCALESTACK_LOCAL
  option(const option&);

  SCALESTACK_LOCAL
  option& operator=(const option&);

  SCALESTACK_LOCAL
  void _set_help(const std::string& help);

  SCALESTACK_LOCAL
  void _set_value_name(const std::string& value_name);

  SCALESTACK_LOCAL
  void _set_default_value(const std::string& default_value);

  SCALESTACK_LOCAL
  void _set_value(const std::string& value, bool overwrite);

  SCALESTACK_LOCAL
  void _set_valid(bool valid);

  SCALESTACK_LOCAL
  void _print_help(void);

  SCALESTACK_LOCAL
  void _print_config(void);

  bool _is_valid;
  bool _is_set;
  module& _module;
  const std::string _name;
  std::string _help;
  std::string _value_name;
  std::string _default_value;
  std::string _value;

  friend class module;
};

} /* namespace kernel */
} /* namespace scalestack */

#endif /* SCALESTACK_KERNEL_OPTION_H */

---