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

A simple threshold-based model for frame capture effect. More...

#include "simple-frame-capture-model.h"

+ Inheritance diagram for ns3::SimpleFrameCaptureModel:
+ Collaboration diagram for ns3::SimpleFrameCaptureModel:

Public Member Functions

 SimpleFrameCaptureModel ()
 
 ~SimpleFrameCaptureModel () override
 
bool CaptureNewFrame (Ptr< Event > currentEvent, Ptr< Event > newEvent) const override
 This method returns whether the reception should be switched to a new incoming frame.
 
dB_u GetMargin () const
 Return the frame capture margin.
 
void SetMargin (dB_u margin)
 Sets the frame capture margin.
 
- Public Member Functions inherited from ns3::FrameCaptureModel
virtual bool IsInCaptureWindow (Time timePreambleDetected) const
 This method returns true if the capture window duration has not elapsed yet, false otherwise.
 
- 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, bool permissive=false) 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.
 
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::FrameCaptureModel
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.
 

Private Attributes

dB_u m_margin
 margin for determining if a new frame
 

Additional Inherited Members

- 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.
 

Detailed Description

A simple threshold-based model for frame capture effect.

If the new incoming frame arrives while the receiver is receiving the preamble of another frame and the SIR of the new incoming frame is above a fixed margin, then the current frame is dropped and the receiver locks onto the new incoming frame.

Config Paths

ns3::SimpleFrameCaptureModel is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/FrameCaptureModel/$ns3::SimpleFrameCaptureModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/FrameCaptureModel/$ns3::SimpleFrameCaptureModel"

Attributes

  • Margin: Reception is switched if the newly arrived frame has a power higher than this value above the frame currently being received (expressed in dB).
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 5
    • Flags: constructwriteread
    • Support level: SUPPORTED

Attributes defined in parent class ns3::FrameCaptureModel

  • CaptureWindow: The duration of the capture window.
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
    • Initial value: +16000ns
    • Flags: constructwriteread
    • Support level: SUPPORTED

No TraceSources are defined for this type.
Group: Wifi

Size of this type is 72 bytes (on a 64-bit architecture).

Definition at line 27 of file simple-frame-capture-model.h.

Constructor & Destructor Documentation

◆ SimpleFrameCaptureModel()

ns3::SimpleFrameCaptureModel::SimpleFrameCaptureModel ( )

Definition at line 44 of file simple-frame-capture-model.cc.

References NS_LOG_FUNCTION.

◆ ~SimpleFrameCaptureModel()

ns3::SimpleFrameCaptureModel::~SimpleFrameCaptureModel ( )
override

Definition at line 49 of file simple-frame-capture-model.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ CaptureNewFrame()

bool ns3::SimpleFrameCaptureModel::CaptureNewFrame ( Ptr< Event > currentEvent,
Ptr< Event > newEvent ) const
overridevirtual

This method returns whether the reception should be switched to a new incoming frame.

Parameters
currentEventthe event of the current frame
newEventthe event of the new incoming frame
Returns
true if the reception should be switched to a new incoming frame, false otherwise

Implements ns3::FrameCaptureModel.

Definition at line 68 of file simple-frame-capture-model.cc.

References GetMargin(), ns3::FrameCaptureModel::IsInCaptureWindow(), NS_LOG_FUNCTION, and ns3::WToDbm().

+ Here is the call graph for this function:

◆ GetMargin()

dB_u ns3::SimpleFrameCaptureModel::GetMargin ( ) const

Return the frame capture margin.

Returns
the frame capture margin

Definition at line 62 of file simple-frame-capture-model.cc.

References m_margin.

Referenced by CaptureNewFrame(), and GetTypeId().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::SimpleFrameCaptureModel::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 26 of file simple-frame-capture-model.cc.

References GetMargin(), ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), SetMargin(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetMargin()

void ns3::SimpleFrameCaptureModel::SetMargin ( dB_u margin)

Sets the frame capture margin.

Parameters
marginthe frame capture margin

Definition at line 55 of file simple-frame-capture-model.cc.

References m_margin, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_margin

dB_u ns3::SimpleFrameCaptureModel::m_margin
private

margin for determining if a new frame

Definition at line 65 of file simple-frame-capture-model.h.

Referenced by GetMargin(), and SetMargin().


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