src.libs/CjNP_linkNodes.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 _CJNP_LINKNODES_H_
#define _CJNP_LINKNODES_H_ 1

#include <string>
#include "CjNetworkProcess.hh"
#include "CjNetworkDimensioner.hh"
#include "CjNodeSelector.hh"

namespace jmitie {
namespace corelib {
class CjNP_linkNodes : public CjNetworkProcess {

private:
ctor_va_t::CjDimFactory_t::Visitor_shared_ptr m_link_dimensioner;
ctor_va_t::CjNodeSelectorFactory_t::Visitor_shared_ptr m_dest_selector_a;
ctor_va_t::CjNodeSelectorFactory_t::Visitor_shared_ptr m_dest_selector_b;
bool m_dupe_ok;
bool m_loop_ok;
bool m_retry_src;

public:
std::string getName() const { return getName_static(); }
static std::string getName_static() { return "linkNodes"; }
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 "Add a link between two nodes, selecting each node with two node selectors.";
        if(opt=="usage") return getProperty_static("desc") + "\n" \
        "node_selector_name1\n"\
        "node_selector_name2\tThe names of the two nodes selectors to use to chose a node pair which to connect.\n"\
        "link_dimensioner_name\tThe name of the link dimensioner to use on the new link.\n"\
        "[dupe_ok]\tIf specified a node pairs which are already connected are included in the node-pair selection(only applies when adding links).\n"\
        "[loop_ok]\tIf specified then it is allowable for the destination and source nodes to be the same.\n"\
        "[retry_src]\tIf present the source node selector will be executed again if the destination node selector cannot find a suitable destination.\n";
        throw std::invalid_argument("CjNP_linkNodes::getProperty_static(" + opt + "): Unknown property requested.");
}

CjNP_linkNodes(const std::string & args, const ctor_va_t & var_arg );
virtual void performAction( const action_va_t & opts );

~CjNP_linkNodes() { }

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

#endif // _CJNP_LINKNODES_H_