A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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)
 
bool IsRxCorrect ()
 
void StartRx (Ptr< const Packet > p)
 
- Public Member Functions inherited from ns3::SpectrumErrorModel
virtual ~SpectrumErrorModel ()
 
- Public Member Functions inherited from ns3::Object
 Object ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 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. 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
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Protected Member Functions

virtual void DoDispose ()
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Private Attributes

uint32_t m_bytes
 
uint32_t m_deliverableBytes
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::SpectrumErrorModel
static TypeId GetTypeId ()
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

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 59 of file spectrum-error-model.h.

Member Function Documentation

void ns3::ShannonSpectrumErrorModel::DoDispose ( void  )
protectedvirtual

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

Subclasses are expected to implement their real destruction code in an overriden 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 46 of file spectrum-error-model.cc.

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

+ Here is the call graph for this function:

void ns3::ShannonSpectrumErrorModel::EvaluateChunk ( const SpectrumValue sinr,
Time  duration 
)
virtual
bool ns3::ShannonSpectrumErrorModel::IsRxCorrect ( )
virtual

Implements ns3::SpectrumErrorModel.

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

References m_bytes, m_deliverableBytes, and NS_LOG_FUNCTION.

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

Implements ns3::SpectrumErrorModel.

Definition at line 53 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

uint32_t ns3::ShannonSpectrumErrorModel::m_bytes
private

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

Referenced by IsRxCorrect(), and StartRx().

uint32_t ns3::ShannonSpectrumErrorModel::m_deliverableBytes
private

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

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


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