src.libs/CjNS_RPN.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 _CJNS_RPN_
#define _CJNS_RPN_ 1

#include "CjNodeSelector.hh"
#include <string>
#include "JLOG.hh"

namespace jmitie {
        namespace corelib {
class CjNS_RPN: public CjNodeSelector {
public:
static std::string getName_static() { return "RPN"; }
virtual 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 "Select a node preferring nodes with a higher number of routes that ingress and egress the node. Can also consider transit only routes.";
        if(opt=="usage") return getProperty_static("desc") + "\n" \
                "[transit]\tInstead of considering all routes at the interfaces of each node, only consider routes that transit the node (2*N fewer than if were considered)"\
                "[ave]\tSpecifies whether the number of routes is to be divided by the out-degree.\n"\
                "[exp=float]\tIf specified the [average] number of routes is taken to this exponent before being placed in selection wheel.\n"\
                "[dupe_ok]\tIf specified, and if this is the second selector in a process, the selector may return a node which is already connected to this node.\n";
        throw std::invalid_argument("CjNS_RPN::getProperty_static(" + opt + "): Unknown property requested.");
}

CjNS_RPN(std::string args, const ctor_va_t &);
virtual bool selectNode( select_arg_t &, unsigned int & node );
virtual ~CjNS_RPN() { JLOG(5, std::cout << "CjNS_RPN being destroyed." << std::endl; ) };

protected:
bool m_transit;
bool m_average;
bool m_dupe_link_ok;
double m_exp;
bool m_exp_set;

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

#endif // _CJNS_RPN_