Add random number files, base class Application
This commit is contained in:
Tom Henderson
173
src/node/application.cc
Normal file
173
src/node/application.cc
Normal file
@@ -0,0 +1,173 @@
|
||||
/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
|
||||
/*
|
||||
* Copyright (c) 2006 Georgia Tech Research Corporation
|
||||
*
|
||||
* 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: George F. Riley<riley@ece.gatech.edu>
|
||||
*/
|
||||
|
||||
// Implementation for ns3 Application base class.
|
||||
// George F. Riley, Georgia Tech, Fall 2006
|
||||
|
||||
#include "application.h"
|
||||
#include "node.h"
|
||||
#include "node-reference.h"
|
||||
#include "ns3/nstime.h"
|
||||
#include "ns3/random-variable.h"
|
||||
#include "ns3/simulator.h"
|
||||
|
||||
using namespace std;
|
||||
|
||||
namespace ns3 {
|
||||
|
||||
#define nil 0
|
||||
|
||||
// Application Methods
|
||||
|
||||
// \brief Application Constructor
|
||||
Application::Application() : m_node(nil), m_startVar(nil), m_stopVar(nil),
|
||||
m_start(false), m_stop(false)
|
||||
{
|
||||
}
|
||||
|
||||
Application::Application(const Application& o)
|
||||
: m_node(nil), m_startVar(nil), m_stopVar(nil),
|
||||
m_start(false), m_stop(false)
|
||||
{ // Copy constructor
|
||||
if (o.GetNode())m_node = new NodeReference(*o.GetNode());
|
||||
// Copy the start and stop random variables if they exist
|
||||
if (o.m_startVar) m_startVar = o.m_startVar->Copy();
|
||||
if (o.m_stopVar) m_stopVar = o.m_stopVar->Copy();
|
||||
if (o.m_start) ScheduleStart();
|
||||
if (o.m_stop) ScheduleStop();
|
||||
}
|
||||
|
||||
|
||||
// \brief Application Destructor
|
||||
Application::~Application()
|
||||
{
|
||||
delete m_node;
|
||||
// Cancel the start/stop events if scheduled
|
||||
if (m_start) Simulator::Cancel(m_startEvent);
|
||||
if (m_stop) Simulator::Cancel(m_stopEvent);
|
||||
// Delete the random variablse
|
||||
delete m_startVar;
|
||||
delete m_stopVar;
|
||||
}
|
||||
|
||||
Application& Application::operator=(const Application& rhs)
|
||||
{
|
||||
if (this == &rhs) return *this; // Self assignment
|
||||
delete m_node;
|
||||
m_node = nil;
|
||||
if (rhs.GetNode())m_node = new NodeReference(*rhs.GetNode());
|
||||
|
||||
delete m_startVar;
|
||||
m_startVar = nil;
|
||||
if (rhs.m_startVar) m_startVar = rhs.m_startVar->Copy();
|
||||
|
||||
delete m_stopVar;
|
||||
m_stopVar = nil;
|
||||
if (rhs.m_stopVar) m_stopVar = rhs.m_stopVar->Copy();
|
||||
|
||||
m_start = false;
|
||||
if (rhs.m_start) ScheduleStart();
|
||||
if (rhs.m_stop) ScheduleStop();
|
||||
return *this;
|
||||
}
|
||||
|
||||
|
||||
// \brief Specify application start time
|
||||
// The virtual method STartApp will be called at the time
|
||||
// specified by startTime.
|
||||
// \param Time to start application (absolute time, from start of simulation)
|
||||
void Application::Start(const Time& startTime)
|
||||
{
|
||||
delete m_startVar;
|
||||
m_startVar = new ConstantVariable(startTime.GetSeconds());
|
||||
ScheduleStart();
|
||||
}
|
||||
|
||||
void Application::Start(const RandomVariable& startVar)
|
||||
{ // Start at random time
|
||||
delete m_startVar;
|
||||
m_startVar = startVar.Copy();
|
||||
ScheduleStart();
|
||||
}
|
||||
|
||||
|
||||
// \brief Specify application stop time
|
||||
// The virtual method StopApp will be called at the time
|
||||
// specified by stopTime.
|
||||
// \param Time to stop application (absolute time, from start of simulation)
|
||||
void Application::Stop(const Time& stopTime)
|
||||
{
|
||||
delete m_stopVar;
|
||||
m_stopVar = new ConstantVariable(stopTime.GetSeconds());
|
||||
ScheduleStop();
|
||||
}
|
||||
|
||||
void Application::Stop(const RandomVariable& stopVar)
|
||||
{ // Stop at random time
|
||||
delete m_stopVar;
|
||||
m_stopVar = stopVar.Copy();
|
||||
ScheduleStop();
|
||||
}
|
||||
|
||||
// \brief Assign this application to a given node
|
||||
// Called by the application manager capability when adding
|
||||
// an application to a node.
|
||||
void Application::SetNode(const Node& n)
|
||||
{
|
||||
delete m_node;
|
||||
m_node = new NodeReference(n);
|
||||
}
|
||||
|
||||
Node* Application::GetNode() const
|
||||
{
|
||||
return m_node->GetNode();
|
||||
}
|
||||
|
||||
// Protected methods
|
||||
// StartApp and StopApp will likely be overridden by application subclasses
|
||||
void Application::StartApplication()
|
||||
{ // Provide null functionality in case subclass is not interested
|
||||
}
|
||||
|
||||
void Application::StopApplication()
|
||||
{ // Provide null functionality in case subclass is not interested
|
||||
}
|
||||
|
||||
|
||||
// Private helpers
|
||||
void Application::ScheduleStart()
|
||||
{
|
||||
m_startEvent = Simulator::Schedule(Seconds(m_startVar->GetValue()) -
|
||||
Simulator::Now(),
|
||||
&Application::StartApplication, this);
|
||||
m_start = true;
|
||||
}
|
||||
|
||||
void Application::ScheduleStop()
|
||||
{
|
||||
m_stopEvent = Simulator::Schedule(Seconds(m_stopVar->GetValue()) -
|
||||
Simulator::Now(),
|
||||
&Application::StopApplication, this);
|
||||
m_stop = true;
|
||||
}
|
||||
|
||||
} //namespace ns3
|
||||
|
||||
|
||||
136
src/node/application.h
Normal file
136
src/node/application.h
Normal file
@@ -0,0 +1,136 @@
|
||||
/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
|
||||
/*
|
||||
* Copyright (c) 2006 Georgia Tech Research Corporation
|
||||
*
|
||||
* 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: George F. Riley<riley@ece.gatech.edu>
|
||||
*/
|
||||
|
||||
#ifndef __APPLICATION_H__
|
||||
#define __APPLICATION_H__
|
||||
|
||||
//
|
||||
// \brief The base class for all ns3 applicationes
|
||||
//
|
||||
// Class Application is the base class for all ns3 applications.
|
||||
// Applications are associated with individual nodes, and are created
|
||||
// using the AddApplication method in the ApplicationManager capability.
|
||||
//
|
||||
// Conceptually, an application has zero or more Socket
|
||||
// objects associated with it, that are created using the Socket
|
||||
// creation API of the Kernel capability. The Socket object
|
||||
// API is modeled after the
|
||||
// well-known BSD sockets interface, although it is somewhat
|
||||
// simplified for use with ns3. Further, any socket call that
|
||||
// would normally "block" in normal sockets will return immediately
|
||||
// in ns3. A set of "upcalls" are defined that will be called when
|
||||
// the previous blocking call would normally exit. THis is documented
|
||||
// in more detail Socket class in socket.h.
|
||||
//
|
||||
// There is a second application class in ns3, called "ThreadedApplication"
|
||||
// that implements a true sockets interface, which should be used
|
||||
// when porting existing sockets code to ns3. The true
|
||||
// sockets approach is significantly
|
||||
// less memory--efficient using private stacks for each defined application,
|
||||
// so that approach should be used with care. The design and implementation
|
||||
// of the ThreadedApplication are still being discussed.
|
||||
|
||||
#include "ns3/event-id.h"
|
||||
#include "ns3/nstime.h"
|
||||
|
||||
namespace ns3 {
|
||||
|
||||
class Node;
|
||||
class NodeReference;
|
||||
class RandomVariable;
|
||||
|
||||
class Application {
|
||||
public:
|
||||
Application();
|
||||
Application(const Application&); // Copy constructor
|
||||
Application& operator=(const Application&); // Assignment operator
|
||||
virtual ~Application();
|
||||
|
||||
virtual Application* Copy() const = 0; // All applications must provide
|
||||
|
||||
// \brief Specify application start time
|
||||
// Applications start at various times in the simulation scenario.
|
||||
// The Start method specifies when the application should be
|
||||
// started. The application subclasses should override the
|
||||
// private "StartApplication" method defined below, which is called at the
|
||||
// time specified, to cause the application to begin.
|
||||
// \param Start time for this application, relative to the
|
||||
// current simulation time.
|
||||
void Start(const Time&);
|
||||
|
||||
// \brief Same as above, but uses a random variable for start time
|
||||
// The random variable returns the desired start time in units of
|
||||
// Seconds.
|
||||
|
||||
void Start(const RandomVariable&);
|
||||
|
||||
// \brief Specify application stop time
|
||||
// Once an application has started, it is sometimes useful
|
||||
// to stop the application. The Stop method specifies when an
|
||||
// application is to stop. The application subclasses should override
|
||||
// the private StopApplication method defined below, to cause the application
|
||||
// to stop.
|
||||
// \param Stop time for this application, relative to the
|
||||
// current simulation time.
|
||||
void Stop(const Time&);
|
||||
|
||||
// \brief Same as above, but uses a random variable for stop time
|
||||
// The random variable returns the desired stop time in units of
|
||||
// Seconds.
|
||||
void Stop(const RandomVariable&);
|
||||
|
||||
// \brief Attaches an application to a specific node
|
||||
// Specifies which node object this application is associated with.
|
||||
// \param Node object to associate with this application.
|
||||
void SetNode(const Node&);
|
||||
|
||||
// \brief Returns the pointer to the attached node.
|
||||
Node* GetNode() const;
|
||||
|
||||
// Members
|
||||
NodeReference* m_node; // All applications have an associated node
|
||||
RandomVariable* m_startVar; // Random variable for start time
|
||||
RandomVariable* m_stopVar; // Random variable for stop time
|
||||
EventId m_startEvent;// Event identifier for start event
|
||||
EventId m_stopEvent; // Event identifier for the stop event
|
||||
bool m_start; // True if start event scheduled
|
||||
bool m_stop; // True if stop event scheduled
|
||||
|
||||
protected:
|
||||
// \brief Application specific startup code
|
||||
// The StartApplication method is called at the start time specifed by Start
|
||||
// This method should be overridden by all or most application
|
||||
// subclasses.
|
||||
virtual void StartApplication();
|
||||
|
||||
// \brief Application specific shutdown code
|
||||
// The StopApplication method is called at the stop time specifed by Stop
|
||||
// This method should be overridden by all or most application
|
||||
// subclasses.
|
||||
virtual void StopApplication();
|
||||
|
||||
private:
|
||||
// Helpers
|
||||
void ScheduleStart();
|
||||
void ScheduleStop();
|
||||
};
|
||||
|
||||
} //namespace ns3
|
||||
#endif
|
||||
45
src/node/node-reference.h
Normal file
45
src/node/node-reference.h
Normal file
@@ -0,0 +1,45 @@
|
||||
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
|
||||
//
|
||||
// Copyright (c) 2006 Georgia Tech Research Corporation
|
||||
//
|
||||
// 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: George F. Riley<riley@ece.gatech.edu>
|
||||
//
|
||||
|
||||
// Define a class that wraps a node pointer. This allows numerous ns3
|
||||
// objects to have access to a node, but without ambiguity of whether
|
||||
// the owner should "delete" it.
|
||||
|
||||
// George F. Riley, Georgia Tech, Spring 2007
|
||||
|
||||
#ifndef __NODE_REFERENCE_H__
|
||||
#define __NODE_REFERENCE_H__
|
||||
|
||||
namespace ns3 {
|
||||
|
||||
class Node;
|
||||
|
||||
class NodeReference {
|
||||
public:
|
||||
NodeReference(const Node& n)
|
||||
: m_node(n) {}
|
||||
Node* GetNode() const { return (Node*)&m_node;}
|
||||
public:
|
||||
const Node& m_node;
|
||||
};
|
||||
|
||||
} // namespace ns3
|
||||
|
||||
#endif
|
||||
Reference in New Issue
Block a user