src.libs/CjND_nroutes.hh

/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
/*
 * mitie
 * Copyright (C) Jason Spencer 2009 <mitie@jasonspencer.org>
 * 
 * mitie is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * mitie is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __CJND_NROUTES_H_
#define __CJND_NROUTES_H_ 1

#include "CjNLTopology.hh"
#include "CjNetworkDimensioner.hh"
#include <string>
#include <stdexcept>

namespace jmitie {
namespace corelib {
class CjND_nroutes : public CjNetworkDimensioner {

protected:
CjNLTopology::WT m_minimumValue;
double m_alpha;
bool m_alpha_set;
double m_beta;
bool m_beta_set;
bool m_warn;
bool m_redim;

public:
static std::string getName_static() { return "nroutes"; }
std::string getName() const { return getName_static(); };
std::string getProperty(const std::string & prop) const { return getProperty_static(prop); }
static std::string getProperty_static(const std::string & opt) {
        if(opt=="desc") return "Sets the link to a function of the number of routes (routes, not load) that traverse it.";
        if(opt=="usage") return getProperty_static("desc") + "\nSets the weight of the link to alpha*number_of_routes_on_link^beta. If alpha or beta are not specified then their value defaults to 1.0. min_val is the minimum value a link weight could be.\n"\
        "[alpha=float]\tThe optional co-efficient of the number of routes. This value must be positive.\n"\
        "[beta=float]\tThe optional exponent of the link weight when using pref selection.\n"\
        "min_val=integer\tThe minimum link weight that will be returned. This value will be returned if the dimensioning is for a new link (therefore no routes to count). This can be any integer greater than 0.\n"\
        "[no_warn]\tPrevents the printing of a warning message every time the minimum value is used.";
        throw std::invalid_argument("CjND_nroutes::getProperty_static(" + opt + "): Unknown property requested.");
}

CjND_nroutes( const std::string & arg, const ctor_va_t & );
virtual CjNLTopology::WT calcWeight( calcw_va_t & va, unsigned int, unsigned int );

};
} // namespace corelib
} // namespace jmitie

#endif // __CJND_NROUTES_H_