Graphical User Interface Guide for Fixed Service

1. General Information

1.1 General Description

This harmonized calculation method for the fixed service is part of the HCM4A Agreement. The GUI program, empowered by the calculation library (DLL), provides means to assess interference between fixed point-to-point links, which may include one passive back-to-back antenna repeater, described in the file format following Annex 2B of the Agreement.

HCM4A software for fixed service consists of two parts – the calculation library (hcm4afs.dll) and the program (CalcFS4A). The implementation of both reuses many elements from the similar software developed for the HCM Agreement in Europe, but implemented independently for the HCM4A Agreement. All calculations are being made in the calculation library. CalcFS4A does not make calculations by itself; instead it uses the library functions calls for calculations. However, the detailed procedure how to account all potential combination of interference paths through passive repeaters are described within the GUI program. This document serves as a user's guide to the GUI program. Although the HCM4A software is developed for Microsoft Windows operating system, it may also be compiled for Linux or MacOS. In case calculation result for Microsoft Windows differs from the version for other OS, version of the HCM4A for fixed service for Windows OS will be the reference.

1.2 General Note

In this description (unless stated differently):

  • All angles are in degrees
  • All heights are in meters
  • All distances are in kilometers

2. HCM4A Calculation Program for Fixed Service (CalcFS4A)

CalcFS4A is created to help Administrations perform interference calculations according to HCM4A Agreement. In addition to that main purpose it allows creating, editing, checking, and comparing HCM4A formatted files.

The GUI program code is cross-platform. Although the main platform for compilation is Windows, it may also be compiled for Linux and MacOS. The program is created using C++ and U++ framework.

2.1 Interference Calculations

CalcFS4A performs two types of interference calculations:

  • List to list calculations: In this case user has to provide CalcFS4A with two files. One has to contain reference list of stations, another – the list of stations being tested. This is the main mode of the software to be used for cross-border coordination interference analysis.
  • Single entry calculations: Program calculates interference just for a single case. User has to provide the program with the file containing either 2 or 4 records depending on whether passive repeater is present. This mode is mainly used for testing.

2.1.1 List to list calculations

List to list calculations perform analysis of one file of stations entries against another. Before performing calculations, you need to set appropriate paths required by CalcFS4A calculation library (hcm4afs.dll). See section on setting up path further in the document.

To perform the calculations, click the menu entry Calculations/List – to List Calculations or the list-to-list button List to List Calculations Button.

Choose HCM4A file dialog box will appear, if files haven't been uploaded yet (see section 2.4 on opening files).

Under HCM4A testing file a file received from a neighboring country or being sent to the neighboring country should be chosen. HCM4A reference data file represents already coordinated stations. After clicking the button Choose HCM4A files dialog box pops up. In this case 2 file can be submitted, for example files, ETH 10-9 and KEN 10-9. These files have header fields, but header could be omitted as well (for upload, saving always inserts empty header).

ETH 10-9: ETH 10-9 File KEN 10-9: KEN 10-9 File

HCM Data File Selection

HCM Data File View

HCM Reference Data File View

Calculation Parameters

Calculation Report

Detailed Calculation Report

2.1.2 Single entry calculations

The calculations are performed by clicking the menu entry Calculations/Single Entry Calculations or the single entry button Single Entry Button.

The program behaves very similar to the List to list calculation case. After clicking the button Choose HCM4A file dialog box pops up. In this case only one file need to be submitted, for example file, KEN 6-ETH 2. As in the List to list case, such file could be uploaded in advance and the button will skip the dialog to select entry file.

KEN 6-ETH 2 KEN 6-ETH 2 File

Choose HCM4A file dialog box

HCM Data File View KEN ETH

Program also writes to the report cases when error occurs. After calculations are started report window will pop up showing calculation progress. Calculations produce similar report as in the List to list calculation case.

Single Entry Calculation Report

By double-clicking a report entry Detailed Calculation Report appears.

Detailed Single Entry Calculation Report

2.2 Trigger for Coordination

The purpose of trigger for coordination is to provide user with the information whether stations require co-ordination. The evaluation is performed according to Annex 11 to the HCM4A Agreement.

In order to perform such evaluation border data must be present on the computer disk and path to the border data has to be set (see the section on path further down the document).

To start calculations, activate menu entry Calculations\Trigger for Coordination or click the trigger button Trigger Button.

You will be asked to provide file with the stations formatted according to Annex 2B to the HCM-Agreement. For example, we will use the file KEN 1-2 (header is omitted). It should be noted that this button doesn't apply the evaluation to stations in the test tab. It performs the evaluation only for stations in the file provided in a dialog box initiated by this button.

KEN 1-2 File

After completing the calculations using the file KEN 1-2, are complete the report will be shown.

Trigger Calculation Report

The report shows Station name, reference, error code, and countries to coordinate with. If field Countries is empty this means that station does not need co-ordination (it is too far away from any country border). The evaluation also shows the border of its own country, which could be ignored.

2.3 CalcFS4A Options

CalcFS4A options can be accessed under main menu Tools\Options or by pressing the options button Options Button.

It contains all available program settings.

2.3.1 Paths

In order to work properly CalcFS4A requires several paths set correctly. The menu to set path includes three entries.

Paths Configuration

Directory of topological data is mandatory data defining path to topological data used by hcm4afs.dll. Directory of morphological data is optional and required only by those countries which are located near a sea. Directory of border data is mandatory only for evaluation of the trigger for co-ordination.

2.3.2 Calculation

There are certain triggers that prevent unnecessary calculations thus speeding up the calculation process. The form below forces the software to perform calculations, if the following conditions are met:

Calculation Options

There are two parameters which trigger calculations. It is frequency difference TX and RX, and distance between TX and RX. If both conditions are met, calculations are performed. A separate parameter to assess the need to calculate interference between a passive repeater and a potential victim receiver. The third parameter limits calculations, which include

2.3.3 Control of input parameters

Control over the values of input parameters can be enabled or disabled. This control currently provides only basic check of the type of input parameter (numerical, string, etc.).

Control Parameters

2.4 File Editing

CalcFS4A can create a new HCM4A file for fixed service; also can edit one by changing data, adding, duplicating or deleting records.

Create a new file To create a new file, go to File\New, or press the New button New File Button.

Open an existing file To open an existing file, go to File\Open, or press the Open button Open File Button.

Save a file To save a file, go to File\Save, or press the Save button Save Button.

There is a command File\Save As available, as well as a Save As button, which always shows Save parameters dialog box. The program allows saving and making other actions on a file with an empty header. Although Save command does not show Save parameters dialog box, it also does not include HCM4A for fixed service header, if file being saved does not have one Save As Button.

Buttons are also duplicated in the file menu.

File Menu

Validating a file The contents of uploaded file or files (List to list case) could be validated against the requirements of Annex 2B of the Agreement by pressing the Validate button Validate Button or via the Tools menu.

Tools Menu

The result of such check is shown below.

Validation Result

It should be noted that not all mandatory parameters as stated in the Annex 2B of the Agreement are actually required for the calculations. The list of parameters, which are mandatory for calculations, is shown below.

Mandatory Tx data Mandatory Rx data
Tx Type of entry (0A) Rx Type of entry (0A)
Tx frequency (1A) Rx frequency (1A)
Tx frequency unit (1A1) Rx frequency unit (1A1)
Tx co-ordinates (4C) Rx co-ordinates (4C)
Tx height of site above sea level (4Z) Rx height of site above sea level (4Z)
Tx power (8B) Rx azimuth (9A)
Tx azimuth (9A) Rx elevation (9B)
Tx elevation (9B) Rx polarization (9D)
Tx polarization (9D) Rx noise power level FkTB (9H)
Tx antenna height above ground (9Y) Rx antenna height above ground (9Y)
Tx antenna gain (9X1) Rx antenna gain (part of 9X1)

Add a record or delete a record To add the record in the list of station one need to press right click on the form, listing stations records, to open a pop-up menu with such command. The same menu also has the "Delete" command to delete specific record (based on the position of the mouse cursor).

Add Delete Record

The GUI provides functionality to edit of any record of the file opened by the GUI program. To edit specific parameter, one should select the form, which shows this parameter, and use right-click to open up edit menu. This will provide access to change elements within this form.

Edit Record

2.5 Update of the GUI Program and DLL

For simplicity of deployment the update is done by downloading updated version of the GUI program, overwriting existing files. The version of the program is reflected in the name of the main window. The version of the calculation library is shown in the detailed log of calculations. The contents of CalFS4A folder are shown below. Thus, updating these files with newer versions is the only action required for the update. In some cases only executable file (.exe) or .dll may be updated, if modifications are minor.

Program Files

2.6 Installer

For simplicity of deployment the GUI program is distributed as a portable software, meaning it is enough to copy a folder with the software (and to properly set paths to topographical and morphological data) to the computer to start using it without any need for traditional installation. If required the installation setup could be created, but the software doesn't require any specific permissions or register record to operate properly anyway.