A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::WifiBandwidthFilter Class Reference

Introspection did not find any typical Config paths. More...

#include "wifi-bandwidth-filter.h"

+ Inheritance diagram for ns3::WifiBandwidthFilter:
+ Collaboration diagram for ns3::WifiBandwidthFilter:

Public Member Functions

 WifiBandwidthFilter ()
 
bool DoFilter (Ptr< const SpectrumSignalParameters > params, Ptr< const SpectrumPhy > receiverPhy) override
 Ignore the signal being received if it is a Wi-Fi PPDU whose TX band (including guard bands) does not overlap the current operating channel.
 
- Public Member Functions inherited from ns3::SpectrumTransmitFilter
 SpectrumTransmitFilter ()
 
int64_t AssignStreams (int64_t stream)
 If this loss model uses objects of type RandomVariableStream, set the stream numbers to the integers starting with the offset 'stream'.
 
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 (discarded) before being processed in this channel and on the receiving Phy.
 
Ptr< const SpectrumTransmitFilterGetNext () const
 Return the next transmit filter in the chain.
 
void SetNext (Ptr< SpectrumTransmitFilter > next)
 Add a transmit filter to be consulted next if this filter does not filter the signal.
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
virtual TypeId GetInstanceTypeId () const =0
 Get the most derived TypeId for this Object.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::SpectrumTransmitFilter
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Protected Member Functions

int64_t DoAssignStreams (int64_t stream) override
 Assign a fixed random variable stream number to the random variables used by this model.
 
- Protected Member Functions inherited from ns3::SpectrumTransmitFilter
virtual int64_t DoAssignStreams (int64_t stream)=0
 Assign a fixed random variable stream number to the random variables used by this model.
 
void DoDispose () override
 Destructor implementation.
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoDispose ()
 Destructor implementation.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 

Additional Inherited Members

Detailed Description

Introspection did not find any typical Config paths.


No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 64 bytes (on a 64-bit architecture).

Definition at line 26 of file wifi-bandwidth-filter.h.

Constructor & Destructor Documentation

◆ WifiBandwidthFilter()

ns3::WifiBandwidthFilter::WifiBandwidthFilter ( )

Definition at line 36 of file wifi-bandwidth-filter.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoAssignStreams()

int64_t ns3::WifiBandwidthFilter::DoAssignStreams ( int64_t  stream)
overrideprotectedvirtual

Assign a fixed random variable stream number to the random variables used by this model.

Subclasses must implement this; those not using random variables can return zero.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Implements ns3::SpectrumTransmitFilter.

Definition at line 141 of file wifi-bandwidth-filter.cc.

◆ DoFilter()

bool ns3::WifiBandwidthFilter::DoFilter ( Ptr< const SpectrumSignalParameters params,
Ptr< const SpectrumPhy receiverPhy 
)
overridevirtual

Ignore the signal being received if it is a Wi-Fi PPDU whose TX band (including guard bands) does not overlap the current operating channel.

Parameters
paramsthe parameters of the signals being received
receiverPhythe SpectrumPhy of the receiver
Returns
whether the signal being received should be ignored

The PPDU can be ignored if the two bands do not overlap.

First non-overlapping case:

                                   ┌─────────┬─────────┬─────────┐
                           PPDU    │  Guard  │ Nominal │  Guard  │
                                   │  Band   │   Band  │  Band   │
                                   └─────────┴─────────┴─────────┘
                               rxMinFreq                     rxMaxFreq

channelMinFreq channelMaxFreq ┌──────────────────────────────┐ │ Operating │ │ Channel │ └──────────────────────────────┘

Second non-overlapping case:

    ┌─────────┬─────────┬─────────┐

PPDU │ Guard │ Nominal │ Guard │ │ Band │ Band │ Band │ └─────────┴─────────┴─────────┘ rxMinFreq rxMaxFreq

                      channelMinFreq                channelMaxFreq
                              ┌──────────────────────────────┐
                              │         Operating            │
                              │           Channel            │
                              └──────────────────────────────┘

Implements ns3::SpectrumTransmitFilter.

Definition at line 52 of file wifi-bandwidth-filter.cc.

References ns3::DynamicCast(), ns3::BooleanValue::Get(), NS_ASSERT, NS_ASSERT_MSG, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::WifiBandwidthFilter::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 42 of file wifi-bandwidth-filter.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

The documentation for this class was generated from the following files: