DipoleAntenna

Package: inet.physicallayer.wireless.common.antenna

DipoleAntenna

compound module

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

mobility : like IMobility

IMobility: The module interface for mobility models.

Source:
mobility: <default("")> like IMobility if typename != "" {
    parameters:
        @display("p=100,100;is=s");
}

Inheritance diagram

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

Extends

Name Type Description
AntennaBase compound module

This module servces as the base module for antenna models.

Parameters

Name Type Default value Description
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 the default value is Z axis, so that antenna mobility models are not required when antennas are approximately positioned in the same plane

Properties

Name Value Description
display i=device/antennatower
class DipoleAntenna

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