mobility-helper.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 INRIA
 *
 * 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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */
 
#ifndef MOBILITY_HELPER_H
#define MOBILITY_HELPER_H
 
#include "ns3/attribute.h"
#include "ns3/node-container.h"
#include "ns3/object-factory.h"
#include "ns3/output-stream-wrapper.h"
#include "ns3/position-allocator.h"
 
#include <vector>
 
namespace ns3
{
 
class PositionAllocator;
class MobilityModel;
 
class MobilityHelper
{
  public:
    MobilityHelper();
 
    ~MobilityHelper();
 
    void SetPositionAllocator(Ptr<PositionAllocator> allocator);
 
    template <typename... Ts>
    void SetPositionAllocator(std::string type, Ts&&... args);
 
    template <typename... Ts>
    void SetMobilityModel(std::string type, Ts&&... args);
 
    void PushReferenceMobilityModel(Ptr<Object> reference);
    void PushReferenceMobilityModel(std::string referenceName);
    void PopReferenceMobilityModel();
 
    std::string GetMobilityModelType() const;
 
    void Install(Ptr<Node> node) const;
    void Install(std::string nodeName) const;
 
    void Install(NodeContainer container) const;
 
    void InstallAll() const;
 
    static void EnableAscii(Ptr<OutputStreamWrapper> stream, uint32_t nodeid);
    static void EnableAscii(Ptr<OutputStreamWrapper> stream, NodeContainer n);
    static void EnableAsciiAll(Ptr<OutputStreamWrapper> stream);
    int64_t AssignStreams(NodeContainer c, int64_t stream);
 
    static double GetDistanceSquaredBetween(Ptr<Node> n1, Ptr<Node> n2);
 
  private:
    static void CourseChanged(Ptr<OutputStreamWrapper> stream, Ptr<const MobilityModel> mobility);
    std::vector<Ptr<MobilityModel>> m_mobilityStack; 
    ObjectFactory m_mobility;                        
    Ptr<PositionAllocator>
        m_position; 
};
 
/***************************************************************
 *  Implementation of the templates declared above.
 ***************************************************************/
 
template <typename... Ts>
void
MobilityHelper::SetPositionAllocator(std::string type, Ts&&... args)
{
    ObjectFactory pos(type, std::forward<Ts>(args)...);
    m_position = pos.Create()->GetObject<PositionAllocator>();
}
 
template <typename... Ts>
void
MobilityHelper::SetMobilityModel(std::string type, Ts&&... args)
{
    m_mobility.SetTypeId(type);
    m_mobility.Set(std::forward<Ts>(args)...);
}
 
} // namespace ns3
 
#endif /* MOBILITY_HELPER_H */