configurationregistrar.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013-2014,2016 - Adjacent Link LLC, Bridgewater, New
 * Jersey
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in
 *   the documentation and/or other materials provided with the
 *   distribution.
 * * Neither the name of Adjacent Link LLC nor the names of its
 *   contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef EMANECONFIGURATIONREGISTRAR_HEADER_
#define EMANECONFIGURATIONREGISTRAR_HEADER_

#include "emane/configurationproperties.h"
#include "emane/configurationexception.h"
#include "emane/configurationupdate.h"
#include "emane/any.h"

#include <initializer_list>
#include <string>
#include <limits>

namespace EMANE
{
  class ConfigurationRegistrar
  {
  public:
    virtual ~ConfigurationRegistrar();

    template<typename T>
    void registerNumeric(const std::string & sName,
                         const ConfigurationProperties & properties = ConfigurationProperties::NONE,
                         const std::initializer_list<T> & values = {},
                         const std::string & sUsage = "",
                         T minValue = std::numeric_limits<T>::lowest(),
                         T maxValue = std::numeric_limits<T>::max(),
                         std::size_t minOccurs = 1,
                         std::size_t maxOccurs = 1,
                         const std::string & sRegexPattern = {});
    template<typename T>
    void registerNonNumeric(const std::string & sName,
                            const ConfigurationProperties & properties = ConfigurationProperties::NONE,
                            const std::initializer_list<T> & values = {},
                            const std::string & sUsage = "",
                            std::size_t minOccurs = 1,
                            std::size_t maxOccurs = 1,
                            const std::string & sRegexPattern = {});

    virtual void registerValidator(ConfigurationValidator validator) = 0;

  protected:
    ConfigurationRegistrar();

    virtual void registerNumericAny(const std::string & sName,
                                    Any::Type type,
                                    const ConfigurationProperties & properties,
                                    const std::vector<Any> & values,
                                    const std::string & sUsage,
                                    const Any & minValue,
                                    const Any & maxValue,
                                    std::size_t minOccurs,
                                    std::size_t maxOccurs,
                                    const std::string & sRegexPattern = {}) = 0;

    virtual void registerNonNumericAny(const std::string & sName,
                                       Any::Type type,
                                       const ConfigurationProperties & properties,
                                       const std::vector<Any> & values,
                                       const std::string & sUsage,
                                       std::size_t minOccurs,
                                       std::size_t maxOccurs,
                                       const std::string & sRegexPattern = {}) = 0;

  };
}

#include "emane/configurationregistrar.inl"

#endif //EMANECONFIGURATIONREGISTRAR_HEADER_