A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
Loading...
Searching...
No Matches
data-collection-object.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2011 Bucknell University
3
*
4
* SPDX-License-Identifier: GPL-2.0-only
5
*
6
* Authors: Tiago G. Rodrigues (tgr002@bucknell.edu)
7
*/
8
9
#ifndef DATA_COLLECTION_OBJECT_H
10
#define DATA_COLLECTION_OBJECT_H
11
12
#include "ns3/object.h"
13
14
#include <string>
15
16
namespace
ns3
17
{
18
19
/**
20
* \ingroup aggregator
21
*
22
* Base class for data collection framework objects.
23
*
24
* All data collection objects have 1) a string name, and 2) enabled
25
* or disabled status.
26
*/
27
class
DataCollectionObject
:
public
Object
28
{
29
public
:
30
/**
31
* \brief Get the type ID.
32
* \return the object TypeId
33
*/
34
static
TypeId
GetTypeId
();
35
36
DataCollectionObject
();
37
~DataCollectionObject
()
override
;
38
39
/// Set the status of an individual object.
40
void
Enable
();
41
/// Unset the status of an individual object.
42
void
Disable
();
43
44
/**
45
* Check the status of an individual object.
46
* \return true if the object is enabled
47
*/
48
virtual
bool
IsEnabled
()
const
;
49
50
/**
51
* Get the object's name.
52
* \return the object's name
53
*/
54
std::string
GetName
()
const
;
55
56
/**
57
* Set the object's name.
58
* \param name the object's name
59
*/
60
void
SetName
(std::string name);
61
62
protected
:
63
/// Object's activation state.
64
bool
m_enabled
;
65
66
/// Name of the object within the data collection framework
67
std::string
m_name
;
68
};
69
70
}
// namespace ns3
71
72
#endif
// DATA_COLLECTION_OBJECT_H
ns3::DataCollectionObject
Base class for data collection framework objects.
Definition
data-collection-object.h:28
ns3::DataCollectionObject::m_name
std::string m_name
Name of the object within the data collection framework.
Definition
data-collection-object.h:67
ns3::DataCollectionObject::DataCollectionObject
DataCollectionObject()
Definition
data-collection-object.cc:43
ns3::DataCollectionObject::IsEnabled
virtual bool IsEnabled() const
Check the status of an individual object.
Definition
data-collection-object.cc:53
ns3::DataCollectionObject::GetName
std::string GetName() const
Get the object's name.
Definition
data-collection-object.cc:59
ns3::DataCollectionObject::m_enabled
bool m_enabled
Object's activation state.
Definition
data-collection-object.h:64
ns3::DataCollectionObject::Disable
void Disable()
Unset the status of an individual object.
Definition
data-collection-object.cc:84
ns3::DataCollectionObject::SetName
void SetName(std::string name)
Set the object's name.
Definition
data-collection-object.cc:65
ns3::DataCollectionObject::Enable
void Enable()
Set the status of an individual object.
Definition
data-collection-object.cc:77
ns3::DataCollectionObject::~DataCollectionObject
~DataCollectionObject() override
Definition
data-collection-object.cc:47
ns3::DataCollectionObject::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition
data-collection-object.cc:23
ns3::Object
A base class which provides memory management and object aggregation.
Definition
object.h:78
ns3::TypeId
a unique identifier for an interface.
Definition
type-id.h:48
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
stats
model
data-collection-object.h
Generated on Fri Nov 8 2024 13:59:06 for ns-3 by
1.11.0