A Discrete-Event Network Simulator
API
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 ()
 
bool CaptureNewFrame (Ptr< Event > currentEvent, Ptr< Event > newEvent) const
 This method returns whether the reception should be switched to a new incoming frame. More...
 
double GetMargin (void) const
 Return the frame capture margin (dB). More...
 
void SetMargin (double margin)
 Sets the frame capture margin (dB). More...
 
- 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. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

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

Private Attributes

double m_margin
 margin for determining if a new frame (dB) More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

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::WaveNetDevice/PhyEntities/[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: construct write read

Attributes defined in parent class ns3::FrameCaptureModel

  • CaptureWindow: The duration of the capture window.
    • Set with class: ns3::TimeValue
    • Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +16000.0ns
    • Flags: construct write read

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

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

Constructor & Destructor Documentation

◆ SimpleFrameCaptureModel()

ns3::SimpleFrameCaptureModel::SimpleFrameCaptureModel ( )

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

References NS_LOG_FUNCTION.

◆ ~SimpleFrameCaptureModel()

ns3::SimpleFrameCaptureModel::~SimpleFrameCaptureModel ( )

Definition at line 57 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
virtual

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 76 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()

double ns3::SimpleFrameCaptureModel::GetMargin ( void  ) const

Return the frame capture margin (dB).

Returns
the frame capture margin in dB

Definition at line 70 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 ( void  )
static

Get the type ID.

Returns
the object TypeId

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

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

+ Here is the call graph for this function:

◆ SetMargin()

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

Sets the frame capture margin (dB).

Parameters
marginthe frame capture margin in dB

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

References m_margin, and NS_LOG_FUNCTION.

Referenced by GetTypeId(), and InterferenceExperiment::Run().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_margin

double ns3::SimpleFrameCaptureModel::m_margin
private

margin for determining if a new frame (dB)

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

Referenced by GetMargin(), and SetMargin().


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