topology-reader.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010 Universita' di Firenze, Italy
 *
 * 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: Tommaso Pecorella (tommaso.pecorella@unifi.it)
 * Author: Valerio Sartini (valesar@gmail.com)
 */
 
#ifndef TOPOLOGY_READER_H
#define TOPOLOGY_READER_H
 
#include "ns3/node.h"
#include "ns3/object.h"
 
#include <list>
#include <map>
#include <string>
 
namespace ns3
{
 
class NodeContainer;
 
class TopologyReader : public Object
{
  public:
    class Link
    {
      public:
        typedef std::map<std::string, std::string>::const_iterator ConstAttributesIterator;
 
        Link(Ptr<Node> fromPtr,
             const std::string& fromName,
             Ptr<Node> toPtr,
             const std::string& toName);
 
        Ptr<Node> GetFromNode() const;
        std::string GetFromNodeName() const;
        Ptr<Node> GetToNode() const;
        std::string GetToNodeName() const;
        std::string GetAttribute(const std::string& name) const;
        bool GetAttributeFailSafe(const std::string& name, std::string& value) const;
        void SetAttribute(const std::string& name, const std::string& value);
        ConstAttributesIterator AttributesBegin() const;
        ConstAttributesIterator AttributesEnd() const;
 
      private:
        Link();
        std::string m_fromName; 
        Ptr<Node> m_fromPtr;    
        std::string m_toName;   
        Ptr<Node> m_toPtr;      
        std::map<std::string, std::string>
            m_linkAttr; 
    };
 
    typedef std::list<Link>::const_iterator ConstLinksIterator;
 
    static TypeId GetTypeId();
 
    TopologyReader();
    ~TopologyReader() override;
 
    // Delete copy constructor and assignment operator to avoid misuse
    TopologyReader(const TopologyReader&) = delete;
    TopologyReader& operator=(const TopologyReader&) = delete;
 
    virtual NodeContainer Read() = 0;
 
    void SetFileName(const std::string& fileName);
 
    std::string GetFileName() const;
 
    ConstLinksIterator LinksBegin() const;
 
    ConstLinksIterator LinksEnd() const;
 
    int LinksSize() const;
 
    bool LinksEmpty() const;
 
    void AddLink(Link link);
 
  private:
    std::string m_fileName;
 
    std::list<Link> m_linksList;
 
    // end class TopologyReader
};
 
// end namespace ns3
}; // namespace ns3
 
#endif /* TOPOLOGY_READER_H */