A18.6 EXAMPLE OF AP

This simple example of an Antenna plugin modifies within a given beam width the resulting antenna gain proportional to the ratio of the actual distance and the distance 'of adaption'.

It aims to show

  • the basic structure of an antenna plugin which is creating its own Input interface;
  • how to set up basic consistency checks;
  • how to define input annotations including tool tip information.


Note that for simplicity Runtime Exceptions have not been included.


The structure details are:

  1. calculation of the resulting antenna gain
  2. consistency check
    1. the validity of the input parameter 'beam width';
    2. whether the value of the input parameter 'adaptive distance' conflicts with the coverage radius, taking account of the path distance factor;
    3. the valid system type applying this antenna.
  3. description
    1. unique name of the plugin – must not be empty;
    2. optional but recommended description of the plugin characteristics;
  4. Input annotations
    note that the value 'peakGain' is setting the default value of the plugin.

Figure 514: Antenna Plugin example source code

Figure 515: Antenna Plugin configuration panel


Figure 516: Consistency check warning messages