RandomWaypointNode.cc

// Copyright 2008 Michael Marsh, University of Maryland.
//
// This file is part of pydtn.
//
// pydtn is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// pydtn 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 pydtn.  If not, see <http://www.gnu.org/licenses/>.
//
// The views and conclusions contained in the software and documentation
// are those of the authors and should not be interpreted as representing
// official policies, either expressed or implied, of the University
// of Maryland.
//
// pydtn extends and embeds the Python interpreter, which is
// Copyright 2001-2006 Python Software Foundation, All Rights Reserved,
// and is released under the PSF License Agreement.
//
// RANLUX random number generation uses the Boost library,
// Copyright 1994-2006 by various authors (details in individual files),
// which is released under the Boost Software License, Version 1.0.

#include "simlpy/interpreter_defs.h"
#include "simlpy/interpreter_hooks.h"

#include "RandomWaypointNode.h"
#include "WaypointRange.h"
#include "RectangularAlignedWaypointRange.h"
#include "ParallelogramWaypointRange.h"
#include "simlpy/Clock.h"
#include "simlpy/SimulationException.h"

#include <iostream>
#include <stdlib.h>

using namespace Mobility;

const std::string
RandomWaypointNode::kIdentifier( "node:mobile:random_waypoint" );

RandomWaypointNode::RandomWaypointNode() :
   m_range( 0 ),
   m_speedMin( 0.001 ),      // a typical pace for an adult snail
   m_speedMax( 299792458.0 ) // c
{
}

RandomWaypointNode::~RandomWaypointNode()
{
   if ( 0 != m_range ) delete m_range;
}

Entity*
RandomWaypointNode::create() const
{
   RandomWaypointNode* n = new RandomWaypointNode;
   n->trigger();
   return n;
}

void
RandomWaypointNode::configure( const ArgList& args )
{
   unsigned int nargs = args.size();
   if ( 0 == nargs )
   {
      std::cerr << "no arguments passed to config()" << std::endl;
      throw SimulationException( __FILE__ , __LINE__ );
   }
   std::string command = parse_string(args[0]);
   if ( "range" == command )
   {
      // We're going to use Duck Typing here.
      if ( nargs < 3 )
      {
         std::cerr << "config('range') requires at least two arguments"
                   << std::endl;
         throw SimulationException( __FILE__ , __LINE__ );
      }
      if ( 3 == nargs )
      {
         // Is it a rectangular region aligned with the axes?
         try
         {
            Position ll = parse_position( args[1] );
            Position ur = parse_position( args[2] );
            if ( 0 != m_range ) delete m_range;
            m_range = new RectangularAlignedWaypointRange( ll, ur );
            return;
         }
         catch ( ... )
         {
         }
      }
      if ( 4 == nargs )
      {
         // Is it a 2-d parallelogram?
         try
         {
            Position a = parse_position( args[1] );
            Position b = parse_position( args[2] );
            Position c = parse_position( args[3] );
            if ( 0 != m_range ) delete m_range;
            m_range = new ParallelogramWaypointRange( a, b, c, a );
            return;
         }
         catch ( ... )
         {
         }
      }
      if ( 5 == nargs )
      {
         // Is it a 3-d parallelohedron?
         try
         {
            Position a = parse_position( args[1] );
            Position b = parse_position( args[2] );
            Position c = parse_position( args[3] );
            Position d = parse_position( args[4] );
            if ( 0 != m_range ) delete m_range;
            m_range = new ParallelogramWaypointRange( a, b, c, d );
            return;
         }
         catch ( ... )
         {
         }
      }
      std::cerr << "Could not understand argument list" << std::endl;
      throw SimulationException( __FILE__ , __LINE__ );
   }
   if ( "speed" == command )
   {
      if ( nargs < 2 )
      {
         std::cerr << "config('speed') requires at least one speed"
                   << std::endl;
         throw SimulationException( __FILE__ , __LINE__ );
      }
      double minSpeed = parse_double( args[1] );
      double maxSpeed = minSpeed;
      if ( nargs > 2 )
      {
         maxSpeed = parse_double( args[2] );
      }
      setSpeed( minSpeed, maxSpeed );
      return;
   }
   MobileNode::configure(args);
}

void
RandomWaypointNode::emit( const ArgList& args )
{
   MobileNode::emit(args);
}

InterpreterItem
RandomWaypointNode::get( const ArgList& args )
{
   unsigned int nargs = args.size();
   if ( 0 == nargs )
   {
      std::cerr << "No attribute specified" << std::endl;
      throw SimulationException( __FILE__ , __LINE__ );
   }

   std::string attr = parse_string(args[0]);

   if ( "speed_range" == attr )
   {
      ArgList alist;
      alist.push_back( construct_double( m_speedMin ) );
      alist.push_back( construct_double( m_speedMax ) );
      return construct_list( alist );
   }

   return MobileNode::get(args);
}

bool
RandomWaypointNode::handler( WaypointEvent& event )
{
   setWaypoint( event.waypoint() );
   return true;
}

void
RandomWaypointNode::setWaypoint( const Presence& wp )
{
   if ( 0 != m_range )
   {
      Position p = m_range->next( wp.position() );
      Position delta = p - wp.position();
      double dist = delta.length();
      double speed = m_speedMin +
         ( m_speedMax - m_speedMin ) * prng();
      double dt = dist / speed;
      long int dts = (long int) ::floor(dt);
      long int dtus = (long int)( Time::MILLION * ( dt - ::floor(dt) ) );
      Time t( dts, dtus );
      t += wp.time();
      t += wp.duration();
      Clock::tentative( new WaypointEvent(this,
                                          this,
                                          wp.time(),
                                          Presence(t,p,Time())) );
   }
   MobileNode::setWaypoint(wp);
}

void
RandomWaypointNode::setRange( WaypointRange* r )
{
   if ( 0 != r )
   {
      if ( 0 != m_range ) delete m_range;
      m_range = r;
   }
}

void
RandomWaypointNode::setSpeed( double min_speed, double max_speed )
{
   if ( max_speed < min_speed )
   {
      std::cerr
         << "The node maximum speed must be at least the node minimum speed."
         << std::endl;
      throw SimulationException( __FILE__ , __LINE__ );
   }
   if ( min_speed <= 0 )
   {
      std::cerr << "The node minimum speed must be greater than zero."
                << std::endl;
   }
   m_speedMin = min_speed;
   m_speedMax = max_speed;
}

---