statisticregistrar.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 EMANESTATISTICREGISTRAR_HEADER_
#define EMANESTATISTICREGISTRAR_HEADER_

#include "emane/statistic.h"
#include "emane/statisticnumeric.h"
#include "emane/statisticnonnumeric.h"
#include "emane/statistictable.h"
#include "emane/statisticproperties.h"

#include <string>
#include <functional>

namespace EMANE
{
  class StatisticRegistrar
  {
  public:
    virtual ~StatisticRegistrar(){}

    template<typename T>
    StatisticNumeric<T> * registerNumeric(const std::string & sName,
                                          const StatisticProperties & properties = StatisticProperties::NONE,
                                          const std::string & sDescription = "");

    template<typename T>
    StatisticNonNumeric<T> * registerNonNumeric(const std::string & sName,
                                                const StatisticProperties & properties = StatisticProperties::NONE,
                                                const std::string & sDescription = "");


    template<typename Key,
             typename Compare = std::less<EMANE::Any>,
             std::size_t scolumn = 0>
    StatisticTable<Key,Compare,scolumn> *
    registerTable(const std::string & sName,
                  const StatisticTableLabels & labels,
                  const StatisticProperties & properties = StatisticProperties::NONE,
                  const std::string & sDescription = "");


    template<typename Key,
             typename Function,
             typename Compare = std::less<EMANE::Any>,
             std::size_t scolumn = 0>
    StatisticTable<Key,Compare,scolumn> *
    registerTable(const std::string & sName,
                  const StatisticTableLabels & labels,
                  Function clearFunc,
                  const std::string & sDescription = "");


  protected:
    virtual void registerStatistic(const std::string & sName,
                                   Any::Type type,
                                   const StatisticProperties & properties,
                                   const std::string & sDescription,
                                   Statistic * pStatistic) = 0;

    virtual void registerTablePublisher(const std::string & sName,
                                        const StatisticProperties & properties,
                                        const std::string & sDescription,
                                        StatisticTablePublisher * pStatiticTablePublisher,
                                        std::function<void(StatisticTablePublisher * p)> clearFunc) = 0;
  };
}

#include "emane/statisticregistrar.inl"

#endif // EMANESTATISTICREGISTRAR_HEADER_