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
send-params.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2007,2008 INRIA
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
* Author: Jahanzeb Farooq <jahanzeb.farooq@sophia.inria.fr>
18
*/
19
20
#ifndef SEND_PARAMS_H
21
#define SEND_PARAMS_H
22
23
#include <stdint.h>
24
25
namespace
ns3
26
{
27
28
class
WimaxPhy;
29
30
/**
31
* \ingroup wimax
32
* \brief The SendParams class defines the parameters with which Send() function of
33
* a particular PHY is called. The sole purpose of this class is to allow
34
* defining the pure virtual Send() function in the PHY base-class (WimaxPhy).
35
* This class shall be sub-classed every time a new PHY is integrated (i.e.,
36
* a new sub-class of WimaxPhy is created) which requires different or
37
* additional parameters to call its Send() function. For example as it is
38
* seen here, it has been sub-classed for the OFDM PHY layer since its Send()
39
* function requires two additional parameters.
40
*/
41
class
SendParams
42
{
43
public
:
44
SendParams
();
45
virtual
~SendParams
();
46
47
private
:
48
};
49
50
}
// namespace ns3
51
52
#endif
/* SEND_PARAMS_H */
53
54
#ifndef OFDM_SEND_PARAMS_H
55
#define OFDM_SEND_PARAMS_H
56
57
#include "ns3/packet-burst.h"
58
59
#include <stdint.h>
60
61
namespace
ns3
62
{
63
64
/**
65
* OfdmSendParams class
66
*/
67
class
OfdmSendParams
:
public
SendParams
68
{
69
public
:
70
/**
71
* Constructor
72
*
73
* \param burst packet burst object
74
* \param modulationType modulation type
75
* \param direction the direction
76
*/
77
OfdmSendParams
(
Ptr<PacketBurst>
burst, uint8_t modulationType, uint8_t direction);
78
~OfdmSendParams
()
override
;
79
80
/**
81
* \return the packet burst
82
*/
83
Ptr<PacketBurst>
GetBurst
()
const
84
{
85
return
m_burst
;
86
}
87
88
/**
89
* \return the modulation type
90
*/
91
uint8_t
GetModulationType
()
const
92
{
93
return
m_modulationType
;
94
}
95
96
/**
97
* \return the direction
98
*/
99
uint8_t
GetDirection
()
const
100
{
101
return
m_direction
;
102
}
103
104
private
:
105
Ptr<PacketBurst>
m_burst
;
///< packet burst
106
uint8_t
m_modulationType
;
///< modulation type
107
uint8_t
m_direction
;
///< direction
108
};
109
110
}
// namespace ns3
111
112
#endif
/* OFDM_SEND_PARAMS_H */
ns3::OfdmSendParams
OfdmSendParams class.
Definition:
send-params.h:68
ns3::OfdmSendParams::GetBurst
Ptr< PacketBurst > GetBurst() const
Definition:
send-params.h:83
ns3::OfdmSendParams::GetModulationType
uint8_t GetModulationType() const
Definition:
send-params.h:91
ns3::OfdmSendParams::m_burst
Ptr< PacketBurst > m_burst
packet burst
Definition:
send-params.h:105
ns3::OfdmSendParams::~OfdmSendParams
~OfdmSendParams() override
Definition:
send-params.cc:45
ns3::OfdmSendParams::m_modulationType
uint8_t m_modulationType
modulation type
Definition:
send-params.h:106
ns3::OfdmSendParams::GetDirection
uint8_t GetDirection() const
Definition:
send-params.h:99
ns3::OfdmSendParams::m_direction
uint8_t m_direction
direction
Definition:
send-params.h:107
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition:
ptr.h:77
ns3::SendParams
The SendParams class defines the parameters with which Send() function of a particular PHY is called.
Definition:
send-params.h:42
ns3::SendParams::SendParams
SendParams()
Definition:
send-params.cc:27
ns3::SendParams::~SendParams
virtual ~SendParams()
Definition:
send-params.cc:31
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
wimax
model
send-params.h
Generated on Tue May 28 2024 23:41:14 for ns-3 by
1.9.6