A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
application.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2006 Georgia Tech Research Corporation
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: George F. Riley<riley@ece.gatech.edu>
19  */
20 
21 #ifndef APPLICATION_H
22 #define APPLICATION_H
23 
24 #include "ns3/event-id.h"
25 #include "ns3/nstime.h"
26 #include "ns3/object.h"
27 #include "ns3/ptr.h"
28 #include "ns3/node.h"
29 
30 namespace ns3 {
31 
32 class Node;
33 class RandomVariable;
34 
61 class Application : public Object
62 {
63 public:
64  static TypeId GetTypeId (void);
65  Application ();
66  virtual ~Application ();
67 
79  void SetStartTime (Time start);
80 
92  void SetStopTime (Time stop);
93 
97  Ptr<Node> GetNode () const;
98 
102  void SetNode (Ptr<Node> node);
103 
104 private:
112  virtual void StartApplication (void);
113 
121  virtual void StopApplication (void);
122 protected:
123  virtual void DoDispose (void);
124  virtual void DoInitialize (void);
125 
131 };
132 
133 } // namespace ns3
134 
135 #endif /* APPLICATION_H */
void SetStopTime(Time stop)
Specify application stop time.
Definition: application.cc:75
keep track of time values and allow control of global simulation resolution
Definition: nstime.h:81
static TypeId GetTypeId(void)
Definition: application.cc:40
virtual void DoInitialize(void)
This method is called only once by Object::Initialize.
Definition: application.cc:93
The base class for all ns3 applications.
Definition: application.h:61
virtual void StartApplication(void)
Application specific startup code.
Definition: application.cc:119
Ptr< Node > GetNode() const
Definition: application.cc:104
Time m_stopTime
The simulation time that the appliacation will start.
Definition: application.h:128
virtual void DoDispose(void)
This method is called by Object::Dispose or by the object's destructor, whichever comes first...
Definition: application.cc:83
Ptr< Node > m_node
Definition: application.h:126
EventId m_startEvent
The simulation time that the appliacation will end.
Definition: application.h:129
void SetNode(Ptr< Node > node)
Definition: application.cc:111
virtual void StopApplication(void)
Application specific shutdown code.
Definition: application.cc:124
an identifier for simulation events.
Definition: event-id.h:46
EventId m_stopEvent
The event that will fire at m_startTime to start the application.
Definition: application.h:130
a base class which provides memory management and object aggregation
Definition: object.h:63
Time m_startTime
The node that this application is installed on.
Definition: application.h:127
a unique identifier for an interface.
Definition: type-id.h:49
void SetStartTime(Time start)
Specify application start time.
Definition: application.cc:69
virtual ~Application()
Definition: application.cc:63