Package: inet.physicallayer.wireless.apsk.packetlevel

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.

See also: ApskScalarRadio, ApskScalarRadioMedium.

Inheritance diagram

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

Known subclasses

Name	Type	Description
ApskDimensionalRadio	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. It must be used in conjunction with the ApskDimensionalRadioMedium model.
ApskLayeredDimensionalRadio	compound module	This radio model is part of a simple hypothetical layered radio. It produces detailed transmissions that have separate representation for all simulated domains. It must be used in conjunction with the ApskLayeredDimensionalRadioMedium model.
ApskLayeredScalarRadio	compound module	This radio model is part of a simple hypothetical layered radio. It produces detailed transmissions that have separate representation for all simulated domains. It must be used in conjunction with the ApskLayeredScalarRadioMedium model.
ApskScalarRadio	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. It must be used in conjunction with the ApskScalarRadioMedium model.

Extends

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

Parameters

Name	Type	Default value	Description
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
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	""
signalAnalogRepresentation	string	"scalar"

Properties

Name	Value	Description
display	i=block/wrxtx
class	ApskRadio

Gates

Name	Direction	Size	Description
upperLayerIn	input
upperLayerOut	output
radioIn	input

Signals

Name	Type	Unit
packetDropped	inet::Packet

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode
packetDropped	packets dropped		count, sum(packetBytes), vector(packetBytes)		none

Scheduled messages (observed)

msg	kind	ctrl	tags	msgname	context
omnetpp::cMessage	0			transmissionTimer	filled
omnetpp::cMessage	0	WirelessSignal		receptionTimer

Direct method calls (observed)

call to	function	info
AckingMac	inet::AckingMac::receiveSignal	transmissionStateChanged
ApskDimensionalRadioMedium	inet::physicallayer::RadioMedium::addRadio	addRadio
ApskDimensionalRadioMedium	inet::physicallayer::RadioMedium::listenOnMedium	listenOnMedium
ApskDimensionalRadioMedium	inet::physicallayer::RadioMedium::receivePacket	receivePacket
ApskDimensionalRadioMedium	inet::physicallayer::RadioMedium::transmitPacket	transmitPacket
RadioMedium	inet::physicallayer::RadioMedium::addRadio	addRadio
RadioMedium	inet::physicallayer::RadioMedium::listenOnMedium	listenOnMedium
RadioMedium	inet::physicallayer::RadioMedium::receivePacket	receivePacket
RadioMedium	inet::physicallayer::RadioMedium::transmitPacket	transmitPacket

Called methods (observed)

function	info	call from
inet::physicallayer::ApskRadio::setRadioMode	setRadioMode	AckingMac

Incoming messages (observed)

gate	msg	kind	ctrl	srcModule	tags
radioIn	WirelessSignal	0		ApskRadio
upperLayerIn	Packet	0		AckingMac	DispatchProtocolInd, InterfaceReq, MacAddressInd, MacAddressReq, NetworkProtocolInd, PacketProtocolTag, SocketReq

Outgoing messages (observed)

gate	msg	kind	ctrl	destModule	tags
upperLayerOut	Packet	0		AckingMac	ErrorRateInd, PacketProtocolTag, SignalPowerInd, SignalTimeInd, SnirInd

Packet operations (observed)

chunkType	packetAction
ApskPhyHeader	insertAtFront, popAtFront

Shared Tagging operations (observed)

tagType	tagAction
	clearTags
ErrorRateInd	findTag
PacketProtocolTag	addTag, addTagIfAbsent, getTag
SnirInd	findTag

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.
//
// @see ~ApskScalarRadio, ~ApskScalarRadioMedium.
//
module ApskRadio extends FlatRadioBase
{
    parameters:
        string protocol = default("");
        string signalAnalogRepresentation @enum("scalar","dimensional") = default("scalar");
        transmitter.typename = default(signalAnalogRepresentation == "scalar" ? "ApskScalarTransmitter" : signalAnalogRepresentation == "dimensional" ? "ApskDimensionalTransmitter" : "");
        receiver.typename = default(signalAnalogRepresentation == "scalar" ? "ApskScalarReceiver" : signalAnalogRepresentation == "dimensional" ? "ApskDimensionalReceiver" : "");
        @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