#include <ShortcutRadio.h>

Inheritance diagram for inet::physicallayer::ShortcutRadio:

Public Member Functions
virtual void	handleMessageWhenUp (cMessage *message) override

virtual void	handleUpperPacket (Packet *packet) override

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

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

virtual void	handleStartOperation (LifecycleOperation *operation) override

virtual void	handleStopOperation (LifecycleOperation *operation) override

virtual void	handleCrashOperation (LifecycleOperation *operation) override

Public Member Functions inherited from inet::OperationalMixin< cSimpleModule >
virtual	~OperationalMixin ()
	}@ More...

Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Public Member Functions inherited from inet::IPhysicalLayer
virtual	~IPhysicalLayer ()

Public Member Functions inherited from inet::physicallayer::IRadio
virtual void	setRadioMode (RadioMode radioMode)=0
	Changes the current radio mode. More...

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 void	initialize (int stage) override

virtual ShortcutRadio *	findPeer (MacAddress address)

virtual void	sendToPeer (Packet packet, ShortcutRadio peer)

virtual void	receiveFromPeer (Packet *packet)

Protected Member Functions inherited from inet::physicallayer::PhysicalLayerBase
virtual void	handleSignal (WirelessSignal *signal)

virtual void	handleLowerMessage (cMessage *message) override

virtual void	sendUp (cMessage *message)

virtual bool	isUpperMessage (cMessage *message) const override

virtual bool	isLowerMessage (cMessage *message) const override

virtual bool	isInitializeStage (int stage) const override

virtual bool	isModuleStartStage (int stage) const override

virtual bool	isModuleStopStage (int stage) const override

Protected Member Functions inherited from inet::LayeredProtocolBase
virtual void	handleSelfMessage (cMessage *message)

virtual void	handleUpperMessage (cMessage *message)

virtual void	handleUpperCommand (cMessage *message)

virtual void	handleLowerCommand (cMessage *message)

virtual void	handleLowerPacket (Packet *packet)

Protected Member Functions inherited from inet::OperationalMixin< cSimpleModule >
virtual int	numInitStages () const override

virtual void	refreshDisplay () const override

virtual void	handleMessage (cMessage *msg) override

virtual void	handleMessageWhenDown (cMessage *msg)

virtual bool	handleOperationStage (LifecycleOperation operation, IDoneCallback doneCallback) override
	Perform one stage of a lifecycle operation. More...

virtual State	getInitialOperationalState () const
	Returns initial operational state: OPERATING or NOT_OPERATING. More...

virtual void	handleActiveOperationTimeout (cMessage *message)

virtual bool	isUp () const
	utility functions More...

virtual bool	isDown () const

virtual void	setOperationalState (State newState)

virtual void	scheduleOperationTimeout (simtime_t timeout)

virtual void	setupActiveOperation (LifecycleOperation operation, IDoneCallback doneCallback, State)

virtual void	delayActiveOperationFinish (simtime_t timeout)

virtual void	startActiveOperationExtraTime (simtime_t delay=SIMTIME_ZERO)

virtual void	startActiveOperationExtraTimeOrFinish (simtime_t extraTime)

virtual void	finishActiveOperation ()

Protected Attributes
RadioMode	radioMode = RADIO_MODE_OFF

double	bitrate = NaN

cPar *	lengthOverhead = nullptr

cPar *	durationOverhead = nullptr

cPar *	propagationDelay = nullptr

cPar *	packetLoss = nullptr

TransmissionState	transmissionState = TRANSMISSION_STATE_UNDEFINED

Protected Attributes inherited from inet::physicallayer::PhysicalLayerBase
int	upperLayerInGateId = -1

int	upperLayerOutGateId = -1

int	radioInGateId = -1

Protected Attributes inherited from inet::OperationalMixin< cSimpleModule >
State	operationalState

simtime_t	lastChange

Operation	activeOperation

cMessage *	activeOperationTimeout

cMessage *	activeOperationExtraTimer

Static Protected Attributes
static std::map< MacAddress, ShortcutRadio * >	shortcutRadios

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

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

Protected Types inherited from inet::OperationalMixin< cSimpleModule >
enum	State

Member Function Documentation

◆ findPeer()

ShortcutRadio * inet::physicallayer::ShortcutRadio::findPeer ( MacAddress address )

protectedvirtual

 {
     auto it = shortcutRadios.find(address);
     return (it == shortcutRadios.end()) ? nullptr : it->second;
 }

Referenced by handleUpperPacket().

◆ getAntenna()

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

inlineoverridevirtual

Returns the antenna used by the transceiver of this radio.

This function never returns nullptr.

Implements inet::physicallayer::IRadio.

51 { return nullptr; }

◆ getId()

virtual int inet::physicallayer::ShortcutRadio::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.

50 { return -1; }

◆ getMedium()

virtual const IRadioMedium* inet::physicallayer::ShortcutRadio::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.

54 { return nullptr; }

◆ getRadioGate()

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

inlineoverridevirtual

Returns the gate of the radio that receives incoming signals.

Implements inet::physicallayer::IRadio.

45 { return gate("radioIn"); }

◆ getRadioMode()

virtual RadioMode inet::physicallayer::ShortcutRadio::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.

46 { return radioMode; }

◆ getReceivedSignalPart()

virtual IRadioSignal::SignalPart inet::physicallayer::ShortcutRadio::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.

58 { return IRadioSignal::SIGNAL_PART_WHOLE; }

◆ getReceiver()

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

inlineoverridevirtual

Returns the receiver part of this radio.

This function never returns nullptr.

Implements inet::physicallayer::IRadio.

53 { return nullptr; }

◆ getReceptionInProgress()

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

inlineoverridevirtual

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

Implements inet::physicallayer::IRadio.

56 { return nullptr; }

◆ getReceptionState()

virtual ReceptionState inet::physicallayer::ShortcutRadio::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.

48 { return RECEPTION_STATE_UNDEFINED; }

◆ getTransmissionInProgress()

virtual const ITransmission* inet::physicallayer::ShortcutRadio::getTransmissionInProgress ( ) const

inlineoverridevirtual

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

Implements inet::physicallayer::IRadio.

55 { return nullptr; }

◆ getTransmissionState()

virtual TransmissionState inet::physicallayer::ShortcutRadio::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.

49 { return transmissionState; }

◆ getTransmittedSignalPart()

virtual IRadioSignal::SignalPart inet::physicallayer::ShortcutRadio::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.

57 { return IRadioSignal::SIGNAL_PART_WHOLE; }

◆ getTransmitter()

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

inlineoverridevirtual

Returns the transmitter part of this radio.

This function never returns nullptr.

Implements inet::physicallayer::IRadio.

52 { return nullptr; }

◆ handleCrashOperation()

virtual void inet::physicallayer::ShortcutRadio::handleCrashOperation ( LifecycleOperation * operation )

inlineoverridevirtual

Implements inet::OperationalMixin< cSimpleModule >.

63 {} // TODO implementation

◆ handleMessageWhenUp()

void inet::physicallayer::ShortcutRadio::handleMessageWhenUp ( cMessage * message )

overridevirtual

Reimplemented from inet::LayeredProtocolBase.

 {
     if (message->getArrivalGate() == gate("radioIn"))
         receiveFromPeer(check_and_cast<Packet *>(message));
     else
         PhysicalLayerBase::handleMessageWhenUp(message);
 }

◆ handleStartOperation()

virtual void inet::physicallayer::ShortcutRadio::handleStartOperation ( LifecycleOperation * operation )

inlineoverridevirtual

Implements inet::OperationalMixin< cSimpleModule >.

61 {} // TODO implementation

◆ handleStopOperation()

virtual void inet::physicallayer::ShortcutRadio::handleStopOperation ( LifecycleOperation * operation )

inlineoverridevirtual

Implements inet::OperationalMixin< cSimpleModule >.

62 {} // TODO implementation

◆ handleUpperPacket()

void inet::physicallayer::ShortcutRadio::handleUpperPacket ( Packet * packet )

overridevirtual

Reimplemented from inet::LayeredProtocolBase.

 {
     auto destination = packet->getTag<MacAddressReq>()->getDestAddress();
     transmissionState = IRadio::TRANSMISSION_STATE_TRANSMITTING;
     emit(transmissionStateChangedSignal, transmissionState);
     if (destination.isBroadcast()) {
         for (auto it : shortcutRadios)
             if (it.second != this)
                 sendToPeer(packet->dup(), it.second);
         delete packet;
     }
     else {
         auto peer = findPeer(destination);
         if (peer != nullptr)
             sendToPeer(packet, peer);
         else
             throw cRuntimeError("ShortcutRadio not found");
     }
     transmissionState = IRadio::TRANSMISSION_STATE_IDLE; // TODO zero time transmission simulated
     emit(transmissionStateChangedSignal, transmissionState);
 }

◆ initialize()

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

overrideprotectedvirtual

Reimplemented from inet::physicallayer::PhysicalLayerBase.

 {
     PhysicalLayerBase::initialize(stage);
     if (stage == INITSTAGE_LOCAL) {
         bitrate = par("bitrate");
         lengthOverhead = &par("lengthOverhead");
         durationOverhead = &par("durationOverhead");
         propagationDelay = &par("propagationDelay");
         packetLoss = &par("packetLoss");
         gate("radioIn")->setDeliverImmediately(true);
     }
     // TODO INITSTAGE
     else if (stage == INITSTAGE_LINK_LAYER) {
         auto interfaceTable = getModuleFromPar<IInterfaceTable>(par("interfaceTableModule"), this);
         auto networkInterface = CHK(interfaceTable->findInterfaceByInterfaceModule(this));
         auto address = networkInterface->getMacAddress();
         shortcutRadios[address] = this;
     }
 }

◆ receiveFromPeer()

void inet::physicallayer::ShortcutRadio::receiveFromPeer ( Packet * packet )

protectedvirtual

 {
     auto& packetProtocolTag = packet->getTagForUpdate<PacketProtocolTag>();
     if (packetProtocolTag->getProtocol() == &Protocol::shortcutPhy) {
         const auto& header = packet->popAtFront<ShortcutPhyHeader>();
         packetProtocolTag->setProtocol(header->getPayloadProtocol());
     }
     emit(packetSentToUpperSignal, packet);
     send(packet, gate("upperLayerOut"));
 }

Referenced by handleMessageWhenUp().

◆ sendToPeer()

void inet::physicallayer::ShortcutRadio::sendToPeer	(	Packet *	packet,
		ShortcutRadio *	peer
	)

protectedvirtual

 {
     if (dblrand() < packetLoss->doubleValue()) {
         EV_WARN << "Packet " << packet << " lost.";
         delete packet;
     }
     else {
         auto length = b(lengthOverhead->intValue());
         if (length < b(0))
             throw cRuntimeError("invalid lengthOverhead value: %li bit", length.get());
         if (length > b(0)) {
             auto& protocolTag = packet->getTagForUpdate<PacketProtocolTag>();
             auto header = makeShared<ShortcutPhyHeader>();
             header->setChunkLength(length);
             header->setPayloadProtocol(protocolTag->getProtocol());
             packet->insertAtFront(header);
             protocolTag->setProtocol(&Protocol::shortcutPhy);
         }
         simtime_t transmissionDuration = packet->getBitLength() / bitrate + durationOverhead->doubleValue();
         packet->setDuration(transmissionDuration);
         sendDirect(packet, propagationDelay->doubleValue(), transmissionDuration, peer->gate("radioIn")->getPathStartGate());
     }
 }

Referenced by handleUpperPacket().

◆ setRadioMode()

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

inlineoverridevirtual

47 { this->radioMode = radioMode; }

Member Data Documentation

◆ bitrate

double inet::physicallayer::ShortcutRadio::bitrate = NaN

protected

Referenced by initialize(), and sendToPeer().

◆ durationOverhead

cPar* inet::physicallayer::ShortcutRadio::durationOverhead = nullptr

protected

Referenced by initialize(), and sendToPeer().

◆ lengthOverhead

cPar* inet::physicallayer::ShortcutRadio::lengthOverhead = nullptr

protected

Referenced by initialize(), and sendToPeer().

◆ packetLoss

cPar* inet::physicallayer::ShortcutRadio::packetLoss = nullptr

protected

Referenced by initialize(), and sendToPeer().

◆ propagationDelay

cPar* inet::physicallayer::ShortcutRadio::propagationDelay = nullptr

protected

Referenced by initialize(), and sendToPeer().

◆ radioMode

RadioMode inet::physicallayer::ShortcutRadio::radioMode = RADIO_MODE_OFF

protected

◆ shortcutRadios

std::map< MacAddress, ShortcutRadio * > inet::physicallayer::ShortcutRadio::shortcutRadios

staticprotected

Referenced by findPeer(), handleUpperPacket(), and initialize().

◆ transmissionState

TransmissionState inet::physicallayer::ShortcutRadio::transmissionState = TRANSMISSION_STATE_UNDEFINED

protected

Referenced by handleUpperPacket().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ findPeer()

◆ getAntenna()

◆ getId()

◆ getMedium()

◆ getRadioGate()

◆ getRadioMode()

◆ getReceivedSignalPart()

◆ getReceiver()

◆ getReceptionInProgress()

◆ getReceptionState()

◆ getTransmissionInProgress()

◆ getTransmissionState()

◆ getTransmittedSignalPart()

◆ getTransmitter()

◆ handleCrashOperation()

◆ handleMessageWhenUp()

◆ handleStartOperation()

◆ handleStopOperation()

◆ handleUpperPacket()

◆ initialize()

◆ receiveFromPeer()

◆ sendToPeer()

◆ setRadioMode()

Member Data Documentation

◆ bitrate

◆ durationOverhead

◆ lengthOverhead

◆ packetLoss

◆ propagationDelay

◆ radioMode

◆ shortcutRadios

◆ transmissionState