flow-monitor-helper.h

Go to the documentation of this file.

//
// Copyright (c) 2009 INESC Porto
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License version 2 as
// published by the Free Software Foundation;
//
// This program 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, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// Author: Gustavo J. A. M. Carneiro  <gjc@inescporto.pt> <gjcarneiro@gmail.com>
//
#ifndef FLOW_MONITOR_HELPER_H
#define FLOW_MONITOR_HELPER_H
 
#include "ns3/flow-classifier.h"
#include "ns3/flow-monitor.h"
#include "ns3/node-container.h"
#include "ns3/object-factory.h"
 
#include <string>
 
namespace ns3
{
 
class AttributeValue;
class Ipv4FlowClassifier;
class Ipv6FlowClassifier;
 
class FlowMonitorHelper
{
  public:
    FlowMonitorHelper();
    ~FlowMonitorHelper();
 
    // Delete copy constructor and assignment operator to avoid misuse
    FlowMonitorHelper(const FlowMonitorHelper&) = delete;
    FlowMonitorHelper& operator=(const FlowMonitorHelper&) = delete;
 
    void SetMonitorAttribute(std::string n1, const AttributeValue& v1);
 
    Ptr<FlowMonitor> Install(NodeContainer nodes);
    Ptr<FlowMonitor> Install(Ptr<Node> node);
    Ptr<FlowMonitor> InstallAll();
 
    Ptr<FlowMonitor> GetMonitor();
 
    Ptr<FlowClassifier> GetClassifier();
 
    Ptr<FlowClassifier> GetClassifier6();
 
    void SerializeToXmlStream(std::ostream& os,
                              uint16_t indent,
                              bool enableHistograms,
                              bool enableProbes);
 
    std::string SerializeToXmlString(uint16_t indent, bool enableHistograms, bool enableProbes);
 
    void SerializeToXmlFile(std::string fileName, bool enableHistograms, bool enableProbes);
 
  private:
    ObjectFactory m_monitorFactory;        
    Ptr<FlowMonitor> m_flowMonitor;        
    Ptr<FlowClassifier> m_flowClassifier4; 
    Ptr<FlowClassifier> m_flowClassifier6; 
};
 
} // namespace ns3
 
#endif /* FLOW_MONITOR_HELPER_H */