DipoleAntenna¶

Package: inet.physicallayer.wireless.common.antenna

compound module DipoleAntenna

This antenna model describes the well-known dipole antenna or doublet. It consists of two identical conductive elements, which are bilaterally symmetrical.

Inheritance diagram¶

Extends¶

Name	Type	Description
AntennaBase	compound module	Serves as the base module for antenna 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
mobilityModule	string		The path to the mobility module relative to this module, only used if no mobility submodule is present
numAntennas	int	1	The number of antennas in the antenna array
length	double		The length of the dipole antenna
wireAxis	string	“z”	Allows matching the antenna radiation pattern (IAntennaGain) to the visual representation, antenna orientation is determined by the antenna’s mobility model

Properties¶

Name	Value	Description
class	DipoleAntenna	The default value is the Z axis, so that antenna mobility models are not required when antennas are approximately positioned in the same plane
display	i=device/antennatower

Source code¶

//
// This antenna model describes the well-known dipole antenna or doublet. It
// consists of two identical conductive elements, which are bilaterally
// symmetrical.
//
module DipoleAntenna extends AntennaBase
{
    parameters:
        double length @unit(m); // The length of the dipole antenna
        string wireAxis = default("z"); // Allows matching the antenna radiation pattern (IAntennaGain) to the visual representation, antenna orientation is determined by the antenna's mobility model
                                        // The default value is the Z axis, so that antenna mobility models are not required when antennas are approximately positioned in the same plane
        @class(DipoleAntenna);
}

File: src/inet/physicallayer/wireless/common/antenna/DipoleAntenna.ned