Cellopt2 File Interface: Revision 10
Cellopt2 File Interface: Revision 10
Technical Reference
Revision 10
www.actix.com
The content of this manual is provided for information only, is subject to change without notice, and should not be construed as a commitment by Actix. Actix assumes no responsibility or liability for any errors or inaccuracies that appear in this documentation. Copyright Actix 2009. All rights reserved. All trademarks are hereby acknowledged.
www.actix.com
Contents
1 INTRODUCTION ..........................................................................................4 2 DESCRIPTION ............................................................................................5
2.1 INPUT FILE ..................................................................................................... 5 2.2 MESSAGE ....................................................................................................... 5 2.3 MNEMONICS .................................................................................................... 5 2.4 MASK ........................................................................................................... 6 2.5 MODEL .......................................................................................................... 6 2.6 LIST ............................................................................................................. 6 2.7 DATA ............................................................................................................ 7
3 CONTENT .................................................................................................8
3.1 ACATR ......................................................................................................... 8 3.2 ACDAT ......................................................................................................... 8 3.3 ALAYR .......................................................................................................... 9 3.4 ALIST........................................................................................................... 9 3.5 ALOAD ......................................................................................................... 9 3.6 IANTN ........................................................................................................ 10 3.7 ICARF ........................................................................................................ 10 3.8 ICARL ........................................................................................................ 11 3.9 ICODE ....................................................................................................... 12 3.10 ICOFL ...................................................................................................... 12 3.11 ICONC...................................................................................................... 13 3.12 ICONF ...................................................................................................... 14 3.13 ICPAR ...................................................................................................... 15 3.14 IFREQ ...................................................................................................... 15 3.15 IFRQG ...................................................................................................... 16 3.16 ISECT ...................................................................................................... 16 3.17 ISITE ....................................................................................................... 17 3.18 IMXSP ...................................................................................................... 17
www.actix.com
Introduction 4
1 Introduction
This document describes some of the messages that form the Cellopt AFP 2 generic file interface. The described messages are necessary for correctly creating input data files. Some necessary Cellopt AFP concepts and definitions are explained to help you understand the data needed for the input files. Chapter 4 gives examples of the most common input files for Cellopt AFP, and how they are created with different messages.
www.actix.com
Description 5
2 Description
This chapter contains the descriptions of the different types of definitions that need to be understood.
2.2 Message
A message is a single line of information beginning with a mnemonic, a model name and, optionally, fields separated by a TAB (ASCII character 9). These messages give you a powerful way of defining the input data to Cellopt AFP. There are two different basic types of messages, input messages and application messages. The input messages have the letter i as the first character in the mnemonic and is used for sending data into Cellopt AFP 2. The application messages have the letter a as the first character in the mnemonic and is used for sending commands and some data into Cellopt AFP 2.
2.3 Mnemonics
Different mnemonics are used to define the different types of messages. Important mnemonics for the file interface are: iSECT - Used to define sectors in the network. iCARF - Used to define radios in the network. iFRQG - Used to define which frequencies belongs to a Sub set/Set /MAL. iCONC - Used to define a relation between two radios or sectors, e.g. neighbour relation, interference, exception.
PROPRIATARY AND CONFIDENTIAL www.actix.com
Description 6
iCONF - Used to define illegal/ forbidden frequencies for a radio. iCOFL - Used to define illegal/ forbidden frequencies for all radios in a layer. iCARL - Used to define a specific category and layer for a specific radio. aLOAD - Used for loading a file. aLIST - Used for creating a list. aCATR - Used for creating a category. aLAYR - Used for creating a layer.
2.4 Mask
The mask defines which bits are valid for the message. The first bit in the message is the least significant bit. A 1 means that the data field is valid and a 0 means that it will not be taken into account. Here is an example of a mask for a message of the form: Mnemonic Model Mask Data1 Data2 Data3 Data4 Data5 Data6
in which we require the model and mask bits, and data bits 1,3 and 6.
Model 1 1
Mask 1 2
Data1 1 4
Data2 0 0
Data3 1 16
Data4 0 0
Data5 0 0
Data6 1 128
In this case, the mask should be set to 151 and the data Data1, Data3 and Data6 will be read into Cellopt AFP. Note that the model and mask data fields must be included in the mask itself, but the mnemonic field must not. If the model and mask fields of the mask i.e. the two least significant bits, are set to 0 the message will be a delete message and those data fields that are set will be deleted. To help with the mask, you can use the table below or a calculator that can convert binary to decimal.
d0 Value Sum 1 1
d1 2 3
d2 4 7
d3 8 15
d4 16 31
d5 32 63
d6 64 127
d7 128 255
d8 256 511
d9 512 1023
2.5 Model
A model is the representation of the network structure and behaviour, containing the penalties, settings and the files to be loaded. The model part of the message could be seen as a default name of a model. This name will be changed inside Cellopt AFP to the model name in which the file is loaded. Therefore, use e.g. model as the model name in the input file.
2.6 List
A list is a set of assignment restrictions, e.g. a set of several messages having the same behaviour. Cellopt AFP uses three different types of lists, frequency penalty lists, and separation penalty lists and separation penalties with statistics lists.
PROPRIATARY AND CONFIDENTIAL www.actix.com
Description 7
2.7 Data
A data field can be of any of the following types: char, int or float. The asterix (*) character is used as a wild character and an empty data field should be represented with the dash (-) character.
www.actix.com
Content 8
3 Content
This chapter explains the content of the different data fields in the messages.
3.1 aCATR
Name: Define a New Category Description: Defines a new category. Message: aCATR category_name Data category_name Description The name of the category that will be created Data Type Char Range
3.2 aCDAT
Name: Define a new sector alias. Description: Defines a new sector alias. Message: aCDAT type site sector carrier aliasmap_name alias Data type site sector carrier aliasmap_name alias Description For sector alias, type should be 4. No other values are currently supported. Name of site to which alias is applied Name of sector to which alias is applied Unused, set to * Data Type Int Char Char Char Char Char Range 0-5
Usage: Used to define new sector aliases in Cellopt AFP. All values are tab separated.
aCDAT aCDAT aCDAT 4 4 4 183_1 183_1 183_1 0 1 2 * * * SwitchName SwitchName SwitchName BX02537A BX02537B BX02537C
www.actix.com
Content 9
3.3 aLAYR
Name: Define a New Layer Description: Defines a new layer in Cellopt AFP.. Message: aLAYR category_name layer_name Data category_name layer_name Description The name of the category that the layer will belong to The name of the layer that will be created Data Type Char Char Range
3.4 aLIST
Name: Create a List Description: Creates a new list in Cellopt AFP Message: aLIST list_desc type_of_penalty Data List_desc Type_of_penalty Description Name of the list that will be created. Which type of penalty the list contains Data Type Char Int 0 frequency penalties 1 separation penalties with statistics 2 separation penalties Usage: Used to create a new list. Must be used before using the messages iCONC, iCOFL and iCONF into a new list. Range
3.5 aLOAD
Name: Load a File Description: Loads a file into Cellopt AFP. Message: aLOAD FileType FileName ListName Data FileType Description The file type of the file Data Type Int Range 1 Cellopt AFP 2 Generic Format 0 All other formats FileName ListName Name of the file Name of the lists that will be created. Optional numbers of these. Char Char
www.actix.com
Content 10
3.6 iANTN
Name: Antenna Record Description: The record defining the sectors antenna data. Message: iANTN model mask site_desc sector_desc azimuth height tilt beamwidth antenna_type Data Site_desc Description The site name or number. Data Type Char Range The wild character (*) is not allowed The wild character (*) is not allowed 0-360 >=0 Negative is uptilt 0-360
Sector_desc
The sector name or number. A site can have many sectors and are then separated by this description The azimuth of the antenna used for this sector The height of the antenna The tilt of the antenna The beamwidth of the antenna used for this sector The antenna model used for this sector
Char
Usage: Used to create antennae in the network. This message gives the antenna configuration data for the sectors. This message could be used for the Radio Database if the features in Cellopt AFP that is using antenna data including the use in Cellopt MDA and the Radioplan map.
3.7 iCARF
Name: Carrier Record Description: The record defining the carrier data. Message: iCARF model mask site_desc sector_desc car_desc freq frq_id served_traffic code_desc fix_id position control_id HSN MAIO Data Site_desc Description The site name or number. Data Type Char Range The wild character (*) is not allowed The wild character (*) is not allowed The wild character (*) is not allowed
Sector_desc
The sector name or number. A site can have many sectors and are then separated by this description The radio name or number
Char
Car_desc
Char
Freq
Int
www.actix.com
Content 11
Data Frq_id
Description
The amount of traffic that is served by this radio The color code for this radio. Whether this radio is fixed to the freq value or if it is free to change. This can be changed inside Cellopt AFP The position in the sector for this radio
>=0
0 = free 1 = fixed
Position
Int
>0 and unique for this radio on this site and sector. 0 = not control radio 1 = control radio 0-63
Control_id
Int
HSN MAIO
The Hopping Sequence Number for this radio The MAIO for this radio
Int Int
Usage: Used to create radios in the network and the specific characteristics for radios. This is the second part in creating the Radio Database.
3.8 iCARL
Name: Carrier Category Layer Record Description: The record defining the category and layer for this radio Message: iCARL model site_desc sector_desc car_desc cat_desc layer_desc Data Site_desc Sector_desc Description The site name or number. The sector name or number. A site can have many sectors and are then separated by this description The radio name or number. If the wild character (*) is used this relation will be valid for the whole sector. The Category name. The layer name. Data Type Char Char Range The wild character (*) is not allowed The wild character (*) is not allowed
Car_desc
Char
Cat_desc Layer_desc
Char Char
The wild character (*) is not allowed The wild character (*) is not allowed
Usage: Used to set the category and layer for specific radios.
www.actix.com
Content 12
3.9 iCODE
Name: Color Code Record Description: The record defining a globally available color code. Data Model Mask Code_desc Only delete used. Description Data Type Char * Int Char * Range
3.10 iCOFL
Name: Frequency Constraint List Description: The record defining the extra penalty values for an illegal/forbidden frequency for the Category and Layer in a list. Message: iCOFL model mask cat_desc layer_desc freq list_desc coPenalty adjPenalty sep_req Data Cat_desc Layer_desc Freq list_desc Description The Category name. The layer name. The frequency illegal/forbidden to the radio. The list where the illegal/forbidden frequencies is stored. The co-channel penalty for assigning the above frequency to the above radio/sector. The adj-channel penalty for assigning the above frequency to the above radio/sector. The separation for the relation above. Data Type Char Char Int Char = ListIllegalFrequency or ListForbiddenFrequency >=0 Penalty not applicable for forbidden frequencies. Float >=0 Penalty not applicable for forbidden frequencies. Int 0,1,2,.. Range The wild character (*) is not allowed The wild character (*) is not allowed
CoPenalty
Float
AdjPenalty
Sep_req
Usage: Used to create radios in the network and the specific characteristics for radios. This message is used to create illegal/forbidden frequency lists.
www.actix.com
Content 13
3.11 iCONC
Name: Carrier Constraint Relation Description: The record defining the statistic values between two radios or between two sectors. Message: iCONC model mask site_desc sector_desc car_desc site_R_desc sector_R_desc car_R_desc list_desc coStatistic adjStatistic sep_req Data Site_desc Description The serving site name or number. Data Type Char Range The wild character (*) is not allowed The wild character (*) is not allowed
Sector_desc
The serving sector name or number. A site can have many sectors and are then separated by this description The serving radio name or number. If the wild character (*) is used this relation will be valid for the whole sector. The interfering/neighbour site name or number. The serving sector name or number. A site can have many sectors and are then separated by this description
Char
Car_desc
Char
Site_R_desc
Char
The wild character (*) is not allowed The wild character (*) is not allowed. Not allowed to equal sector_desc if site_desc equal site_R_desc
Sector_R_desc
Char
Car_R_desc
The serving radio name or number. If the wild character (*) is use this relation will be valid for the whole sector. The list where the relation is kept. The list must have been created with the aLIST message. The co-channel statistic for the relation above. The adj-channel statistic the relation above. The separation for the relation above.
Char
list_desc
Char
Usage: Used to create radios in the network and the specific characteristics for radios. This message is used to create Interference Lists, Neighbour Lists and Exception Lists. For the last two types of lists the statistics fields are typically set to 0. Note: For separations penalty lists the separation can be set either in the input messages or in the program. The optimiser will take the highest set separation as the valid one. To have the ability to change the separation the separation in the input file should be set to 0. For separations penalty with statistics lists the separation can only be set in the input file.
www.actix.com
Content 14
The most usual separation value for those is 2. Separation with higher values than 2 will use the adjStatistic as statistic.
3.12 iCONF
Name: Frequency Constraint Relation Description: The record defining the extra penalty values between a radio, or a sector, or a network and an illegal/ forbidden frequency. Message: iCONF model mask site_desc sector_desc car_desc freq list_desc coPenalty adjPenalty sep_req Data Site_desc Sector_desc Description The site name or number. The sector name or number. A site can have many sectors and are then separated by this description The radio name or number. If the wild character (*) is used this relation will be valid for the whole sector. The frequency illegal/ forbidden to the radio. The list where the illegal/ forbidden frequencies is stored. The name of the list have to be ListIllegalFrequency or ListForbiddenFrequency The co-channel penalty for assigning the above frequency to the above radio/sector. The adj-channel penalty for assigning the above frequency to the above radio/sector. The separation for the relation above. Data Type Char Char Range The wild character (*) is not allowed The wild character (*) is not allowed
Car_desc
Char
Freq list_desc
CoPenalty
Float
>=0
AdjPenalty
Float
>=0
Sep_req
Int
0,1,2,..
Usage: Used to create radios in the network and the specific characteristics for radios. This message is used to create illegal/forbidden frequency lists.
www.actix.com
Content 15
3.13 iCPAR
Name: Concentric parent Description: The record associating inner cells with parent outer cells. Message: iCPAR inner_site_desc inner_sector_desc outer_site_desc outer_sector_desc Data Inner_site_desc Description The name of the site containing the inner sector. The name of the inner sector. The name of the site containing the outer sector. The name of the outer sector. Data Type Char Range The wild character (*) is not allowed The wild character (*) is not allowed The wild character (*) is not allowed The wild character (*) is not allowed
Inner_sector_desc Outer_site_desc
Char Char
Outer_sector_desc
Char
Usage: Used to match inner sectors with their parent outer sectors.
3.14 iFREQ
Name: Frequency Record Description: The record defining a globally available frequency. Data Model Mask Frq_id Only delete used. Description Data Type Char * Int Int >=0 Range
Usage: The frequencies are treated as adjacent if their frequency ids are consecutive.
www.actix.com
Content 16
3.15 iFRQG
Name: Frequency Group Record Description: The record defining a globally available frequency groups. Message: IFRQG model group_id no_freqs frequency1 frequency2 ... Data Group_id Description Specify what type of group and the number of that group. The types and their offset are: Sub set = 1 Set = 2 Group = 3 MAL, user defined = 4 MAL, pre-generated = 8 MAL, dynamic = 9 The group_id is created by using the formula sub set / set / group / MAL id + type_offset * 100 000 no_freqs Frequency1 Frequency2 . The number frequencies included in the sub set/set /MAL The number of the first frequency in the sub set/set /MAL The number of the second frequency in the sub set/set /MAL . Int Int Int Data Type Int Range
Usage: Used to define the frequencies in each of the sub set/set/group/MAL. Used in the Radio Database when using frequency groups (sub set/set/group) and SFH (MAL) planning.
3.16 iSECT
Name: Sector Record Description: The record defining the sector Message: iSECT model mask site_desc sector_desc served_traffic served_area Data Site_desc Description The site name or number. Data Type Char Range The wild character (*) is not allowed The wild character (*) is not allowed >=0 >=0
Sector_desc
The sector name or number. A site can have many sectors and are then separated by this description The amount of traffic that is served in this sector The area that is served in this sector.
Char
Served_traffic Served_area
Float Float
Usage: Used to create sectors in the network. This message is one of two parts in creating the Radio Database.
PROPRIATARY AND CONFIDENTIAL www.actix.com
Content 17
3.17 iSITE
Name: Site Record Description: The record defining the site Message: iSITE model mask site_desc latitude longitude Data Site_desc Description The site name or number. Data Type Char Range The wild character (*) is not allowed
latitude longitude
The latitude represented as a decimal, e.g. -56.0424 The longitude represented as a decimal, e.g. 12.7292
Float Float
Usage: Used to create sites in the network. This is the highest level you can define in the network, and gives the positions of the sites. This message could be used for the Radio Database if the features in Cellopt AFP that are using site positions are used, including in Cellopt MDA and the Radioplan map.
3.18 iMXSP
Name: Maximum Separation Description: The record defining the category / layers and separation values for Maximum Separation (GFRU).
synth_max_sep
Float
>=0
Float
Float
www.actix.com
Content 18
Usage: Used to create and define the Max Separation Values for GSM radios having separation requirementsQTRU and GFRU groups. The value of zero in the separation/frequency fields will be treated as unassigned. All values for the separation / frequency fields are specified as MHz. Note: The model and mask fields are not used for this message.
www.actix.com
#Radio Database for a network with 3 sector and 2 radios for each sector iSECT iSECT iSECT iCARF iCARF iCARF iCARF iCARF iCARF model model model model model model model model model 63 CO021 1 6573.000 1.250 63 CO021 2 6210.000 1.120 63 CO022 1 5349.000 1.580 16383 CO021 1 1 102 0 0.000 43 1 1 1 0 0 16383 CO021 1 2 86 0 0.000 - 1 2 0 0 0 16383 CO021 2 1 108 0 0.000 44 1 1 1 0 0 16383 CO021 2 2 99 0 0.000 - 1 2 0 0 0 16383 CO022 1 1 80 0 0.000 45 1 1 1 0 0 16383 CO022 1 2 89 0 0.000 - 1 2 0 0 0
#Radio Database for a network with 3 sector and 2 radios for each sector iSITE iSITE iANTN iANTN iANTN iSECT iSECT iSECT iCARF iCARF iCARF iCARF iCARF iCARF model model model model model model model model model model model model model model 31 CO021 56.0424 12.7292 31 CO022 56.0535 12.7287 511 CO021 1 0 25 2 65 742266 511 CO021 2 180 25 4 65 742266 511 CO022 1 20 40 -2 90 742280 63 CO021 1 6573.000 1.250 63 CO021 2 6210.000 1.120 63 CO022 1 5349.000 1.580 16383 CO021 1 1 102 0 0.000 43 1 1 1 0 0 16383 CO021 1 2 86 0 0.000 - 1 2 0 0 0 16383 CO021 2 1 108 0 0.000 44 1 1 1 0 0 16383 CO021 2 2 99 0 0.000 - 1 2 0 0 0 16383 CO022 1 1 80 0 0.000 45 1 1 1 0 0 16383 CO022 1 2 89 0 0.000 - 1 2 0 0 0
#Radio Database for a network with 3 sector and 2 radios for each sector iFRQG iFRQG iFRQG iSECT model model model model 900002 8 900005 6 900010 9 63 CO021 95 98 102 104 105 108 112 117 90 93 96 99 101 103 88 92 97 100 106 108 109 114 116 1 6573.000 1.250 www.actix.com
Actix Cellopt2 File Interface Technical Reference Revision 10 iCARF iCARF iCARF iCARF iSECT iCARF iCARF iCARF iCARF iSECT iCARF iCARF iCARF iCARF model model model model model model model model model model model model model model 16383 CO021 1 1 102 0 0.000 43 1 1 1 0 0 16383 CO021 1 2 900002 0 0.000 - 1 2 0 3 16383 CO021 1 3 900002 0 0.000 - 1 3 0 3 16383 CO021 1 4 900002 0 0.000 - 1 4 0 3 63 CO021 2 6210.000 1.120 16383 CO021 2 1 108 0 0.000 44 1 1 1 0 0 16383 CO021 2 2 900005 0 0.000 - 1 2 0 6 16383 CO021 2 3 900005 0 0.000 - 1 3 0 6 16383 CO021 2 4 900005 0 0.000 - 1 4 0 6 63 CO022 1 5349.000 1.580 16383 CO022 1 1 80 0 0.000 45 1 1 1 0 0 16383 CO022 1 2 900010 0 0.000 - 1 2 0 8 16383 CO022 1 3 900010 0 0.000 - 1 3 0 8 16383 CO022 1 4 900010 0 0.000 - 1 4 0 8
0 2 4 0 1 2 0 2 4
#Interference list for the above network. All relations are set on a sector to sector #basis. aLIST iCONC iCONC iCONC iCONC iCONC iCONC area 1 model 4095 model 4095 model 4095 model 4095 model 4095 model 4095 CO021 CO021 CO021 CO021 CO021 CO021 1 1 1 1 2 2 * * * * * * CO021 CO021 CO022 CO022 CO022 CO022 2 2 1 1 1 1 * * * * * * area area area area area area 0.136 0.170 0.096 0.994 0.226 0.634 0.019 0.067 0.011 0.580 0.111 0.280 2 2 2 2 2 2
neighbour 2 model 4095 CO021 model 4095 CO021 model 4095 CO021 model 4095 CO021 model 4095 CO021 model 4095 CO021
1 1 2 2 2 2
* * * * * *
2 2 1 1 1 1
* * * * * *
0 0 0 0 0 0
0 0 0 0 0 0
0 0 0 0 0 0
www.actix.com
Actix Cellopt2 File Interface Technical Reference Revision 10 iCONC iCONC iCONC iCONC iCONC model model model model model 4095 4095 4095 4095 4095 CO021 CO021 CO021 CO021 CO021 1 2 2 2 2 * * * * * CO021 CO021 CO021 CO022 CO022 2 1 1 1 1 * * * * * exception exception exception exception exception 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
iCONF model 1023 CO021 1 * 90 ListIllegalFrequency 0 0 1 iCONF model 1023 CO021 2 * 91 ListIllegalFrequency 0 0 1 iCONF model 1023 CO022 1 * 92 ListIllegalFrequency 0 0 1 iCONF model 1023 CO021 1 * 90 ListForbiddenFrequency 0 0 1 iCONF model 1023 CO021 2 * 91 ListForbiddenFrequency 0 0 1 iCONF model 1023 CO022 1 * 92 ListForbiddenFrequency 0 0 1
1 2 1 2
0 0 Denmark Denmark
A B C A 5 B 6 C 5
10 12 12.5
20 15 12
www.actix.com
5.1 Radios
When choosing Cellopt AFP 2 format, Radios in the export from Cellopt AFP the output file will have the following look: # #19 rows with comments #
iCARF iCARF iCARF iCARF iCARF iCARF model model model model model model 16383 16383 16383 16383 16383 16383 CO021 CO021 CO021 CO021 CO022 CO022 1 1 2 2 1 1 1 2 1 2 1 2 98 0 0.000 49 1 1 1 0 0 103 0 0.000 - 1 2 0 0 0 95 0 0.000 48 1 1 1 0 0 100 0 0.000 - 1 2 0 0 0 108 0 0.000 47 1 1 1 0 0 89 0 0.000 - 1 2 0 0 0
5.3 MALs
When choosing Cellopt AFP 2 format, MALs in the export from Cellopt AFP the output file will have the following look: # #19 rows with comments #
iFRQG model 900001 8 95 98 102 104 105 108 112 117 iFRQG model 900005 6 90 93 96 99 101 103 iFRQG model 900010 9 88 92 97 100 106 108 109 114 116
www.actix.com
www.actix.com