src.libs/CjNP_topStatDump.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_TOPSTATDUMP_H_
#define _CJNP_TOPSTATDUMP_H_ 1

#include <string>
#include <stdexcept>
#include "CjNP_LoggableBase.hh"

namespace jmitie {
namespace corelib {
class CjNP_topStatDump : public CjNP_LoggableBase {

public:
std::string getName() const { return getName_static(); }
static std::string getName_static() { return "topStatDump"; }
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 "Prints various topology statistics, including: number of nodes, number of links, the number of nodes that are connected to themselves (self-loops), whether the topology is partitioned, and what fraction of node pairs are connected.";
        if(opt=="usage") return getProperty_static("desc") + "\nAvailable options:\n" + CjNP_LoggableBase::getProperty_static(opt);
        throw std::invalid_argument("CjNP_topStatDump::getProperty_static(" + opt + "): Unknown property requested.");
}

CjNP_topStatDump(const std::string & args, const ctor_va_t & var_arg );

virtual void performAction( const action_va_t & opts );

~CjNP_topStatDump();

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

#endif // _CJNP_TOPSTATDUMP_H_