Simple SpectrumPhy implementation that sends customizable waveform. More...

#include <waveform-generator.h>

Inheritance diagram for ns3::WaveformGenerator:

Collaboration diagram for ns3::WaveformGenerator:

Public Member Functions
	WaveformGenerator ()

virtual	~WaveformGenerator ()

Ptr< NetDevice >	GetDevice ()
	get the associated NetDevice instance More...

double	GetDutyCycle () const

Ptr< MobilityModel >	GetMobility ()
	get the associated MobilityModel instance More...

Time	GetPeriod () const

Ptr< AntennaModel >	GetRxAntenna ()
	get the AntennaModel used by the NetDevice for reception More...

Ptr< const SpectrumModel >	GetRxSpectrumModel () const

void	SetAntenna (Ptr< AntennaModel > a)
	set the AntennaModel to be used More...

void	SetChannel (Ptr< SpectrumChannel > c)
	Set the channel attached to this device. More...

void	SetDevice (Ptr< NetDevice > d)
	set the associated NetDevice instance More...

void	SetDutyCycle (double value)

void	SetMobility (Ptr< MobilityModel > m)
	Set the mobility model associated with this device. More...

void	SetPeriod (Time period)
	Set the period according to which the WaveformGenerator switches on and off. More...

void	SetTxPowerSpectralDensity (Ptr< SpectrumValue > txs)
	Set the Power Spectral Density used for outgoing waveforms. More...

virtual void	Start ()
	Start the waveform generator. More...

void	StartRx (Ptr< SpectrumSignalParameters > params)
	Notify the SpectrumPhy instance of an incoming signal. More...

virtual void	Stop ()
	Stop the waveform generator. More...

Public Member Functions inherited from ns3::SpectrumPhy
	SpectrumPhy ()

virtual	~SpectrumPhy ()

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...

SimpleRefCount &	operator= (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)

Static Public Member Functions
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::SpectrumPhy
static TypeId	GetTypeId (void)

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...

Private Member Functions
virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

virtual void	GenerateWaveform ()

Private Attributes
bool	m_active

Ptr< AntennaModel >	m_antenna

Ptr< SpectrumChannel >	m_channel

double	m_dutyCycle

Ptr< MobilityModel >	m_mobility

Ptr< NetDevice >	m_netDevice

Time	m_period

TracedCallback< Ptr< const Packet > >	m_phyTxEndTrace

TracedCallback< Ptr< const Packet > >	m_phyTxStartTrace

Time	m_startTime

Ptr< SpectrumValue >	m_txPowerSpectralDensity

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

Detailed Description

Simple SpectrumPhy implementation that sends customizable waveform.

Doxygen introspection did not find any typical Config paths.

The generated waveforms have a given Spectrum Power Density and duration (set with the SetResolution()) . The generator activates and deactivates periodically with a given period and with a duty cycle of 1/2.

This PHY model supports a single antenna model instance which is used for both transmission and reception (though received signals are discarded by this PHY).

Attributes

Period: the period (=1/frequency)
- Set with class: ns3::TimeValue
- Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +1000000000.0ns
- Flags: construct write read
DutyCycle: the duty cycle of the generator, i.e., the fraction of the period that is occupied by a signal
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0.5
- Flags: construct write read

TraceSources

TxStart: Trace fired when a new transmission is started
TxEnd: Trace fired when a previosuly started transmission is finished

Definition at line 52 of file waveform-generator.h.

Constructor & Destructor Documentation

ns3::WaveformGenerator::WaveformGenerator ( )

Definition at line 38 of file waveform-generator.cc.

ns3::WaveformGenerator::~WaveformGenerator ( )

virtual

Definition at line 50 of file waveform-generator.cc.

Member Function Documentation

void ns3::WaveformGenerator::DoDispose ( void )

privatevirtual

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 57 of file waveform-generator.cc.

References m_channel, m_mobility, m_netDevice, and NS_LOG_FUNCTION.

void ns3::WaveformGenerator::GenerateWaveform ( )

privatevirtual

Definition at line 193 of file waveform-generator.cc.

References m_active, m_antenna, m_channel, m_dutyCycle, m_period, m_phyTxStartTrace, m_txPowerSpectralDensity, NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::Simulator::Schedule().

Referenced by Start().

Here is the call graph for this function:

Here is the caller graph for this function:

Ptr< NetDevice > ns3::WaveformGenerator::GetDevice ( )

virtual

get the associated NetDevice instance

Returns: a Ptr to the associated NetDevice instance

Implements ns3::SpectrumPhy.

Definition at line 96 of file waveform-generator.cc.

References m_netDevice.

double ns3::WaveformGenerator::GetDutyCycle ( ) const

Returns: the value of the duty cycle

Definition at line 185 of file waveform-generator.cc.

References m_dutyCycle.

Referenced by GetTypeId().

Here is the caller graph for this function:

Ptr< MobilityModel > ns3::WaveformGenerator::GetMobility ( )

virtual

get the associated MobilityModel instance

Returns: a Ptr to the associated MobilityModel instance

Implements ns3::SpectrumPhy.

Definition at line 103 of file waveform-generator.cc.

References m_mobility.

Time ns3::WaveformGenerator::GetPeriod ( ) const

Returns: the value of the period according to which the WaveformGenerator switches on and off

Definition at line 172 of file waveform-generator.cc.

References m_period.

Referenced by GetTypeId().

Here is the caller graph for this function:

Ptr< AntennaModel > ns3::WaveformGenerator::GetRxAntenna ( )

virtual

get the AntennaModel used by the NetDevice for reception

Returns: a Ptr to the AntennaModel used by the NetDevice for reception

Implements ns3::SpectrumPhy.

Definition at line 153 of file waveform-generator.cc.

References m_antenna.

Ptr< const SpectrumModel > ns3::WaveformGenerator::GetRxSpectrumModel ( ) const

virtual

Returns: returns the SpectrumModel that this SpectrumPhy expects to be used for all SpectrumValues that are passed to StartRx. If 0 is returned, it means that any model will be accepted.

Implements ns3::SpectrumPhy.

Definition at line 110 of file waveform-generator.cc.

TypeId ns3::WaveformGenerator::GetTypeId ( void )

static

Definition at line 66 of file waveform-generator.cc.

References GetDutyCycle(), GetPeriod(), m_phyTxEndTrace, m_phyTxStartTrace, ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), SetDutyCycle(), ns3::TypeId::SetParent(), and SetPeriod().

Here is the call graph for this function: