A Discrete-Event Network Simulator
API
ns3::ShannonSpectrumErrorModel Class Reference

This class implements the error model described in this paper: N. More...

#include "spectrum-error-model.h"

+ Inheritance diagram for ns3::ShannonSpectrumErrorModel:
+ Collaboration diagram for ns3::ShannonSpectrumErrorModel:

Public Member Functions

void EvaluateChunk (const SpectrumValue &sinr, Time duration) override
 Evaluates a chunk. More...
 
bool IsRxCorrect () override
 Checks if the packet being received is correct. More...
 
void StartRx (Ptr< const Packet > p) override
 Start a packet reception. More...
 
- Public Member Functions inherited from ns3::SpectrumErrorModel
 ~SpectrumErrorModel () override
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () 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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () 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 errors. 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 ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SpectrumErrorModel
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Protected Member Functions

void DoDispose () override
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize ()
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate ()
 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 ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Private Attributes

uint32_t m_bytes
 Length of the packet being received. More...
 
uint32_t m_deliverableBytes
 Bytes that can be received according to the Shnanon's formula. More...
 

Additional Inherited Members

Detailed Description

This class implements the error model described in this paper: N.

Baldo and M. Miozzo, "Spectrum-aware Channel and PHY layer modeling for ns3", in Proceedings of International Workshop on Network Simulation Tools (NSTOOLS 2009), 19 October 2009, Pisa (Italy).

Definition at line 75 of file spectrum-error-model.h.

Member Function Documentation

◆ DoDispose()

void ns3::ShannonSpectrumErrorModel::DoDispose ( void  )
overrideprotectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 60 of file spectrum-error-model.cc.

References ns3::Object::DoDispose(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ EvaluateChunk()

void ns3::ShannonSpectrumErrorModel::EvaluateChunk ( const SpectrumValue sinr,
Time  duration 
)
overridevirtual

◆ GetTypeId()

TypeId ns3::ShannonSpectrumErrorModel::GetTypeId ( void  )
static

Register this type.

Returns
The TypeId.

Definition at line 50 of file spectrum-error-model.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ IsRxCorrect()

bool ns3::ShannonSpectrumErrorModel::IsRxCorrect ( )
overridevirtual

Checks if the packet being received is correct.

Returns
true if the packet is correct.

Implements ns3::SpectrumErrorModel.

Definition at line 99 of file spectrum-error-model.cc.

References m_bytes, m_deliverableBytes, and NS_LOG_FUNCTION.

◆ StartRx()

void ns3::ShannonSpectrumErrorModel::StartRx ( Ptr< const Packet p)
overridevirtual

Start a packet reception.

Parameters
pthe packet

Implements ns3::SpectrumErrorModel.

Definition at line 67 of file spectrum-error-model.cc.

References ns3::Packet::GetSize(), m_bytes, m_deliverableBytes, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_bytes

uint32_t ns3::ShannonSpectrumErrorModel::m_bytes
private

Length of the packet being received.

Definition at line 92 of file spectrum-error-model.h.

Referenced by IsRxCorrect(), and StartRx().

◆ m_deliverableBytes

uint32_t ns3::ShannonSpectrumErrorModel::m_deliverableBytes
private

Bytes that can be received according to the Shnanon's formula.

Definition at line 93 of file spectrum-error-model.h.

Referenced by EvaluateChunk(), IsRxCorrect(), and StartRx().


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