ns3::SpectrumErrorModel Class Reference

#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.
virtual bool	IsRxCorrect ()=0
	Checks if the packet being received is correct.
virtual void	StartRx (Ptr< const Packet > p)=0
	Start a packet reception.
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< Object >	GetObject () 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< Object >	GetObject (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.
SimpleRefCount &	operator= (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 ()
	Register this type.
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.

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.
Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

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

Constructor & Destructor Documentation

~SpectrumErrorModel()

ns3::SpectrumErrorModel::~SpectrumErrorModel ( )

override

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

sinr	the SpectrumValue experienced by the Chunk
duration	the Chunk length

Implemented in ns3::ShannonSpectrumErrorModel.

GetTypeId()

TypeId ns3::SpectrumErrorModel::GetTypeId ( )

static

Register this type.

Returns

The TypeId.

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

p	the packet

Implemented in ns3::ShannonSpectrumErrorModel.

---

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

• src/spectrum/model/spectrum-error-model.h
• src/spectrum/model/spectrum-error-model.cc