spectrum-aware transmit filter object More...

#include "spectrum-transmit-filter.h"

Inheritance diagram for ns3::SpectrumTransmitFilter:

Collaboration diagram for ns3::SpectrumTransmitFilter:

Public Member Functions
	SpectrumTransmitFilter ()

int64_t	AssignStreams (int64_t stream)
	If this loss model uses objects of type RandomVariableStream, set the stream numbers to the integers starting with the offset 'stream'.

bool	Filter (Ptr< const SpectrumSignalParameters > params, Ptr< const SpectrumPhy > receiverPhy)
	Evaluate whether the signal to be scheduled on the receiving Phy should instead be filtered (discarded) before being processed in this channel and on the receiving Phy.

Ptr< const SpectrumTransmitFilter >	GetNext () const
	Return the next transmit filter in the chain.

void	SetNext (Ptr< SpectrumTransmitFilter > next)
	Add a transmit filter to be consulted next if this filter does not filter the signal.

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 ()
	Get the type ID.

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.

Protected Member Functions
virtual int64_t	DoAssignStreams (int64_t stream)=0
	Assign a fixed random variable stream number to the random variables used by this model.

void	DoDispose () override
	Destructor implementation.

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

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.

Private Member Functions
virtual bool	DoFilter (Ptr< const SpectrumSignalParameters > params, Ptr< const SpectrumPhy > receiverPhy)=0
	Evaluate whether the signal to be scheduled on the receiving Phy should instead be filtered (discarded) before being processed in this channel and on the receiving Phy.

Private Attributes
Ptr< SpectrumTransmitFilter >	m_next {nullptr}
	SpectrumTransmitFilter chained to this one.

Additional Inherited Members
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

spectrum-aware transmit filter object

Introspection did not find any typical Config paths.

Interface for transmit filters that permit an early discard of signal reception before propagation loss models or receiving Phy objects have to process the signal, for performance optimization purposes.

No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Spectrum

Size of this type is 64 bytes (on a 64-bit architecture).

Definition at line 28 of file spectrum-transmit-filter.h.

Constructor & Destructor Documentation

◆ SpectrumTransmitFilter()

ns3::SpectrumTransmitFilter::SpectrumTransmitFilter ( )

Definition at line 30 of file spectrum-transmit-filter.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::SpectrumTransmitFilter::AssignStreams ( int64_t stream )

If this loss model uses objects of type RandomVariableStream, set the stream numbers to the integers starting with the offset 'stream'.

Return the number of streams (possibly zero) that have been assigned. If there are SpectrumTransmitFilters chained together, this method will also assign streams to the downstream models.

Parameters

stream the stream index offset start

Returns: the number of stream indices assigned by this model

Definition at line 80 of file spectrum-transmit-filter.cc.

References DoAssignStreams(), and m_next.

Here is the call graph for this function:

◆ DoAssignStreams()

virtual int64_t ns3::SpectrumTransmitFilter::DoAssignStreams ( int64_t stream )

protectedpure virtual

Assign a fixed random variable stream number to the random variables used by this model.

Subclasses must implement this; those not using random variables can return zero.

Parameters

stream first stream index to use

Returns: the number of stream indices assigned by this model

Implemented in ns3::WifiBandwidthFilter.

Referenced by AssignStreams().

Here is the caller graph for this function:

◆ DoDispose()

void ns3::SpectrumTransmitFilter::DoDispose ( )

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 36 of file spectrum-transmit-filter.cc.

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

Here is the call graph for this function:

◆ DoFilter()

virtual bool ns3::SpectrumTransmitFilter::DoFilter	(	Ptr< const SpectrumSignalParameters >	params,
		Ptr< const SpectrumPhy >	receiverPhy )

privatepure virtual

Evaluate whether the signal to be scheduled on the receiving Phy should instead be filtered (discarded) before being processed in this channel and on the receiving Phy.

Parameters

params	the spectrum signal parameters.
receiverPhy	pointer to the receiving SpectrumPhy

Returns: whether to perform filtering of the signal

Implemented in ns3::WifiBandwidthFilter.

Referenced by Filter().

Here is the caller graph for this function:

◆ Filter()

bool ns3::SpectrumTransmitFilter::Filter	(	Ptr< const SpectrumSignalParameters >	params,
		Ptr< const SpectrumPhy >	receiverPhy )

Evaluate whether the signal to be scheduled on the receiving Phy should instead be filtered (discarded) before being processed in this channel and on the receiving Phy.

Parameters