A Discrete-Event Network Simulator
API
data-collection-object.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2011 Bucknell University
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  * Authors: Tiago G. Rodrigues (tgr002@bucknell.edu)
19  */
20 
21 #ifndef DATA_COLLECTION_OBJECT_H
22 #define DATA_COLLECTION_OBJECT_H
23 
24 #include <string>
25 #include "ns3/object.h"
26 
27 namespace ns3 {
28 
38 {
39 public:
44  static TypeId GetTypeId ();
45 
47  virtual ~DataCollectionObject ();
48 
50  void Enable (void);
52  void Disable (void);
53 
55  virtual bool IsEnabled (void) const;
56 
58  std::string GetName (void) const;
59 
61  void SetName (std::string name);
62 
63 protected:
65  bool m_enabled;
66 
68  std::string m_name;
69 
70 };
71 
72 } // namespace ns3
73 
74 #endif // DATA_COLLECTION_OBJECT_H
void Enable(void)
Set the status of an individual object.
Base class for data collection framework objects.
virtual bool IsEnabled(void) const
Check the status of an individual object.
std::string m_name
Name of the object within the data collection framework.
static TypeId GetTypeId()
Get the type ID.
bool m_enabled
Object&#39;s activation state.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void Disable(void)
Unset the status of an individual object.
void SetName(std::string name)
Set the object&#39;s name. All spaces are replaced by underscores.
A base class which provides memory management and object aggregation.
Definition: object.h:87
std::string GetName(void) const
Get the object&#39;s name.
a unique identifier for an interface.
Definition: type-id.h:58