inet::physicallayer::NoiseSource Class Reference

#include <NoiseSource.h>

Inheritance diagram for inet::physicallayer::NoiseSource:

Public Member Functions
virtual	~NoiseSource ()
virtual const cGate *	getRadioGate () const override
	Returns the gate of the radio that receives incoming signals. More...
virtual RadioMode	getRadioMode () const override
	Returns the current radio mode, This is the same mode as the one emitted with the last radioModeChangedSignal. More...
virtual void	setRadioMode (RadioMode radioMode) override
	Changes the current radio mode. More...
virtual ReceptionState	getReceptionState () const override
	Returns the current radio reception state. More...
virtual TransmissionState	getTransmissionState () const override
	Returns the current radio transmission state. More...
virtual int	getId () const override
	Returns an identifier for this radio which is globally unique for the whole lifetime of the simulation among all radios. More...
virtual const IAntenna *	getAntenna () const override
	Returns the antenna used by the transceiver of this radio. More...
virtual const ITransmitter *	getTransmitter () const override
	Returns the transmitter part of this radio. More...
virtual const IReceiver *	getReceiver () const override
	Returns the receiver part of this radio. More...
virtual const IRadioMedium *	getMedium () const override
	Returns the radio medium where this radio is transmitting and receiving radio signals. More...
virtual const ITransmission *	getTransmissionInProgress () const override
	Returns the ongoing transmission that the transmitter is currently transmitting or nullptr. More...
virtual const ITransmission *	getReceptionInProgress () const override
	Returns the ongoing reception that the receiver is currently receiving or nullptr. More...
virtual IRadioSignal::SignalPart	getTransmittedSignalPart () const override
	Returns the signal part of the ongoing transmission that the transmitter is currently transmitting or -1 if no transmission is in progress. More...
virtual IRadioSignal::SignalPart	getReceivedSignalPart () const override
	Returns the signal part of the ongoing reception that the receiver is currently receiving or -1 if no reception is in progress. More...
Public Member Functions inherited from inet::IPhysicalLayer
virtual	~IPhysicalLayer ()
Public Member Functions inherited from inet::IPrintableObject
virtual	~IPrintableObject ()
virtual std::ostream &	printToStream (std::ostream &stream, int level, int evFlags=0) const
	Prints this object to the provided output stream. More...
virtual std::string	printToString () const
virtual std::string	printToString (int level, int evFlags=0) const
virtual std::string	getInfoStringRepresentation (int evFlags=0) const
virtual std::string	getDetailStringRepresentation (int evFlags=0) const
virtual std::string	getDebugStringRepresentation (int evFlags=0) const
virtual std::string	getTraceStringRepresentation (int evFlags=0) const
virtual std::string	getCompleteStringRepresentation (int evFlags=0) const

Protected Member Functions
virtual int	numInitStages () const override
virtual void	initialize (int stage) override
virtual void	handleMessage (cMessage *message) override
virtual void	startTransmission ()
virtual void	endTransmission ()
virtual void	scheduleSleepTimer ()
virtual void	scheduleTransmissionTimer (const ITransmission *transmission)

Protected Attributes
const int	id = nextId++
cGate *	radioIn = nullptr
int	mediumModuleId = -1
ModuleRefByPar< IRadioMedium >	medium
const IAntenna *	antenna = nullptr
const ITransmitter *	transmitter = nullptr
cMessage *	transmissionTimer = nullptr
cMessage *	sleepTimer = nullptr

Additional Inherited Members
Public Types inherited from inet::physicallayer::IRadio
enum	RadioMode {   RADIO_MODE_OFF, RADIO_MODE_SLEEP, RADIO_MODE_RECEIVER, RADIO_MODE_TRANSMITTER,   RADIO_MODE_TRANSCEIVER, RADIO_MODE_SWITCHING }
	This enumeration specifies the requested operational mode of the radio. More...
enum	ReceptionState { RECEPTION_STATE_UNDEFINED, RECEPTION_STATE_IDLE, RECEPTION_STATE_BUSY, RECEPTION_STATE_RECEIVING }
	This enumeration specifies the reception state of the radio. More...
enum	TransmissionState { TRANSMISSION_STATE_UNDEFINED, TRANSMISSION_STATE_IDLE, TRANSMISSION_STATE_TRANSMITTING }
	This enumeration specifies the transmission state of the radio. More...
Public Types inherited from inet::IPrintableObject
enum	PrintLevel {   PRINT_LEVEL_TRACE, PRINT_LEVEL_DEBUG, PRINT_LEVEL_DETAIL, PRINT_LEVEL_INFO,   PRINT_LEVEL_COMPLETE = INT_MIN }
enum	PrintFlag { PRINT_FLAG_FORMATTED = (1 << 0), PRINT_FLAG_MULTILINE = (1 << 1) }
Static Public Member Functions inherited from inet::physicallayer::IRadio
static const char *	getRadioModeName (RadioMode radioMode)
	Returns the name of the provided radio mode. More...
static const char *	getRadioReceptionStateName (ReceptionState receptionState)
	Returns the name of the provided radio reception state. More...
static const char *	getRadioTransmissionStateName (TransmissionState transmissionState)
	Returns the name of the provided radio transmission state. More...
Static Public Attributes inherited from inet::physicallayer::IRadio
static simsignal_t	radioModeChangedSignal = cComponent::registerSignal("radioModeChanged")
	This signal is emitted when the radio mode of the radio is changed. More...
static simsignal_t	listeningChangedSignal = cComponent::registerSignal("listeningChanged")
	This signal is emitted when the radio listening of the radio is changed. More...
static simsignal_t	receptionStateChangedSignal = cComponent::registerSignal("receptionStateChanged")
	This signal is emitted when the radio reception state of the radio is changed. More...
static simsignal_t	transmissionStateChangedSignal = cComponent::registerSignal("transmissionStateChanged")
	This signal is emitted when the radio transmission state of the radio is changed. More...
static simsignal_t	receivedSignalPartChangedSignal = cComponent::registerSignal("receivedSignalPartChanged")
	This signal is emitted when the received part is changed by the radio. More...
static simsignal_t	transmittedSignalPartChangedSignal = cComponent::registerSignal("transmittedSignalPartChanged")
	This signal is emitted when the transmitted part is changed by the radio. More...
Static Protected Attributes inherited from inet::physicallayer::IRadio
static int	nextId = 0
static cEnum *	radioModeEnum = nullptr
	The enumeration registered for radio mode. More...
static cEnum *	receptionStateEnum = nullptr
	The enumeration registered for radio reception state. More...
static cEnum *	transmissionStateEnum = nullptr
	The enumeration registered for radio transmission state. More...

Constructor & Destructor Documentation

~NoiseSource()

inet::physicallayer::NoiseSource::~NoiseSource ( )

virtual

{
    // NOTE: can't use the medium module here, because it may have been already deleted
    cModule *medium = getSimulation()->getModule(mediumModuleId);
    if (medium != nullptr)
        check_and_cast<IRadioMedium *>(medium)->removeRadio(this);
    cancelAndDelete(sleepTimer);
    cancelAndDelete(transmissionTimer);
}

Member Function Documentation

endTransmission()

void inet::physicallayer::NoiseSource::endTransmission ( )

protectedvirtual

{
    transmissionTimer->setContextPointer(nullptr);
    scheduleSleepTimer();
}

Referenced by handleMessage().

getAntenna()

virtual const IAntenna* inet::physicallayer::NoiseSource::getAntenna ( ) const

inlineoverridevirtual

Returns the antenna used by the transceiver of this radio.

This function never returns nullptr.

Implements inet::physicallayer::IRadio.

{ return antenna; }

getId()

virtual int inet::physicallayer::NoiseSource::getId ( ) const

inlineoverridevirtual

Returns an identifier for this radio which is globally unique for the whole lifetime of the simulation among all radios.

Implements inet::physicallayer::IRadio.

{ return id; } // TODO

getMedium()

virtual const IRadioMedium* inet::physicallayer::NoiseSource::getMedium ( ) const

inlineoverridevirtual

Returns the radio medium where this radio is transmitting and receiving radio signals.

This function never returns nullptr.

Implements inet::physicallayer::IRadio.

{ return medium; }

getRadioGate()

virtual const cGate* inet::physicallayer::NoiseSource::getRadioGate ( ) const

inlineoverridevirtual

Returns the gate of the radio that receives incoming signals.

Implements inet::physicallayer::IRadio.

{ return radioIn; }

getRadioMode()

virtual RadioMode inet::physicallayer::NoiseSource::getRadioMode ( ) const

inlineoverridevirtual

Returns the current radio mode, This is the same mode as the one emitted with the last radioModeChangedSignal.

Implements inet::physicallayer::IRadio.

{ return RADIO_MODE_TRANSMITTER; }

getReceivedSignalPart()

virtual IRadioSignal::SignalPart inet::physicallayer::NoiseSource::getReceivedSignalPart ( ) const

inlineoverridevirtual

Returns the signal part of the ongoing reception that the receiver is currently receiving or -1 if no reception is in progress.

This is the same part as the one emitted with the last receivedPartChangedSignal.

Implements inet::physicallayer::IRadio.

{ return IRadioSignal::SIGNAL_PART_NONE; }

getReceiver()

virtual const IReceiver* inet::physicallayer::NoiseSource::getReceiver ( ) const

inlineoverridevirtual

Returns the receiver part of this radio.

This function never returns nullptr.

Implements inet::physicallayer::IRadio.

{ return nullptr; }

getReceptionInProgress()

virtual const ITransmission* inet::physicallayer::NoiseSource::getReceptionInProgress ( ) const

inlineoverridevirtual

Returns the ongoing reception that the receiver is currently receiving or nullptr.

Implements inet::physicallayer::IRadio.

{ return nullptr; }

getReceptionState()

virtual ReceptionState inet::physicallayer::NoiseSource::getReceptionState ( ) const

inlineoverridevirtual

Returns the current radio reception state.

This is the same state as the one emitted with the last receptionStateChangedSignal.

Implements inet::physicallayer::IRadio.

{ return RECEPTION_STATE_UNDEFINED; }

getTransmissionInProgress()

const ITransmission * inet::physicallayer::NoiseSource::getTransmissionInProgress ( ) const

overridevirtual

Returns the ongoing transmission that the transmitter is currently transmitting or nullptr.

Implements inet::physicallayer::IRadio.

{
    if (!transmissionTimer->isScheduled())
        return nullptr;
    else
        return static_cast<WirelessSignal *>(transmissionTimer->getContextPointer())->getTransmission();
}

getTransmissionState()

virtual TransmissionState inet::physicallayer::NoiseSource::getTransmissionState ( ) const

inlineoverridevirtual

Returns the current radio transmission state.

This is the same state as the one emitted with the last transmissionStateChangedSignal.

Implements inet::physicallayer::IRadio.

{ return TRANSMISSION_STATE_TRANSMITTING; }

getTransmittedSignalPart()

virtual IRadioSignal::SignalPart inet::physicallayer::NoiseSource::getTransmittedSignalPart ( ) const

inlineoverridevirtual

Returns the signal part of the ongoing transmission that the transmitter is currently transmitting or -1 if no transmission is in progress.

This is the same part as the one emitted with the last transmittedPartChangedSignal.

Implements inet::physicallayer::IRadio.

{ return IRadioSignal::SIGNAL_PART_WHOLE; }

getTransmitter()

virtual const ITransmitter* inet::physicallayer::NoiseSource::getTransmitter ( ) const

inlineoverridevirtual

Returns the transmitter part of this radio.

This function never returns nullptr.

Implements inet::physicallayer::IRadio.

{ return transmitter; }

handleMessage()

void inet::physicallayer::NoiseSource::handleMessage ( cMessage *  message )

overrideprotectedvirtual

{
    if (message == sleepTimer)
        startTransmission();
    else if (message == transmissionTimer)
        endTransmission();
    else
        delete message;
}

initialize()

void inet::physicallayer::NoiseSource::initialize ( int  stage )

overrideprotectedvirtual

{
    if (stage == INITSTAGE_LOCAL) {
        sleepTimer = new cMessage("sleepTimer");
        transmissionTimer = new cMessage("transmissionTimer");
        antenna = check_and_cast<IAntenna *>(getSubmodule("antenna"));
        transmitter = check_and_cast<ITransmitter *>(getSubmodule("transmitter"));
        medium.reference(this, "radioMediumModule", true);
        mediumModuleId = check_and_cast<cModule *>(medium.get())->getId();
        radioIn = gate("radioIn");
        radioIn->setDeliverImmediately(true);
    }
    else if (stage == INITSTAGE_PHYSICAL_LAYER) {
        medium->addRadio(this);
        scheduleSleepTimer();
    }
}

numInitStages()

virtual int inet::physicallayer::NoiseSource::numInitStages ( ) const

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

scheduleSleepTimer()

void inet::physicallayer::NoiseSource::scheduleSleepTimer ( )

protectedvirtual

{
    scheduleAfter(par("sleepInterval"), sleepTimer);
}

Referenced by endTransmission(), and initialize().

scheduleTransmissionTimer()

void inet::physicallayer::NoiseSource::scheduleTransmissionTimer ( const ITransmission *  transmission )

protectedvirtual

{
    scheduleAfter(transmission->getDuration(), transmissionTimer);
}

Referenced by startTransmission().

setRadioMode()

virtual void inet::physicallayer::NoiseSource::setRadioMode ( RadioMode  radioMode )

inlineoverridevirtual

Changes the current radio mode.

The actual change may take zero or more time. The new radio mode will be emitted with a radioModeChangedSignal.

Implements inet::physicallayer::IRadio.

{ throw cRuntimeError("Invalid operation"); }

startTransmission()

void inet::physicallayer::NoiseSource::startTransmission ( )

protectedvirtual

{
    WirelessSignal *signal = check_and_cast<WirelessSignal *>(medium->transmitPacket(this, nullptr));
    transmissionTimer->setContextPointer(const_cast<WirelessSignal *>(signal));
    scheduleTransmissionTimer(signal->getTransmission());
}

Referenced by handleMessage().

Member Data Documentation

antenna

const IAntenna* inet::physicallayer::NoiseSource::antenna = nullptr

protected

Referenced by initialize().

id

const int inet::physicallayer::NoiseSource::id = nextId++

protected

medium

ModuleRefByPar<IRadioMedium> inet::physicallayer::NoiseSource::medium

protected

Referenced by initialize(), startTransmission(), and ~NoiseSource().

mediumModuleId

int inet::physicallayer::NoiseSource::mediumModuleId = -1

protected

Referenced by initialize(), and ~NoiseSource().

radioIn

cGate* inet::physicallayer::NoiseSource::radioIn = nullptr

protected

Referenced by initialize().

sleepTimer

cMessage* inet::physicallayer::NoiseSource::sleepTimer = nullptr

protected

Referenced by handleMessage(), initialize(), scheduleSleepTimer(), and ~NoiseSource().

transmissionTimer

cMessage* inet::physicallayer::NoiseSource::transmissionTimer = nullptr

protected

Referenced by endTransmission(), getTransmissionInProgress(), handleMessage(), initialize(), scheduleTransmissionTimer(), startTransmission(), and ~NoiseSource().

transmitter

const ITransmitter* inet::physicallayer::NoiseSource::transmitter = nullptr

protected

Referenced by initialize().

---

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

• NoiseSource.h
• NoiseSource.cc