Compound Module APSKScalarRadio

Package: inet.physicallayer.apskradio.packetlevel
File: src/inet/physicallayer/apskradio/packetlevel/APSKScalarRadio.ned

This radio model provides a hypothetical radio that simply uses one of the well-known modulations without utilizing other techiques such as forward error correction, interleaving, spreading, etc. It must be used in conjunction with the APSKScalarRadioMedium model.

Usage diagram:

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram:

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Extends:

Name	Type	Description
APSKRadio	compound module	This radio model provides a hypothetical radio that simply uses one of the well-known modulations without utilizing other techiques such as forward error correction, interleaving, spreading, etc.

Parameters:

Name	Type	Default value	Description
antennaType	string	"IsotropicAntenna"	NED type of the antenna model
transmitterType	string	"APSKScalarTransmitter"	NED type of the transmitter model
receiverType	string	"APSKScalarReceiver"	NED type of the receiver model
energyConsumerType	string	""	NED type of the energy consumer model
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
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
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
carrierFrequency	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

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
receptionStateChanged	long
bitErrorRate
radioModeChanged	long
transmittedSignalPartChanged	long
packetReceivedFromUpper	cPacket
receivedSignalPartChanged	long
packetErrorRate
symbolErrorRate
packetSentToUpper	cPacket
transmissionStateChanged	long
listeningChanged
minSNIR

Statistics:

Name	Title	Source	Record	Interpolation Mode
receptionState	Radio reception state	receptionStateChanged	count, vector	sample-hold
bitErrorRate	Bit error rate	bitErrorRate	histogram
radioMode	Radio mode	radioModeChanged	count, vector	sample-hold
packetErrorRate	Packet error rate	packetErrorRate	histogram
symbolErrorRate	Symbol error rate	symbolErrorRate	histogram
transmissionState	Radio transmission state	transmissionStateChanged	count, vector	sample-hold
minSNIR	Min SNIR	minSNIR	histogram

Source code:

//
// This radio model provides a hypothetical radio that simply uses one of the
// well-known modulations without utilizing other techiques such as forward
// error correction, interleaving, spreading, etc. It must be used in
// conjunction with the ~APSKScalarRadioMedium model.
//
// See also ~APSKScalarRadioMedium, ~ScalarAnalogModel, ~APSKScalarTransmitter,
// and ~APSKScalarReceiver.
//
module APSKScalarRadio extends APSKRadio
{
    parameters:
        transmitterType = default("APSKScalarTransmitter");
        receiverType = default("APSKScalarReceiver");
}