ns-3
ns3::WaveformGenerator Class Reference

#include <waveform-generator.h>

Inheritance diagram for ns3::WaveformGenerator:
Collaboration diagram for ns3::WaveformGenerator:

List of all members.

Public Member Functions

void SetChannel (Ptr< SpectrumChannel > c)
void SetMobility (Ptr< MobilityModel > m)
void SetDevice (Ptr< NetDevice > d)
Ptr< MobilityModelGetMobility ()
Ptr< NetDeviceGetDevice ()
Ptr< const SpectrumModelGetRxSpectrumModel () const
void StartRx (Ptr< SpectrumSignalParameters > params)
void SetTxPowerSpectralDensity (Ptr< SpectrumValue > txs)
void SetPeriod (Time period)
Time GetPeriod () const
void SetDutyCycle (double value)
double GetDutyCycle () const
virtual void Start ()
virtual void Stop ()

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::WaveformGenerator.

Detailed Description

Simple SpectrumPhy implementation that sends customizable waveform. 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.


Member Function Documentation

get the associated NetDevice instance

Returns:
a Ptr to the associated NetDevice instance

Implements ns3::SpectrumPhy.

Returns:
the value of the duty cycle

Referenced by GetTypeId().

get the associated MobilityModel instance

Returns:
a Ptr to the associated NetDevice instance

Implements ns3::SpectrumPhy.

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

Referenced by GetTypeId().

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.

This method returns the TypeId associated to ns3::WaveformGenerator.

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::SpectrumPhy/$ns3::WaveformGenerator
  • /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::WaveformGenerator
  • /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::SpectrumPhy/$ns3::WaveformGenerator
  • /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::WaveformGenerator

Attributes defined for this type:

  • Period: the period (=1/frequency)
    • Set with class: TimeValue
    • Underlying type: Time
    • 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 defined for this type:

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

Reimplemented from ns3::SpectrumPhy.

References GetDutyCycle(), GetPeriod(), ns3::MakeTraceSourceAccessor(), ns3::Seconds(), SetDutyCycle(), ns3::TypeId::SetParent(), and SetPeriod().

Set the channel attached to this device.

Parameters:
cthe channel

Implements ns3::SpectrumPhy.

References NS_LOG_FUNCTION_NOARGS.

set the associated NetDevice instance

Parameters:
dthe NetDevice instance

Implements ns3::SpectrumPhy.

void ns3::WaveformGenerator::SetDutyCycle ( double  value)
Parameters:
valuethe value of the duty cycle

Referenced by GetTypeId().

Set the mobility model associated with this device.

Parameters:
mthe mobility model

Implements ns3::SpectrumPhy.

Set the period according to which the WaveformGenerator switches on and off

Parameters:
period

Referenced by GetTypeId().

Set the Power Spectral Density used for outgoing waveforms

Parameters:
txsthe Power Spectral Density

References NS_LOG_FUNCTION.

void ns3::WaveformGenerator::Start ( void  ) [virtual]

Start the waveform generator

Reimplemented from ns3::Object.

References ns3::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::Simulator::ScheduleNow().

Notify the SpectrumPhy instance of an incoming signal

Parameters:
paramsthe parameters of the signals being received

Implements ns3::SpectrumPhy.

References NS_LOG_FUNCTION.

void ns3::WaveformGenerator::Stop ( void  ) [virtual]

Stop the waveform generator

References NS_LOG_FUNCTION.


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