A Discrete-Event Network Simulator
API
data-collection-object.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011 Bucknell University
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Authors: Tiago G. Rodrigues (tgr002@bucknell.edu)
18  */
19 
20 #ifndef DATA_COLLECTION_OBJECT_H
21 #define DATA_COLLECTION_OBJECT_H
22 
23 #include "ns3/object.h"
24 
25 #include <string>
26 
27 namespace ns3
28 {
29 
39 {
40  public:
45  static TypeId GetTypeId();
46 
48  ~DataCollectionObject() override;
49 
51  void Enable();
53  void Disable();
54 
59  virtual bool IsEnabled() const;
60 
65  std::string GetName() const;
66 
71  void SetName(std::string name);
72 
73  protected:
75  bool m_enabled;
76 
78  std::string m_name;
79 };
80 
81 } // namespace ns3
82 
83 #endif // DATA_COLLECTION_OBJECT_H
Base class for data collection framework objects.
std::string m_name
Name of the object within the data collection framework.
virtual bool IsEnabled() const
Check the status of an individual object.
std::string GetName() const
Get the object's name.
bool m_enabled
Object's activation state.
void Disable()
Unset the status of an individual object.
void SetName(std::string name)
Set the object's name.
void Enable()
Set the status of an individual object.
static TypeId GetTypeId()
Get the type ID.
A base class which provides memory management and object aggregation.
Definition: object.h:89
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.