src/mobility/mobility-model-notifier.h
author Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Mon, 23 Jul 2007 15:53:54 +0200
changeset 968 70d02500c9d5
child 1347 83786345b743
permissions -rw-r--r--
mobility models

/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2007 INRIA
 * All rights reserved.
 *
 * 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_MODEL_NOTIFIER_H
#define MOBILITY_MODEL_NOTIFIER_H

#include "ns3/object.h"
#include "ns3/component-manager.h"
#include "ns3/callback.h"
#include "mobility-model.h"

namespace ns3 {

/**
 * \brief notify listeners of position changes.
 */
class MobilityModelNotifier : public Object
{
public:
  static const InterfaceId iid;
  static const ClassId cid;

  typedef Callback<void,Ptr<const MobilityModel> > Listener;

  /**
   * Create a new position notifier
   */
  MobilityModelNotifier ();

  /**
   * \param position the position which just changed.
   */
  void Notify (Ptr<const MobilityModel> position) const;

  /**
   * \param listener listener to add
   *
   * The listener will be notified upon every position change.
   */
  void RegisterListener (Listener listener);
  /**
   * \param listener listener to remove
   *
   * The listener will not be notified anymore upon every 
   * position change. It is not an error to try to unregister
   * a non-registered liste
   */
  void UnregisterListener (Listener listener);
private:
  std::list<Listener> m_listeners;
};

} // namespace ns3

#endif /* MOBILITY_MODEL_NOTIFIER_H */