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
spectrum-transmit-filter.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2022 University of Washington
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
18
#ifndef SPECTRUM_TRANSMIT_FILTER_H
19
#define SPECTRUM_TRANSMIT_FILTER_H
20
21
#include <ns3/object.h>
22
23
namespace
ns3
24
{
25
26
struct
SpectrumSignalParameters;
27
class
SpectrumPhy;
28
39
class
SpectrumTransmitFilter
:
public
Object
40
{
41
public
:
42
SpectrumTransmitFilter
();
43
48
static
TypeId
GetTypeId
();
49
56
void
SetNext
(
Ptr<SpectrumTransmitFilter>
next);
57
63
Ptr<const SpectrumTransmitFilter>
GetNext
()
const
;
64
75
bool
Filter
(
Ptr<const SpectrumSignalParameters>
params,
Ptr<const SpectrumPhy>
receiverPhy);
76
77
protected
:
78
void
DoDispose
()
override
;
79
80
private
:
91
virtual
bool
DoFilter
(
Ptr<const SpectrumSignalParameters>
params,
92
Ptr<const SpectrumPhy>
receiverPhy) = 0;
93
94
Ptr<SpectrumTransmitFilter>
m_next
{
nullptr
};
95
};
96
97
}
// namespace ns3
98
99
#endif
/* SPECTRUM_TRANSMIT_FILTER_H */
ns3::Object
A base class which provides memory management and object aggregation.
Definition:
object.h:89
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition:
ptr.h:78
ns3::SpectrumTransmitFilter
spectrum-aware transmit filter object
Definition:
spectrum-transmit-filter.h:40
ns3::SpectrumTransmitFilter::Filter
bool Filter(Ptr< const SpectrumSignalParameters > params, Ptr< const SpectrumPhy > receiverPhy)
Evaluate whether the signal to be scheduled on the receiving Phy should instead be filtered (discarde...
Definition:
spectrum-transmit-filter.cc:71
ns3::SpectrumTransmitFilter::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition:
spectrum-transmit-filter.cc:34
ns3::SpectrumTransmitFilter::DoFilter
virtual bool DoFilter(Ptr< const SpectrumSignalParameters > params, Ptr< const SpectrumPhy > receiverPhy)=0
Evaluate whether the signal to be scheduled on the receiving Phy should instead be filtered (discarde...
ns3::SpectrumTransmitFilter::GetNext
Ptr< const SpectrumTransmitFilter > GetNext() const
Return the next transmit filter in the chain.
Definition:
spectrum-transmit-filter.cc:65
ns3::SpectrumTransmitFilter::SpectrumTransmitFilter
SpectrumTransmitFilter()
Definition:
spectrum-transmit-filter.cc:41
ns3::SpectrumTransmitFilter::SetNext
void SetNext(Ptr< SpectrumTransmitFilter > next)
Add a transmit filter to be consulted next if this filter does not filter the signal.
Definition:
spectrum-transmit-filter.cc:59
ns3::SpectrumTransmitFilter::m_next
Ptr< SpectrumTransmitFilter > m_next
SpectrumTransmitFilter chained to this one.
Definition:
spectrum-transmit-filter.h:94
ns3::SpectrumTransmitFilter::DoDispose
void DoDispose() override
Destructor implementation.
Definition:
spectrum-transmit-filter.cc:47
ns3::TypeId
a unique identifier for an interface.
Definition:
type-id.h:59
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
spectrum
model
spectrum-transmit-filter.h
Generated on Sun Jul 2 2023 18:22:03 for ns-3 by
1.9.6