ApskRadio¶

Package: inet.physicallayer.wireless.apsk.packetlevel

compound module ApskRadio

This radio model provides a hypothetical radio that simply uses one of the well-known modulations without utilizing other techniques such as forward error correction, interleaving, spreading, etc.

See also: ApskScalarRadio, ScalarRadioMedium.

Inheritance diagram¶

Known subclasses¶

Name	Type	Description
ApskLayeredRadio	compound module	This radio model is part of a simple hypothetical layered radio. It produces detailed transmissions that have separate representations for all simulated domains.
ApskDimensionalRadio	compound module	(no description)
ApskScalarRadio	compound module	(no description)
ApskUnitDiskRadio	compound module	Specializes ApskRadio to use the simplified signal representation of the unit disk signal propagation model. Suitable for simulations where computational efficiency is more important than detailed physical layer modeling.

Extends¶

Name	Type	Description
FlatRadioBase	compound module	Serves as a base module for flat radio models.

Parameters¶

Name	Type	Default value	Description
displayStringTextFormat	string	“”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
radioMediumModule	string	“radioMedium”	Module path of the medium module where this radio communicates
energySourceModule	string	“”	Module path of the energy source module which provides energy to the radio
initialRadioMode	string	“off”
switchingTimes	string	“ms 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0”	Time parameters to switch between radio modes
sendRawBytes	bool	false	When true packets are serialized into a sequence of bytes before sending out
separateTransmissionParts	bool	false	When enabled the transmission of preamble, header and data part are simulated separately
separateReceptionParts	bool	false	When enabled the reception of preamble, header and data part are simulated separately
displayCommunicationRange	bool	false	If true communication range is displayed as a blue circle around the node
displayInterferenceRange	bool	false	If true interference range is displayed as a gray circle around the node
signalAnalogRepresentation	string	“scalar”
centerFrequency	double		Center frequency of the band where the radio transmits and receives signals on the medium
bandwidth	double		Bandwidth of the band where the radio transmits and receives signals on the medium
protocol	string	“”

Properties¶

Name	Value	Description
class	ApskRadio
display	i=block/wrxtx

Gates¶

Name	Direction	Size	Description
upperLayerIn	input
upperLayerOut	output
radioIn	input

Signals¶

Name	Type	Unit	Description
listeningChanged
packetDropped	inet::Packet
packetReceivedFromLower	cPacket
packetReceivedFromUpper	cPacket
packetSentToLower	cPacket
packetSentToUpper	cPacket
radioModeChanged	long
receivedSignalPartChanged	long
receptionEnded
receptionStarted
receptionStateChanged	long
transmissionEnded
transmissionStarted
transmissionStateChanged	long
transmittedSignalPartChanged	long

Statistics¶

Name	Title	Source	Record	Interpolation Mode
bitErrorRate	Bit error rate	bitErrorRate(packetSentToUpper)	histogram
minSnir	Min SNIR	minimumSnir(packetSentToUpper)	histogram
packetDropped	packets dropped		count,sum(packetBytes),vector(packetBytes)	none
packetErrorRate	Packet error rate	packetErrorRate(packetSentToUpper)	histogram
radioMode	Radio mode	radioModeChanged	count,vector	sample-hold
receptionState	Radio reception state	receptionStateChanged	count,vector	sample-hold
symbolErrorRate	Symbol error rate	symbolErrorRate(packetSentToUpper)	histogram
transmissionState	Radio transmission state	transmissionStateChanged	count,vector	sample-hold

Source code¶

//
// This radio model provides a hypothetical radio that simply uses one of the
// well-known modulations without utilizing other techniques such as forward
// error correction, interleaving, spreading, etc.
//
// @see ~ApskScalarRadio, ~ScalarRadioMedium.
//
module ApskRadio extends FlatRadioBase
{
    parameters:
        string protocol = default("");
        transmitter.typename = default("ApskTransmitter");
        receiver.typename = default("ApskReceiver");
        @class(ApskRadio);
        @signal[packetDropped](type=inet::Packet);
        @statistic[packetDropped](title="packets dropped"; record=count,sum(packetBytes),vector(packetBytes); interpolationmode=none);
}

File: src/inet/physicallayer/wireless/apsk/packetlevel/ApskRadio.ned