A Discrete-Event Network Simulator
API
ns3::SpectrumErrorModel Class Referenceabstract

#include "spectrum-error-model.h"

+ Inheritance diagram for ns3::SpectrumErrorModel:
+ Collaboration diagram for ns3::SpectrumErrorModel:

Public Member Functions

 ~SpectrumErrorModel () override
 
virtual void EvaluateChunk (const SpectrumValue &sinr, Time duration)=0
 Evaluates a chunk. More...
 
virtual bool IsRxCorrect ()=0
 Checks if the packet being received is correct. More...
 
virtual void StartRx (Ptr< const Packet > p)=0
 Start a packet reception. More...
 
- 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::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose ()
 Destructor implementation. 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...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ~SpectrumErrorModel()

ns3::SpectrumErrorModel::~SpectrumErrorModel ( )
override

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

Member Function Documentation

◆ EvaluateChunk()

virtual void ns3::SpectrumErrorModel::EvaluateChunk ( const SpectrumValue sinr,
Time  duration 
)
pure virtual

Evaluates a chunk.

Parameters
sinrthe SpectrumValue experienced by the Chunk
durationthe Chunk length

Implemented in ns3::ShannonSpectrumErrorModel.

◆ GetTypeId()

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

Register this type.

Returns
The TypeId.

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ IsRxCorrect()

virtual bool ns3::SpectrumErrorModel::IsRxCorrect ( )
pure virtual

Checks if the packet being received is correct.

Returns
true if the packet is correct.

Implemented in ns3::ShannonSpectrumErrorModel.

◆ StartRx()

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

Start a packet reception.

Parameters
pthe packet

Implemented in ns3::ShannonSpectrumErrorModel.


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