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:
- calculation of the resulting antenna gain
- consistency check
- the validity of the input parameter 'beam width';
- whether the value of the input parameter 'adaptive distance' conflicts with the coverage radius, taking account of the path distance factor;
- the valid system type applying this antenna.
- description
- unique name of the plugin – must not be empty;
- optional but recommended description of the plugin characteristics;
- Input annotations
note that the value 'peakGain' is setting the default value of the plugin.
Figure 506: Antenna Plugin example source code
Figure 507: Antenna Plugin configuration panel
Figure 508: Consistency check warning messages