Atoll 3.2.1 Task Automation Guide

Version3.2.
TaskAutomationGuide
AT321_TAG_E1
AT321_TAG_E1
Atoll3.2.1TaskAutomationGuide
Release:AT321_TAG_E1(January2014)
Copyright19972014Forsk.AllRightsReserved.
Publishedby:
Forsk
7ruedesBriquetiers
31700Blagnac,France
Tel:+33562747210
Fax:+33562747211
Thesoftwaredescribedinthisdocumentisprovidedunderalicenceagreement.Thesoftwaremayonlybeusedorcopiedunderthetermsandconditionsofthelicenceagreement.
Nopartofthecontentsofthisdocumentmaybereproducedortransmittedinanyformorbyanymeanswithoutwrittenpermissionfromthepublisher.
Theproductorbrandnamesmentionedinthisdocumentaretrademarksorregisteredtrademarksoftheirrespectiveregisteringparties.
Thepublisherhastakencareinthepreparationofthisdocument,butmakesnoexpressedorimpliedwarrantyofanykindandassumesnoresponsibilityforerrorsoromissions.No
liabilityisassumedforincidentalorconsequentialdamagesinconnectionwithorarisingoutoftheuseoftheinformationcontainedherein.
Atoll 3.2.1 Task Automation Guide
2014 Forsk
TableofContents
AT321_TAG_E1
TableofContents
GettingStarted ................................................................................... 17
1.1
SupportedExtensions ................................................................................... 17
1.2
1.2.1
1.2.2
1.2.3
1.2.4
1.2.5
ScriptTutorial.......................................................................................... 17
WritingaVBScriptFile ................................................................................. 17
TestingtheScript..................................................................................... 18
SchedulingtheScript .................................................................................. 18
DebuggingtheScript.................................................................................. 21
ErrorManagement.................................................................................... 21
1.3
1.3.1
1.3.2
1.3.3
MacroTutorial ......................................................................................... 23
AddingMacrostoAtoll ................................................................................ 24
RunningaMacro ..................................................................................... 25
SavingaListofMacros ................................................................................ 25
1.4
WindowsScriptHost,32bitvs64bit...................................................................... 25
ObjectModel..................................................................................... 29
2.1
InterfacesImplementedbyObjects........................................................................ 29
2.2
2.2.1
2.2.2
PropertiesandMethodsProvidedbyObjects ............................................................... 30
Parameters.......................................................................................... 30
ErrorInformation ..................................................................................... 30
ApplicationObject ............................................................................... 33
3.1
HowtoAccesstheApplicationObject...................................................................... 34
3.2
get_Application........................................................................................ 34
3.3
get_Parent............................................................................................ 35
3.4
get_Active ............................................................................................ 35
3.5
put_Active ............................................................................................ 35
3.6
get_Documents........................................................................................ 35
3.7
get_Name............................................................................................. 36
3.8
get_FullName.......................................................................................... 36
3.9
get_Path .............................................................................................. 36
3.10
get_ActiveDocument.................................................................................... 36
3.11
get_WindowStatus ..................................................................................... 37
3.12
put_WindowStatus..................................................................................... 37
3.13
put_StatusBar ......................................................................................... 37
3.14
get_Visible............................................................................................ 38
3.15
put_Visible ............................................................................................ 38
3.16
get_Version ........................................................................................... 38
3.17
Quit .................................................................................................. 39
3.18
LogMessage........................................................................................... 39
3.19
CreatePropertyContainer................................................................................ 39
TableofContents
3.20
get_IniFileFullPath......................................................................................40
3.21
put_IniFileFullPath ......................................................................................40
3.22
GetOption .............................................................................................40
3.23
SetOption .............................................................................................41
3.24
Sleep.................................................................................................41
3.25
SetAddinInfoEx .........................................................................................41
3.26
put_OLENotRespondingDialog............................................................................42
3.27
put_OLEBusyDialog .....................................................................................42
3.28
put_OLEMessagePendingDelay ...........................................................................42
3.29
3.29.1
3.29.2
3.29.3
3.29.4
3.29.5
3.29.6
3.29.7
3.29.8
3.29.9
3.29.10
3.29.11
3.29.12
3.29.13
3.29.14
3.29.15
ApplicationEvents......................................................................................42
WillQuitApp..........................................................................................42
DocumentOpenComplete ..............................................................................43
WillCloseDocument ...................................................................................43
WillSaveDocument ....................................................................................43
DocumentSaveComplete...............................................................................43
DocumentNewComplete...............................................................................43
WillRefreshDocument .................................................................................44
RefreshDocumentComplete ............................................................................44
WillArchiveDocument..................................................................................44
ArchiveDocumentComplete.............................................................................44
WillRun .............................................................................................44
RunComplete.........................................................................................45
LicenceAcquireComplete...............................................................................45
LicenceReleaseComplete...............................................................................46
WillNewDocumentFromDatabase........................................................................47
DocumentsObject ...............................................................................51
4.1
HowtoAccessaDocumentsObject........................................................................51
4.2
get_Count .............................................................................................52
4.3
get_Item..............................................................................................52
4.4
get_Application ........................................................................................52
4.5
get_Parent ............................................................................................52
4.6
Open.................................................................................................52
4.7
Add ..................................................................................................53
4.8
OpenFromDatabase .....................................................................................53
4.9
CloseAll...............................................................................................54
4.10
SaveAll................................................................................................55
Forsk2014
DocumentObject ................................................................................59
5.1
HowtoAccessaDocumentObject.........................................................................61
5.2
get_Application ........................................................................................61
5.3
get_Parent ............................................................................................61
5.4
get_FullName ..........................................................................................61
5.5
get_Name .............................................................................................62
5.6
get_Path..............................................................................................62
5.7
get_ReadOnly ..........................................................................................62
5.8
get_Saved .............................................................................................62
AT321_TAG_E1
TableofContents
5.9
get_CoordSystemProjection.............................................................................. 62
5.10
putref_CoordSystemProjection........................................................................... 63
5.11
get_CoordSystemDisplay ................................................................................ 63
5.12
putref_CoordSystemDisplay.............................................................................. 63
5.13
get_CoordSystemInternal ................................................................................ 63
5.14
get_TransmissionUnit ................................................................................... 64
5.15
put_TransmissionUnit ................................................................................... 64
5.16
get_ReceptionUnit ..................................................................................... 64
5.17
put_ReceptionUnit ..................................................................................... 64
5.18
get_DistanceUnit ....................................................................................... 64
5.19
put_DistanceUnit....................................................................................... 64
5.20
Close ................................................................................................. 65
5.21
FilePrint .............................................................................................. 65
5.22
Save.................................................................................................. 65
5.23
Refresh ............................................................................................... 65
5.24
Archive............................................................................................... 66
5.25
Run.................................................................................................. 66
5.26
SetConfig ............................................................................................. 66
5.27
Import................................................................................................ 67
5.28
GetRecords............................................................................................ 67
5.29
Redraw ............................................................................................... 68
5.30
CenterMapOn ......................................................................................... 68
5.31
GetRootFolder ......................................................................................... 68
5.32
RunPathloss........................................................................................... 69
5.33
GetService ............................................................................................ 69
5.34
ExportConfig .......................................................................................... 70
5.35
GetCommandDefaults................................................................................... 70
5.36
InvokeCommand....................................................................................... 71
5.37
get_RadiatedPowerUnit................................................................................. 71
5.38
put_RadiatedPowerUnit ................................................................................. 71
5.39
get_AntennaGainUnit ................................................................................... 71
5.40
put_AntennaGainUnit ................................................................................... 72
5.41
get_HeightOffsetUnit ................................................................................... 72
5.42
put_HeightOffsetUnit................................................................................... 72
5.43
get_DatabaseConnectionString........................................................................... 72
5.44
HasRunningTask........................................................................................ 72
5.45
RunEx ................................................................................................ 73
5.46
get_DatabaseSchemaString.............................................................................. 73
5.47
get_DisplayApplicationDialogues.......................................................................... 73
5.48
put_DisplayApplicationDialogues ......................................................................... 74
TableofContents
5.49
PutDatabaseSchemaString ...............................................................................74
5.50
PutDatabaseConnectionString ............................................................................74
5.51
ChangeDatabaseConnection ..............................................................................74
5.52
get_TemperatureUnit...................................................................................75
5.53
put_TemperatureUnit...................................................................................75
5.54
GetDocumentProperties.................................................................................75
5.55
SetDocumentProperties .................................................................................75
TabularDataObject ..............................................................................81
6.1
HowtoAccessaTabularDataObject.......................................................................82
6.2
get_ColumnCount ......................................................................................83
6.3
get_RowCount.........................................................................................83
6.4
Edit ..................................................................................................83
6.5
AddNew ..............................................................................................84
6.6
Update ...............................................................................................84
6.7
Delete................................................................................................84
6.8
GetValue ..............................................................................................84
6.9
SetValue ..............................................................................................85
6.10
GetPrimaryKey .........................................................................................87
6.11
FindPrimaryKey ........................................................................................87
6.12
Find..................................................................................................87
6.13
GetFormattedValue .....................................................................................88
6.14
CancelUpdate ..........................................................................................89
6.15
get_ColumnNumber ....................................................................................89
6.16
get_CanEdit ...........................................................................................89
6.17
get_CanAddNew .......................................................................................90
6.18
get_CanFilterSort .......................................................................................90
6.19
get_Filter..............................................................................................90
6.20
put_Filter .............................................................................................90
6.21
get_Sort ..............................................................................................91
6.22
put_Sort ..............................................................................................92
6.23
GetOriginalValue .......................................................................................92
6.24
get_RowStatus .........................................................................................92
6.25
get_Columns...........................................................................................93
ZonesandPredictionsTabularDataObjects ..............................................97
7.1
ZonesTabularDataObject ...............................................................................97
7.2
PredictionsTabularDataObject ..........................................................................98
8
8.1
Forsk2014
CoordSystemObject .......................................................................... 103

HowtoAccessaCoordSystemObject.................................................................... 103
AT321_TAG_E1
TableofContents
8.2
Code................................................................................................ 103
8.3
ConvertCoordsTo...................................................................................... 104
8.4
Datum............................................................................................... 105
8.5
DatumName.......................................................................................... 105
8.6
Description ........................................................................................... 105
8.7
Ellipsoid ............................................................................................. 105
8.8
EllipsoidName ........................................................................................ 105
8.9
Name ............................................................................................... 106
8.10
Pick................................................................................................. 106
8.11
ProjMethod .......................................................................................... 106
8.12
ProjParameter........................................................................................ 107
8.13
SetDatum............................................................................................ 107
8.14
SetProjection......................................................................................... 107
8.15
Unit ................................................................................................. 107
ChildFolderObject.............................................................................. 111
9.1
HowtoAccessaChildFolderObject ...................................................................... 112
9.2
get_Application....................................................................................... 112
9.3
get_Parent........................................................................................... 113
9.4
get_Name............................................................................................ 113
9.5
put_Name ........................................................................................... 113
9.6
get_Count............................................................................................ 114
9.7
get_Item ............................................................................................. 114
9.8
get__NewEnum ....................................................................................... 114
9.9
get_Visible........................................................................................... 114
9.10
put_Visible ........................................................................................... 115
9.11
get_Selected ......................................................................................... 115
9.12
put_Selected ......................................................................................... 116
9.13
Export ............................................................................................... 116
9.14
CentreOnMap ........................................................................................ 118
9.15
Redraw .............................................................................................. 118
9.16
AddChild ............................................................................................. 118
9.17
Remove.............................................................................................. 119
9.18
get_position .......................................................................................... 119
9.19
put_position.......................................................................................... 119
9.20
get_Object........................................................................................... 119
9.21
get_dispatch.......................................................................................... 119
9.22
get_ObjectKind ....................................................................................... 120
9.23
GetProperty .......................................................................................... 121
9.24
SetProperty .......................................................................................... 122
TableofContents
Forsk2014
9.25
GetPropertiesInfo..................................................................................... 122
9.26
PropertyIsPropertyContainer........................................................................... 122
9.27
PropertyIsTabularData................................................................................. 122
9.28
LoadProperties ....................................................................................... 122
9.29
SaveProperties....................................................................................... 123
9.30
RemoveItem ......................................................................................... 123
9.31
SetCustomIcon ....................................................................................... 123
10
PropertyContainerObject ................................................................... 127
10.1
Get................................................................................................. 127
10.2
Set................................................................................................. 128
10.3
GetInfo ............................................................................................. 128
10.4
IsPropertyContainer................................................................................... 128
10.5
IsTabularData........................................................................................ 128
10.6
Load................................................................................................ 128
10.7
Save ................................................................................................ 129
10.8
RemoveAll........................................................................................... 129
10.9
Remove ............................................................................................. 129
11
ChildFolderObjectProperties .............................................................. 133
11.1
HowtoAccessChildFolderObjectProperties .............................................................. 133
11.2
CommonChildFolderObjectProperties .................................................................. 134
11.3
PredictionsFolderProperties........................................................................... 134
11.4
11.4.1
11.4.2
11.4.3
11.4.4
11.4.5
11.4.6
CoveragePredictionProperties ......................................................................... 135

GeneralProperties.................................................................................. 137
Group,Filter,andSortProperties ...................................................................... 137
NonSimulationbasedCoverageConditions............................................................. 137
SimulationbasedCoverageConditions ................................................................. 139
ShadowingandIndoorCoverageConditions............................................................. 140
DisplayProperties................................................................................... 140
11.5
GSMSimulationGroupProperties....................................................................... 142
11.6
UMTSSimulationGroupProperties...................................................................... 143
11.7
WiMAXandLTESimulationGroupProperties.............................................................. 144
11.8
3GPPMultiRATSimulationGroupProperties.............................................................. 145
11.9
PropagationModelProperties.......................................................................... 146
11.10
CWMeasurementProperties........................................................................... 148
11.11
DriveTestDataProperties ............................................................................. 149
11.12
CustomChildFolderObjectProperties.................................................................... 149
11.13
MasterLinkProperties ................................................................................ 150
11.14
LinkProperties....................................................................................... 150
11.15
11.15.1
VectorLayerProperties ................................................................................ 150

DisplayProperties................................................................................... 150
12
10
ChildFolderFeatureObjects ................................................................. 155
AT321_TAG_E1
TableofContents
12.1
12.1.1
12.1.2
12.1.3
12.1.4
12.1.5
ClutterFeatureObject ................................................................................. 155

HowtoAccesstheClutterFeatureObject................................................................ 155
get_Source ......................................................................................... 155
get_ClassAttributes .................................................................................. 156
get_DefaultAttributes ................................................................................ 156
AccessingClutterClassAttributes ...................................................................... 156
12.2
12.2.1
12.2.2
12.2.3
12.2.4
12.2.5
TrafficFeatureObject .................................................................................. 158

HowtoAccesstheTrafficFeatureObject................................................................ 158
get_Source ......................................................................................... 158
get_ScenarioProvider................................................................................. 158
ExportCumulatedTraffic............................................................................... 159
................................................................................................... 160
12.3
12.3.1
12.3.2
UMTSTrafficScenarioProviderObject .................................................................... 161

GetMeanSize........................................................................................ 161
Create ............................................................................................. 161
12.4
12.4.1
12.4.2
12.4.3
12.4.4
12.4.5
EnvironmentBasedTrafficMapFeatureObject............................................................. 163
HowtoAccessEnvironmentBasedTrafficMapFeatureObjects ............................................. 163
get_Source ......................................................................................... 163
get_ClassAttributes .................................................................................. 163
get_DefaultAttributes ................................................................................ 163
AccessingEnvironmentBasedTrafficMapsAttributes ..................................................... 164
12.5
12.5.1
12.5.2
12.5.3
12.5.4
12.5.5
12.5.6
12.5.7
SimulationFeatureObject .............................................................................. 165

HowtoAccessSimulationFeatureObjects............................................................... 166
get_Source ......................................................................................... 166
get_Statistics ....................................................................................... 166
get_Cells........................................................................................... 167
get_Sites........................................................................................... 167
get_Mobiles ........................................................................................ 167
get_Results ......................................................................................... 167
12.6
12.6.1
12.6.2
12.6.3
12.6.4
12.6.5
12.6.6
SimulationGroupFeatureObject ........................................................................ 168

HowtoAccessSimulationGroupFeatureObjects......................................................... 168
get_Source ......................................................................................... 170
get_Statistics ....................................................................................... 170
get_MeanSimulation................................................................................. 170
get_StdDevSimulation ................................................................................ 170
AccessingMobiles,Cells,Sites,forSimulationsandSimulationGroups........................................ 171
12.7
12.7.1
12.7.2
12.7.3
12.7.4
3GPPMultiRATSimulationGroupFeatureObject .......................................................... 175

get_Source ......................................................................................... 175
get_Statistics ....................................................................................... 176
get_MeanSimulation................................................................................. 176
get_StdDevSimulation ................................................................................ 176
12.8
12.8.1
12.8.2
12.8.3
12.8.4
12.8.5
12.8.6
12.8.7
12.8.8
12.8.9
12.8.10
12.8.11
12.8.12
12.8.13
12.8.14
12.8.15
12.8.16
12.8.17
12.8.18
GSMInterferenceMatrixFeatureObject.................................................................. 177
HowtoAccessGSMInterferenceMatrixFeatureObjects ................................................... 177
get_Source ......................................................................................... 178
Load ............................................................................................... 178
CompleteScopeInfo.................................................................................. 178
get_Scope .......................................................................................... 178
put_Active.......................................................................................... 179
get_Active .......................................................................................... 179
get_Type ........................................................................................... 179
put_Type ........................................................................................... 180
get_BasedOnTraffic.................................................................................. 180
put_BasedOnTraffic .................................................................................. 181
get_Resolution...................................................................................... 181
put_Resolution ...................................................................................... 181
get_StdDev......................................................................................... 181
put_StdDev ......................................................................................... 182
get_InfoQuantityIndicator............................................................................. 182
put_InfoQuantityIndicator ............................................................................ 182
get_CdfTab......................................................................................... 182
13
DocumentCommands ......................................................................... 187

11
TableofContents
Forsk2014
13.1
HowtoInvokeaDocumentCommand ................................................................... 188
13.2
IMPORTXML......................................................................................... 188
13.3
EXPORTXML ......................................................................................... 189
13.4
APPENDTABLECOLUMN................................................................................ 189
13.5
CALCULATEPOINTS.................................................................................... 190
13.6
IMPORTTESTMOBILEDATA ............................................................................. 191
13.7
RUNNEIGHBOURALLOCATION .......................................................................... 192
13.8
RUNINTERTECHNOLOGYNEIGHBOURALLOCATION.......................................................... 193
13.9
RUNINTRACARRIERNEIGHBOURALLOCATION .............................................................. 193
13.10
RUNINTERCARRIERNEIGHBOURALLOCATION.............................................................. 194
13.11
CLONESTUDY ........................................................................................ 195
13.12
DUPLICATESTUDY..................................................................................... 195
13.13
COMPARESTUDY ..................................................................................... 196
13.14
CALCULATEEQUIPMENTLOSSES ......................................................................... 197
13.15
CALCULATEREPEATERS ................................................................................ 197
13.16
CALCULATEREMOTEANTENNAS......................................................................... 198
13.17
EXPORTACTIVESETANALYSIS ............................................................................ 199
13.18
CALCULATEPOINTSECI0 ................................................................................ 202
13.19
RUNALLCARRIERSALLOCATION .......................................................................... 202
13.20
RUNMASTERCARRIERALLOCATION....................................................................... 203
13.21
MWRun ............................................................................................. 204
13.22
EXPORTMAPWINDOW................................................................................. 213
13.23
IMPORTPLANETDATAFILE.............................................................................. 214
13.24
EXPORTMWLINKANALYSISPROFILEPICTURE............................................................... 215
13.25
GETPOWERMODE .................................................................................... 215
13.26
SETPOWERMODE ..................................................................................... 216
13.27
APPENDVECTORDATACOLUMN ......................................................................... 216
13.28
LOADSAVEPRINTSETUP................................................................................ 217
13.29
CALCULATEPATHLOSS................................................................................. 218
13.30
MWLinksCustomExport ................................................................................ 219
14
14.1
14.1.1
14.1.1.1
14.1.1.2
14.1.1.3
14.1.1.4
14.1.1.5
14.1.1.6
14.1.1.7
14.1.1.8
14.1.1.9
14.1.1.10
14.1.1.11
14.1.1.12
12
Enumerations,Structures,andInterfaces ............................................... 223

Enumerations ........................................................................................ 223
AtollTypeLibraryEnumerations ....................................................................... 223
AtoSaveStatus .................................................................................... 223
AtoSaveChanges .................................................................................. 223
AtoRefreshPriority................................................................................. 223
AtoArchiveStatus .................................................................................. 223
AtoWindowStatus................................................................................. 223
AtoLogType ...................................................................................... 224
AtoCompareOp ................................................................................... 224
AtoTransmissionUnit............................................................................... 224
AtoReceptionUnit ................................................................................. 224
AtoDistanceUnit................................................................................... 224
AtoRadiatedPowerUnit ............................................................................. 225
AtoAntennaGainUnit............................................................................... 225
AT321_TAG_E1
14.1.1.13
14.1.1.14
14.1.1.15
14.1.1.16
14.1.1.17
14.1.2
14.1.2.1
14.1.2.2
14.1.2.3
TableofContents
AtoHeightOffsetUnit................................................................................ 225
AtoRootType...................................................................................... 225
AtoRowFilter...................................................................................... 225
AtoRowStatus..................................................................................... 225
AtoTemperatureUnit ............................................................................... 226
FSKGISLibTypeLibraryEnumerations ................................................................... 226
GeographicUnit .................................................................................... 226
ProjectionMethod.................................................................................. 226
ProjParameterIndices ............................................................................... 227
13
TableofContents
14
Forsk2014
Chapter1
GettingStarted
16
Forsk2014
Chapter1:GettingStarted
AT321_TAG_E1
1 GettingStarted
AtollprovidesasetofprogrammableextensionsenablinguserstoenhancethealreadyrichfunctionalitiesavailableinAtoll.
Ifyouplantowritescriptsormacros,youmustbefamiliarwithMicrosoftWindowsScriptTechnologies,especiallywiththe
VBScriptlanguage.
Youcanstartby:
Goingthroughthesection"SupportedExtensions"onpage 17tolearnwhichtypesofextensionscanbedeveloped.
Readingthefollowingtutorialsbeforestartingyourowndevelopment:
"ScriptTutorial"onpage 17,
"MacroTutorial"onpage 23,
1.1 SupportedExtensions
Thefollowingtypesofextensionsareavailable.
Scripts
AscriptisasequenceofVBScriptstatementsinatextfile,executablefromoutsideAtoll(WindowsScriptHost).Scripts
allowtaskautomationinAtollwhennointeractionwiththeuserisneeded.Scriptsdonotrequireanysetupandare
speciallyusefulforschedulingtasksinbatchmode.ScriptsuseCOMinterprocesscommunicationforcommunicating
withAtoll.
Samplecode:
Severalscriptsareavailablefordownloadatwww.forsk.com.
Macros
AmacroisasequenceofVBScriptstatementsinatextfile,executablefromwithinAtoll.Macrosallowtaskautoma
tioninAtoll.Macrosmayinteractwiththeuser,buttheinteractionislimitedbyVBScript.Macrosmustbeaddedto
Atollinordertobeavailableforexecution.TheycanbesavedinAtolluserconfigurationfiles.Macrocommandscan
beaddedtotoolbars.MacrosuseCOMinprocesscommunicationforcommunicatingwithAtoll.
Samplecode:
Severalmacrosareavailablefordownloadatwww.forsk.com.
1.2 ScriptTutorial
Throughthistutorial,youwilllearntoautomatesomesimpletasks,suchasarchivingdatatodatabases,runningcalculations,
andexecutingscriptsonascheduledtime.
1.2.1 WritingaVBScriptFile
Openatexteditor,andtypeinthefollowingcode:
Option Explicit
Dim var
Dim myapp
Dim doc
Sub Atoll_RunComplete(arg1, arg2)
var = 1
End Sub
Set myapp = CreateObject("Atoll.Application")
WScript.ConnectObject myapp, "Atoll_"
17
Forsk2014
myapp.Visible = False
Set doc = myapp.Documents.OpenFromDatabase(
"Provider=SQLOLEDB.1;UserID=myNameName;Password=myPwd;InitialCatalog=myAtollDbName;Data Source=myServer;", "")
doc.Run True
var = 0
Do While var = 0
WScript.Sleep 1000
Loop
doc.Save("C:\mydoc.atl")
WScript.DisconnectObject myapp
doc = Null
Const atoSaveNo = 0
myapp.Documents.CloseAll atoSaveNo
myapp.Quit atoSaveNo
myapp = Null
WScript.Quit 0
Youmustreplacealltheparametersbeginningwith"my"withyourownvaluesintheaboveconnectionstring.Thisscript:
1. StartsaninvisibleAtollsession.
2. Opensanewdocumentfromanexistingdatabase.
3. Runsallthecalculationsinthisdocument.
4. Waitsfortheendofcalculations.
EventRunCompleteisthrownwhencalculationsaredone.Thesyntaxforcatchinganyeventistoconcatenatethe
nameoftheeventtothestring"Atoll_".Astheseparametershavenotbeenusedintheaboveexample,theyhave
beennamed"arg1"and"arg2".Moreover,weconnectanddisconnectthescriptusingtheappropriatemethodof
WScript.
5. Savesthedocument.
6. ExitstheAtollsession.
SaveyourscriptfileasaVBScriptfile,forexampleC:\Atollmacros\tutorial.vbs.
1.2.2 TestingtheScript
Totestthescript:
1. DoubleclicktheC:\Atollmacros\tutorial.vbsfileinWindowsExplorer.
2. CheckafewminuteslaterwhetherC:\TEMP\mydoc.atlhasbeencreatedornot.
1.2.3 SchedulingtheScript
YoucanschedulescriptsusingtheWindowsTaskScheduler.ThistutorialdescribesthestepsforWindows2000.Forother
operatingsystems,wheretheproceduremightdifferslightly,pleaserefertoWindowsHelp.
ToopentheWindowsTaskScheduler:
1. SelectStart>Settings>ControlPanel.TheControlPanelopens.
2. DoubleclicktheScheduledTasksicon.
18
AT321_TAG_E1
3. DoubleclicktheAddScheduledTaskicon.TheScheduledTaksWizardopens.
4. ClickNext.
Figure 1.1:ScheduledTasksWizard
5. ClicktheBrowsebutton.
6. Selectcscript.exe.
7. ClickNext.
8. Changethenameofthetask,forexample"Atolltutorial".
9. Chooseyourpreferredperiodicity.
10. ClickNext.
Thefollowingwizardpagesenableyoutodefinemorepreciselywhenyourtaskshouldrunandwhichuserstartsit.
11. Inthelastpage,selecttheOpenadvancedpropertiesforthistaskwhenIclickFinishcheckbox.
12. ClickFinish.TheadvancedpropertiesAtollTutorialdialogueopens.
19
Forsk2014
13. IntheAtollTutorialdialogue,addyourVBScriptfilenameintheRunfieldandappend"\\B"optiontospecifybatch
mode.Thissuppressesdialogueboxessuchasalertsandscripterrors.
Figure 1.4:AtollTutorial
14. Setaccountinformationifneeded.
15. ClickOK.YourtaskwillbedisplayedintheScheduledTaskswindow:
Figure 1.5:ScheduledTasks
Tomodifythetaskproperties:
1. RightclicktheAtollTutorialtask.Thecontextmenuopens.
2. SelectPropertiesfromthecontextmenu.
20
AT321_TAG_E1
Tocontrolthecurrentstatusofthetask:
SelectView>Details.
Toopenthelogfile:
SelectAdvanced>ViewLog.
Totestthenewtask:
1. RightclicktheAtollTutorialtask.Thecontextmenuopens.
2. SelectRunfromthecontextmenu.
1.2.4 DebuggingtheScript
Todebugthescript,useacommandpromptconsoleandthewscript"//X"commandlineoption:
wscript tutorial.vbs //X

Youwillbepromptedforthedebuggeryouwanttouse.MicrosoftprovidesaspecialisedscriptdebuggertodebugVBScript
code, which is available in the free downloads section of Microsofts website. You can set breakpoints and inspect the
contentsofvariablesusingthisdebugger.
Whiledebugging,youcantemporarilymakeAtollvisibleonthedesktopusing:
Myapp.Visible = True
1.2.5 ErrorManagement
Itisimportanttocheckforanyerrorthatmightoccurduringtheexecutionofthescript.MicrosoftVisualBasicscripting
languageprovides"OnErrorResumeNext"alongwiththe"Err"objecttomanageerrors.Hereisoursamplescriptwitherror
management:
Option Explicit
Dim var
Dim myapp
Dim doc
On Error Resume Next
Sub CatchError
If Err Then
myapp.LogMessage Err.Description, 1
WScript.Echo Err.Description
End If
WScript.Echo "Script failed."
myapp.LogMessage "Script failed.", 1
Const atoSaveNo = 0
If IsObject(doc) Then
doc.Close atoSaveNo
doc = Null
21
Forsk2014
End If
If IsObject(myapp) Then
myapp.Quit 0
myapp = Null
End If
WScript.Quit -1
End Sub
Sub Atoll_RunComplete(arg1, arg2)
var = 1
End Sub
Set myapp = CreateObject("Atoll.Application")
If Err Then
WScript.Echo "Can't create 'Atoll.Application' object."
Err.Clear
Call CatchError
End If
WScript.ConnectObject myapp, "Atoll_"
myapp.Visible = False
Set doc = myapp.Documents.OpenFromDatabase(
"Provider=SQLOLEDB.1;UserID=myName;Password=myPwd;InitialCatalog=myAtollDbName;DataSource=myServer;", "")
If Err Then Call CatchError End If
doc.Run True
var = 0
Do While var = 0
WScript.Sleep 1000
Loop
doc.Save("C:\mydoc.atl")
WScript.DisconnectObject myapp
doc = Null
22
AT321_TAG_E1
myapp.Quit atoSaveNo
myapp = Null
WScript.Quit 0
Errorcheckingisactivatedwith"OnErrorResumeNext".Whenanerroroccurs,thescriptcontinuesexecutionfromthenext
lineandthe"Err"objectissetaccordingly.YoucancheckforErr.Number,orforErr(becauseNumberisitsdefaultproperty)
tocatchanyerror.
1.3 MacroTutorial
MacrosarerunbyAtolluponbeinginvokedbytheuser.MacrosarewritteninVBScript,likescripts.Thedifferencebetween
scriptsandmacrosistheexecutioncontext.
WhenamacroislaunchedfromAtoll,aninstanceofanAtollApplicationobjectisautomaticallyaddedasascriptlevelvari
ableavailabletothemacrocode.Therefore,CreateObjectorGetObjecttoaccessanApplicationobjectmustnotbecalled.
Thefirstlineofyourmacrocanbedirectly:
mydoc = Atoll.ActiveDocument
ThescriptlevelvariablenamefortheAtollApplicationobjectis"Atoll"anditisoptional.So,theabovelineisequivalentto:
mydoc = ActiveDocument
Macroscanalsobeinvokedinresponsetoapplicationevents.
Example
Sub Atoll_DocumentSaveComplete(doc)
LogMessage "Archive on save running ..."
Dim status
status = doc.Archive
Const atoError = 1
Const atoArchiveCanceled = 1
If Err.Number <> 0 Then
LogMessage "Archive on save failed. " & Err.Description & ".", atoError
Else
If status = atoArchiveCanceled Then
LogMessage "Archive on save failed.", atoError
LogMessage "You must resolve the conflicts manually.", atoError
MsgBox "Archive on save failed. You must resolve the conflicts manually."
Else
LogMessage "Archive on save completed successfully."
23
Forsk2014
End If
End If
End Sub
Theaboveexampleshowsamacrousedtoautomaticallyarchiveadocumentonceithasbeensaved.
1.3.1 AddingMacrostoAtoll
YoucanaddamacrotoyourAtollsessionasfollows:
1. SelectTools>AddinsandMacros.TheAddinsandMacrosdialogueopens.
2. UnderMacros,clicktheAddbutton.
Browseforyourscriptfile.Youcancreateanewmacrofilebytypinganameforthenew(empty)macrofileinthefile
selectionbox.AtollwillinitializethisnewfilewithminimalVBScriptscript.Atollinterpretsyourfileandlistsallpublic
macrosfoundinthefileinanexplorer.
Ifyoucreateanemptymacrofile,itisinitialisedwiththefollowingcode:
Public Sub Main

End Sub
YoucantheneditthefileandaddanycommandinthesubMain,oraddanothersubandexecuteit..
3. Expandtheexplorerentry,selectamacroandclicktheRunbuttontostartthemacro.
Toeditamacrofile:
1. UnderMacros,selectthemacrointhelistofmacros.
2. ClicktheEditbutton.Themacrofileisopenedinthedefaulteditor.
3. Modifythecode.
4. Savethefile.
5. Closethefileeditor
6. IntheAddinsandMacrosdialogue,clicktheRefreshbutton.Atollwillupdatethemacro.
Figure 1.6:AddingMacrosinAtoll
Toassociateaniconfiletoamacro:
1. UnderMacros,selectthemacrointhelistofmacros.
2. ClicktheIconbutton.
24
AT321_TAG_E1
3. Selecttheiconfiletobeusedforthemacro.
AtoolbarbuttonisaddedforthemacroinAtoll,whichyoucanclicktorunthemacro.
For macros returning values, only functions, and not subroutines, may be defined. This is the case, for example, of all
"OnWill"callsasthereturnedvalue,thestatusvalue,allowstheusertobypassthestandardbehaviour.
Forfunctions,thenameofthereturnedvalueisthesameasthenameofthefunction:
Function Atoll_WillRun(doc, success)

doc.Save
Atoll_WillRun = False Intercepts the run order and cancels
it by returning False
End Function
1.3.2 RunningaMacro
Torunamacro:
SelectamacrointheAddinsandMacrosdialogueandclickRun,or
SelectamacrointheAddinsandMacrosdialogueanddoubleclickit,or
Clickthemacrosbuttoninthetoolbar.
Ifaproblemoccursduringthemacroexecution,anerrormessageisdisplayedinadialogueboxwiththelinenumberindi
cated.ThesamemessageisalsologgedintheAtollEventViewer.
1.3.3 SavingaListofMacros
OncemacroshavebeenaddedtoanAtollsession,theycanbesavedinaconfigurationfile.IfnodocumentisopeninAtoll,
youcanstillusetheTools>UserConfigurations>Savecommandforsavingthemacrosintheconfigurationfile.
Similartoallotherconfigurationfilecontents,iftheconfigurationfileisnamedAtoll.cfgandisstoredatthesamelocationas
Atoll.exe,Atollwillalwaysbestartedwiththelistofmacrossavedinthisconfigurationfile.Macroswillbeavailableevenif
noAtolldocumentisopen.Formoreinformationonconfigurationfiles,pleaserefertotheAdministratorManual.
1.4 WindowsScriptHost,32bitvs64bit
MicrosoftWindowsScriptHostisusedtorunscripts.
Ona64bitOS,thereisa32bitanda64bitversionofWindowsScriptHostavailable.BothcanbeusedtoscriptAtoll.The
AtollversionusedbyascriptdependsontheAtollversionsinstalled(32/64bit)andontheWindowsScriptHostversionused
torunthescript.
ThefollowingtableshowstheAtollversionlaunchedbyWindowsScriptHost:
Only 32-bit Atoll installed Only 64-bit Atoll installed
Both 32-bit and 64-bit

Atoll installed
32-bit WSH used to run

the script
32-bit Atoll is launched
64-bit WSH used to run

the script
Youneedtoexplicitlyuse32bitor64bitWindowsScriptHostonmachineswhereboth32bitAtolland64bitAtollare
installed.
25
26
Forsk2014
Chapter2
ObjectModel
28
Forsk2014
Chapter2:ObjectModel
AT321_TAG_E1
2 ObjectModel
ThischapterdescribestheAtollobjectmodel.Figure 2.1onpage 29providesanoverviewoftheAtollobjectmodel.
Application
Documents
Document1
TabularData1
Document2
PropertyContainer1
TabularData1
PropertyContainer2
TabularData2
TabularData2
ChildFolder1
ChildFolder1
ChildFolder2
ChildFolder2
CoordSystem
CoordSystem
Figure 2.1:AtollObjectModel
Atollexposesanumberofobjectsofvarioustypes.TheseobjectsprovideaccesstoAtollcomponentsthroughpropertiesand
methods.Propertiesandmethodsusuallyhaveinputandoutputparameters.
TheobjectsexposedbyAtollare:
Name
Description
ApplicationObject
TheApplicationobjectprovidesanentrypointforclientstoretrieveand
navigatethroughtheAtollobjectmodel.
DocumentsObject
TheDocumentsobjectisusedtocreateanewdocumentortoiterate
throughopendocumentsinanAtollsession.
DocumentObject
TheDocumentobjectprovidesaccesstoATLdocumentsanddatabase
connections.
TabularDataObject
TheTabularDataobjectprovidesaccesstoAtolltableswhetheranAtoll
documentisconnectedtoadatabaseornot.Italsoprovidesaccesstoother
tableswhicharenotdatabasetables,suchasPREDICTIONSandZONES.
CoordSystemObject
Thisobjectcontainstheentiredefinitionofacoordinatesystem.
ChildFolderObject
AChildFolderobjectrepresentsanitemintheAtollExplorerwindow.
PropertyContainerObject
ThePropertyContainerobjectisagenericcontainercontainingasetof
namedpropertiesofarbitrarytypes
TransmitterObject
TheTransmitterobjectprovidesreadonlyaccesstoantennapatterns,
antennalosses,andsometransmitterproperties.
2.1 InterfacesImplementedbyObjects
AtollobjectsprovideaccesstoAtollcomponentsthroughpropertiesandmethods.
29
Chapter2:ObjectModel
Forsk2014
2.2 PropertiesandMethodsProvidedbyObjects
AccesstoAtollcomponentsisavailablethroughpropertiesandmethods.Propertiesandmethodsusuallyhaveinputand
outputparameters.
Forreadingandwritingaproperty,youwrite:
value = object.property for reading a property

object.property = value for writing a property
Forcallingamethod,youwrite:
object.method
2.2.1 Parameters
Propertiesandmethodsmayhaveparameters.
InputParameters
Inputparametersaremarkedwith[in].Inputparametersarenotmutatedbymethodsorpropertysettersimplementation.
Inputparametersarespecifiedbyvalue.
OutputParameters
Output parameters are marked with [out]. Output parameters are specifiedby reference. Upon successfulcompletion of
methodsorpropertygetters,thereferencedvalueischanged.
Input/OutputDataTypes
BSTR
BSTRmaybeusedasamethodparameterdatatype.Itisusedtospecifyacharacterstring.InVBScript,itcorresponds
totheStringdatatype.
VARIANT
VARIANTmaybeusedasamethodparameterdatatype.Itisusedtospecifyvaluesofmanydifferenttypes,especially
arrays.ItcanbeusedbyVBScript.
2.2.2 ErrorInformation
Whenanerrorisreturnedbyapropertyormethod,anerrorinformationcontextiscreatedandanexceptionisthrown.Ifthe
scriptormacrodoesnotusetheOnErrorResumeNextstatement,itwillbeterminatedduetotheerror.
IfthescriptormacrousestheOnErrorResumeNextstatement,theerrorinformationisavailableaspropertiesofthescript
levelErrobject.Forexample,Err.Descriptionwhichprovidestheerrordescription:
In
Dim strDescription
If Err Then
strDescription = Err.Description
End If
PleaserefertotheVBScriptLanguageReferenceformoreinformationaboutVBScript,errorhandling,andtheErrscriptlevel
variable.
30
Chapter3
ApplicationObject
32
Forsk2014
Chapter3:ApplicationObject
AT321_TAG_E1
3 ApplicationObject
TheApplicationobjectprovidesanentrypointforclientstoretrieveandnavigatethroughtheAtollobjectmodel.
TheApplicationobjectprovidesthefollowingpropertiesandmethods:
Name
Description
Attributes
get_Application
ReturnstheAtollApplicationobject.
Type:Applicationobject
Access:Read
get_Parent
Access:Read
get_Active
ReturnswhethertheAtollwindowisactive
ornot.
Type:Boolean
Access:Read/Write
put_Active
SetstheAtollwindowactive.
Type:Boolean
Access:Read/Write
get_Documents
ReturnstheDocumentsobject.
Type:Documentsobject
Access:Read
get_Name
Returnstheapplicationname.The
applicationnameisalways"Atoll".
Type:String
Access:Read
get_FullName
Returnsthefullpathoftheexecutable.
Type:String
Access:Read
get_Path
Returnsthepathoftheexecutable.
Type:String
Access:Read
get_ActiveDocument
Returnstheactivedocument.
Type:Documentobject
Access:Read
get_WindowStatus
ReturnsthewindowstatusoftheAtoll
application.
Type:Integer
Access:Read/Write
put_WindowStatus
SetsthewindowstatusoftheAtoll
application.
Type:Integer
Access:Read/Write
put_StatusBar
SetsthestatusbartextoftheAtoll
application.
Type:String
Access:Write
get_Visible
Returnstheapplicationvisiblestate.
Type:Boolean
Access:Read/Write
put_Visible
Setstheapplicationvisiblestate.
Type:Boolean
Access:Read/Write
get_Version
Returnstheapplicationversion.
Type:String
Access:Read
Quit
Quitstheapplication.
LogMessage
DisplaysamessageintheAtollevent
observerwindow.
CreatePropertyContainer
ReturnsanemptyPropertyContainerobject.
get_IniFileFullPath
ReturnsthefullpathtotheAtollinitialisation
file.
Type:String
Access:Read/Write
put_IniFileFullPath
SetsthefullpathtotheAtollinitialisation
file.
Type:String
Access:Read/Write
GetOption
ReturnsanoptionreadfromtheAtoll
initialisationfile.
SetOption
SetsanoptionintheAtollinitialisationfile.
33
Forsk2014
Name
Description
Sleep
Suspendstheapplicationapartment
execution.
Attributes
TheApplicationobjectfiresthefollowingevents:
Name
Description
WillQuitApp
EventfiredwhentheuserwantstoexitanAtollsession.
DocumentOpenComplete
Eventfiredwhenadocumenthasbeenopened
WillCloseDocument
Eventfiredwhentheuserwantstocloseadocument.
WillSaveDocument
Eventfiredwhentheuserwantstosaveadocument.
DocumentSaveComplete
Eventfiredjustafteradocumenthasbeensaved.
DocumentNewComplete
Eventfiredwhenanewdocumenthasbeencreated.
WillRefreshDocument
Eventfiredwhentheuserwantstorefreshadocumentfromdatabase.
RefreshDocumentComplete
Eventfiredwhenadocumenthasbeenrefreshedfromdatabase.
WillArchiveDocument
Eventfiredwhentheuserwantstoarchiveadocumenttothedatabase.
ArchiveDocumentComplete
Eventfiredwhenthedocumenthasbeenarchivedindatabase.
WillRun
Eventfiredwhentheuserwantstostartacalculation.
RunComplete
Eventfiredwhenthecalculationhasfinished.
LicenceAcquireComplete
ThisfeatureenablestheusertologAtolllicencetokenusagefromanaddin.
LicenceReleaseComplete
ThisfeatureenablestheusertologAtolllicencetokenusagefromanaddin.
3.1 HowtoAccesstheApplicationObject
Theapplicationobjectisthetoplevelobject.Subobjectsareobtainedthroughpropertiesoftheapplication.Togetanappli
cationobjectinVBScript,useoneofthefollowing:
Set app = CreateObject("Atoll.Application")

BecauseAtollregistersitselfintheRunningObjectsTablewhenanAtollsessionisrunning,youcanuse:
Set app = GetObject(, "Atoll.Application")
Using GetObject("", "Atoll.Application") (note the difference in the first parameter) will
automaticallystartanewinstanceofAtollifnosessionisalreadyrunningandattachthe
macrotothisnewinstance.
EachcalltoGetObject("","Atoll.Application")willstartanewAtollinstance.Ifthisisnot
intended,useGetObject(,Atoll.Application),whichattachesthescripttothefirstAtoll
sessionstartedwhenseveralsessionsarerunning.
Inthecontextofmacros,aninstanceofthemainobjectApplicationisautomaticallyaddedasaglobalvariableofthemacro
code.Therefore,itmustnotcallCreateObjectorGetObjecttogetanApplicationobject.
TheglobalvariableoftypeApplicationobjectavailabletomacrosisnamed"Atoll".
3.2 get_Application
34
AT321_TAG_E1
HRESULT get_Application(IApplication **ppVal);

Parameters
[out]ppVal:AddressoftheIApplicationinterfacepointerusedtoreturntheAtollApplicationobject.
3.3 get_Parent
HRESULT get_Parent(IApplication **ppVal);

Parameters
3.4 get_Active
ReturnswhethertheAtollwindowisactiveornot.
HRESULT get_Active(VARIANT_BOOL *pVal);

Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturnwhethertheAtollwindowsapplicationisactiveornot.
Example
Dim app
Dim act
act = app.Active
app.Active = True
3.5 put_Active
Setsthemainapplicationwindowactive.
HRESULT put_Active(VARIANT_BOOL aNewVal);

Parameters
[in]aNewVal:
VARIANT_TRUE:Activatesthemainwindowapplication.
Example
See"get_Active"onpage 35.
3.6 get_Documents
ReturnstheDocumentsobject.
35
HRESULT get_Documents(IDocuments **ppDocVal);

Parameters
[out]ppDocVal:AddressoftheIDocumentsinterfacepointerusedtoreturntheDocumentsobject.
Example
Dim app
Dim docs
Set docs = app.Documents
3.7 get_Name
Returnstheapplicationname.Theapplicationnameisalways"Atoll".
HRESULT get_Name(BSTR *pVal);

Parameters
[out]pVal:AddressoftheBSTRusedtoreturntheapplicationname.
3.8 get_FullName
Returnsthefullpathoftheexecutable.
HRESULT get_FullName(BSTR *pVal);

Parameters
[out]pVal:AddressoftheBSTRusedtoreturntheapplicationfullpath.
Remarks
Thepathnamereturnedisthefullpath,forexample,"C:\ProgramFiles\Forsk\Atoll\Atoll.exe".
3.9 get_Path
Returnsthepathoftheexecutable.
HRESULT get_Path(BSTR *pVal);

Parameters
[out]pVal:AddressoftheBSTRusedtoreturntheapplicationpath.
Remarks
Thepathreturnedisprovidedasanabsolutepath,forexample,"C:\ProgramFiles\Forsk".
3.10 get_ActiveDocument
Returnstheactivedocument.
36
Forsk2014
AT321_TAG_E1
HRESULT get_ActiveDocument(IDocument **ppDocVal);

Parameters
[out]ppDocVal:AddressoftheIDocumentinterfacepointerusedtoreturntheDocumentobject.
Example
Dim app
Dim doc
Set doc = app.ActiveDocument
3.11 get_WindowStatus
ReturnsthewindowstatusoftheAtollapplication.
HRESULT get_WindowStatus(enum AtoWindowStatus *pVal);

Parameters
[out]pVal:AddressoftheAtoWindowStatusenumerationusedtoreturnthewindowstatus.
Example
Dim app
Dim status
status = app.WindowStatus
Const atoMinimized = 2
app.WindowStatus = atoMinimized
3.12 put_WindowStatus
SetsthewindowstatusoftheAtollapplication.
HRESULT put_WindowStatus(enum AtoWindowStatus aNewVal);

Parameters
[in]newVal:Thewindowstatus.
Example
See"get_WindowStatus"onpage 37.
3.13 put_StatusBar
SetsthestatusbartextoftheAtollapplication.
37
Forsk2014
HRESULT put_StatusBar(const BSTR bstrNewVal);

Parameters
[in]bstrNewVal:Thetexttodisplayinthestatusbar.
Example
Dim app
app.StatusBar = This is my message
3.14 get_Visible
Returnstheapplicationvisiblestate.
HRESULT get_Visible(VARIANT_BOOL *pVal);

Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturntheapplicationvisiblestate.
Remarks
WhenAtollisnotvisible,adialoguethatwouldnormallyrequireuserinputisautomaticallyclosedasiftheuserhasclicked
itsdefaultbuttonwithoutchanginganyofthedialoguecontrols.
3.15 put_Visible
Setstheapplicationvisiblestate.
HRESULT put_Visible(VARIANT_BOOL aNewVal);

Parameters
[in]aNewVal:
VARIANT_TRUE:MakesAtollvisible.
VARIANT_FALSE:HidesAtoll.
Remarks
WhenAtollisnotvisible,adialoguethatwouldnormallyrequireuserinputisautomaticallyclosedasiftheuserhasclicked
itsdefaultbuttonwithoutchanginganyofthedialoguecontrols.
3.16 get_Version
Returnstheapplicationversion.
HRESULT get_Version(BSTR *pVal);

Parameters
[out]pVal:AddressoftheBSTRusedtoreturntheversion.
38
AT321_TAG_E1
Remarks
ThestringisformattedlikeintheAtollaboutdialogue,forexample,"2.6.1".
Atoll3.1.0andabove:
Theapplicationbuildnumberisincludedinthestring,forexample,"3.1.0(Build3730)"
3.17 Quit
Quitstheapplication.
HRESULT Quit(enum AtoSaveChanges aSaveChanges, enum AtoSaveStatus *pStatus);

Parameters
[in]aSaveChanges:
atoSaveNo:Discardsdocumentchanges,thenclosestheapplication.
atoSaveYes:Savesdocumentchanges,thenclosestheapplication.
atoSavePrompt:Theuserispromptedtosavedocumentchanges,thentheapplicationisclosed.
[out]pStatus:TheAtoSaveStatusenumerationpointerusedtoreturnwhetherchangesweresuccessfullysavedornot.
ReturnsatoSaveCanceledwhentheuserwaspromptedandhaschosennottosavethechanges,otherwisereturns
atoSaveSucceeded.
3.18 LogMessage
DisplaysamessageintheAtolleventobserverwindow.
HRESULT LogMessage(const BSTR bstrMsg, enum AtoLogType aLogtype = atoInfo);

Parameters
[in]bstrMsg:Thetexttodisplay.
[in]aLogType:
atoInfo:Aninformationmessageisdisplayed.
atoError:Anerrormessageisdisplayed.
atoWarning:Awarningmessageisdisplayed.
:
4.
5.
:
3.19 CreatePropertyContainer
ReturnsanemptyPropertyContainerobject.
HRESULT CreatePropertyContainer(VARIANT *pProperties)

Parameters
[out]pProperties:AddressoftheVARIANTusedtoreturntheemptyPropertyContainerobject.
39
Forsk2014
Remarks
TheVARIANTreturnedifoftypeVT_DISPATCH,anditimplementstheIPropertyContainerinterface.Theemptycontainer
returnedcanbeusedtoholddefaultparametersspecifictoanAtolldocumentcommandortoholdanAtollChildFolder
Objectproperties.
3.20 get_IniFileFullPath
ReturnsthefullpathtotheAtollInitialisationFile.
HRESULT get_IniFileFullPath(BSTR *pVal);

Parameters
[out]pVal:AddressoftheBSTRusedtoreturnthefullpathtotheAtollInitialisationFile.
Remarks
TheAtollInitialisationFileisusuallynamed"Atoll.ini"anditislocatedinthedirectorywhereAtollwasinstalled.
Pleasenotethatforperformancereasons,someoptionsreadfromtheInitialisationFilebyAtollarecachedforsubsequent
usage.AfterthepathtotheInitialisationFilehasbeenchanged,andinorderforsomeoptionstobeused,itisnecessaryto
quitAtollandstartitagain.Therefore,itisrecommendedtochangethefullpathtotheInitialisationFileassoonastheAtoll
ApplicationObjecthasbeencreated.
PleaserefertotheAtollAdministratorManualforthelistofavailableoptions.
3.21 put_IniFileFullPath
SetsthefullpathtotheAtollInitialisationFile.
HRESULT put_IniFileFullPath(BSTR bstrFile);

Parameters
[in]bstrFile:ABSTRusedtospecifythefullpathtotheAtollInitialisationFile.
Remarks
TheAtollInitialisationFileisusuallynamed"Atoll.ini"anditislocatedinthedirectorywhereAtollwasinstalled.
usage.AfterthepathtotheInitialisationFilehasbeenchanged,andinorderforsomeoptionstobeused,itisnecessaryto
quitAtollandstartitagain.Therefore,itisrecommendedtochangethefullpathtotheInitialisationFileassoonastheAtoll
ApplicationObjecthasbeencreated.
PleaserefertotheAtollAdministratorManualforthelistofavailableoptions.
3.22 GetOption
ReturnsanoptionreadfromtheAtollInitialisationFile.
HRESULT GetOption(BSTR bstrSection, BSTR bstrOption, VARIANT *pVal);

Parameters
[in]bstrSection:ABSTRusedtospecifythenameofanAtollInitialisationFilesection.
[in]bstrOption:ABSTRusedtospecifythenameofanAtollInitialisationFileoption.
[out]pVal:AddressoftheVARIANTusedtoreturntheoptionvalue.ThetypeoftheVARIANTreturnedisVT_NULLwhenthe
optionbstrOptionisnotfoundunderthesectionbstrSectionintheInitialisationFile.ThetypeofthereturnedVARIANTis
VT_I4whentheoptionbstrOptionisaninteger,otherwisethetypeoftheVARIANTreturnedisVT_BSTR.IfbstrOptionisleft
empty,pValwillbeusedtoreturntheentiresectionwhosenameisspecifiedinbstrSection.
40
AT321_TAG_E1
Remarks
PleaserefertotheAtollAdministratorManualforthelistofavailablesectionsandoptions.
3.23 SetOption
SetsanoptionintheAtollInitialisationFile.
HRESULT SetOption(BSTR bstrSection, BSTR bstrOption, VARIANT varValue);

Parameters
[in]bstrSection:ABSTRusedtospecifythenameofanAtollInitialisationFilesection.
[in]bstrOption:ABSTRusedtospecifythenameofanAtollInitialisationFileoption.
[in]varValue:AVARIANTusedtospecifytheoptionvaluetowritetotheInitialisationFile.
Remarks
ThecallermusthavewriteaccesspermissiontotheInitialisationFile.
usage.Therefore,itisrecommendedtosetoptionsassoonastheAtollApplicationObjecthasbeencreated.
PleaserefertotheAtollAdministratorManualforthelistofavailablesectionsandoptions.
3.24 Sleep
Suspendstheapplicationapartmentexecution.
HRESULT Sleep(long lMilliseconds);

Parameters
[in]lMilliseconds:Alongintegerusedtospecifythetime,inmilliseconds,tosleep.
Example
Sleep 5 seconds
Atoll.Sleep 5000
Remarks
Applicationeventscanstillbeprocessedwhiletheapplicationapartmentexecutionissuspended.
ApplicationVersion
2.8.1
3.25 SetAddinInfoEx
Reservedforfutureuse.
HRESULT SetAddinInfoEx(
LONGLONG hInstance,
LPDISPATCH dispatch,
long idr,
long cookie
);
41
Forsk2014
Parameters
3.26 put_OLENotRespondingDialog
EnablesordisablesOLEnotrespondingdialog.
HRESULT put_OLENotRespondingDialog(VARIANT_BOOL newVal);

Parameters
[in]newVal:AVARIANT_BOOLusedtospecifywhethertheOLEnotrespondingdialogisenabled(VARIANT_TRUE),ordisabled
(VARIANT_FALSE).
3.27 put_OLEBusyDialog
EnablesordisablesOLEbusydialog.
HRESULT put_OLEBusyDialog(VARIANT_BOOL newVal);

Parameters
[in] newVal: A VARIANT_BOOL used to specify whether the OLE busy dialog is enabled (VARIANT_TRUE), or disabled
(VARIANT_FALSE).
3.28 put_OLEMessagePendingDelay
SetstheOLEmessagependingdelay.
HRESULT put_OLEMessagePendingDelay(LONG newVal);

Parameters
[in]newVal:ALONGintegerusedtospecifytheOLEmessagependingdelay.
3.29 ApplicationEvents
Eventsrelatedtotheapplicationarefired:
Beforetheapplicationshutsdown,
Whenadocumenthasjustbeenopened,
Beforeadocumentisclosed,
Beforeadocumentissaved,
Whenadocumenthasbeensaved,
Whenanewdocumenthasjustbeencreated,
Beforeadocumentisrefreshedfromdatabase,
Whenadocumenthasbeenrefreshedfromdatabase,
Beforeadocumentisarchivedindatabase,
Whenadocumenthasbeenarchivedindatabase,
Whenacalculationisrequested,
Afteracalculationhascompleted,
Whenalicenceisacquired,
Whenalicenceisreleased,
Beforeanewdocumentiscreatedfromanexistingdatabase.
3.29.1 WillQuitApp
EventfiredwhentheuserwantstoexitanAtollsession.Itoccursjustbeforealladdinsaredisconnectedandafteralldocu
mentshavebeenclosed.
42
AT321_TAG_E1
HRESULT WillQuitApp(VARIANT_BOOL* evtStatus);

Parameters
[out] evtStatus: A VARIANT_BOOL pointer used to return whether Atoll is allowed to quit (VARIANT_TRUE) or not
(VARIANT_FALSE).
3.29.2 DocumentOpenComplete
Eventfiredwhenadocumenthasbeenopened.
HRESULT DocumentOpenComplete(IDocument* document);

Parameters
[in]document:TheIDocumentinterfacepointerofthedocumentobjectwhichhasbeenopened.
3.29.3 WillCloseDocument
Eventfiredwhentheuserwantstocloseadocument.Itoccursjustbeforethedocumentcloses,i.e.,afterallconfirmations
requestedbyAtollhavebeenanswered(stoprunningtasks,savechanges,etc...).
HRESULT WillCloseDocument(IDocument* document, VARIANT_BOOL* evtStatus);

Parameters
[in]document:TheIDocumentinterfacepointerofthedocumentobjectbeingclosed.
[out]evtStatus:AVARIANT_BOOLpointerusedtoreturnwhetherthedocumentisallowedtobeclosed(VARIANT_TRUE)or
not(VARIANT_FALSE).
3.29.4 WillSaveDocument
Eventfiredwhentheuserwantstosaveadocument.Itoccursjustbeforethedocumentfileissavedbutafteravalidfilename
isset.
HRESULT WillSaveDocument(IDocument* document, VARIANT_BOOL* evtStatus);

Parameters
[in]document:TheIDocumentinterfacepointerofthedocumentobjectbeingsaved.
[out]evtStatus:AVARIANT_BOOLpointerusedtoreturnwhenthedocumentisallowedtobesaved(VARIANT_TRUE)ornot
(VARIANT_FALSE).
3.29.5 DocumentSaveComplete
Eventfiredjustafteradocumenthasbeensaved.
HRESULT DocumentSaveComplete (IDocument* document);

Parameters
[in]document:TheIDocumentinterfacepointerofthedocumentwhichhasbeensuccessfullysaved.
3.29.6 DocumentNewComplete
Eventfiredwhenanewdocumenthasbeencreated.
43
Forsk2014
HRESULT DocumentNewComplete(IDocument* document);

Parameters
[in]document:TheIDocumentinterfacepointerofthedocumentwhichhasbeencreated.
3.29.7 WillRefreshDocument
Eventfiredwhentheuserwantstorefreshadocumentfromdatabase.Itoccursjustbeforetheconnectionwiththedatabase
ischecked.
HRESULT WillRefreshDocument(IDocument* document, VARIANT_BOOL* evtStatus);

Parameters
[in]document:TheIDocumentinterfacepointerofthedocumentbeingrefreshed.
[out]evtStatus:AVARIANT_BOOLpointerusedtoreturnwhetherthedocumentisallowedtoberefreshed(VARIANT_TRUE)
ornot(VARIANT_FALSE).
3.29.8 RefreshDocumentComplete
Eventfiredwhenadocumenthasbeenrefreshedfromdatabase.
HRESULT RefreshDocumentComplete(IDocument* document);

Parameters
[in]document:TheIDocumentinterfacepointerofthedocumentwhichhasbeenrefreshed.
3.29.9 WillArchiveDocument
Eventfiredwhentheuserwantstoarchiveadocumenttothedatabase.Itoccursjustaftertheconnectionwiththedatabase
issetupandafterAtollhascheckedifanychangeshavetobearchived.Ifnothingrequiresarchiving,thiseventisnotfired.
HRESULT WillArchiveDocument(IDocument* document, VARIANT_BOOL* evtStatus);

Parameters
[in]document:TheIDocumentinterfacepointerofthedocumentbeingarchived.
[out]evtStatus:AVARIANT_BOOLpointerusedtoreturnwhetherthedocumentisallowedtobearchived(VARIANT_TRUE)
ornot(VARIANT_FALSE).
3.29.10 ArchiveDocumentComplete
Eventfiredwhenthedocumenthasbeenarchivedindatabase.Itoccursjustbeforetheconnectionwiththedatabaseis
broken.
HRESULT ArchiveDocumentComplete(IDocument* document);

Parameters
[in]document:TheIDocumentinterfacepointerofthedocumentwhichhasbeenarchived.
3.29.11 WillRun
Eventfiredwhentheuserwantstostartacalculation.IfallissettoVARIANT_TRUE,thiseventoccursaftertheuserhas
confirmedthatallpreviouscalculationsmustbedeleted.
44
AT321_TAG_E1
HRESULT WillRun(
IDocument* document,
VARIANT_BOOL all,
VARIANT_BOOL* evtStatus
);
Parameters
[in]document:TheIDocumentinterfacepointerofthedocumentonwhichcalculationisrequested.
[in]all:AVARIANT_BOOLvalueusedtospecifywhethertheuserhasrequested"CalculateAll(Ctrl+F7)"(VARIANT_TRUE)or
"Calculate(F7)"(VARIANT_FALSE).
[out] evtStatus: A VARIANT_BOOL pointer used to return whether calculation is allowed to run against the document
(VARIANT_TRUE)ornot(VARIANT_FALSE).
3.29.12 RunComplete
Eventfiredwhenthecalculationhasfinished.Itoccursafteralltaskshavecompleted.
HRESULT RunComplete(IDocument* document, VARIANT_BOOL succeeded);

Parameters
[in]document:TheIDocumentinterfacepointerofthedocument.
[in] succeeded: The VARIANT_BOOL used to specify whether calculation has succeeded (VARIANT_TRUE) or not
(VARIANT_FALSE).
Remarks
Fordocumentsbasedonthe3GPPMultiRATtemplate,theremaybeseveralRunCompleteeventsinresponsetoonecalcu
lationtask.Forinstance,thepathlossmatricescalculationmightresultin3RunCompleteevents,oneforLTE,oneforUMTS,
andoneforGSMmatrices.
3.29.13 LicenceAcquireComplete
ThisfeatureenablestheusertologAtolllicencetokenusagefromanaddin.Licencetokenconsumptionisavailableglobally
forallAtollinstancesrunningononelicenceserverusingadedicatedapplication(monitor.exe).
Externallicencetokensarenottrackedbythisevent.LicenceeventsfortheMeasurementsmodule(Measures)isavailable
forautoconnectedaddinsonly.
Firedwhenonelicencetokenisacquired.
HRESULT LicenceAcquireComplete(
IDocument *pDocument,
long lModuleID
);
Parameters
[in]pDocument:TheIDocumentinterfacepointerofthedocumentthatneededonelicencetoken.
[in]lModuleID:ThelongintegerusedtospecifytheIDofthelicencetokenthathasjustbeenacquired.
45
Forsk2014
Remarks
lModuleIDwillbeoneoftheseconstantvalues:
LICENCE_GSMTDMA
LICENCE_MW
LICENCE_MEASURES
LICENCE_AFP
LICENCE_PACK3G
LICENCE_UMTS
LICENCE_CDMA
LICENCE_TDSCDMA
LICENCE_WIMAX
LICENCE_LTE
ForLICENCE_MEASUREStoken,pDocumentwillbeNULL.
Moduleidentifiersusedwhenlicenceapplicationeventsarefired:
const long LICENCE_GSMTDMA = 2;

const long LICENCE_MW = 4;
const long LICENCE_MEASURES = 8;
const long LICENCE_AFP = 16;
const long LICENCE_PACK3G = 32;
const long LICENCE_UMTS = 64;
const long LICENCE_CDMA = 128;
const long LICENCE_TDSCDMA = 256;
const long LICENCE_WIMAX = 512;
const long LICENCE_LTE = 2048;
3.29.14 LicenceReleaseComplete
ThisfeatureenablestheusertologAtolllicencetokenusagefromanaddin.Licencetokenconsumptionisavailableglobally
forallAtollinstancesrunningononelicenceserverusingadedicatedapplication(monitor.exe).
Externallicencetokensarenottrackedbythisevent.LicenceeventsfortheMeasurements(Measures)modulewillbeavail
ableforautoconnectedaddinsonly.
Firedwhenonelicencetokenisreleased.
HRESULT LicenceReleaseComplete(
IDocument *pDocument,
long lModuleID
);
Parameters
[in]pDocument:TheIDocumentinterfacepointerofthedocumentthatjustreleasedthelicencetoken.
[in]lModuleID:ThelongintegerusedtospecifytheIDofthelicencetokenthathasjustbeenreleased.
Remarks
lModuleIDwillbeoneoftheseconstantvalues:
46
LICENCE_GSMTDMA
AT321_TAG_E1
LICENCE_MW
LICENCE_PACK3G
LICENCE_UMTS
LICENCE_CDMA
LICENCE_TDSCDMA
LICENCE_WIMAX
LICENCE_LTE
3.29.15 WillNewDocumentFromDatabase
3.2.0
Firedjustbeforeanewdocumentiscreatedfromanexistingdatabase.
HRESULT WillNewDocumentFromDatabase(
BSTR connexion,
BSTR schema,
VARIANT_BOOL *pEvtStatus
);
Parameters
[in]connexion:Thedatabaseconnexionstring.
[in]schema:Thedatabaseschema.
[out]evtStatus:AVARIANT_BOOLpointerusedtoreturnwhetherthecreationofthenewdocumentfromthedatabaseiden
tifiedbytheconnexionandschemaparametersisallowed(VARIANT_TRUE)ornot(VARIANT_FALSE).
47
48
Forsk2014
Chapter4
DocumentsObject
50
Forsk2014
Chapter4:DocumentsObject
AT321_TAG_E1
4 DocumentsObject
TheDocumentsobjectisusedtocreateanewdocumentortoiteratethroughopendocumentsinanAtollsession.
TheDocumentsobjectprovidesthefollowingpropertiesandmethods:
Name
Description
Attributes
get_Count
Returnsthenumberofcurrentlyopendocumentsinan
Atollsession.
Type:Integer
Access:Read
get_Item
ReturnsonedocumentcurrentlyopeninanAtollsession.
Type:Documents
object
Access:Read
get_Application
ReturnstheAtollapplicationobject.
Type:Application
object
Access:Read
get_Parent
Type:Application
object
Access:Read
Open
Opensanexistingdocumentandaddsittothecollectionof
opendocuments.
Add
Createsanewdocumentandaddsittothecollectionof
opendocuments.
OpenFromDatabase
Createsanewdocumentfromadatabaseandaddsitto
thecollectionofopendocuments.
CloseAll
Closesallopendocuments.
SaveAll
Savesallopendocuments.
4.1 HowtoAccessaDocumentsObject
ToaccessaDocumentsobject:
Dim allDocs
Set allDocs = Atoll.Documents
The"ForEach"VBScriptstatementcanbeusedwiththeDocumentscollectionobject:
Dim allDocs
Dim doc
Set allDocs = Atoll.Documents
For Each doc In allDocs
do some work with doc
...
Next
51
Forsk2014
4.2 get_Count
ReturnsthenumberofcurrentlyopendocumentsinanAtollsession.
HRESULT get_Count(LONG *pVal);

Parameters
[out]pVal:ALONGpointerusedtoreturnthenumberofopendocuments.
Example
Dim nDocs
nDocs = Atoll.Documents.Count
4.3 get_Item
ReturnsonedocumentcurrentlyopeninanAtollsession.
HRESULT get_Item(const VARIANT vIdx, IDocument **ppDoc);

Parameters
[in]vIdx:AVARIANToftypeVT_I4orVT_BSTRidentifyingthereturneddocument.AvariantoftypeVT_I4isinterpretedasa
zerobasedindexinthedocumentscollection.AvariantoftypeVT_BSTRisinterpretedasthenameofadocument.
[out]ppDoc:AddressoftheIDocumentinterfacepointerusedtoreturntheAtolldocumentobject.
Remarks
Thenameofadocumentisthedocumentfilename,asreturnedbyget_Name().
4.4 get_Application

Parameters
[out]ppVal:AddressoftheIApplicationinterfacepointerusedtoreturntheAtollapplicationobject.
4.5 get_Parent
HRESULT get_Parent(IApplication **ppVal);
Parameters
[out]ppVal:AddressoftheIApplicationinterfacepointerusedtoreturntheAtollapplicationobject.
4.6 Open
Opensanexistingdocumentandaddsittothecollectionofopendocuments.
52
AT321_TAG_E1
HRESULT Open(const
**pDoc);
BSTR
bstrPathName,
VARIANT_BOOL
aReadOnly,
IDocument
Parameters
[in]bstrPathName:Theabsolutepathofthedocumenttoopen.
[in]readOnly:VARIANT_TRUEmeansthedocumentwillbeopenedinreadonlymode.VARIANT_FALSEmeansthedocument
willbeopenedinreadwritemode.
[out]pDoc:AddressoftheIDocumentinterfacepointerusedtoreturntheopenDocumentobject.
Example
Dim doc
Set doc = app.Documents.Open(C:\Temp\myProject.atl)
4.7 Add
Createsanewdocumentandaddsittothecollectionofopendocuments.
HRESULT Add(BSTR templateName, IDocument **pDoc);

Parameters
[in]templateName:ThenameofanAtolltemplate.
[out]pDoc:AddressoftheIDocumentinterfacepointerusedtoreturnthenewDocumentobject.
Example
Dim doc
Set doc = app.Documents.Add(UMTS)
4.8 OpenFromDatabase
Createsanewdocumentfromadatabaseandaddsittothecollectionofopendocuments.
HRESULT OpenFromDatabase(VARIANT connection, BSTR schema, IDocument **pDoc);

Parameters
[in] connection: A VARIANT of type VT_BSTR or VT_UNKNOWN. If the variant is of type VT_BSTR, it is interpreted as the
connectionstringofthedatabaseyouwanttoconnectto.IfthevariantifoftypeVT_UNKNOWN,itisinterpretedasanADODB
connectioninterfacepointer.PleasereadtheMicrosoftdocumentationaboutADOXinterfaces.
[in]schema:Thenameofthedatabaseschema,incaseofdatabasessupportingmutischemabaseddefinition.Thesyntaxof
theschemastringis:
PropertyName = Value[;PropertyName = Value]

Availablepropertiesare:
PropertyName
Value
Version
Description
Project
string
2.6.0
Databaseschema
53
Forsk2014
KeepConnection
0|1
2.6.0
Whethertokeepconnectionwiththedatabaseornot
FieldGroups
groupname
[,groupname]
2.6.0
Commaseparatedvaluesoffieldgroups
SiteLists
sitelist[,sitelist]
2.6.0
Commaseparatedvaluesofsitelists
IntraTechnology
Neighbours
0|1
2.6.1
Whethertoloadthetable"NEIGHBOURS"ornot
InterTechnology
Neighbours
0|1
2.6.1
Whethertoloadthetable"NEIGHBOURSEXT"ornot
3.1.2
Commaseparatedvaluesofsystems.
Whencreatinganewdocumentfroma3GPPMultiRAT
database,itisusedtospecifytheradioaccesstechnologies
toload.
Availablevaluesforsystemsare:
GSM
UMTS
LTE
Whennopropertynamed"Systems"isspecifiedinthe
schemastring,allradiotechnologiesareloaded.
Systems
system,[system]
[out]pDoc:AddressoftheIDocumentinterfacepointerusedtoreturnthenewDocumentobject.
Remarks
Adialogueboxisdisplayedtoentertheschemapropertiesinthethesecases:
a. When schema is NULL, or schema is equal to the string constant "0".
b. When a project is specified, and when no site lists are specified in the schema parameter.
Nodialogueboxisdisplayedwhenaprojectisspecified,andwhenthesitelistspropertyoftheschemaparameterissetto
"<ALL>".Inthiscase,allsitesareloadedfromthedatabase.
Example
CreatinganewdocumentfromaMSAccessdatabase:
Public Sub OpenMSAccessDatabase

conn = "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\myproject.mdb"
Atoll.Documents.OpenFromDatabase conn, ""
End Sub
Creatinganewdocumentfromadatabase,specifyingasitelisttoload:
Public Sub OpenSiteList

conn = "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\myproject.mdb"
Atoll.Documents.OpenFromDatabase conn, "Site Lists=MySiteList"
End Sub
CreatinganewdocumentfromanOracledatabase,withnodialoguebox:
Creatinganewdocumentfroma3GPPMultiRATOracledatabase,loadingLTEandUMTSinformationonly:
4.9 CloseAll
Closesallopendocuments.
HRESULT CloseAll(AtoSaveChanges saveChanges, AtoSaveStatus *status);
54
AT321_TAG_E1
Parameters
[in]saveChanges:
atoSaveNo:Discardsdocumentchanges,thenclosesallopendocuments.
atoSaveYes:Savesdocumentchanges,thenclosesallopendocuments.
atoSavePrompt:Theuserispromptedtosavedocumentchanges,thenallopendocumentsareclosed.
[out]status:TheAtoSaveStatusenumerationpointerusedtoreturnwhetherchangesweresuccessfullysavedornot.
ReturnsatoSaveCanceledwhentheuserwaspromptedandhaschosennottosavethechanges,otherwisereturns
atoSaveSucceeded.
4.10 SaveAll
Savesallopendocuments.
HRESULT SaveAll();
55
56
Forsk2014
Chapter5
DocumentObject
58
Forsk2014
Chapter5:DocumentObject
AT321_TAG_E1
5 DocumentObject
TheDocumentobjectprovidesaccesstoATLdocumentsanddatabaseconnections.Adocumentcanbemanaged(open,save,
close,etc.)usingitspropertiesandmethods.Adocumentisalsothemainentrytomanageallthedataitcontains.
TheDocumentobjectprovidesthefollowingpropertiesandmethods:
Name
Description
Attributes
get_Application
ReturnstheAtollApplicationObject.
Type:Application
object
Access:Read
get_Parent
ReturnstheAtollDocumentscollection.
Type:Documents
object
Access:Read
get_FullName
Returnsthedocumentfullpath.
Type:String
Access:Read
get_Name
Returnsthedocumentfilenamewithouttheextension.
Type:String
Access:Read
get_Path
Returnsthedocumentpath.
Type:String
Access:Read
get_ReadOnly
Returnstrueifthedocumentisreadonly,falseotherwise.
Type:Boolean
Access:Read
get_Saved
Returnsfalseifthedocumentcontainsunsavedchanges,
trueotherwise.
Type:Boolean
Access:Read
get_CoordSystemProjection
Returnstheprojectioncoordinatesystemofadocument.
Type:CoordSystem
object
Access:Read/Write
putref_CoordSystemProjection
Setstheprojectioncoordinatesystemofadocument.
Type:CoordSystem
object
Access:Read/Write
get_CoordSystemDisplay
Returnsthedisplaycoordinatesystemofadocument.
Type:CoordSystem
object
Access:Read/Write
putref_CoordSystemDisplay
Setsthedisplaycoordinatesystemofadocument.
Type:CoordSystem
object
Access:Read/Write
get_CoordSystemInternal
Returnstheinternalcoordinatesystemofadocument.
Type:CoordSystem
object
Access:Read
get_TransmissionUnit
Returnsthetransmissionpowerunit.
Type:Integer
Access:Read/Write
put_TransmissionUnit
Setsthetransmissionpowerunit.
Type:Integer
Access:Read/Write
get_ReceptionUnit
Returnsthesignallevelreceptionunit.
Type:Integer
Access:Read/Write
put_ReceptionUnit
Setsthesignallevelreceptionunit.
Type:Integer
Access:Read/Write
get_DistanceUnit
Returnsthedisplaydistanceunit.
Type:Integer
Access:Read/Write
put_DistanceUnit
Setsthedisplaydistanceunit.
Type:Integer
Access:Read/Write
59
60
Forsk2014
Name
Description
Attributes
Close
Closesadocument.
FilePrint
Sendsadocumenttoaprinter.
Save
Savesadocument.
Refresh
Refreshesthedocumentfromadatabase.
Archive
Archivesthedocumentinadatabase.
Run
Startscalculations.
SetConfig
Loadsaconfigurationfile.
Import
Loadsafilecontaininggeographicdata.
GetRecords
ReturnsaTabularDataobjectforarequestedcategoryof
records.
Redraw
Refreshesallitemsinthedocument.
CenterMapOn
Centresmaponaparameterpoint.
GetRootFolder
ReturnstherootChildFolderobjectusedtoenumerateall
ChildFolderobjectsbelongingtoonetaboftheAtoll
explorerwindow.
RunPathloss
Calculatesthepathlossmatriceswithnoneedforany
predefinedstudies.
GetService
ReturnsaDocumentServiceObject.
ExportConfig
Exportsasubsetofthecurrentdocumentconfigurationtoa
file.
GetCommandDefaults
Returnscurrentdefaultparametersspecifictoacommand.
InvokeCommand
Invokesacommand.
get_RadiatedPowerUnit
Returnsthecurrentradiatedpowerunit.
Type:Integer
Access:Read/Write
put_RadiatedPowerUnit
Setsthecurrentradiatedpowerunit.
Type:Integer
Access:Read/Write
get_AntennaGainUnit
Returnsthecurrentantennagainunit.
Type:Integer
Access:Read/Write
put_AntennaGainUnit
Setsthecurrentantennagainunit.
Type:Integer
Access:Read/Write
get_HeightOffsetUnit
Returnsthecurrentheightoffsetunit.
Type:Integer
Access:Read/Write
put_HeightOffsetUnit
Setsthecurrentheightoffsetunit.
Type:Integer
Access:Read/Write
get_DatabaseConnectionString
Returnsthedatabaseconnectionstring.
Type:String
Access:Read/Write
HasRunningTask
Returnstruewhenthereissomecalculationinprogress.
Type:Boolean
Access:Read
RunEx
Startscalculations.
get_DatabaseSchemaString
Returnsthedatabaseschemastring.
Type:String
Access:Read/Write
get_DisplayApplicationDialogues
ReturnstruewhensomemethodsonsomeAtollinterfaces
maydisplaysomedialogueboxes.
Type:Boolean
Access:Read/Write
AT321_TAG_E1
Name
Description
Attributes
put_DisplayApplicationDialogues
ReturnstruewhensomemethodsonsomeAtollinterfaces
maydisplaysomedialogueboxes.
Type:Boolean
Access:Read/Write
PutDatabaseSchemaString
Setsthedatabaseschemastring.
Type:String
Access:Read/Write
PutDatabaseConnectionString
Setsthedatabaseconnectionstring.
Type:String
Access:Read/Write
ChangeDatabaseConnection
Changesthedatabaseconnectionstring.
Type:String
Access:Read/Write
5.1 HowtoAccessaDocumentObject
Toaccessadocument,youcaneither:
1. Requesttheactivedocumentfromtheapplication:
Set myDoc = Atoll.ActiveDocument

2. Or,usetheDocumentsobject:
Set myDoc = Atoll.Documents.Open(C:\temp\myproject.atl)
5.2 get_Application
ReturnstheAtollApplicationObject.

Parameters
[out]ppVal:AddressoftheIApplicationinterfacepointerusedtoreturntheAtollApplicationObject.
5.3 get_Parent
ReturnstheAtollDocumentscollection.
HRESULT get_Parent(IDocuments **ppDocVal);

Parameters
[out]ppDocVal:AddressoftheIDocumentsinterfacepointerusedtoreturntheAtollDocumentscollection.
5.4 get_FullName
Returnsthedocumentfullpath.
HRESULT get_FullName(BSTR *pVal);

Parameters
[out]pVal:AddressoftheBSTRusedtoreturnthedocumentfullpath.
61
Forsk2014
Remarks
Withanewdocumentthathasneverbeensaved,oradocumentopenedfromadatabase,anemptystringisreturned.
5.5 get_Name
Returnsthedocumentfilenamewithouttheextension.

Parameters
[out]pVal:AddressoftheBSTRusedtoreturnthedocumentfilenamewithouttheextension.
Remarks
5.6 get_Path
Returnsthedocumentpath.
HRESULT get_Path(BSTR *pVal);

Parameters
[out]pVal:AddressoftheBSTRusedtoreturnthedocumentpath.
Remarks
5.7 get_ReadOnly
Returnstrueifthedocumentisreadonly,falseotherwise.
HRESULT get_readOnly(VARIANT_BOOL *pVal);

Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturnthereadonlystatusofthedocument.
5.8 get_Saved
Returnsfalseifthedocumentcontainsunsavedchanges,trueotherwise.
HRESULT get_Saved(VARIANT_BOOL *pVal);

Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturnwhetherthedocumentcontainsunsavedchangesornot.
5.9 get_CoordSystemProjection
Returnstheprojectioncoordinatesystemofadocument.
62
AT321_TAG_E1
HRESULT get_CoordSystemProjection(IDispCoordSystem **ppVal);

Parameters
[out]ppVal:AddressoftheIDispCoordSysteminterfacepointerusedtoreturntheprojectioncoordinatesystemofthedocu
ment.
5.10 putref_CoordSystemProjection
Setstheprojectioncoordinatesystemofadocument.
HRESULT putref_CoordSystemProjection(IDispCoordSystem *pVal);

Parameters
[in]pVal:AddressoftheIDispCoordSysteminterfacepointerusedtosettheprojectioncoordinatesystemofthedocument.
5.11 get_CoordSystemDisplay
Returnsthedisplaycoordinatesystemofadocument.
HRESULT get_CoordSystemDisplay(IDispCoordSystem **ppVal);

Parameters
[out]ppVal:AddressoftheIDispCoordSysteminterfacepointerusedtoreturnthedisplaycoordinatesystemofthedocument.
5.12 putref_CoordSystemDisplay
Setsthedisplaycoordinatesystemofadocument.
HRESULT putref_CoordSystemDisplay(IDispCoordSystem *pVal);

Parameters
[in]pVal:AddressoftheIDispCoordSysteminterfacepointerusedtosetthedisplaycoordinatesystemofthedocument.
5.13 get_CoordSystemInternal
Returnstheinternalcoordinatesystemofadocument.
HRESULT get_CoordSystemInternal(IDispCoordSystem **ppVal);

Parameters
[out]ppVal:AddressoftheIDispCoordSysteminterfacepointerusedtoreturntheinternalcoordinatesystemofthedocu
ment.
Remarks
Whenthedocumentisnotconnectedtoadatabase,theinternalcoordinatesystemisthesameasthedisplaycoordinate
system.Whenthedocumentisconnectedtoadatabase,theinternalcoordinatesystemwontchangewhenthedisplaycoor
dinatesystemischanged.Whenthedocumentisconnectedtoadatabase,theinternalcoordinatesystemisthedisplaycoor
dinatesystemthatwasinusewhenthedocumentwasarchivedinthedatabaseforthefirsttime.
Thecoordinatesofsitesaredefinedwiththeinternalcoordinatesystem.
63
5.14 get_TransmissionUnit
Returnsthetransmissionpowerunit.
HRESULT get_TransmissionUnit(enum AtoTransmissionUnit *pVal);

Parameters
[out]pVal:AddressoftheAtoTransmissionUnitenumerationvalueusedtoreturnthetransmissionpowerunit.
5.15 put_TransmissionUnit
Setsthetransmissionpowerunit.
HRESULT put_TransmissionUnit(enum AtoTransmissionUnit aNewVal);

Parameters
[in]aNewVal:TheAtoTransmissionUnitenumerationvalueusedtospecifythetransmissionpowerunit.
5.16 get_ReceptionUnit
Returnsthesignallevelreceptionunit.
HRESULT get_ReceptionUnit(enum AtoReceptionUnit *pVal);

Parameters
[out]pVal:AddressoftheAtoReceptionUnitenumerationvalueusedtoreturnthesignallevelreceptionunit.
5.17 put_ReceptionUnit
Setsthesignallevelreceptionunit.
HRESULT put_ReceptionUnit(enum AtoReceptionUnit aNewVal);

Parameters
[in]aNewVal:TheAtoReceptionUnitenumerationvalueusedtospecifythesignallevelreceptionunit.
5.18 get_DistanceUnit
Returnsthedisplaydistanceunit.
HRESULT get_DistanceUnit(enum AtoDistanceUnit *pVal);

Parameters
[out]pVal:AddressoftheAtoDistanceUnitenumerationvalueusedtoreturnthedisplaydistanceunit.
5.19 put_DistanceUnit
Setsthedisplaydistanceunit.
64
Forsk2014
AT321_TAG_E1
HRESULT put_DistanceUnit(enum AtoDistanceUnit aNewVal);

Parameters
[in]aNewVal:TheAtoDistanceUnitenumerationvalueusedtospecifythedisplaydistanceunit.
5.20 Close
Closesadocument.
HRESULT Close(enum AtoSaveChanges saveChanges, enum AtoSaveStatus *pStatus);

Parameters
[in]saveChanges:AnAtoSaveChangesenumerationvalue.Thevaluesare:
Constant
Value
Description
atoSaveNo
Documentisclosedwithoutbeingsaved.
atoSaveYes
Documentissavedbeforebeingclosed.
atoSavePrompt
Theuserispromptedwhetherthedocumentmustbesavedbefore
closed.
status:atoSucceededifsavewasforcedtoatoSaveYesoratoSaveNooriftheuserwaspromptedandhehasanswered[out]
pStatus:AddressoftheAtoSaveStatusenumerationvalue.Returnedvaluesare:
Constant
Value
Description
atoSaveSucceeded
Documenthasbeensuccessfullysaved.
atoSaveCanceled
Changesinthedocumenthasbeencancelledbytheuser.
5.21 FilePrint
Sendsadocumenttoaprinter.Thecurrentprintsettingsareused.
HRESULT FilePrint();
5.22 Save
Savesadocument.
HRESULT Save(const BSTR pVal);

Parameters
[in]pVal:ABSTRusedtospecifywherethedocumentwillbesaved.WhenpValisanemptystring,thedocumentissavedin
place,theactionperformedisthesameastheAtoll"File|Save"menucommand.WhenpValisthefullpathtoanATLfile,
thentheactionperformedisthesameastheAtoll"File|Saveas..."menucommand.WhenpValisthefullpathtoaMicrosoft
AccessdatabasefileorwhenpValisanOracledatabaseconnectionstring,thentheactionperformedisthesameastheAtoll
"File|Database|Export..."menucommand.
5.23 Refresh
Refreshesthedocumentfromadatabase.Thedocumentmustbeconnectedtoadatabase.
65
Forsk2014
HRESULT Refresh(enum AtoRefreshPriority aPriority);

Parameters
[in]aPriority:TheAtoRefreshPriorityenumerationvalueusedtorefreshthedocumentfromthedatabase.
5.24 Archive
Archivesthedocumentinadatabase.Thedocumentmustbeconnectedtoadatabase.
HRESULT Archive(enum AtoArchiveStatus *pStatus);

Parameters
[out]pStatus:AddressoftheAtoArchiveStatususedtoreturntheresultoftheoperation.
Remarks
Atoll>=2.7.0:
WhentheDisplayApplicationDialoguepropertyofthedocumentissettotrue,thestandardAtollarchivedialoguewillbe
displayed,otherwisenodialogueisdisplayedandallchangesarearchived.
5.25 Run
Startscalculations.
HRESULT Run(VARIANT_BOOL aAll);

Parameters
[in]aAll:TheVARIANT_BOOLvalueusedtospecifywhetherallpreviousresultsmustbedeletedbeforethecalculationsstarts
(VARIANT_TRUE),orifonlyinvalidpathlossmatricesmustbecalculated(VARIANT_FALSE).
Remarks
1)WhenaAllissettoVARIANT_TRUE,theresultisthesameastheAtoll"Tools|Forcecalculation"menucommand.When
aAllissettoVARIANT_FALSE,theresultisthesameastheAtoll"Tools|Calculate"menucommand.
2)Themethodreturnsimmediatelyandcalculationsoccurinthebackground.
3)AnerrorisreturnedwhenitiscalledonaMicrowaveRadioLinksAtolldocument.
TheWillRunapplicationeventisthrownbythismethod.
5.26 SetConfig
Loadsaconfigurationfile.
HRESULT SetConfig(const BSTR bstrFileName);

Parameters
[in]bstrFileName:TheBSTRusedtospecifythefullpathoftheconfigurationfiletoload.
Remarks
Theconfigurationfileisa.CFGfileobtainedusingtheAtoll"UserConfiguration|Export..."menucommand.Itmaycontain
geographic configuration and folder configurations. Please see the Atoll Administrator Manual. The configurations in the
documentarereplacedwiththeconfigurationscontainedinthe.CFGfile.Ifyousimplywanttoaddsomegeographicdatato
adocument,youshouldratherusetheImportmethodinstead.
66
AT321_TAG_E1
5.27 Import
Loadsafilecontaininggeographicdata.
HRESULT Import(const BSTR fileName);

Parameters
[in]fileName:ABSTRusedtospecifythefullpathofthefiletoload.
Remarks
Thegeographicfilecanbe:
An.CFGfile.Alldatafromitsgeographicsectionareloaded.PleaseseetheAtollAdministratorManual.
AnyfileformatsupportedbyAtoll(.BIL,.TIF,etc).
Thegeographiccontentoftheimportedfile(.CFG,.GEO,.BIL,.TIF,etc.)isaddedtothecurrentconfigurationofthegeographic
datainthedocument.Theexistinggeographicconfigurationisnotremoved.
Ifyouwanttoreplacethegeographicconfigurationofadocument,youshouldusetheSetConfigfunctioninstead.
Youmustensurethatnoinputsarerequestedfromtheuserwhenimportingthefile(for
instancethefiletype,georeferencementparameters,etc.)whentheapplicationisnot
visible.
5.28 GetRecords
ReturnsanAtollTabularDataObjectforarequestedcategoryofrecords.
n
HRESULT GetRecords(
const BSTR bstrTableName,
VARIANT_BOOL aAll,
ITabularData *ppRecords
);
Parameters
[in]bstrTableName:ABSTRusedtospecifythenameofthetablefromwhichtherecordsarerequested.
[in] aAll: A VARIANT_BOOL. When it is set to VARIANT_TRUE, all the records of the table are returned. When it is set to
VARIANT_FALSEandwhenthereisanAtolldocumentfolderassociatedwithbstrTableName,thefiltersetonthedocument
folderisusedtofilterthereturnedrecords.Ifnoassociatedfolderexists,thisparameterisignored.
[out]ppRecords:AddressoftheITabularDatainterfacepointerusedtoreturntheAtollTabularDataObject.
Remarks
Thelistofavailabletablenamesdefined by Atollcanbe found inthetemplate (.MDB)file. Please see the Administrator
Manualfortheavailabletablenames.Someothertablenamesareavailable:
PREDICTIONS:togetpathlossmatricesandsignallevelmatrices.
ZONES:togeteitherthecalculationzoneorthefocuszone.
ChangesintroducedinAtollversion2.7.1andabove
1)Table"REPEATERS_VIEW"
WhenbstrTableNameisequaltoREPEATERS_VIEW,theTabularDataobjectreturnedisajoinonthe"TRANSMITTERS"and
the"REPEATERS"table.Thefieldsreturnedwillbethe"TRANSMITTERS"tablefieldsandthe"REPEATERS"tablefields,where
TRANSMITTERS.TX_ID=REPEATERS.TX_ID.Thenameofthefieldsofthe"REPEATERS"tableinthe"REPEATERS_VIEW"are
67
Forsk2014
prefixedwith"TX_ID."whereasthenamesofthefieldscomingfromthe"TRANSMITTERS"tableareleftunchanged.When
aAll is VARIANT_FALSE, then the filter set on the Transmitters folder of the Atoll document is used to filter the
REPEATERS_VIEWtablerecords,otherwiseallrepeatersorremoteantennasarereturned.Aremoteantennaisarepeater
whiththefieldEQUIPMENT_NAMEsettoVT_NULL.
2)Table"REPEATERS"
WhenbstrTableNameisequaltoREPEATERS,andaAllisVARIANT_FALSE,thenthefiltersetontheTransmittersfolderof
theAtolldocumentisusedtofiltertheREPEATERStablerecords,otherwiseallrepeatersorremoteantennasarereturned.
AremoteantennaisarepeaterwhiththefieldEQUIPMENT_NAMEsettoVT_NULL.
ChangesintroducedinAtollversion3.1.1andabove
1)Table"MWLinks"
When bstrTableName is equal to MWLinks, the TabularData object returned has an additional column named
"_LINK_LENGTH",usedtoaccessthelengthofMicrowavelinksassingleprecisionfloatingpointvalues.
Example
Dim records
Returns the content of the SITES table
Set records = app.ActiveDocument.GetRecords("Sites", True)
Returns the content of the Sites folder, taking the folder filter into account
Set records = app.ActiveDocument.GetRecords("Sites", False)
5.29 Redraw
Refreshesallitemsinthedocument.
HRESULT Redraw();
Remarks
IthasthesameeffectastheiconRefresh(F5)inAtoll.
5.30 CenterMapOn
Centresmaponaparameterpoint.
HRESULT CenterMapOn(double* ptx, double* pty);

Parameters
[in]ptx,[in]pty:Thedoublepointersusedtospecifythecoordinatesofthepointtocentresthemapviewon.Thecoordinate
systemusedmustbethethedocumentcoordinatesystem.
5.31 GetRootFolder
ReturnstherootAtollChildFolderObjectusedtoenumerateallChildFolderobjectsbelongingtoonetaboftheAtollexplorer
window.
HRESULT GetRootFolder(enum AtoRootType aType, IChildFolder **ppItem);
68
AT321_TAG_E1
Parameters
[in]aType:TheAtoRootTypeenumerationvalueusedtospecifytheAtollexplorerwindowtab.ThereisonerootChildFolder
objectforeachtaboftheAtollexplorerwindow.
[out]ppItem:AddressoftheIChildFolderinterfacepointerusedtoreturntherootChildFolderobject.
Example
Dim geo
const atoGeo = 1
Returns the root ChildFolder object of the Atoll explorer "Geo" tab
Set geo = app.ActiveDocument.GetRootFolder(atoGeo)
5.32 RunPathloss
Calculatesthepathlossmatriceswithnoneedforanypredefinedstudies.
HRESULT RunPathloss(VARIANT_BOOL allTx, VARIANT_BOOL forced);

Parameters
[in]allTx:WhenVARIANT_TRUE,thecalculationismadeforallactivetransmittersinthetable.WhenVARIANT_FALSE,only
filteredtransmittersarecalculated.
[in] forced: When VARIANT_TRUE, the calculation is forced even for transmitters having available valid results. When
VARIANT_FALSE,thecalculationismadeonlyfortransmittershavingunavailableorinvalidresults.
Remarks
1)Thismethodcorrespondstothemenucommands"Calculations|CalculatePathLossMatrices"and"Calculations|Force
PathLossMatrixCalculation"availableintheCalculationssubmenuoftheTransmittersfolder.
2)Themethodreturnsimmediatelyandthecalculationsoccurinthebackground.
Howtodetecttheendofpathlossmatricescalculation?
Towaitfortheendofbackgroundpathlossmatricescalculation,pleaseusetheHasRunningTaskdocumentobjectmethod.
Whilebackgroundcalculationsarerunning,HasRunningTaskreturnsTrue.AssoonasHasRunningTaskreturnsFalse,youcan
assumethatbackgroundcalculationsarefinished:
'"Wait" Loop
Do While AtollDoc.HasRunningTask
WScript.Sleep 1000
Loop
5.33 GetService
ReturnsascriptableDocumentServiceObject.
HRESULT GetService(BSTR bstrName, IDispatch** ppProvider)

Parameters
[in]bstrName:ABSTRusedtospecifythenameoftheservice.
69
Forsk2014
Theavailablevaluesare:
"SIGNAL":AResultFileProviderobject,implementingtheIResultFileProviderinterface.
OndocumentsbasedontheGSMGPRSEDGEtemplate:
"AFP":AGSMFrequencyPlanAllocationobject,implementingtheIAfpLauncherinterface.
"AFP_IM":AGSMInterferenceMatricesobject,implementingtheIAfpImLauncherinterface.
[out]ppProvider:AddressoftheIDispatchinterfacepointerusedtoreturnthescriptableDocumentServiceObject.
5.34 ExportConfig
Exportsasubsetofthecurrentdocumentconfigurationtoafile.
HRESULT ExportConfig(const BSTR bstrContent, const BSTR bstrFile);

Parameters
[in]bstrContent:ABSTRusedtospecifytheconfigurationsubsettoexport:
"GEO":The"GeographicDataSet"configurationisexported.
"GEO+ZONES":The"GeographicDataSet"and"ComputationandFocusZones"configurationsareexported.
"FULL":Allavailableconfigurationsareexported.
Atoll2.7.1andabove:
bstrContentisparsedaccordingtotheformat"OPTION[+OPTION]".ThesetofspecifiedoptionsareexportedtobstrFile.Avail
ableoptionsare:
OPTIONname
Description
GEO
GeographicDataSet
ZONES
ComputationandFocusZones
STUDIES
PredictionList
Atoll 3.1.0 and above:
OPTIONname
Description
FOLDERS
FolderConfiguration
MACROS
Macros
AFP
AFPConfiguration
ANP
AutomaticNeighbourAllocationParameters
MW
MicrowaveLinkParameters
PNO
AutomaticPNOffsetAllocationParameters
SCP
AutomaticScramblingCodeAllocationParameters
[in]bstrFile:ABSTRusedtospecifythenameoftheexportfile.
5.35 GetCommandDefaults
Returnscurrentdefaultparametersspecifictoacommand.
HRESULT GetCommandDefaults(
const BSTR bstrCommandName,
70
AT321_TAG_E1
IPropertyContainer **ppParameters
);
Parameters
[in]bstrCommandName:ABSTRusedtospecifythecommand.
[out] ppParameters: Address of the IPropertyContainer interface pointer used to return the defaults parameters for the
bstrCommandNamecommand.
5.36 InvokeCommand
Invokesacommand.
HRESULT InvokeCommand(
const BSTR bstrCommandName,
IPropertyContainer *pParameters,
IPropertyContainer **ppResults
);
Parameters
[in]bstrCommandName:ABSTRusedtospecifythecommand.
[in]pParameters:TheIPropertyContainerinterfacepointerusedtospecifythePropertyContainerobjectholdingtheparam
etersneededtocarryoutthecommand.
IfsettoNULL,defaultparametersforthecommandwillbeused.
ppResults:Resultsofthecommandinvokation.
*ppResultswillbesettoNULLifthecommandhasnoresults.
5.37 get_RadiatedPowerUnit
Returnsthecurrentradiatedpowerunit.
HRESULT get_RadiatedPowerUnit(enum AtoRadiatedPowerUnit *pVal);

Parameters
[out]pVal:AddressoftheAtoRadiatedPowerUnitenumerationvalueusedtoreturntheradiatedpowerunit.
5.38 put_RadiatedPowerUnit
Setsthecurrentradiatedpowerunit.
HRESULT put_RadiatedPowerUnit(enum AtoRadiatedPowerUnit aNewVal);

Parameters
[in]aNewVal:TheAtoRadiatedPowerUnitenumerationvalueusedtospecifytheradiatedpowerunit.
5.39 get_AntennaGainUnit
Returnsthecurrentantennagainunit.
71
HRESULT get_AntennaGainUnit(enum AtoAntennaGainUnit *pVal);

Parameters
[out]pVal:AddressoftheAtoAntennaGainUnitenumerationvalueusedtoreturntheantennagainunit.
5.40 put_AntennaGainUnit
Setsthecurrentantennagainunit.
HRESULT put_AntennaGainUnit(enum AtoAntennaGainUnit aNewVal);

Parameters
[in]aNewVal:TheAtoAntennaGainUnitenumerationvalueusedtospecifytheantennagainunit.
5.41 get_HeightOffsetUnit
Returnsthecurrentheightoffsetunit.
HRESULT get_HeightOffsetUnit(enum AtoHeightOffsetUnit *pVal);

Parameters
[out]pVal:AddressoftheAtoHeightOffsetUnitenumerationvalueusedtoreturntheheightoffsetunit.
5.42 put_HeightOffsetUnit
Setsthecurrentheightoffsetunit.
HRESULT put_HeightOffsetUnit(enum AtoHeightOffsetUnit aNewVal);

Parameters
[in]aNewVal:TheAtoHeightOffsetUnitenumerationvalueusedtospecifytheheightoffsetunit.
5.43 get_DatabaseConnectionString
Returnsthedatabaseconnectionstring.
HRESULT get_DatabaseConnectionString(BSTR *pVal);

Parameters
[out]pVal:AddressoftheBSTRusedtoreturnthedatabaseconnectionstring.
Remarks
Anerrorisreturnedwhenthedocumentisnotconnectedtoadatabase.
5.44 HasRunningTask
Returnstruewhenthereissomecalculationinprogress.
HRESULT HasRunningTask(VARIANT_BOOL *pVal);
72
Forsk2014
AT321_TAG_E1
Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturnwhetherthereissomecalculationinprogressornot.
Remarks
Whensomecalculationisinprogress,itisimpossibletostartnewones.
5.45 RunEx
Startcalculations.
HRESULT RunEx(VARIANT_BOOL aAll, VARIANT_BOOL vbBlocking);

Parameters
[in]aAll:TheVARIANT_BOOLvalueusedtospecifywhetherallpreviousresultsmustbedeletedbeforethecalculationsstarts
(VARIANT_TRUE),orifonlyinvalidpathlossmatricesmustbecalculated(VARIANT_FALSE).
[in] vBlocking: The VARIANT_BOOL value used to specify whether the calculations will occur in the background
(VARIANT_FALSE),orifthemethodshouldwaitforthecalculationstofinishbeforereturning(VARIANT_TRUE).
Remarks
1)WhenaAllissettoVARIANT_TRUE,theresultisthesameastheAtoll"Tools|Forcecalculation"menucommand.When
aAllissettoVARIANT_FALSE,theresultisthesameastheAtoll"Tools|Calculate"menucommand.
TheWillRunapplicationeventisthrownbythismethod.
WhenvbBlockingissettoVARIANT_TRUE,theRunCompleteapplicationeventisthrownbythismethodbeforeitreturns.
5.46 get_DatabaseSchemaString
Returnsthedatabaseschemastring.
HRESULT get_DatabaseSchemaString(BSTR *pVal);

Parameters
[out]pVal:AddressoftheBSTRusedtoreturnthedatabaseschemastring.
Remarks
Anerrorisreturnedwhenthedocumentisnotconnected.
ThedatabaseschemastringisreturnedusingtheexactsamesyntaxdescribedfortheOpenFromDatabasemethod.
5.47 get_DisplayApplicationDialogues
ReturnstruewhensomemethodsonsomeAtollinterfacesmaydisplaysomedialogueboxes.
HRESULT get_DisplayApplicationDialogues(VARIANT_BOOL *pVal);

Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturnwhethersomedialogueboxemaybedisplayeduponinvokationof
somemethodonsomeAtollinterface.
Remarks
SettingtheApplicationObjectvisibilitystatetofalsesetsthisvaluetofalse.
73
Forsk2014
5.48 put_DisplayApplicationDialogues
ReturnstruewhensomemethodsonsomeAtollinterfacesmaydisplaysomedialogueboxes.
HRESULT put_DisplayApplicationDialogues(VARIANT_BOOL aNewVal);

Parameters
[in]aNewVal:TheVARIANT_BOOLusedtospecifywhethersomedialogueboxemaybedisplayeduponinvokationofsome
methodonsomeAtollinterface.
Remarks
SettingtheApplicationObjectvisibilitystatetofalsesetsthisvaluetofalse.
5.49 PutDatabaseSchemaString
Setsthedatabaseschemastring.
HRESULT PutDatabaseSchemaString(BSTR aVal);

Remarks
Thismethodisnotimplemented.
Pleasedonotusethismethod.
AtollVersion
2.8.1
5.50 PutDatabaseConnectionString
Setsthedatabaseconnectionstring.
HRESULT PutDatabaseConnectionString(BSTR aVal);

Parameters
[in]aVal:
TheBSTRusedtospecifythenewdatabaseconnectionstring.
Todisconnectthedocumentfromthedatabase,specifyaNULLBSTRvalueoranemptystring.
Remarks
Anerrorisreturnedwhenthedocumentisnotconnectedtoadatabase.
DependingontheaValparametervalue,theactionperformedisthesameasDatabase|ConnectionProperties|Modify,or
Database|ConnectionProperties|Disconnect.
AtollVersion
2.8.1
5.51 ChangeDatabaseConnection
Changesthedatabaseconnectionstring.
HRESULT ChangeDatabaseConnection(BSTR aCnn, BSTR aReserved);
74
AT321_TAG_E1
Parameters
[in]aCnn:
TheBSTRusedtospecifythenewdatabaseconnectionstring.
[in]aReserved:
ABSTRreservedforafutureusage.
Remarks
Pleasedonotusethismethod.UsePutDatabaseConnectionStringinstead.
AtollVersion
2.8.1
5.52 get_TemperatureUnit
Returnsthedisplaytemperatureunit.
HRESULT get_TemperatureUnit(enum AtoTemperatureUnit *pVal);

Parameters
[out]pVal:AddressoftheAtoTemperatureUnitenumerationvalueusedtoreturnthedisplaytemperatureunit.
5.53 put_TemperatureUnit
Setsthedisplaytemperatureunit.
HRESULT put_TemperatureUnit(enum AtoTemperatureUnit aNewVal);

Parameters
[in]aNewVal:TheAtoTemperatureUnitenumerationvalueusedtospecifythedisplaytemperatureunit.
5.54 GetDocumentProperties
Returnsthedocumentproperties.
HRESULT GetDocumentProperties(IPropertyContainer **ppProperties);

Parameters
[out]ppProperties:AddressoftheIPropertyContainerinterfacepointerusedtoreturnthedocumentproperties.
Remarks
PleaseseetheSetDocumentPropertiesdocumentationforthelistofavailabledocumentproperties.
5.55 SetDocumentProperties
Setsthedocumentproperties.
HRESULT SetDocumentProperties(IPropertyContainer *pProperties);
75
Forsk2014
Parameters
[in]pProperties:TheIPropertyContainerinterfacepointerusedtospecifythedocumentproperties.
Remarks
Availabledocumentpropertiesare:
Name
Type
PROJECT
String
DATE
String
AUTHOR
String
TITLE
String
COMMENT
String
STATUS
String
LOGO
String
USER_PROPERTY0
USER_PROPERTY1
USER_PROPERTY2
USER_PROPERTY3
USER_PROPERTY4
USER_PROPERTY5
USER_PROPERTY6
USER_PROPERTY7
USER_PROPERTY8
USER_PROPERTY9
76
USER_PROPERTY_NAME0
String
USER_PROPERTY_NAME1
String
USER_PROPERTY_NAME2
String
USER_PROPERTY_NAME3
String
USER_PROPERTY_NAME4
String
USER_PROPERTY_NAME5
String
USER_PROPERTY_NAME6
String
USER_PROPERTY_NAME7
String
USER_PROPERTY_NAME8
String
AT321_TAG_E1
USER_PROPERTY_NAME9
String
77
78
Forsk2014
Chapter6
TabularDataObject
80
Forsk2014
Chapter6:TabularDataObject
AT321_TAG_E1
6 TabularDataObject
TheTabularDataobjectprovidesaccesstoAtolltableswhetheranAtolldocumentisconnectedtoadatabaseornot.Italso
providesaccesstoothertableswhicharenotdatabasetables,suchasPREDICTIONSandZONES,explainedin"Zonesand
PredictionsTabularDataObjects"onpage 97.
AccesstotabulardatainanAtolldocumentconnectedtoadatabase
For each database table, access is provided to differences between the content of the
databasewhenthedatatablehasbeenrefreshedforthelasttimeandthecurrenttable
contentstoredinanAtolldocument.ThesearethedifferenceslistedintheAtollDatabase
Archivedialogue,whichcanbesubmittedthroughanexternalprocessusingthisinterface.
Accessisgiventheoriginaldataasretrievedbythelatestrefreshoperationfromthedata
base.Accessisnotgiventothecurrentcontentofthedatabase.Therefore,itisnotpossi
bletoshoworsolveconflictsbetweenthedataintheAtolldocumentandthecurrent
contentofthedatabase.
Foragivendatabasetable,originaldatavaluesandrowstatusesarenotstoredinthedata
base.TheyarestoredintheAtolldocument.
TheTabularDataobjectprovidesthefollowingpropertiesandmethods:
Name
Description
Attributes
get_ColumnCount
ReturnsthenumberofcolumnsoftheTabularDataObject.
Type:Integer
Access:Read
get_RowCount
ReturnsthenumberofrowsoftheTabularDataObject
Type:Integer
Access:Read
Edit
Putsarowintoeditionmode.
AddNew
AddsanewemptyrowtotheTabularDataObject.Therow
addedisputintoeditionmode.
Update
Commitsarowchangesandputstherowfromeditionmode
tonormalmode.
Delete
Deletesarecord.
GetValue
Returnsavalueofacolumnforagivenrow.
SetValue
Setsthevalueofacolumnfortherowbeingeditedoradded.
GetPrimaryKey
Returnsthevalueoftheprimarykeyforagivenrownumber.
FindPrimaryKey
Searchestherowwhoseprimarykeyequalstheinputvalue
andreturnstherownumberoftherowfound.
Find
Searchesacolumnforavalue.
GetFormattedValue
Returnsacolumnvalueformattedasastring.
CancelUpdate
Cancelsapendingupdate.
get_ColumnNumber
Returnsacolumnnumber.
Type:Integer
Access:Read
get_CanEdit
Checksifrowscanbemodified.
Type:Boolean
Access:Read
get_CanAddNew
Checksifrowscanbeadded.
Type:Boolean
Access:Read
get_CanFilterSort
Checksifrowscanbefilteredorsorted.
Type:Boolean
Access:Read
get_Filter
Returnsthefiltercurrentlysetonthetable.
Type:String
Access:Read/Write
81
Forsk2014
Name
Description
Attributes
put_Filter
Filtersthetabledataaccordingtoafiltercriteria.
Type:String
Access:Read/Write
get_Sort
Returnsthesortordercurrentlysetonthetable.
Type:String
Access:Read/Write
put_Sort
Sortsthetabledata.
Type:String
Access:Read/Write
GetOriginalValue
Returnsanoriginalfieldvalue.
get_RowStatus
Returnsarowstatus.
Type:Integer
Access:Read
6.1 HowtoAccessaTabularDataObject
ATabularDataobjectisdefinedbyitsstructure(numberofcolumns,nameofcolumns)anditscontent(rows=records).
Column0androw0arespecial:
Row0holdsthefieldnames,i.e.,thetablestructuredescription.
Column0holdsauniqueidentifierforrecords,calledRECORD_ID.Thisidentifierisnotpersistentandmustnotbe
usedbetweentwosessionsofAtoll,neitherwhenrefreshingnorwhenarchiving.
Thus,inordertogetatabulardatastructure,youwrite:
Dim i
Dim colName
Dim records
Set records = Atoll.ActiveDocument.GetRecords("Transmitters", True)
For i = 0 To records.ColumnCount
colName = records.GetValue(0, i)
Next
Thefirstvalue(fori=0)isalways"RECORD_ID".Thesecond(fori=1)is"SITE_NAME"incaseofTRANSMITTERStable,andso
on.Thelastonecorrespondstoi=ColumnCount.
Toreadthecalculationradiiofallthetransmitters,youwrite:
Dim i
Dim radius
Dim records
Set records = Atoll.ActiveDocument.GetRecords("Transmitters", True)
For i = 1 To records.RowCount
radius = records.GetValue(i, CALC_RADIUS)
Next
Notethattheloopdoesnotstartwithi=0becauseGetValuewouldreturnthestring"CALC_RADIUS"andnotavalue.
Ifweknowthatcolumn"CALC_RADIUS"isnumber11,wecouldinsteadwrite:
82
AT321_TAG_E1
radius = records.GetValue(i, 11)

ButitisbettertoletAtollmanagethecorrespondencebyitself.
ThetablenamesyoucanusetorequestGetRecordsinadocumentareAtolltablesdefinedinthedocumenttemplateinitially
usedtocreateyourdocument,anddependonthetypeofnetwork.
Youcanalsogetsomeadditionaltables:Predictions,Zones.
Predictionstabulardatagivesaccesstopathlossandsignallevelmatrices.
Zonestabulardatagivesaccesstocalculationandfocuszones.
Formoreinformation,see"ZonesandPredictionsTabularDataObjects"onpage 97.
6.2 get_ColumnCount
ReturnsthenumberofcolumnsoftheTabularDataObject.
HRESULT get_ColumnCount(long *pVal);

Parameters
[out]pVal:Addressofthelongintegerusedtoreturnthenumberofcolumns.
Remarks
This number does not include the RECORD_ID column. If a table TABLE1 is defined by FIELD1, FIELD2, and FIELD3,
get_ColumnCountreturns3,eventhoughthereare4columns:RECORD_ID,FIELD1,FIELD2,andFIELD3.
6.3 get_RowCount
ReturnsthenumberofrowsoftheTabularDataObject
HRESULT get_RowCount(long *pVal);

Parameters
[out]pVal:Addressofthelongintegerusedtoreturnthenumberofrows.
Remarks
The first row is row number 0 and it contains the TabularData Object field names. If a table TABLE1 has no record, 0 is
returned.Theactualcontentsofthetablestartsatrownumber1.GetValue(0,1)returnsFIELD1,whichisthenameofthe
columnnumber1(readinrownumber0).GetValue(0,0)returnsRECORD_ID,whichisthenameofthecolumnnumber0
(readinrownumber0).GetValue(1,1)returnsthevalueforcolumnFIELD1(number1)inrownumber1.
6.4 Edit
Putsarowintoeditionmode.
HRESULT Edit(long iRow);

Parameters
[in]iRow:Thelongintegerusedtospecifytherownumbertoputintoeditionmode.
Remarks
Oncearowisputintoeditionmode,itispossibletochangetherowcontentsbyusingSetValue.Updateisusedtocommit
therowchanges.
83
Forsk2014
DontforgettocallthismethodbeforeacalltoSetValueandtocallUpdatetocommitthe
changesintherow.
6.5 AddNew
AddsanewemptyrowtotheTabularDataObject.Therowaddedisputintoeditionmode.
HRESULT AddNew();
DontforgettocallthismethodbeforeacalltoSetValueandtocallUpdatetoactuallyadd
thenewrow.
6.6 Update
Commitsarowchangesandputstherowfromeditionmodetonormalmode.
HRESULT Update(long *piRow);

Parameters
[out]piRow:Thelongintegerpointerusedtoreturnthenumberoftherowthatwasineditionmode.IfthemethodEdit
startedtheediting,thesameiRowasinEditisreturned.IfitwasAddNewmethod,thenumberistherownumberwherethe
newrecordhasbeenadded.
Remarks
Atonepointintime,onlyonerecordcanbeputintoeditionmode.ThismethodmustbecalledonceaftereachEditand
AddNew.Editinganotherrecordwithoutupdatingthepreviousonewillthrowanerror.Edit/Updatecannotbemixedupfor
differentrecords,neithercanbeAddNew/Update.
6.7 Delete
Deletesarecord.
HRESULT Delete(long iRow);

Parameters
[in]iRow:Thelongintegerusedtospecifytherownumberoftherecordtodelete.
Remarks
AvalidiRownumberisanyinteger,suchthat0<iRow<=RowCount.Deletioncanfailiftherecordtodeleteisrelatedto
anotherone.Forinstanceanantennafromthetable"ANTENNAS"cannotbedeletedifitisbeingusedbyatransmitterfrom
thetable"TRANSMITTERS".
Eveniftherecorddeletiondoesntbreakintegrityrelationsbetweentables,deletingarecordmayinvolveupdatingother
tablesorrecords.
Forinstance,becarefulwhenusingthismethodwiththe"TRANSMITTERS"tableandthe"TRXs"table.IfyoudeleteoneTRX,
youwanttoeditthe"TRANSMITTERS"tableinordertoupdatethefield"NUM_TRX".
6.8 GetValue
Returnsavalueofacolumnforagivenrow.
84
AT321_TAG_E1
HRESULT GetValue(long iRow, const VARIANT iCol, VARIANT *pVal);

Parameters
[in]iRow:Thelongintegerusedtospecifytherownumber.
[in]iCol:TheVARIANTusedtospecifyacolumn.WheniColisoftypeVT_I4,iColisinterpretedasacolumnnumber.WheniCol
isoftypeVT_BSTR,iColisinterpretedasacolumnname.
[out]pVal:AddressoftheVARIANTusedtoreturnthecolumnvalue.
Remarks
AvalidiRownumberisanyinteger,suchthat0<iRow<=RowCount.AvalidiColiseitheranintegersuchthat0<iCol<=Colum
nCountorastringcontainingthenameofanexistingcolumn.
Thecolumnnamesarenotcasesensitive.
Youshouldneverassumethatthetypeof thereturnedVARIANTistheoneyouexpect.Forinstance,aVARIANToftype
VT_NULLmaybereturnedwhenthevalueofthecolumnisthe"Null"value.YoushouldexplicitlyconvertthereturnedVARI
ANTtothetypeyouexpectandhandleconversionerrors.
WhenusingaTabularDataObjecttoaccessdatabasetables,pleaserefertotheAtollAdministratorManualfortheavailable
columnnames,types,units,andtocheckifthecolumnspecificationallowsfor"Null"values.Forsitecoordinatesvalues,
pleaserefertotheAtollTechnicalReferenceGuideforcoordinatesystemsandunits.Sitecoordinatesareexpressedinthe
internalcoordinatesystemoftheAtolldocument.
Example
Set sites = app.ActiveDocument.GetRecords(Sites)
For i = 1 To sites.ColumnCount
colName = sites.GetValue(0, i)
Next
6.9 SetValue
Setsthevalueofacolumnfortherowbeingeditedoradded.
HRESULT SetValue(const VARIANT iCol, const VARIANT newVal);

Parameters
[in]iCol:TheVARIANTusedtospecifyacolumn.
[in]newVal:TheVARIANTusedtospecifythecolumnvalue.
Remarks
AvalidiColiseitheranintegersuchthat0<iCol<=ColumnCountorastringcontainingthenameofanexistingcolumn.The
columnnamesarenotcasesensitive.
YoumusthavepreviouslycalledEditorAddNewtospecifytherowtoeditbeforewritingthecolumnvalue.Ifthismethodis
usedforalargenumberofrecords,itisrecommendedtogetthecolumnnumbersbeforehandandthentousetheSetValue
methodwiththisnumberandnotwithaVARIANToftypeVT_BSTR.Thiswillrunfaster.Togetthecolumnnumber,youcan
searchtherownumber0forthefieldnameyouwanttouse.
Example
ThisexampleincrementsalltheTXLOSSESofallthetransmittersintheactivedocumentby1dB.
Dim transmitters
Dim doc
85
Dim i
Dim txLosses
Set doc = app.ActiveDocument
Set transmitters = doc.GetRecords(Transmitters)
For i = 1 To transmitters.RowCount
txLosses = transmitters.GetValue(i, LOSSES)
transmitters.Edit(i)
transmitters.SetValue(LOSSES, txLosses + 1)
transmitters.Update
Next
Instead,wecouldhaveused:
For i = 1 To transmitters.RowCount
txLosses = transmitters.GetValue(i, 12)
transmitters.Edit(i)
transmitters.SetValue(12, txLosses + 1)
transmitters.Update
Next
Updatingthemaincontourofthefocuszone:
Public Sub WriteZone()

Set doc = ActiveDocument
Set zones = doc.GetRecords("Zones", true)
row = zones.Find(0, "NAME", atoEQ, "FocusZone")
Dim pts(3,1)
pts(0,0) = 555000
pts(0,1) = 2188000
pts(1,0) = 600000
pts(1,1) = 2188000
pts(2,0) = 600000
pts(2,1) = 2140000
pts(3,0) = 555000
pts(3,1) = 2140000
86
Forsk2014
AT321_TAG_E1
zones.Edit row
zones.SetValue "POINTS", pts
zones.Update
End Sub
6.10 GetPrimaryKey
Returnsthevalueoftheprimarykeyforagivenrownumber.
HRESULT GetPrimaryKey(long iRow, VARIANT* pVal);

Parameters
[in]iRow:Therownumber.
[out]pVal:AddressoftheVARIANTusedtoreturntheprimarykey.
Remarks
AvalidiRownumberisanintegerwhosevalueisgreaterthanzeroorequaltozeroandlowerthanorequaltotherowcount
oftheTabularDataobject.MostofTabularDataobjectshaveaprimarykey.Ifnoprimarykeyisdefined,thevalueofthe
columnRECORD_IDfortherowiRowisreturned.WhentheTabularDataobjectprimarykeyismadeofseveralcolumns,the
typeofthevariantreturnedisaonedimensionVARIANTarray,oftypeVT_ARRAY|VT_VARIANT,andVARIANTarrayvalues
arethevaluesofthecolumnsdefiningtheprimarykey.Otherwise,theVARIANTreturnedisthevalueofthecolumnusedto
definetheprimarykey.
When0isusedfortheiRowparameter,thenamesofthecolumnsdefiningtheprimarykeyarereturned.Thevariantreturned
isoftypeVT_BSTRorVT_ARRAY|VT_VARIANTwithvariantsoftypeVT_BSTR,whethertheprimarykeyismadeofoneor
severalcolumns,respectively.
6.11 FindPrimaryKey
Searchestherowwhoseprimarykeyequalstheinputvalueandreturnstherownumberoftherowfound.Ifnorowisfound,
returns1.
HRESULT FindPrimaryKey(VARIANT val, long* iRow);

Parameters
[in]val:TheVARIANTusedtospecifythekeyvaluetosearchfor.
[out]iRow:Addressofthelongintegerusedtoreturnthenumberoftherowwhoseprimarykeyequalsval.Ifnorowisfound,
1isreturned.
Remarks
Whentheprimarykeyismadeofseveralcolumns,theinputvariantmustbeoftypeVT_ARRAY|VT_VARIANT.
6.12 Find
Searchesacolumnforavalue.
HRESULT Find(
long iRowStart,
const VARIANT iCol,
87
Forsk2014
enum AtoCompareOp op,

const VARIANT value,
long* piRow
);
Parameters
[in]iRowStart:Thelongintegerusedtospecifytherownumberfromwhichthevaluewillbesearchedfor.
[in]iCol:TheVARIANTusedtospecifythecolumnnumberorthecolumnnamethatwillbesearched.
[in]op:TheatoCompareOpenumerationvalueusedtospecifythesearchcriteria(greaterthan,lessthan,equalto,etc).
[in]value:TheVARIANTusedtospecifythevaluetosearch.
[out] piRow: The long integer pointer used to return the row number of the first row matching the search criteria. 1 is
returnedifnorowisfound.
Remarks
PatchiRowStartinsidealoopinordertoscanseveralrowsmatchingthesearchcriteria.
Thismethodshouldbeusedonlyforafewsearches,becauseontheAtollside,thismethodscanstherowsoneaftertheother
andcanbeverytimeconsuming.
IfthecolumnistheprimarykeyoftheTabularDataObject,useFindPrimaryKeyinstead.
Forrepetitivesearchoperations,useacollection(map)ofalltherowsandwriteyourownfilter.
Example
Inthisexample,wesearchforalltransmitterswhoseLOSSESareequalto2,andreplacethemwith3.
Dim transmitters
Dim iRow
Const atoEQ = 0
Set transmitters = ActiveDocument.GetRecords(Transmitters, False)
iRow = 0
While iRow <> -1
iRow = transmitters.Find(iRow + 1, "LOSSES", atoEQ, 2)
If iRow <> -1 Then
transmitters.Edit(iRow)
transmitters.SetValue("LOSSES", 3)
transmitters.Update
End If
Wend
6.13 GetFormattedValue
Returnsacolumnvalueformattedasastring.
HRESULT GetFormattedValue(long iRow, const VARIANT iCol, BSTR *pVal);
88
AT321_TAG_E1
Parameters
[in]Row:Therownumber.
AvalidiRownumberisanintegerwhosevalueisgreaterthanzeroorequaltozero,andlowerthanorequaltothe
rowcountoftheTabularDataobject.
[in]iCol:TheVARIANTusedtodefinethecolumn.
WheniColvarianttypeifVT_I4,iColisinterpretedasacolumnnumber.Avalidcolumnnumberisanintegerwhose
valueisgreaterthanzeroorequaltozero,andlowerthanorequaltothecolumncountoftheTabularDataobject.
WheniColvarianttypeifVT_BSTR,iColisinterpretedasacolumnname.Columnnamesarenotcasesensitive.
[out]pVal:AddressofaBSTRstringusedtoreturntheformattedvalue.
Remarks
When0isusedfortheiRowparameter,thetitleofthecolumnspecifiedbyiColisreturned.Thetitleofacolumnislocalized
andmaybeshowntoauser,asopposedtothecolumnname.
6.14 CancelUpdate
Cancelsapendingupdate.ThismethodmaybecalledafterEditorAddNewtocanceltheoperation.
HRESULT CancelUpdate();
6.15 get_ColumnNumber
Returnsacolumnnumber.
HRESULT get_ColumnNumber(const VARIANT vColName, long *pCol);

Parameters
[in]vColName:TheVARIANTusedtospecifythenameofthecolumn.
[ou]pCol:Addressofthelongintegerusedtoreturncolumnnumber.
Remarks
Itisfastertoreaddatafromtablesusingthecolumnnumberinsteadofthecolumnname.Italsoworksforlinkedfields.
Forinstanceyoucanwrite:
Set sites = doc.GetRecords("SITES", False)

colLatitude = sites.ColumnNumber("LATITUDE")
For i = 1 To sites.RowCount
latitude = sites.GetValue i, colLatitude
Next
6.16 get_CanEdit
Checksifrowscanbemodified.
HRESULT get_CanEdit(VARIANT_BOOL *pVal);
89
Forsk2014
Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturnwhetherrowscanbemodifiedornot.
Remarks
IfVARIANT_FALSEisreturned,thentheEditoperationonthistableisundefined.
6.17 get_CanAddNew
Checksifrowscanbeadded.
HRESULT get_CanAddNew(VARIANT_BOOL *pVal);

Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturnwhetherrowscanbeaddedornot.
Remarks
IfVARIANT_FALSEisreturned,thentheAddNewoperationonthistableisundefined.
6.18 get_CanFilterSort
Checksifrowscanbefilteredorsorted.
HRESULT get_CanFilterSort(VARIANT_BOOL *pVal);

Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturnwhetherrowscanbefilteredorsorted.
Remarks
IfVARIANT_FALSEisreturned,thentheFilterandSortoperationsonthistableareundefined.
6.19 get_Filter
Returnsthefiltercurrentlysetonthetable.
HRESULT get_Filter(VARIANT *pvCriteria);

Parameters
[out]:pvCriteria:AddressoftheVARIANTusedtoreturnthefilterpreviouslysetonthetable.
Remarks
PleaserefertotheAtoRowFilterenumerationdefinitionforthelistofconstantsusedtofilteronlymodified,added,ordeleted
rows.
6.20 put_Filter
Filtersthetabledataaccordingtoafiltercriteria.
HRESULT put_Filter(const VARIANT vCriteria);
90
AT321_TAG_E1
Parameters
[in]vCriteria:TheVARIANTusedtospecifythefiltercriteria.WhenvCriteriaisoftypeVT_I4,itisinterpretedasanAtoRow
Filterenumerationvalue.WhenvCriteriaisoftypeVT_BSTR,itisinterpretedasafilterstring.Filterstringsarewhatcanbe
seenintheAtoll"Table"tabpropertiesforrecordfolders,whenusingadvancedfiltering.PleaserefertotheAtollUserManual
formoreinformationaboutadvancedfilteringondata.
Remarks
PleaserefertotheAtoRowFilterenumerationdefinitionforthelistofconstantsusedtofilteronlymodified,added,ordeleted
rows.
IfthetableisretrievedusingGetRecordswithaAllparametersettoFalse,settingthispropertyisthesameassettingthefilter
interactivelyinanAtollsession.
Toremoveanypreviousfilter,callthismethodeitherwithatoRowFilterNonevalueorwithanemptystring.
When the Atoll document is not connected to a database, atoRowFilterModifiedOrNew and atoRowFilterDeleted are not
available.
6.21 get_Sort
Returnsthesortordercurrentlysetonthetable.
HRESULT get_Sort(VARIANT *pvCriteria);

Parameters
[in]vCriteria:TheVARIANT,oftypeVT_BSTR,usedtospecifythesortorder.Itcontainsalistofcommaseparateddatabase
fieldnames.EachfieldisoptionallyfollowedbytheDESCkeywordtoindicatethatthesortorderassociatedwiththefieldis
"Descending".
Remarks
IfthetableisretrievedusingGetRecordswithaAllparametersettoFalse,settingthispropertyisthesameassettingthesort
orderinteractivelyinanAtollsession.
Toremoveanyprevioussortorder,callthismethodwithanemptystring.
Example
Private Sub PrintTransmittersTable(transmRec, infoMsg)
For nRow = 1 To transmRec.RowCount
LogMessage infoMsg & ": " & transmRec.GetValue(nRow, "TX_ID")
Next
End Sub
Sub Main
Set t = ActiveDocument.GetRecords("transmitters", False)
Sort ascending according to the "SITE_NAME" database field
t.Sort = "SITE_NAME"
PrintTransmitterTables t, "Sort = SITE_NAME"
Sort descending according to the "SITE_NAME" database field
t.Sort = "SITE_NAME DESC"
PrintTransmittersTable t, "Sort = SITE_NAME DESC"
91
Forsk2014
End Sub
6.22 put_Sort
Sortsthetabledata.
HRESULT put_Sort(const VARIANT vCriteria);

Parameters
[in]vCriteria:TheVARIANT,oftypeVT_BSTR,usedtospecifythesortorder.Itcontainsalistofcommaseparateddatabase
fieldnames.EachfieldisoptionallyfollowedbytheDESCkeywordtoindicatethatthesortorderassociatedwiththefieldis
"Descending".
Remarks
IfthetableisretrievedusingGetRecordswithaAllparametersettoFalse,settingthispropertyisthesameassettingthesort
orderinteractivelyinanAtollsession.
Toremoveanyprevioussortorder,callthismethodwithanemptystring.
Example
See"get_Sort"onpage 91.
6.23 GetOriginalValue
Returnsanoriginalfieldvalue.
HRESULT GetOriginalValue(long iRow, const VARIANT iCol, VARIANT *pVal);

Parameters
[in]iRow:Thelongintegerusedtospecifyarownumber.
[in]iCol:TheVARIANTusedtospecifyacolumnnameoracolumnnumber.
[out]pVal:AddressofVARIANTusedtoreturntheoriginalcolumnvalue.
Remarks
Theoriginalvalue,asopposedtothecurrentvaluereturnbyGetValue,isthevalueretrievedfromthedatabasewhenthe
Atolldocumenthasbeenrefreshedforthelasttime.
Iftherowisunmodified,theoriginalvalueisthesameasthecurrentvalue.
Iftherowisdeletedthecurrentvalueisthenullvalueandtheoriginalvalueisthevaluejustbeforetherowwasdeleted.
6.24 get_RowStatus
Returnsarowstatus.
HRESULT get_RowStatus(long iRow, enum AtoRowStatus *pVal);

Parameters
[in]iRow:Thelongintegerusedtospecifyarownumber.
[out]pVal:AddressoftheAtoRowStatusenumerationvalueusedtoreturntherowstatus.
92
AT321_TAG_E1
Remarks
WhenanAtolldocumentisopenfromadatabase,rowstatusesaresettoatoRowStatusUnmodifiedandoriginalvaluesare
setforallrowcolumns.
Whenthedocumentisarchivedorrefreshedfromthedatabase,rowstatusesaresettoatoRowStatusUnmodifiedandall
columnsoriginalvaluesaresetforrowsthathavebeenarchivedorrefreshed.
Whenanewrowiscreated,therowstatusissettoatoRowStatusNewandtheoriginalvalueforallcolumnsaresettothenull
value.
Whenarowismodified,therowstatusissettoatoRowStatusModified.Ifyoureverttherowchanges,therowstatusisset
toatoRowStatusUnmodified.
Whenarowisdeleted,therowstatusissettoatoRowStatusDeleted,therowcolumnvaluesaresettothenullvalue,andthe
originalcolumnvaluesarethecolumnvaluesjustbeforetherowwasdeleted.
6.25 get_Columns
Returnstablecolumnsdefinition.
HRESULT get_Columns(ITabularData** ppVal);

Parameters
[out]ppVal:
AddressoftheITabularDatainterfacepointerusedtoreturnatabulardataobjectholdingthetablecolumnsdefinition:
ColumnName
Type
Description
LEGEND
String
Thedisplaynameofthecolumn
NAME
String
Thedatabasenameofthecolumn
TYPE
Integer
Thedatatypeofthecolumn.Validvaluesare:
0=Text
1=Shortinteger
2=Longinteger
3=Single
4=Double
5=True/False
6=Date/Time
7=Currency;
SIZE
Integer
Thesize,inbytes,foracolumnofTYPE0(Text).
DEFAULT
Variant
Thedefaultvalueofthecolumn.Thetypeofthevariantdependsonthe
typeofthecolumn,asindicatedbyTYPE.
MaybeNull.
FORMATTED_DEFAULT
String
Thedefaultvalueofthecolumn,formattedasastring.
GROUP
String
Thenameofthedatabasefieldgroupthecolumnbelongsto.
ISCUSTOMFIELD
Boolean
Whetherthecolumnisausercolumn(True),ornot(False).
CHOICELIST_TYPE
Integer
WhetheracolumnofTYPE0(Text)contentvaluesarerestrictedtothe
valuesspecifiedinCHOICELIST_VALUES.
CHOICELIST_VALUES
String
NewlineseparatedstringofvalidvaluesforacolumnofTYPEtext.
93
94
Forsk2014
Chapter7
ZonesandPredictions
TabularDataObjects
96
Forsk2014
Chapter7:ZonesandPredictionsTabularDataObjects
AT321_TAG_E1
7 ZonesandPredictionsTabularDataObjects
7.1 ZonesTabularDataObject
ColumnName
Type
Description
NAME
String
"ComputationZone"ifthisrowisthecomputationzone.
"FocusZone"ifthisrowispartofthefocuszone.
"FilterZone"ifthisrowispartofthefilteringzone.
"PrintZone"ifthisrowispartoftheprintingzone.
"ExpBitmapZone"ifthisrowispartofthecoverageexportzone.
Atoll>=2.8.1
"HotSpotZone"ifthisrowispartofthehotspotzone.
POINTS
Array
Anarrayofpointsasdoublevalues.
CONTOUR_NUM
Integer
Thecontourindex.
POLYGON_NUM
Integer
Thepolygonindex.
POLYGON_NAME
String
Atoll>=2.8.1
Thenameofthepolygon.
Forhotspotzones,itisthenameofaspecifichotspotzone.
Forotherzones,itisthenamethezonesubfolder,intheexplorerwindow.
Thiscolumnisreadonly.
AtollVersion
2.8.1
Itisnowpossibletoaccesshotspotzones.
Their content is identified by the "NAME" column ("HotSpotZone"), then a specific hot spot zone is specified by the
"POLYGON_NAME"column,whichisusedtoindicateaspecifichotspotzoneinthehotspotzonesfolder.
However,unlikeotherzones,hotspotzonesaccessisreadonly.Itisnotpossibletoeditahotspotzone,todeleteahotspot
zone,ortocreateanewhotspotzone.
Example
Readingthefirstcontourofthefocuszone:
Public Sub ReadZone()

Set zones = doc.GetRecords("Zones", True)
row = zones.Find(1, "NAME", atoEQ, "FocusZone")
pts = zones.GetValue(row, "POINTS")
If (IsArray(pts)) Then
For i = LBound(pts, 1) To UBound(pts, 1)
ptx = pts(i,0)
pty = pts(i,1)
MsgBox "Pts(" + CStr(i) + ") = " + CStr(ptx) + ", " + CStr(pty)
Next
97
Forsk2014
Else
MsgBox "Not an array"
End If
End Sub
7.2 PredictionsTabularDataObject
The"PREDICTIONS"TabularDataobjectisreadonlyexceptfortheLOCKEDfield,whichcanbeusedtolockorunlockpahloss
matricesofatransmitter.
AtollVersion
2.8.0
ThefieldPATH_NAMEisreadwrite.ItsvaluecanbesettoNull,inwhichcasepathlossmatricesforTX_IDaredeleted.
ColumnName
Type
Description
TX_ID
String
Transmittername.
LOCKED
Boolean
Trueifthepathlossmatricesarelocked,otherwiseFalse.
VALID
Boolean
Trueifthemainandextendedpathlossmatricesarevalid,otherwiseFalse.
INVALID_CAUSE
String
Causeofinvalidity,whenVALIDreturnsFalse.
NullvaluewhenVALIDreturnsTrue.
SIZE
Integer
Sizeofthemainmatrixplusthesizeoftheextendedmatrix,inbytes.
PATHNAME
String
Nullvaluewhenthereisnostorageforthemainmatrix.
"(Embeddedindocument)"ifthestorageisnotexternal.
Otherwisecontainsthemainpathlossmatrixfilepath.
PATHLOSS
Object
TheobjectimplementstheIGridDatainterface.Thisgriddatacontainsthe
mainpathlossmatrixdatafortransmitterTX_ID.
Nullvaluewhenthereisnoavailableresultforthemainmatrix.
SIGNAL
Object
mainsignallevelmatrixdatafortransmitterTX_ID.
LOWRES_PATHLOSS
Object
extendedpathlossmatrixdatafortransmitterTX_ID.
Nullvaluewhenthereisnoavailableresultfortheextendedmatrix.
LOWRES_SIGNAL
Object
extendedsignallevelmatrixdatafortransmitterTX_ID.
String
Atollversion 2.7.0
Nullvaluewhenthereisnostoragefortheextendedmatrix.
"(Embeddedindocument)"ifthestorageisnotexternal.
Otherwisecontainstheextendedpathlossmatrixfilepath.
LOWRES_PATHNAME
AtollVersion
2.8.1
Newcolumnsareavailable
ThesevaluesareavailableevenwhenVALIDreturnsFALSEbuttheyarenotuptodatewhentheresolutionofpathlossmatri
ces,thecalculationarea,orthetransmitterlocationhaschanged.
98
AT321_TAG_E1
ColumnName
Type
Description
GRID_X
Double
Xcoordinateofthetopleftcornerofthemainpathlossmatrixupperleft
pixel.
GRID_Y
Double
Ycoordinateofthetopleftcornerofthemainpathlossmatrixupperleft
pixel.
GRID_NX
Integer
Numberofcolumnsinthemainpathlossmatrix.
GRID_NY
Integer
Numberofrowsinthemainpathlossmatrix.
GRID_RESX
Double
Resolutionofthemainpathlossmatrix,inmetre.
GRID_RESY
Double
Resolutionofthemainpathlossmatrix,inmetre.
LOWRES_GRID_X
Double
Xcoordinateofthetopleftcorneroftheextendedpathlossmatrixupper
leftpixel.
LOWRES_GRID_Y
Double
Ycoordinateofthetopleftcorneroftheextendedpathlossmatrixupper
leftpixel.
LOWRES_GRID_NX
Integer
Numberofcolumnsintheextendedpathlossmatrix.
LOWRES_GRID_NY
Integer
Numberofrowsintheextendedpathlossmatrix.
LOWRES_GRID_RESX
Double
Resolutionoftheextendedpathlossmatrix,inmetre.
LOWRES_GRID_RESY
Double
Resolutionoftheextendedpathlossmatrix,inmetre.
ColumnName
Type
Description
TX_PATHLOSS
Object
TheobjectimplementstheIGridDatainterface.
TX_SIGNAL
Object
TX_LOWRES_PATHLOSS
Object
TX_LOWRES_SIGNAL
Object
AtollVersion
3.1.0
Newcolumnsareavailable:
TX_PATHLOSS,TX_SIGNAL,TX_LOWRES_PATHLOSS,TX_LOWRES_SIGNALforthetransmitterTX_IDdonottakeintoaccount
itsrepeatersorremoteantennas.
Onthecontrary,usingPATHLOSS,SIGNAL,LOWRES_PATHLOSS,LOWRES_SIGNAL,contributionsfromrepeatersorremote
antennasarecombinedintoonematrix.
PleaseuseTX_PATHLOSS,TX_SIGNAL,TX_LOWRES_PATHLOSS,TX_LOWRES_SIGNALcolumnswhenyouneedtoconsider
transmittersignalorpathlossindependentlyfromitsrepeatersorremoteantennas.
AtollVersion
3.2.0
Itisnowpossibletoupdatepathlossmatriceswithexternalresults(.LOSfiles).
99
Forsk2014
YoucaneditthePATH_NAMEorLOWRES_PATHNAMEcolumns,specifyingvalid.LOSabsolutefullpath.
Inthiscase,whentherowinthepredictionstableisupdated,pathlossmatricesareupdatedwiththecontentoffilesprevi
ouslyspecified.
Pleasenotethatfothistowork,youhavetogeoreferenceyourprovided.LOSfiles,withastandardBILheaderfile(.hdr).
Pleasenotethatevenifyour.LOSfilesneedtobegeoreferencedjustliketheywere.BILfiles,.LOSfilesarewrittenbottom
up,nottopdown.
TX_PATHLOSS
TX_SIGNAL
TX_LOWRES_PATHLOSS
TX_LOWRES_SIGNAL
100
Object
mainpathlossmatrixdatafortransmitterTX_ID.
Valuesreturneddonotincludecontributionsfromrepeatersorremote
antennasofthetransmitterTX_ID.
Object
mainsignallevelmatrixdatafortransmitterTX_ID.
Object
extendedpathlossmatrixdatafortransmitterTX_ID.
Object
extendedsignallevelmatrixdatafortransmitterTX_ID.
Chapter8
CoordSystemObject
102
Forsk2014
Chapter8:CoordSystemObject
AT321_TAG_E1
8 CoordSystemObject
Thisobjectcontainstheentiredefinitionofacoordinatesystem.SeveralcoordinatesystemsareusedinAtolldocuments;one
fordisplay,oneforprojectedgeographicfiles,andoneforsitecoordinates.Thelastonecanberelatedtothesystemusedfor
display.
ThisobjectisnotdefinedinAtolllibrarybutintheFSKGISLiblibrary.Itcanconvertpointsfromonecoordinatesystemto
another.
TheCoordSystemobjectprovidesthefollowingpropertiesandmethods:
Name
Description
Code
Returnsorsetsthenumericcodeofthecoordinatessystem.
ConvertCoordsTo
Convertsthecoordinatesofapointexpressedinthecurrent
systemtoanotherone.
Datum
Returnsorsetsthenumericvalueofthedatum.
DatumName
Nameofthedatum.
Description
Descriptionofthedatum.
Ellipsoid
Returnsorsetsthenumericvalueoftheellipsoid.
EllipsoidName
Nameoftheellipsoid.
Name
Returnsorsetsthenameofthecoordinatessystem.
Pick
Opensthecoordinatessystemdialogue.
ProjMethod
Projectionmethodusedforthecurrentcoordinatessystem.
ProjParameter
Readsaparameteroftheprojection.
SetDatum
Changesthedatumofthesystem.
SetProjection
Setstheprojectionparametersofthecoordinatesystem.
Unit
Returnsorsetstheunitofthecoordinatesystem.
Attributes
Fordetailsoncoordinatesystems,seetheTechnicalReferenceGuide.
8.1 HowtoAccessaCoordSystemObject
Togetthecoordinatesystemusedforsites:
Dim doc
Dim coordSys
Set doc = Atoll.ActiveDocument
Set coordSys = doc.CoordSystemInternal
8.2 Code
Returnsorsetsthenumericcodeofthecoordinatessystem.
HRESULT Code(long *pVal);

HRESULT Code(long val);
103
Forsk2014
Parameters
pVal:AddressoftheLongreadasthecodeofthesystem.
val:Longvaluerepresentingthecodeofthesystemtoset.
Classical system codes have values less than 32767. System codes greater or equal to
32768correspondtouserdefinedsystems.
8.3 ConvertCoordsTo
Convertsthecoordinatesofapointexpressedinthecurrentsystemtoanotherone.
HRESULT ConvertCoordsTo(
IDispCoordSystem *targetCS,
VARIANT inPoint,
VARIANT *outPoint
);
Parameters
[in]targetCS:AnIDispCoordSysteminterfacepointerusedtospecifythecoordinatesystemtowhichinputcoordinatesmust
beconverted.
[in]inPoint:AVARIANTusedusedtospecifythecoordinatesofaninputpoint.Thecoordinatesareexpressedinthecurrent
coordinatesystem.TheVARIANTmustaonedimensionarrayof2floatingpointvalues(VT_ARRAY|VT_R8).Elementatindex
0isusedtospecifythexcoordinate,elementatindex1isusedtospecifytheycoordinate.
[out]outPoint:ApointertoaVARIANTusedtoreturnthecoordinateoftheinPointinputpointexpressedinthetargetCScoor
dinatesystem.ThetypeoftheVARIANTreturnedisVT_ARRAT|VT_R8:aonedimensionarrayof2floatingpointvalues.
Elementatindex0isusedtospecifythexcoordinate,elementatindex1isusedtospecifytheycoordinate.
Example
Public Sub ConvertSitesCoordinates
Dim sites
Dim x
Dim y
Dim oFrom
Set oFrom = ActiveDocument.CoordSystemInternal
Dim oTo
Set oTo = ActiveDocument.CoordSystemDisplay
Dim coords
Set sites = ActiveDocument.GetRecords("Sites", True)
Dim i
For i = 1 To sites.RowCount
x = sites.GetValue(i, "LONGITUDE")
y = sites.GetValue(i, "LATITUDE")
coords = oFrom.ConvertCoordsTo(oTo, Array(x, y))
104
AT321_TAG_E1
LogMessage sites.GetValue(i,"NAME")&":"&CStr(coords(0))&";"&CStr(coords(1))
Next
End Sub
8.4 Datum
Returnsorsetsthenumericvalueofthedatum.
HRESULT Datum(long *pVal);

HRESULT Datum(long val);
Parameters
pVal:Addressreadasthedatumcodeofthesystem.
val:Valuetobesetasthedatumcodeofthesystem.
8.5 DatumName
Nameofthedatum.
HRESULT DatumName(BSTR *pVal);

Parameters
pVAl:Pointerofthedatumname.
8.6 Description
Descriptionofthedatum.
HRESULT Description(BSTR *pVal);

Parameters
pVal:Pointerofdatumdescription.
8.7 Ellipsoid
Returnsorsetsthenumericvalueoftheellipsoid.
HRESULT Ellipsoid(long* pVal);

HRESULT Ellipsoid(long Val);
Parameters
pVal:Addressreadastheellipsoidcodeofthesystem.
val:Valuetobesetastheellipsoidcodeofthesystem.
8.8 EllipsoidName
Nameoftheellipsoid.
105
Forsk2014
HRESULT EllipsoidName(BSTR* pVal);

Parameters
pVal:Pointertothenameoftheellipsoid.
8.9 Name
Returnsorsetsthenameofthecoordinatessystem.
HRESULT Name(BSTR *pVal);

HRESULT Name(BSTR pVal); [id(8)]
Parameters
pVal:Addressreadasthenameofthecoordinatessystem.
val:Valuetobesetasthenameofthecoordinatessystem.
8.10 Pick
Opensthecoordinatessystemdialogue.
HRESULT Pick(OLE_HANDLE parentWindow, WORD types, VARIANT_BOOL *ret);

Parameters
parentWindow:OLE_HANDLEoftheparentwindowforwhichthedialogueisrequiredtobeopened.
types:BitsetofCoordSysType(seeCoordSysTypes)correspondingtothetypesofsystemsthedialoguemustfilterbefore
opening.
ret:PointertoaVARIANT_BOOL,settoVARIANT_TRUEiftheuserquitsthedialoguewithOK,otherwiseVARIANT_FALSE.
CoordSysTypes
enum CoordSysType
{ fgUndefinedCoordSys = 1,
fgGeographic2D
= 2,
fgProjected2D
= 4
} CoordSysType;
8.11 ProjMethod
Projectionmethodusedforthecurrentcoordinatessystem.
HRESULT ProjMethod(ProjectionMethod *pVal);

Parameters
pVal:PointertothereadProjectionMethod(seeProjectionMethods).
106
AT321_TAG_E1
8.12 ProjParameter
Readsaparameteroftheprojection.
HRESULT ProjParameter(ProjParameterIndices index, double *pVal);

Parameters
index:Indexoftheparametertoread.
pVal:Addressofthedoublecontainingthevalueoftheparameter.
Remarks
Keepinmindthattherealvalidrangeofindexparametersdependsontheprojectionmethod.
8.13 SetDatum
Changesthedatumofthesystem.
HRESULT SetDatum(long ellipsoidCode, VARIANT params);

Parameters
ellipsoidCode:Numericcodeoftheellipsoidofthenewdatum.
params:Parametersoftheprojectionprovidedasanarrayofvariants.
8.14 SetProjection
Setstheprojectionparametersofthecoordinatesystem.
HRESULT SetProjection(ProjectionMethod method, VARIANT projectionParameters);

Parameters
[in]method:TheProjectionMethodenumerationvalueusedtochangetheprojectionmethodofthecoordinatesystem.
[in]projectionParameters:ASAFEARRAYofVARIANTsoftypeVT_R8usedtospecifytheprojectionparametersofthecoordi
natesystem.Theprojectionparametersmustmatchwiththemethodparameter.Eachparameterisidentifiedbyitsindexin
thearray,startingfrom0.ArrayindexesarethesameasProjParameterIndicesenumerationvalues.Projectionparameters
valuesarethethesameasvaluesreturnedbytheProjParameterproperty.
8.15 Unit
Returnsorsetstheunitofthecoordinatesystem.
HRESULT Unit(GeographicUnit *pVal);

HRESULT Unit(GeographicUnit newVal);
Parameters
pVAl:Addressofthecurrentgeographicunit(seeGeographicUnits)ofthesystem.
newVal:Newvalueforthegeographicunit.
107
108
Forsk2014
Chapter9
ChildFolderObject
110
Forsk2014
Chapter9:ChildFolderObject
AT321_TAG_E1
9 ChildFolderObject
AChildFolderobjectrepresentsanitemintheapplicationexplorerwindow.Itcanbeacollectionofsubitems.
TheChildFolderobjectprovidesthefollowingpropertiesandmethods:
Name
Description
Attributes
get_Application
ReturnstheApplicationobject.
Access:Read
get_Parent
ReturnstheparentChildFolderobject.
Type:ChildFolderobject
Access:Read
get_Name
ReturnstheChildFolderobjectdisplayname.
Type:String
Access:Read/Write
put_Name
SetstheChildFolderobjectdisplayname.
Type:String
Access:Read/Write
get_Count
ReturnsthenumberofchildrenoftheChildFolderobject.
Type:Integer
Access:Read
get_Item
ReturnsoneofthechildrenoftheChildFolderobject.
Type:ChildFolderchildren
collection
Access:Read
get__NewEnum
Returnsanobjectusedtoenumeratethechildrenofthe
ChildFolderobject.
get_Visible
ReturnsthevisibilitystateoftheChildFolderobject.
Type:Boolean
Access:Read/Write
put_Visible
SetsthevisibilitystateoftheChildFolderobject.
Type:Boolean
Access:Read/Write
get_Selected
ReturnstheselectedstateoftheChildFolderobject.
Type:Boolean
Access:Read/Write
put_Selected
SetstheselectedstateoftheChildFolderobject.
Type:Boolean
Access:Read/Write
Export
ExportsaChildFolderobjecttoafile,inagivenformat.
CentreOnMap
Centrestheapplicationmapwindowaroundthe
ChildFolderobject.
Redraw
RedrawstheChildFolderobject.
AddChild
AddsanewchildtothecurrentChildFolderobject.
Remove
RemovestheChildFolderobjectfromitsparentChildFolder
object.
get_position
ReturnstheChildFolderobjectpositionrelativetoits
parentChildFolderobject.
Type:Integer
Access:Read/Write
put_position
SetstheChildFolderobjectpositionrelativetoitsparent
ChildFolderobject.
Type:Integer
Access:Read/Write
get_Object
AccesstosomespecificfeaturesontheChildFolderobject.
get_dispatch
get_ObjectKind
ReturnsatypeidentifieroftheChildFolderobject.
GetProperty
ReturnsaChildFolderobjectproperty.
SetProperty
SetsaChildFolderobjectproperty.
Type:String
Access:Read
111
Forsk2014
Name
Description
GetPropertiesInfo
Returnsnamesandtypesforallpropertiesavailableonthe
ChildFolderobject.
PropertyIsPropertyContainer
ReturnstruewhenaChildFolderobjectpropertyisa
PropertyContainerobject.
PropertyIsTabularData
ReturnstruewhenaChildFolderobjectpropertya
TabularDataobject.
LoadProperties
Setspropertiesfromapropertycontainertothe
ChildFolderobject.
SaveProperties
SavesalltheChildFolderobjectpropertiestoanother
propertycontainer.
RemoveItem
RemovesoneofthechildrenoftheChildFolderobject.
SetCustomIcon
Setsthepathofanicontouseforacustomchildfolder.
Attributes
9.1 HowtoAccessaChildFolderObject
AChildFolderisfirstobtainedthrougharootentrypointfromthedocumentandisrelatedtoataboftheAtollExplorer
window.
MostChildFolderobjectsmayhavechildren,canbeselected,setvisible,andrenamed.Onlycoveragepredictionsmaybe
exported.
Dim folder
Dim item
Dim doc
Dim dataRoot
Const atoData = 0
Set doc = Atoll.ActiveDocument
Set dataRoot = doc.GetRootFolder(atoData)
For Each folder in dataRoot
do some work with this folder, for instance:
For Each item in folder
do some work with this item
Next
Next
9.2 get_Application
112
AT321_TAG_E1
Parameters
9.3 get_Parent
ReturnstheparentAtollChildFolderobject.
HRESULT get_Parent(VARIANT *pVal);

Parameters
[out] pVal: Address of the VARIANT used to return the parent ChildFolder object. The type of the returned VARIANT is
VT_DISPATCH.WhentheChildFolderobjectisarootChildFolderobject,theIDispatchinterfacepointeroftheAtollDocument
isreturned,otherwisetheIDispatchinterfacepointeroftheparentChildFolderobjectisreturned.
9.4 get_Name
ReturnstheChildFolderobjectdisplayname.

Parameters
[out]pVal:AddressoftheBSTRusedtoreturnthedisplayname.
Example
Renamingthe"Transmitters"folder.
Dim folder
Dim dataTab
Dim folderName
Const atoData = 0
Set dataTab = ActiveDocument.GetRootFolder(atoData)
For Each folder In dataTab
folderName = folder.Name
If folderName = Transmitters Then
folder.Name = TransmittersTest
End if
Next
9.5 put_Name
SetstheChildFolderobjectdisplayname.
HRESULT put_Name(const BSTR aNewVal);
113
Forsk2014
Parameters
[in]aNewVal:TheBSTRusedtospecifythedisplayname.
Example
See"get_Name"onpage 113.
9.6 get_Count
ReturnsthenumberofchildrenoftheChildFolderobject.
HRESULT get_Count(long *pVal);

Parameters
[out]pVal:Addressofthelongintegerusedtoreturnthenumberofchildren.
9.7 get_Item
ReturnsoneofthechildrenoftheChildFolderobject.
HRESULT get_Item(const VARIANT iIdx, IChildFolder **pVal);

Parameter
[in]iIdx:AVARIANToftypeVT_I4orVT_BSTRidentifyingthereturnedChildFolderobject.IfthetypeofthevariantisVT_I4,
itisinterpretedasazerobasedindexinthelistofchildren.IfthetypeofthevariantisVT_BSTR,itisfirstinterpretedasthe
displaynameofthechildtosearchfor,andifthedisplaynameisnotfound,itistheninterpretedasaChildFolderobjectkind,
asreturnedbyget_ObjectKind.
[out]pVal:AddressoftheIChildFolderinterfacepointerusedtoreturnaChildFolderobject.
9.8 get__NewEnum
ReturnsanobjectusedtoenumeratethechildrenoftheChildFolderobject.
HRESULT get__NewEnum(LPUNKNOWN *ppUnk);

Parameters
[out]ppUnk:AddressoftheIUnknowninterfacepointerusedtoreturntheenumeratorobject.TheIEnumVARIANTinterface
isimplementedbytheenumeratorobject.
Example
Const atoModule = 2
Set modules = app.ActiveDocument.GetRootFolder(atoModule)
For Each module In modules
do something with module
Next
9.9 get_Visible
ReturnsthevisibilitystateoftheChildFolderobject.
114
AT321_TAG_E1
HRESULT get_Visible(VARIANT_BOOL *pVal);

Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturnthevisibilitystate.
Thevisibilitystatevaluesare:
VARIANT_TRUE:theChildFolderobjectmaybedisplayedonAtollMapViewwindows.
VARIANT_FALSE:theChildFolderobjectwontbedisplayedonAtollMapViewwindows.
Remarks
ThevisibilitystateonlymakessenseforChildFolderobjectsthatmayappearonAtollMapViewwindows.get_Visibleand
put_Visiblecallsareignoredforobjectsthatdonotsupportit.Noerrorisreturned.
Example
dataFolder.Item("Predictions").Visible = True
9.10 put_Visible
SetsthevisibilitystateoftheChildFolderobject.
HRESULT put_Visible(VARIANT_BOOL aNewVal);

Parameters
[in]aNewVal:TheVARIANT_BOOLusedtospecifythevisibilitystate.
Thevisibilitystatevaluesare:
VARIANT_TRUE:theChildFolderobjectmaybedisplayedonAtollMapViewwindows.
VARIANT_FALSE:theChildFolderobjectwontbedisplayedonAtollMapViewwindows.
Remarks
ThevisibilitystateonlymakessenseforChildFolderobjectsthatmayappearonAtollMapViewwindows.get_Visibleand
put_Visiblecallsareignoredforobjectsthatdontsupportit.Noerrorisreturned.
Example
dataFolder.Item("Predictions").Visible = True
9.11 get_Selected
ReturnstheselectedstateoftheChildFolderobject.
HRESULT get_Selected(VARIANT_BOOL *pVal);

Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturntheselectedstateoftheChildFolderobject.
Remarks
get_Selectedandput_Selectedcallsareignoredforobjectsthatdontsupportit.Noerrorisreturned.
115
Example
Public Sub SelectTx
Const atoData = 0
Set dataFolder = doc.GetRootFolder(atoData)
Select the "Site0_0" transmitter
For Each folder In dataFolder
If folder.Name = "Transmitters" Then
folder.Item("Site0_0").Selected = True
End If
Next
End Sub
9.12 put_Selected
SetstheselectedstateoftheChildFolderobject.
HRESULT put_Selected(VARIANT_BOOL aNewVal);

Parameters
[in]newVal:TheVARIANT_BOOLusedtospecifytheselectedstate.
Remarks
get_Selectedandput_Selectedcallsareignoredforobjectsthatdontsupportit.Noerrorisreturned.
Example
See"get_Selected"onpage 115.
9.13 Export
ExportsaChildFolderobjecttoafile,inagivenformat.Thismethodcanonlybeusedforstudies.
HRESULT Export(
const BSTR bstrFileName,
IDispCoordSystem* proj,
const BSTR bstrFormat
);
Parameters
[in]bstrFileName:Astringcontaininganabsolutefilepath.
[in]proj:AnIDispCoordSysteminterfacepointerusedtodefinethecoordinatesystemfortheexport.
[in]bstrFormat:AstringusedtodefinetheformatofthefilespecifiedbybstrFileName.
116
Forsk2014
AT321_TAG_E1
ThesyntaxforthebstrFormatparameteris:
PropertyName=Value;[PropertyName=Value;]format
format:
Availablevaluesare:
SHP
AGD
MIF
TAB
BMP
TIF
TXT
ARCVIEWGRIDASCII
PNG
JP2
Pleasereadtheapplicationdocumentationtolearnmoreaboutthesefileformats.
ThedataexportedisthegeographiccoveragepredictionofastudywhenusingSHP,AGD,MIF,TAB,BMP,ARCVIEW
GRIDASCII,PNG,JP2,orTIFformats.However,ifyouspecifyTXTformat,thismethodwillexportthestudyreportin
tabulatedASCIItextformat.Thispredictionstudyreportisthesameastheoneavailablebyrightclickingthestudyin
theapplicationandselectingGenerateReport.
Availablepropertiesare:
PropertyName
Resolution
AreaType
Value
integer
0|1|2
Version
Description
2.8.1
Thisistheexportresolution,expressedinmeter.
Ifnotspecified,theresolutionusedtoperformtheexportis
thestudyresolution.
Itisonlyrelevantwhentheexportformatisavectorformat,
asopposedtoarasterformat.
2.8.1
Usedtospecifythezonetoexport.Availablevaluesare:
0:TheEntireCoveredArea
1:TheComputationZone
2:TheGeographicExportZone
Ifnotspecified,theentirecoveredareaisconsideredto
performtheexport.
Itisonlyrelevantforrasterformats,asopposedtovector
formats.
ReturnValue
S_OK:Exporthascompletedsuccessfully.
S_FALSE:Exportcouldntbeperformedbecauseofoneofthefollowingreasons:
ThefolderspecifiedinbstrFileNamedoesnotexist.
Thestudyvisibilitycheckboxiscleared.
Thestudyhasnocoverage.
WhenS_FALSEisreturned,nooutputfileiscreated.
Example
Const SID_PREDICTIONS = "{DA676EF0-E300-4AFF-BBFA-EC55D3798E4F}"
Public Sub ExportStudy
Dim oStudy
Dim oCS
Set oCS = ActiveDocument.CoordSystemDisplay
117
Forsk2014
For Each oStudy In ActiveDocument.GetRootFolder(0).Item(SID_PREDICTIONS)

oStudy.Export "c:\export.asc", oCS, "ARCVIEWGRIDASCII"
oStudy.Export "c:\export.txt", oCS, "TXT"
oStudy.Export "c:\export.bmp", oCS, "BMP"
Next
End Sub
9.14 CentreOnMap
CentrestheAtollMapViewwindowaroundtheChildFolderobject.
HRESULT CentreOnMap(void);
Remarks
CentreOnMaponlymakessenseforChildFolderobjectsthatmayappearonAtollMapViewwindows.CentreOnMapcallswill
beignoredforobjectsthatdontsupportit.Noerrorwillbereturned.
9.15 Redraw
RedrawstheChildFolderobject.
HRESULT Redraw(void);
Remarks
RedrawonlymakessenseforChildFolderobjectsthatmayappearonAtollMapViewwindows.Redrawcallswillbeignored
forobjectsthatdontsupportit.Noerrorwillbereturned.
9.16 AddChild
AddsanewchildtothecurrentAtollchildfolderobject.
HRESULT AddChild(const VARIANT spec, long position, IChildFolder2** pVal)

Parameters
[in]spec:VARIANTusedtodefinethechilditemtoadd.
[in]position:Thepositionusedtodefinewheretoaddthenewchild.
[out]pVal:AddressofaIChildFolder2interfacepointerusedtoreturnthenewAtollchildfolderobjectjustadded.
Remark
Thetypeofthechildaddeddependsonthetypeofthespecinputparameter.
WhenspecifoftypeVT_UNKNOWNorVT_DISPATCH,andwhenitisanAtollChildFolderobject,specisinterpretedasasource
ChildFolderobject.AddChildwilladdalinktothesourceChildFolderobject.ThesourceAtollChildFoldercannotbealink
itself.LinkscanonlybecreatedattherootleveloftheAtollExplorergeoordatatabs.Linksalwaysarecreatedatposition0.
ThesourceChildFolderobjectandthecurrentChildFolderobjectmustbelongtodifferentAtolldocuments.
WhenspecifoftypeVT_UNKNOWNorVT_DISPATCH,andwhenitisanAtollPropertyContainerobject,thenanewChild
FolderisaddedwiththecontentoftheAtollPropertyContainerobject.Thepropertiesneededtoactuallybeabletoadda
newChildFolderobjectdependonthecurrentChildFolderobjecttype,asreturnedbyObjectKind.
118
AT321_TAG_E1
9.17 Remove
RemovestheChildFolderobjectfromitsparentChildFolderobject.
HRESULT Remove(void);
Remarks
AChildFolderobjectcannotbeusedanymoreafteritisremoved.ChildFolderobjectsmayberemovedbyAtoll,forinstance
whenF5isusedinteractivelytorefreshthescreen.
Atollversion>=2.8.2:
Thismethodisdeprecated.PleaseuseRemoveIteminstead.
9.18 get_position
ReturnstheChildFolderobjectpositionrelativetoitsparentChildFolderobject.
HRESULT get_position(long *pPos);

Parameters
[out]pPos:AddressofthelongintegerusedtoreturntheChildFolderobjectposition.ChildFolderobjectsareorderedfrom
position0(top)totoget_Count()1(bottom).
9.19 put_position
SetstheChildFolderobjectpositionrelativetoitsparentChildFolderobject.
HRESULT put_position(long lPos);

Parameters
[in]lPos:AlongintegerusedtospecifytheChildFolderobjectposition.
IflPos 0,theChildFolderobjectismovedtothetop.
IflPos get_Count()1,theChildFolderobjectismovedtothebottom.
9.20 get_Object
HRESULT get_Object(IUnknown **ppObject);

Parameters
[out]ppObject:AddressoftheIUnknowninterfacepointerusedtoaccesssomespecificfeatures.
Remarks
Duetothenatureoftheinterfacereturned,get_Objectcannotbeusedbymacrosandscripts.Macrosorscriptsmustuse
get_dispatchinstead.
9.21 get_dispatch
119
Forsk2014
HRESULT get_dispatch(IDispatch **ppDispatch);

Parameter
[out]ppDispatch:AddressoftheIDispatchinterfacepointerusedtoaccesssomespecificfeatures.
9.22 get_ObjectKind
ReturnsatypeidentifieroftheChildFolderobject.
HRESULT get_ObjectKind(BSTR *pRetVal);

Parameters
[out]pRetVal:AddressoftheBSTRusedtoreturnthetypeidentifier.
Remarks
TobeabletoidentifytheChildFolderobjecttype,andthereforetosafelyaccessspecificfeaturesoftheChildFolderobject,
hereisthelistoftheavailabletypeidentifiers:
120
Version
SID
StringValue
SpecificFeatures
2.4.0
SID_CLUTTER
{7CB51DE8A96111D286880060086457D1}
Tabulardataclutter
properties.
2.4.0
SID_SIMULATIONS
{CDDF1E1D19634D80A057D23A19570984}
Simulationsfolder.
2.4.0
SID_SIMULATIONSGROUP
{AF5E2B981D5448FA89C58BFA2936ABF2}
"Groupsofsimulations"
folder.
2.4.0
SID_SIMULATION
{095C5D9096F14BA885BBB2F990AC2DD9}
"Simulation"items.
2.5.1
SID_SITES
{90443F685B3B4AFDB7BBB057095EBAAD}
Sitesfolder.
2.5.1
SID_ANTENNAS
{5FBEB2AE3BBB4FBA94D85D8EA5A32069}
Antennasfolder.
2.5.1
SID_TRANSMITTERS
{F7E891E8F7F54870BF63AF559AD50FD3}
Transmittersfolder,ina
singleRATdocument.
2.5.1
SID_PREDICTIONS
{DA676EF0E3004AFFBBFAEC55D3798E4F}
Predictionsfolder.
2.5.1
SID_UMTS_PARAMETERS
{D4F57EE3778543489BA628998AA6BD80}
UMTSParametersfolder.
2.5.1
SID_CW_MEASUREMENTS
{41413C4AC9DE43DDA917612A0AF198FC}
CWMeasurementsfolder.
2.5.1
SID_MEASURE_TX
{2C102EE5BFF44A5A813002BD0E2F70D7}
CWMeasurements
transmitter.
2.5.1
SID_MEASURE_ITEM
{36858A487A85482E9DA0B9E935ADE84C}
CWMeasurements.
2.5.1
SID_TESTMOBILEDATA
{21C11380D8CF4902B622763522AD9FC4}
DriveTestDatafolder.
2.5.1
SID_NUM_MEASURE_ITEM
{916801F90539448C8C0C491FAC6399ED}
DriveTestDataitems.
2.5.1
SID_PARAMETERS_FOLDER
{43B88455226454F908F59A500DB4FD1}
Parametersfolder.
AT321_TAG_E1
2.5.1
SID_HEXAGON_SCHEMA
{B167D45EA0BC4DC6B9D76F7B131CADF1}
HexagonalDesignfolder.
2.6.0
SID_TRAFFICFOLDER
{B3B25A07A9944e8dBBD151556D6C4245}
Trafficfolder.
2.7.0
SID_PROPAGATIONMODELS
{4A2D160B7D114D0792DFA3CF6B68D402}
Propagationmodelsfolder.
2.8.2
{16A53FB3A9614EEA8C302387DBF1CC24}
MasterlinkChildFolder
object.
2.8.2
{232BDB73A68F41A6A95475112D907BBF}
LinkChildFolderobject.
3.1.0
{CC6370627AFF4516BEFBBCC954E905B1}
GSMTransmittersfolder,ina
multiRATdocument.
3.1.0
{FD147AA0B9A247AC8CD551C77A708AF8}
LTETransmittersfolder,ina
multiRATdocument.
3.1.0
{090A23A1EE08420D9739651D1045EF16}
UMTSTransmittersfolder,in
amultiRATdocument.
3.2.0
{65FF5F7DDBF04B52ABB866F3414FD4C3}
CDMA2000Transmitters
folder,inamultiRAT
document.
3.2.1
StudyFolder
Asubfolderofthe
predictionsfolder.
9.23 GetProperty
ReturnsaChildFolderobjectproperty.
HRESULT GetProperty(const BSTR bstrName, VARIANT *pValue);

Parameters
[in]bstrName:Apropertyname.
[out]pValue:AddressoftheVARIANTusedtoreturntheproperty.
Remarks
ThetypeofthereturnedVARIANTcanbeanyofthefollowing:
C++
VBScript
VT_BOOL
Boolean
VT_I4
Integer
VT_R4
Single
VT_R8
Double
VT_UNKNOWN
Object
VT_DISPATCH
Object,TabularDataobject,ChildFolderobject,PropertyContainer
object
VT_BSTR
String
VT_ARRAY|(anyoftheprevioustypes)
Array,witharrayitemsoftheprevioustypes
TheerrorE_INVALIDARGisreturnedwhenthereisnopropertynamedbstrNamefortheChildFolderobject.Theproperties
availablefortheChildFolderobjectdependonthetypeoftheChildFolderobject,asreturnedbyget_ObjectKind.
121
Forsk2014
9.24 SetProperty
SetsaChildFolderobjectproperty.
HRESULT SetProperty(const BSTR bstrName, const VARIANT varValue);

Parameters
[in]varValue:TheVARIANTusedtospecifythepropertyvalue.
Remarks
TheerrorE_INVALIDARGisreturnedwhenthereisnopropertynamedbstrNamefortheChildFolderobject.Theproperties
availablefortheChildFolderobjectdependonthetypeoftheChildFolderobject,asreturnedbyget_ObjectKind.
9.25 GetPropertiesInfo
ReturnsnamesandtypesforallpropertiesavailableontheChildFolderobject.
HRESULT GetPropertiesInfo(VARIANT *pValue);

Parameters
[out]pValue:AddressoftheVARIANTusedtoreturnthenamesandtypesforallpropertiesinthepropertycontainer.
9.26 PropertyIsPropertyContainer
ReturnstruewhenaChildFolderobjectpropertyisaPropertyContainerobject.
HRESULT
PropertyIsPropertyContainer(const BSTR bstrName, VARIANT_BOOL *pValue);
Parameters
[in]bstrName:Thepropertyname.
[out]pValue:AddressoftheVARIANT_BOOLusedtoreturnwhetherthepropertyisaPropertyContainerobjectornot.
9.27 PropertyIsTabularData
ReturnstruewhenaChildFolderobjectpropertyisaTabularDataobject.
HRESULT PropertyIsTabularData(const BSTR bstrName, VARIANT_BOOL *pValue);

Parameters
[out]pValue:AddressoftheVARIANT_BOOLusedtoreturnwhethertheChildFolderpropertytypeisTabularDataobject.
9.28 LoadProperties
SetspropertiesfromapropertycontainertotheChildFolderobject.
HRESULT LoadProperties(const VARIANT varSource);
122
AT321_TAG_E1
Parameters
[in]varSource:VARIANToftypeVT_DISPATCH,usedtospecifyapropertycontainerforthepropertiestoset.
9.29 SaveProperties
SavesalltheChildFolderobjectpropertiestoanotherpropertycontainer.
HRESULT SaveProperties( const VARIANT varDestination) ;
Parameters
[in]varDestination:VARIANToftypeVT_DISPATCH,usedtospecifyapropertycontainerwhereallpropertieswillbeset.
9.30 RemoveItem
RemovesoneofthechildrenoftheChildFolderobject.
HRESULT RemoveItem( const VARIANT idx) ;
Parameters
[in]idx:AVARIANToftypeVT_I4orVT_BSTRusedtospecifyoneofthechildrentoremove.
IfthetypeofthevariantisVT_I4,itisinterpretedasazerobasedindexinthelistofchildren.
IfthetypeofthevariantisVT_BSTR,itisfirstinterpretedasthedisplaynameofthechildtoremove,andifthedisplayname
isnotfound,itistheninterpretedasaChildFolderobjectkind,asreturnedbyget_ObjectKind.
Remarks
AChildFolderobjectcannotbeusedanymoreafteritisremoved.ChildFolderobjectsmayberemovedbytheapplication,for
instancewhenF5isusedinteractivelytorefreshthescreen.
ThismethodfailsforChildFolderobjectsthatcannotberemovedinteractively,andanerrorisreturnedinthatcase.
9.31 SetCustomIcon
Setsthepathofanicontouseforacustomchildfolder.
HRESULT SetCustomIcon(const BSTR bstrPath);
Parameters
[in]bstrPath:Thefullpathtotheiconfile(*.ico)toload.
123
124
Forsk2014
Chapter10
PropertyContainer
Object
126
Forsk2014
Chapter10:PropertyContainerObject
AT321_TAG_E1
10 PropertyContainerObject
ThePropertyContainerobjectisagenericcontainercontainingasetofnamedpropertiesofarbitrarytypes.
ThePropertyContainerobjectprovidesthefollowingpropertiesandmethods:
Name
Description
Attributes
Get
Returnsanamedproperty.
Set
Setsanamedproperty.
GetInfo
Returnsnamesandtypesforallpropertiessettotheproperty
container.
IsPropertyContainer
Returnstruewhenanamedpropertyisofa
PropertyContainerobject.
Type:Boolean
Access:Read
IsTabularData
ReturnstruewhenanamedpropertyisofaTabularData
object.
Type:Boolean
Access:Read
Load
Addspropertiesfromanotherpropertycontainertothe
propertycontainer.
Save
Savesallthepropertiestoanotherpropertycontainer.
RemoveAll
Removesallpropertiesfromthepropertycontainer.
Remove
Removesanamedpropertyfromthepropertycontainer.
10.1 Get
Returnsanamedproperty.
HRESULT Get(const BSTR bstrName, VARIANT *pValue);

Parameters
[out]pValue:AddressoftheVARIANTusedtoreturntheproperty.
Remarks
ThetypeofthereturnedVARIANTcanbeanyofthefollowing:
C++
VBScript
VT_BOOL
Boolean
VT_I4
Integer
VT_R4
Single
VT_R8
Double
VT_UNKNOWN
Object
VT_DISPATCH
Object,TabularDataObject,ChildFolderObject,PropertyContainer
Object
VT_BSTR
String
VT_ARRAY|(anyoftheprevioustypes)
Array,witharrayitemsoftheprevioustypes
127
Forsk2014
The error E_INVALIDARG is returned when the property named bstrName has not been previously set to the property
container.
10.2 Set
Setsanamedproperty.
HRESULT Set(const BSTR bstrName, const VARIANT varValue);

Parameters
[in]varValue:TheVARIANTusedtospecifythepropertyvalue.
Remarks
IfthepropertynamedbstrNamehasbeenpreviouslyset,itscontentisreplacedbyvarValue,otherwiseanewpropertynamed
bstrNameisaddedtothepropertycontainer.
10.3 GetInfo
Returnsnamesandtypesforallpropertiessettothepropertycontainer.
HRESULT GetInfo(VARIANT *pValue);

Parameters
[out]pValue:AddressoftheVARIANTusedtoreturnthenamesandtypesforallpropertiesinthepropertycontainer.
10.4 IsPropertyContainer
ReturnstruewhenanamedpropertyisaPropertyContainerobject.
HRESULT IsPropertyContainer(const BSTR bstrName, VARIANT_BOOL *pValue);

Parameters
[out]pValue:AddressoftheVARIANT_BOOLusedtoreturnwhetherthepropertyisaPropertyContainerObject.
10.5 IsTabularData
ReturnstruewhenanamedpropertyisaTabularDataobject.
HRESULT IsTabularData(const BSTR bstrName, VARIANT_BOOL *pValue);

Parameters
[out]pValue:AddressoftheVARIANT_BOOLusedtoreturnwhetherthepropertyisaTabularDataObject.
10.6 Load
Addspropertiesfromanotherpropertycontainertothepropertycontainer.
128
AT321_TAG_E1
HRESULT Load(const VARIANT varSource);

Parameters
[in]varSource:VARIANToftypeVT_DISPATCH,usedtospecifyapropertycontainerforthepropertiestoadd.
10.7 Save
Savesallthepropertiestoanotherpropertycontainer.
HRESULT Save(const VARIANT varDestination);

Parameters
[in]varDestination:VARIANToftypeVT_DISPATCH,usedtospecifyapropertycontainerwhereallpropertieswillbeset.
10.8 RemoveAll
Removesallpropertiesfromthepropertycontainer.
HRESULT RemoveAll(void);
10.9 Remove
Removesanamedpropertyfromthepropertycontainer.
HRESULT Remove(const BSTR bstrName, VARIANT *pValue);

Parameters
[out]pValue:AddressoftheVARIANTusedtoreturntheoriginalpropertyvalue,beforeitisremoved.
129
130
Forsk2014
Chapter11
ChildFolderObject
Properties
132
Forsk2014
Chapter11:ChildFolderObjectProperties
AT321_TAG_E1
11 ChildFolderObjectProperties
ChildFolderobjectpropertiesarenamedproperties.ThesetofavailablepropertiesforagivenChildFolderobjectdependson
theChildFolderobjecttype,returnedbyget_ObjectKind.
ChildFolderobjectpropertynamesusuallyresembletheirGUIrepresentationsinthepropertiesdialoguesinsideAtoll.
ChildFolderobjectpropertiesaredividedintothefollowinggroupsaccordingtotheiruseandapplicationinAtoll:
"CommonChildFolderObjectProperties"onpage 134,
"PredictionsFolderProperties"onpage 134,
"CoveragePredictionProperties"onpage 135,
"GSMSimulationGroupProperties"onpage 142,
"UMTSSimulationGroupProperties"onpage 143,
"WiMAXandLTESimulationGroupProperties"onpage 144,
"3GPPMultiRATSimulationGroupProperties"onpage 145,
"PropagationModelProperties"onpage 146,
"CWMeasurementProperties"onpage 148,
"DriveTestDataProperties"onpage 149,
"CustomChildFolderObjectProperties"onpage 149,
"MasterLinkProperties"onpage 150,
"LinkProperties"onpage 150,
"VectorLayerProperties"onpage 150.
11.1 HowtoAccessChildFolderObjectProperties
ThefollowingsamplecodesshowhowtoreadandwriteChildFolderObjectproperties.
ReadingaChildFolderObjectProperty
item:AChildFolderobject.
propertyname:Thepropertyname.
propertyvalue:Thepropertyvalue.

If the property type is an Object (Atoll Tabular Data Object, Atoll Property
Container Object, ...), then replace the next line with
"Set propertyvalue = item.GetProperty(propertyname)"
propertyvalue = item.GetProperty(propertyname)
If Err Then
MsgBox item.Name & "." & propertyname & "does not exist."
Else
MsgBox item.Name & "." & propertyname & " = " & CStr(propertyvalue)
End If
WritingaChildFolderObjectProperty
item:AChildFolderobject.
propertyname:Thepropertyname.
propertyvalue:Thepropertyvalue.
133
Forsk2014
item.SetProperty propertyname, propertyvalue

If Err Then
MsgBox Err.Description
End If
11.2 CommonChildFolderObjectProperties
SomeChildFolderobjectpropertiesarecommontoallkindsofChildFolderobjects.Thesepropertiesincludethefollowing.
Name
Description
Attributes
NAME
ChildFolderobjectnameasitappearsintheExplorerwindow.
Version :2.6.1
Type:String
Access:Read/Write
VISIBLE
ChildFoldervisibilitystate.Thispropertyisonlyrelevantfor
geographicChildFolderobjects.
Version :2.6.1
Type:Boolean
Access:Read/Write
SELECTED
ChildFolderselectedstate,eitherselectedornotselected.
Version :2.6.1
Type:Boolean
Access:Read/Write
POSITION
ChildFolderposition,relativetotheparentChildFolderobject.
Version :2.6.1
Type:Integer
Access:Read/Write
OBJECTKIND
ChildFoldertypeidentifier.Thisisthesameasthevaluereturned
byget_ObjectKind.
Version :2.7.0
Type:String
Access:Read
ISGEOGRAPHIC
ReturnstrueiftheChildFolderobjectcanbevisibleintheMap
window,falseotherwise.
Whenthispropertyisfalse,thepropertiesandmethodsspecific
totheMapviewareneitherrelevantnorapplicable.
Version :2.7.0
Type:Boolean
Access:Read
VISIBILITYSCALEMIN
ChildFolderminimumvisibilityscaledisplayproperty.This
propertyisonlyrelevantforgeographicChildFolderobjects.
Version :2.7.0
Type:Integer
Access:Read/Write
VISIBILITYSCALEMAX
ChildFoldermaximumvisibilityscaledisplayproperty.This
propertyisonlyrelevantforgeographicChildFolderobjects.
Version :2.7.0
Type:Integer
Access:Read/Write
ADDTOLEGEND
ChildFolderaddtolegenddisplayproperty.Thispropertyisonly
relevantforgeographicChildFolderobjects.
Version :2.7.0
Type:Boolean
Access:Read/Write
DOCUMENT
ADocumentobject.
TheChildFolderobjectispartoftheDocumentobject.
Version :2.8.2
Type:Object
Access:Read
LEGEND
ChildFolderobjectnameasitappearsintheLegendwindow.
Version :3.2.0
Type:String
Access:Read/Write
11.3 PredictionsFolderProperties
Typereturnedbyget_ObjectKind:{DA676EF0E3004AFFBBFAEC55D3798E4F}
ThefollowingpropertiesareaccessiblethroughthePredictionsfolder.
134
AT321_TAG_E1
Name
Description
Attributes
PRIVATESTORAGE
Pathtothepathlossmatricesprivatestoragefolder,asitappears
inthePredictionsfolderproperties.
Version :2.6.1
Type:String
Access:Read/Write
11.4 CoveragePredictionProperties
Thecoveragepredictiontypesreturnedbyget_ObjectKindforthevariouscoveragepredictionsarelistedbelow:
"GSMGPRSEDGECoveragePredictions"onpage 135,
"UMTSHSPACoveragePredictions"onpage 135,
"WiMAXCoveragePredictions"onpage 136,
"LTECoveragePredictions"onpage 136.
Coveragepredictionpropertiesareofthefollowingtypes:
"GeneralProperties"onpage 137,
"Group,Filter,andSortProperties"onpage 137,
"NonSimulationbasedCoverageConditions"onpage 137:Coverageconditionsforpredictionsthatcannotbebased
onsimulations,
"SimulationbasedCoverageConditions"onpage 139:Coverageconditionsforpredictionsthatcanbebasedonsim
ulations,
"ShadowingandIndoorCoverageConditions"onpage 140,
"DisplayProperties"onpage 140.
GSMGPRSEDGECoveragePredictions
Name
Type
CoveragebyTransmitter
{9E42C87F56D043caA31378A7CA9A811B}
CoveragebySignalLevel
{1FF202779A4C486aB0A490E7E8EC72E4}
OverlappingZones
{1F0C294B11A045c99B32640FED79BCA6}
CoveragebyC/ILevel
{8A94CAE7B4FF4dc6854ABC90FE8F0073}
InterferedZones
{EB45E33DFB3344f1A63BB4661ACE78B2}
CoveragebyGPRS/EDGECoding
Scheme
{6B062215EEC140e99A02F909AFF6B5DB}
RLC/MACThroughput/Timeslot
{02BE397A1F4B423eAEC4B8138974ADD8}
ApplicationThroughput/Timeslot
{3F8F8CB3A5DC49f98F3D0E7243AA0E6C}
CircuitQualityIndicatorAnalysis
{67EC97E99F064b0f90C0E42A67FE560C}
Attributes
UMTSHSPACoveragePredictions
Name
Type
{A6FB7132FB5E42ccA1C10BEA4AF09921}
{E82C3B13240E4dd3A553583ADDF57713}
OverlappingZones
{53B30925B781499d90E43F9B8570871B}
CoveragebyTotalNoiseLevel(DL)
{1C9384EB57CA433fBDB307E1BE317890}
PilotQualityAnalysis(Ec/Io)
{66287FC581FA40b684E32C2C4E13D121}
ServiceAreaAnalysis(Eb/Nt)(DL)
{5C6427F7D63A4046B8BD1A5E9D165890}
ServiceAreaAnalysis(Eb/Nt)(UL)
{D75ADE37FB8A4693A78847109A913C29}
EffectiveServiceAreaAnalysis(Eb/
Nt)(DL+UL)
{5F74AEFA295842cc8244C12DC19B26C3}
Attributes
135
Forsk2014
Name
Type
HandoffZones
{39A63BBA02EC43e7852307E29B519181}
PilotPollutionAnalysis
{2199E577F3F54ffdBCAB0D748CA7CCD3}
HSDPAQualityandThroughput
Analysis
{BFDDFC83D8EE4225840FEF842DE19B74}
HSUPAQualityandThroughput
Analysis
{E9ED15F1EC144451ADFA1953A6FB2526}
ScramblingCodeCollisionZones
{AC612067A173439eBF7A76B17933A30E}
Attributes
WiMAXCoveragePredictions
Name
Type
Attributes
{BE607087CB08453CB2A0B356CD38C3F5}
Version :2.7.1
{9C602E1CE5E744CA8E5B878D74D07885}
Version :2.7.1
OverlappingZones
{86560A81DE6041CC9B9E83BF33CEF491}
Version :2.7.1
EffectiveSignalAnalysis(DL)
{6A657977CF0E415C8486C41664F7035E}
Version :2.7.1
EffectiveSignalAnalysis(UL)
{3F803866104142678D28FCA43445A642}
Version :2.7.1
CoveragebyC/(I+N)Level(DL)
{DCB4B7564D0242DBB83814A62F603922}
Version :2.7.1
CoveragebyC/(I+N)Level(UL)
{4163305DE2034A7899F6E59EA537AB7E}
Version :2.7.1
CoveragebyBearer(DL)
{C5A270AA15A1443DBBCB77B1B99D447F}
Version :2.7.1
CoveragebyBearer(UL)
{A07FB55064C74D2AB63479FC6A981828}
Version :2.7.1
CoveragebyThroughput(DL)
{645C7166CE004EFBB9AFA7F25A3BBBA6}
Version :2.7.1
CoveragebyThroughput(UL)
{1A8B4ACB8D5149AAAA673ADAB48F09B6}
Version :2.7.1
CoveragebyAerial(DL)
{4A9ED8C5F2DE432B8507C65A3DFE47E3}
Version :3.2.0
Name
Type
Attributes
{BE607087CB08453CB2A0B356CD38C3F5}
Version :2.8.0
{9C602E1CE5E744CA8E5B878D74D07885}
Version :2.8.0
OverlappingZones
{86560A81DE6041CC9B9E83BF33CEF491}
Version :2.8.0
EffectiveSignalAnalysis(DL)
{6A657977CF0E415C8486C41664F7035E}
Version :2.8.0
EffectiveSignalAnalysis(UL)
{3F803866104142678D28FCA43445A642}
Version :2.8.0
{DCB4B7564D0242DBB83814A62F603922}
Version :2.8.0
{4163305DE2034A7899F6E59EA537AB7E}
Version :2.8.0
{C5A270AA15A1443DBBCB77B1B99D447F}
Version :2.8.0
{A07FB55064C74D2AB63479FC6A981828}
Version :2.8.0
{645C7166CE004EFBB9AFA7F25A3BBBA6}
Version :2.8.0
{1A8B4ACB8D5149AAAA673ADAB48F09B6}
Version :2.8.0
CoveragebyQualityIndicator(DL)
{B682A005CCC24C7CA9FAD2FEBA633E15}
Version :2.8.0
LTECoveragePredictions
136
AT321_TAG_E1
Name
Type
Attributes
CoveragebyQualityIndicator(UL)
{E648833C48E149C0A56F6B94DBA9C358}
Version :2.8.0
11.4.1 GeneralProperties
Thesepropertiesareavailableforallkindsofcoveragepredictions.
Name
Description
Attributes
DESCRIPTION
Comments
Version :2.7.0
Type:String
Access:Read/Write
RESOLUTION
Resolutionoftheprediction,inmeters.
Version :2.7.0
Type:Integer
Access:Read/Write
LOCKED
Returnstruewhenthepredictionislockedforcalculations,
falseotherwise.
Version :2.7.0
Type:Boolean
Access:Read/Write
ISEMPTY
Returnstruewhenthepredictioncoverageisempty,false
otherwise.
Version :2.7.0
Type:Boolean
Access:Read
ISPERTRANSMITTER
Returnstruewhenthepredictionispertransmitter,false
otherwise.Thereturnvaluedependsonthedisplayfieldof
theprediction.
Version :2.7.0
Type:Boolean
Access:Read
URL
Anemptystringwhenthecoveragepredictiondoesnot
haveexternalnumericalresults,otherwisetheabsolute
pathtothediskfoldercontainingnumericalresults.
Version :3.2.1
Type:String
Access:Read
11.4.2 Group,Filter,andSortProperties
ThesepropertiesarecalledRECORDSETCONDITIONS,whichareavailableforallkindsofcoveragepredictions.
Name
Attributes
RECORDSETCONDITIONS
Version :2.7.0
PropertyContainerobject
ThefollowingRECORDSETCONDITIONSareavailable:
Name
Description
Attributes
GROUPBY
"GroupBy"partoftherecordsetconditions,appliedtothe
Transmitterstable.
Version :2.7.0
Type:String
Access:Read/Write
FILTER
"Filter"partoftherecordsetconditions,appliedtothe
Transmitterstable.
Version :2.7.0
Type:String
Access:Read/Write
SORT
"Sort"partoftherecordsetconditions,appliedtothe
Transmitterstable.
Version :2.7.0
Type:String
Access:Read/Write
11.4.3 NonSimulationbasedCoverageConditions
ThesepropertiesarecalledCOVERAGECONDITIONS.
137
Forsk2014
Name
Attributes
COVERAGECONDITIONS
Version :2.7.0
PropertyContainerobject
Thesepropertiesareavailableforthefollowingcoveragepredictions:
GSMGPRSEDGE:
OverlappingZones
CoveragebyC/ILevel
InterferedZones
CoveragebyGPRS/EDGECodingScheme
RLC/MACThroughput/Timeslot
ApplicationThroughput/Timeslot
UMTSHSPA:
OverlappingZones
WiMAX(Version :2.7.1):
OverlappingZones
LTE(Version :2.8.0):
OverlappingZones
ThefollowingCOVERAGECONDITIONSareavailable:
138
Name
Description
Attributes
FIELDTYPE
Thefieldtypetobasethepredictionwith.
Thevaluesare:1=PathLoss(dB);2=TotalLosses(dB);
3=SignalLevel(dBm);4=SignalLevel(dBV);5=SignalLevel
(dBV/m);
Version :2.7.0
Type:Integer
Access:Read/Write
SERVERTYPE
Thewaytochoosetransmittersamongavailable(active,not
filtered)onesforthecurrentcoverageprediction.
Thevaluesare:0=All;1=BestSignalLevel;2=SecondBest
SignalLevel;
ForGSMGPRSEDGEdocuments,thefollowingvaluesare
alsoavailable:3=BestSignalLevelperHCSLayer;4=Second
BestSignalperHCSLayer;5=BestSignalLeveloftheHighest
PriorityHCSLayer;
6=BestIdleModeReselectionCriterion(C2);
Version :2.7.0
Type:Integer
Access:Read/Write
SERVERMARGIN
Themargin(indB)fromthebestserversignalleveland
signallevelfromotherserverstakingpartintothecurrent
coverage(availableonlyifthebestsignallevelorhighest
priorityoptionisselected)
e.g.:Ifthetwobestserversignallevelsarewithinthe
margin,thesearebothconsideredinthecoveragearea.
Version :2.7.0
Type:Single
Access:Read/Write
TRXTYPE
GSMGPRSEDGE:TheTRXtypetotakeintoaccountforthe
currentcoverageprediction(BCCH,TCH,TCH_EGPRS,
TCH_INNER).
UMTSHSPA:Thecarriernumbertotakeintoaccountforthe
currentcoverageprediction(ALL=Best;0=Carriernumber0;
1=Carriernumber1;2=Carriernumber2;)
Version :2.7.0
Type:
PropertyContainer
object
Access:Read/Write
USESUBCELLRECEPTIONTHRESHOLD
Whethertousethelowerreceptionthresholddefinedfor
thetransmittersubcellornot.WhensettoTrue,the
FIELDMINIMUMpropertyisignored.
Version :2.7.0
Type:Boolean
Access:Read/Write
AT321_TAG_E1
Name
Description
Attributes
FIELDMINIMUM
Thecoveragepredictionlowerthresholdassociatedwith
theFIELDTYPEproperty.Whensetto32768,nominimum
valuewillbeconsidered.
Version :2.7.0
Type:Single
Access:Read/Write
FIELDMAXIMUM
Thecoveragepredictionupperthresholdassociatedwith
theFIELDTYPEproperty.Whensetto32767,nomaximum
valuewillbeconsidered.
Version :2.7.0
Type:Single
Access:Read/Write
11.4.4 SimulationbasedCoverageConditions
ThesepropertiesarecalledSIMULATIONCONDITIONS.
Name
Attributes
SIMULATIONCONDITIONS
Version :2.7.0
Type:PropertyContainerobject
Thesepropertiesareavailableforthefollowingcoveragepredictions:
UMTSHSPA:
CoveragebyTotalNoiseLevel(DL)
PilotQualityAnalysis(Ec/Io)
ServiceAreaAnalysis(Eb/Nt)(DL)
ServiceAreaAnalysis(Eb/Nt)(UL)
EffectiveServiceAreaAnalysis(Eb/Nt)(DL+UL)
HandoffZones
PilotPollutionAnalysis
HSDPAQualityandThroughputAnalysis
HSUPAQualityandThroughputAnalysis
ScramblingCodeCollisionZones
WiMAX:
LTE(Version :2.8.0):
CoveragebyQualityIndicator(DL)
CoveragebyQualityIndicator(UL)
ThefollowingSIMULATIONCONDITIONSareavailable:
Name
Description
Attributes
TERMINAL
Thenameoftheterminaltypeusedfortheprediction.
Version :2.7.0
Type:String
Access:Read/Write
MOBILITY
Thenameofthemobilitytypeusedfortheprediction.
Version :2.7.0
Type:String
Access:Read/Write
SERVICE
Thenameoftheserviceusedfortheprediction.
Version :2.7.0
Type:String
Access:Read/Write
139
Forsk2014
Name
Description
Attributes
SIMULATION
Thenameofthesimulationusedfortheprediction.When
settoanemptystring,nosimulationwillbeusedtoperform
theprediction.
Version :2.7.0
Type:String
Access:Read/Write
AVERAGESIMULATION
Whethertheaveragesimulationwillbeusedtoperformthe
prediction.Thispropertyisnotrelevantwhenthe
SIMULATIONpropertyisempty.Thispropertyisnot
availableforWiMAXandLTEpredictions.
Version :2.7.0
Type:Boolean
Access:Read/Write
MINIMUMPROBABILITY
Theminimumprobabilityusedtoperformtheprediction.
ThispropertyisonlyrelevantwhentheSIMULATION
propertyisnotemptyandwhentheAVERAGESIMULATION
propertyissettoFalse.Thispropertyisnotavailablefor
WiMAXandLTEpredictions.
Version :2.7.0
Type:Single
Access:Read/Write
CARRIER
Thecarriernumberusedtoperformtheprediction.This
propertyisnotavailableforWiMAXandLTEpredictions.
Version :2.7.0
Type:Integer
Access:Read/Write
DOWNGRADINGALLOWED
Whetherdowngradingwillbeconsideredtoperformthe
prediction,ornot.ThispropertyisnotavailableforWiMAX
andLTEpredictions.
Version :2.7.0
Type:Boolean
Access:Read/Write
BEARER
Thebearerusedtoperformtheprediction.Thispropertyis
onlyrelevantforaHSDPAPrediction.Thispropertyisnot
availableforWiMAXandLTEpredictions.
Version :2.7.0
Type:Integer
Access:Read/Write
11.4.5 ShadowingandIndoorCoverageConditions
ThesepropertiesarecalledCLUTTERCONDITIONS.
Name
Attributes
CLUTTERCONDITIONS
Version :2.7.0
Thesepropertiesareavailableforallkindsofcoveragepredictions:
Name
Description
Attributes
SHADOWING
Whethertocalculateshadowingmarginsrelatedtothe
definedcelledgecoverageprobabilityandthestandard
deviation(s)perclutterclassornot.WhensettoFalse,no
shadowingeffectisconsidered.
Version :2.7.0
Type:Boolean
Access:Read/Write
INDOORCOVERAGE
Whethertodecreasethereceivedsignallevelatthe
receiveroftheindoorlossdefinedforthecorresponding
clutterclass(clutterclassproperties)
Version :2.7.0
Type:Boolean
Access:Read/Write
EDGECOVERAGEPROBABILITY
Avaluebetween0and100,expressinginpercentagevalue
therequiredcoverageprobabilityatthecelledge.
Version :2.7.0
Type:Single
Access:Read/Write
11.4.6 DisplayProperties
Displaypropertiesforcoveragepredictionsareaccessedthroughapropertynamed"DISPLAYPROPERTIES."The"DISPLAY
PROPERTIES"propertyisacontainerobjectusedtocontainindividualdisplayproperties.
140
Name
Attributes
DISPLAYPROPERTIES
Version :2.7.0
AT321_TAG_E1
Thepropertiesavailableinthe"DISPLAYPROPERTIES"propertycontainerare,forallkindsofcoveragepredictions:
REPRESENTATIONtabulardataobject
The"REPRESENTATION"tabulardataobjectcontainsattributesofintervalsorvaluesusedtodisplaythepredictiononthe
map.Thistabulardataobjectcanbeeditedtochange,remove,oradddisplayintervalsordisplayvalues.
The"REPRESENTATION"tabulardataobjectisavailableasa"DISPLAYPROPERTIES"propertynamed"REPRESENTATION"
Name
Attributes
REPRESENTATION
Version :2.7.0
Type:TabularDataobject
Theschemaofthe"REPRESENTATION"tabulardataobjectis:
TabularDataColumnName
Description
Attributes
LINESTYLE
Thestyleofthelineusedtodisplaytheintervalorthevalue.
Thevaluesare:5=None;0=Solid;128=SolidDoubleLine;
1=Dash;2=DashDot;4=DashDotDot;
Version :2.7.0
Type:Integer
Access:Read/Write
LINEWIDTH
Thewidthofthelineusedtodisplaytheintervalorthe
value,expressedintenthofapoint.Forinstance,tohavea
linewidthof0,5pt,theLINEWIDTHpropertyvaluemustbe
setto5.
Version :2.7.0
Type:Integer
Access:Read/Write
FILLSTYLE
Thegraphicalstyleusedtofilltheinteriorofthesurface
definedbythedisplayintervalorthedisplayvalue.The
valuesare:0=None;1=Full;2=Horizontal;3=Vertical;
4=DownDiagonal;5=UpDiagonal;6=Grid;7=Treillis;
Version :2.7.0
Type:Integer
Access:Read/Write
MAINCOLOR
Themaincolorassignedtothedisplayintervalorthedisplay
value.ThecolorformatisRGB.
See"ConvertingIntegerstoRGBandViceversa"on
page 141.
Version :2.7.0
Type:Integer
Access:Read/Write
SECONDARYCOLOR
Thesecondarycolorassignedtothedisplayintervalorthe
displayvalue.ThecolorformatisRGB.
page 141.
Version :2.7.0
Type:Integer
Access:Read/Write
SYMBOL
Thispropertyisnotusedtodisplayapredictionintervalora
predictionvalue.
Version :2.7.0
Type:Integer
Access:Read/Write
SYMBOLSIZE
Thispropertyisnotusedtodisplayapredictionintervalora
predictionvalue.
Version :2.7.0
Type:Integer
Access:Read/Write
VALUE
Thetextassignedtothedisplayvalue.Whenthedisplay
typeofthepredictionissettointervals,aNullvalueis
returned.
Version :2.7.0
Type:StringorNull
Access:Read/Write
MINVALUE
Theminimumvalueofthedisplayinterval.Whenthe
displaytypeofthepredictionissettodisplayuniqueor
discretevalues,aNullvalueisreturned.
Version :2.7.0
Type:DoubleorNull
Access:Read/Write
MAXVALUE
Themaximumvalueofthedisplayinterval.Whenthe
displaytypeofthepredictionissettodisplayuniqueor
Version :2.7.0
Type:DoubleorNull
Access:Read/Write
ConvertingIntegerstoRGBandViceversa
ToconvertIntegertoRGBcolorcomponents:
141
Forsk2014
Dim Red
Dim Green
Dim Blue
Let Red = (color And &HFF)
Let Green = ((color \ 256) And &HFF)
Let Blue = ((color \ 65536) And &HFF)
ToconvertRGBcolourcomponentstoInteger:
Dim color
Let color = (Red + Green * 256 + Blue * 65536)
OtherDISPLAYPROPERTIESproperties
DISPLAYPROPERTIES
PropertyName
Description
Attributes
TYPE
Avaluebetween0and2usedtochoosewhichvalueclasses
todisplayonthemapforthecurrentprediction:0=Unique;
1=DiscreteValues;2=ValueIntervals;
Version :2.7.0
Type:Integer
Access:Read/Write
FIELD
Thefieldtitleusedtochoosewhichcoveragetodisplayon
themap.Thefieldtitlemustbecompatiblewiththedisplay
typeproperty.
Version :2.7.0
Type:String
Access:Read/Write
TRANSPARENCY
Avaluebetween0and100usedtoadjustthelevelof
transparencyofthedisplayintervalorthedisplayvalue.
Version :2.7.0
Type:Integer
Access:Read/Write
11.5 GSMSimulationGroupProperties
ThefollowingpropertiesareaccessibleforaGSMMonteCarlosimulationgroup.
Name
Description
TRAFFICMAPS
Thenamesofthetrafficmapsusedbyasimulation
group.
NUMBEROFSIMULATIONS
Thenumberofsimulationsinasimulationgroup.
Attributes
Version :3.2.1
Type:ArrayofStrings
Access:Read/Write
Version :3.2.1
EXECUTELATER
Type:Integer
Access:Read/Write
Version :3.2.1
Whensettotrue,thegroupofsimulationswillberunas
Type:Boolean
partofthepredictionscalculation.
Access:Read
Version :3.2.1
GLOBALSCALINGFACTOR
GENERATORINITIALISATION
142
Globaltrafficdensitiesweighting.
Type:Single
Access:Read/Write
Version :3.2.1
Theseedofthepseudorandomnumbergenerator,used
Type:Integer
toobtaintwoidenticaluserdistributions.
Access:Read/Write
AT321_TAG_E1
Name
Description
MAXNUMBEROFITERATIONS
Themaximumnumberofiterationsiftheconvergence
criteriacannotbereached.
ULCONVERGENCETHRESHOLD
(forSingleRATdocuments)
GSMULCONVERGENCETHRESHOLD
(for3GPPMultiRATdocuments)
DLCONVERGENCETHRESHOLD
(forSingleRATdocuments)
Attributes
Version :3.2.1
Type:Integer
Access:Read/Write
Version :3.2.1
TheULrelativeinterferencedifferencetoreachbetween Type:Single
Access:Read/Write
twoiterativesteps.
Version :3.2.1
TheDLrelativeinterferencedifferencetoreachbetween Type:Single
Access:Read/Write
twoiterativesteps.
GSMDLCONVERGENCETHRESHOLD
(for3GPPMultiRATdocuments)
ULCONVERGENCEINTERFERENCES
Version :3.2.1
TheULnoiseriserelativeinterferencetoreachbetween
Type:Single
twoiterativesteps.
Access:Read/Write
DLCONVERGENCEPWRCTRLGAIN
ThepowercontrolgaindifferencetoreachDLbetween
twoiterativesteps.
Version :3.2.1
Type:Single
Access:Read/Write
11.6 UMTSSimulationGroupProperties
Typereturnedbyget_ObjectKind:{AF5E2B981D5448FA89C58BFA2936ABF2}
ThefollowingpropertiesareaccessibleforaUMTSMonteCarlosimulationgroup.
Name
Description
Attributes
TRAFFICMAPS
Thenamesofthetrafficmapsusedbyasimulationgroup.
Type:ArrayofStrings
Access:Read/Write
NUMBEROFSIMULATIONS
Version :2.7.1
Type:Integer
Access:Read/Write
EXECUTELATER
Version :2.7.1
Type:Boolean
Access:Read
INFORMATIONABOUTMOBILES
Thetypeofoutputsneededinthe"Mobiles"tabofeach
simulationinthesimulationsgroup.Availablevaluesare:
0=OnlytheAverageSimulationAndStatistics;1=No
InformationAboutMobiles;2=StandardInformationAbout
Mobiles;3=DetailedInformationAboutMobiles;
Version :2.7.1
Type:Integer
Access:Read/Write
BEARERRATEDOWNGRADING
Whensettotrue,R99bearerdowngradingisallowed.
Version :2.7.1
Type:Boolean
Access:Read/Write
GLOBALSCALINGFACTOR
Version :2.7.1
Type:Single
Access:Read/Write
Theseedofthepseudorandomnumbergenerator,usedto
obtaintwoidenticaluserdistributions.
Version :2.7.1
Type:Integer
Access:Read/Write
Version :2.7.1
Type:Integer
Access:Read/Write
143
Forsk2014
Name
Description
Attributes
TheULrelativeinterferencedifferencetoreachbetween
twoiterativesteps.
Version :2.7.1
Type:Single
Access:Read/Write
TheDLrelativeinterferencedifferencetoreachbetween
twoiterativesteps.
Version :2.7.1
Type:Single
Access:Read/Write
CONSTRAINTNUMBEROFCES
Whensettotrue,themaximumnumberofchannel
elementsdefinedpersiteisrespected.
Version :2.7.1
Type:Boolean
Access:Read/Write
CONSTRAINTNUMBEROFCODES
Whensettotrue,OVSFcodesavailibilityischecked.
Version :2.7.1
Type:Boolean
Access:Read/Write
CONSTRAINTULLOADFACTOR
Whensettotrue,themaximumULloadfactorisrespected.
Version :2.7.1
Type:Boolean
Access:Read/Write
CONSTRAINTDLLOAD
Whensettotrue,themaximumDLloadisrespected.
Version :2.7.1
Type:Boolean
Access:Read/Write
CONSTRAINTUSECELLMAXULLOADFA
CTOR
Whensettotrue,themaximumULloadfactorisdefined
percell.
Version :2.7.1
Type:Boolean
Access:Read/Write
CONSTRAINTUSECELLMAXDLLOAD
Whensettotrue,themaximumDLloadisdefinedpercell.
Version :2.7.1
Type:Boolean
Access:Read/Write
MAXULOADFACTOR
GlobalULloadfactortoimposetocells.
Validvaluesarecomprisedbetween0(0%)and1(100%).
Version :2.7.1
Type:Single
Access:Read/Write
MAXDLLOAD
GlobalDLloadtoimposetocells.
Validvaluesarecomprisedbetween0(0%)and1(100%).
Version :2.7.1
Type:Single
Access:Read/Write
IUBTHROUGHPUTS
Iubthroughputs.
Version :3.1.1
Type:Boolean
Access:Read/Write
11.7 WiMAXandLTESimulationGroupProperties
Typereturnedbyget_ObjectKind:{AF5E2B981D5448FA89C58BFA2936ABF2}
ThefollowingpropertiesareaccessibleforaWiMAXorLTEMonteCarlosimulationgroup.
144
Name
Description
Attributes
TRAFFICMAPS
Thenamesofthetrafficmapsusedbyasimulationgroup.
Version :2.8.1
Type:ArrayofStrings
Access:Read/Write
SUBSCRIBERLISTS
Thenamesofthesubscriberlistsusedbyasimulations
group.
Version :2.8.1
Type:ArrayofStrings
Access:Read/Write
NUMBEROFSIMULATIONS
Version :2.8.1
Type:Integer
Access:Read/Write
AT321_TAG_E1
Name
Description
Attributes
EXECUTELATER
Version :2.8.1
Type:Boolean
Access:Read
GLOBALSCALINGFACTOR
Version :2.8.1
Type:Single
Access:Read/Write
Theseedofthepseudorandomnumbergenerator,usedto
obtaintwoidenticaluserdistributions.
Version :2.8.1
Type:Integer
Access:Read/Write
Version :2.8.1
Type:Integer
Access:Read/Write
TheULrelativetrafficloaddifferencetoreachbetweentwo
iterativesteps.
Version :2.8.1
Type:Single
Access:Read/Write
TheDLrelativetrafficloaddifferencetoreachbetweentwo
iterativesteps.
Version :2.8.1
Type:Single
Access:Read/Write
ULNOISERISECONVERGENCETHRESH
OLD
TheULnoiseriserelativeinterferencetoreachbetween
twoiterativesteps.
Version :2.8.1
Type:Single
Access:Read/Write
CONSTRAINTUSECELLMAXULTRAFFIC
LOAD
Whensettotrue,themaximumULtrafficloadisdefined
percell.
Version :2.8.1
Type:Boolean
Access:Read/Write
CONSTRAINTUSECELLMAXDLTRAFFIC
LOAD
Whensettotrue,themaximumDLtrafficloadisdefined
percell.
Version :2.8.1
Type:Boolean
Access:Read/Write
MAXULTRAFFICLOAD
GlobalULtrafficloadtoimposetocells.
Version :2.8.1
Type:Single
Access:Read/Write
MAXDLTRAFFICLOAD
GlobalDLtrafficloadtoimposetocells.
Version :2.8.1
Type:Single
Access:Read/Write
BACKHAULCAPACITY
NOISERISECONTROL
BackhaulCapacity
NoiseRiseControl
Version :3.2.1
Type:Boolean
Access:Read/Write
Version :3.2.1
Type:Boolean
Access:Read/Write
11.8 3GPPMultiRATSimulationGroupProperties
Thefollowingpropertiesareaccessiblefora3GPPMultiRATsimulationgroup.
Ina3GPPMultiRATdocument,youcanaccessallthepropertieswehaveforallthetechnologiesavailableinyourdocument,
exceptULCONVERGENCETHRESHOLDandDLCONVERGENCETHRESHOLDwhichareprefixedwiththetechnologyname.
145
Name
Forsk2014
Description
Attributes
GSMULCONVERGENCETHRESHOLD
Version :3.2.1
ForGSMtechnology:
twoiterativesteps.
Access:Read/Write
GSMDLCONVERGENCETHRESHOLD
Version :3.2.1
ForGSMtechnology:
twoiterativesteps.
Access:Read/Write
Name
Description
Attributes
Version :3.2.1
ForUMTStechnology:
UMTSULCONVERGENCETHRESHOLD TheULrelativeinterferencedifferencetoreachbetween Type:Single
twoiterativesteps.
Access:Read/Write
UMTSDLCONVERGENCETHRESHOLD
Name
Version :3.2.1
ForUMTStechnology:
twoiterativesteps.
Access:Read/Write
Description
Attributes
LTEULCONVERGENCETHRESHOLD
Version :3.2.1
ForLTEtechnology:
twoiterativesteps.
Access:Read/Write
LTEDLCONVERGENCETHRESHOLD
Version :3.2.1
ForLTEtechnology:
twoiterativesteps.
Access:Read/Write
11.9 PropagationModelProperties
TheTypereturnedbyget_ObjectKindforthePropagationModelsfolder:{4A2D160B7D114D0792DFA3CF6B68D402}
get_ObjectKindisaccessibleforthePropagationModelsfolderforversion 2.7.0.
TheTypereturnedbyget_ObjectKindfortheStandardPropagationModel:Atoll.StdPropagModel.1
get_ObjectKindisaccessiblefortheStandardPropagationModelforversion 2.7.0.
TheStandardPropagationModelpropertiesarecalledMODELPROPERTIES.
Name
Attributes
MODELPROPERTIES
Thepropertycontainerholdingthepropagationmodelparameters
Version :2.7.0
ThefollowingMODELPROPERTIESareavailablefortheStandardPropagationModel:
Name
146
Description
Attributes
EFFECTIVEANTENNAHEIGHTMETHO
D
Version :2.7.0
Type:Integer
Access:Read/Write
EFFECTIVEANTENNAHEIGHTDISTANC
EMIN
Version :2.7.0
Type:Double
Access:Read/Write
AT321_TAG_E1
Name
Description
Attributes
EFFECTIVEANTENNAHEIGHTDISTANC
EMAX
Version :2.7.0
Type:Single
Access:Read/Write
DIFFRACTIONMETHOD
Version :2.7.0
Type:Integer
Access:Read/Write
CLUTTERLOSSES
CLUTTERCLEARANCES
LossforeachclutterclassdefinedintheAtolldocument.
Whentherearenoclutterclasses,theNullvalueis
returned,otherwisethesizeofthereturnedarrayisthe
numberofclutterclassesdefinedintheAtolldocument.
Version :2.7.0
Type:ArrayofSingle
Access:Read/Write
ClearanceforeachclutterclassdefinedintheAtoll
Version :2.7.0
document.Whentherearenoclutterclasses,theNullvalue
Type:ArrayofSingle
isreturned,otherwisethesizeofthereturnedarrayisthe
Access:Read/Write
numberofclutterclassesdefinedintheAtolldocument.
CLUTTERWEIGHTINGFUNCTION
Version :2.7.0
Type:Integer
Access:Read/Write
CLUTTERMAXIMUMDISTANCE
Version :2.7.0
Type:Double
Access:Read/Write
K1
Version :2.7.0
Type:ArrayofSingle
Access:Read/Write
K2
Version :2.7.0
Type:ArrayofSingle
Access:Read/Write
K3
Version :2.7.0
Type:Double
Access:Read/Write
K4
Version :2.7.0
Type:Double
Access:Read/Write
K5
Version :2.7.0
Type:Double
Access:Read/Write
K6
Version :2.7.0
Type:Double
Access:Read/Write
KCLUTTER
Version :2.7.0
Type:Double
Access:Read/Write
NEARTRANSMITTERMAXIMUMDISTA
NCE
Version :2.7.0
Type:Double
Access:Read/Write
PROFILES
Version :2.7.0
Type:Integer
Access:Read/Write
GRIDCALCULATION
Version :2.7.0
Type:Integer
Access:Read/Write
147
Name
Forsk2014
Description
Attributes
CONSIDERCLUTTERHEIGHTSINDIFFR
ACTION
Version :2.7.0
Type:Integer
Access:Read/Write
HILLYTERRAINCORRECTION
Version :2.7.0
Type:Integer
Access:Read/Write
CLUTTERRECEIVERHEIGHTS
Heightofthereceiverforeachclutterclassdefinedinthe
Version :2.7.0
Atolldocument.Whentherearenoclutterclasses,theNull
Type:ArrayofSingle
valueisreturned,otherwisethesizeofthereturnedarrayis
Access:Read/Write
thenumberofclutterclassesdefinedintheAtolldocument.
LIMITATIONTOFREESPACELOSS
Version :2.7.0
Type:Integer
Access:Read/Write
RECEIVERONTOPOFCLUTTER
Version :2.7.0
Type:Integer
Access:Read/Write
11.10 CWMeasurementProperties
TheTypereturnedbyget_ObjectKindfortheCWMeasurementsfolder:SID_CW_MEASUREMENTS
ThefollowingpropertiesareaccessiblefortheCWMeasurementsfolder:
Name
Description
Attributes
VECTORDATAFILTER
Advancedvectortablefilter,asitappearsinCW
Measurementsfoldersproperties.
Type:String
Access:Read/Write
TheTypereturnedbyget_ObjectKindforaCWMeasurementssubfolder:MeasureTx
ThefollowingpropertiesareaccessibleforaCWMeasurementssubfolder:
Name
Description
Attributes
VECTORDATAFILTER
Measurementssubfolderproperties.
Type:String
Access:Read/Write
TheTypereturnedbyget_ObjectKindforaCWMeasurementsitem:MeasureItem
ThefollowingpropertiesareaccessibleforaCWMeasurementsitem:
Name
Description
Attributes
VECTORDATAFILTER
Measurementsitemproperties.
Type:String
Access:Read/Write
PREDICTIONMODEL
Nameofapropagationmodel.
Type:String
Access:Read/Write
Type:String
Access:Read/Write
HEADER
TRANSMITTERNAME
148
Nameofatransmitter.
Type:String
Access:Read/Write
TRANSMITTERFREQUENCY
Type:Single
Access:Read/Write
RECEIVERHEIGHT
Type:Single
Access:Read/Write
AT321_TAG_E1
Name
Description
Attributes
RECEIVERGAIN
Type:Single
Access:Read/Write
RECEIVERLOSSES
Type:Single
Access:Read/Write
VECTORDATA
Tablecontentofthemeasurementpath.
TECHNOLOGYNAME
Technologyname:"UMTS","LTE",or"GSM"
Version :3.1.1
Type:String
Access:Read/Write
11.11 DriveTestDataProperties
TheTypereturnedbyget_ObjectKindforaDriveTestDataitem:NumMeasureItem
ThefollowingpropertiesareaccessibleforaDriveTestDataitem:
Name
Description
Attributes
HEADER
Type:String
Access:Read/Write
RECEIVERHEIGHT
Type:Single
Access:Read/Write
RECEIVERGAIN
Type:Single
Access:Read/Write
RECEIVERLOSSES
Type:Single
Access:Read/Write
VECTORDATA
Tablecontentofthemeasurementpath.
11.12 CustomChildFolderObjectProperties
TheTypereturnedbyget_ObjectKindforacustomChildFolderobjectistheversiondependentPROGIDofthecustomChild
Folderobject.
get_ObjectKindisaccessibleforthecustomChildFolderobjectsforversion 2.7.0.
ThefollowingpropertiesareaccessibleforacustomChildFolderobject.
Name
Description
Attributes
MODELPROPERTIES
ThepropertycontainerholdingthecustomChildFolderobject
properties.
TheMODELPROPERTIESPropertyContainerobjectwill
containpropertiesexposedbythecustomChildFolderobject
.
Version :2.7.0
Type:PropertyContainer
object
Access:Read/Write
CANRENAME
ReturnstruewhenthecustomChildFolderobjectcanbe
renamed.
Whenfalseisreturned,the"Rename"contextmenuoption
fortheChildFolderobjectisunavailable.
Version :2.7.0
Type:Boolean
Access:Read/Write
CANDELETE
ReturnstruewhenthecustomChildFolderobjectcanbe
deleted.
Whenfalseisreturned,the"Delete"contextmenuoptionfor
theChildFolderobjectisunavailable.
Version :2.7.0
Type:Boolean
Access:Read/Write
TRANSPARENCY
Theglobaltransparencybetween0and100associatedwith
thecustomChildFolderobject.
Version :2.7.0
Type:Integer
Access:Read/Write
149
Forsk2014
Name
Description
Attributes
COMMENT
ThecommentstringassociatedwiththecustomChildFolder
object.
Version :3.2.1
Type:String
Access:Read/Write
11.13 MasterLinkProperties
MasterLinkChildFolderobjectsarelocatedastoplevelitemsineithertheDatatabortheGeotabofthedocumentexplorer
window.They are usedtospecifylinksfromoneChildFolderobjectto anotherChildFolderobject(thetargetChildFolder
object),locatedinanotherDocumentobject(thetargetDocumentobject).
TheTypereturnedbyget_ObjectKindforMasterLinkChildFolderobjectsis:
{16A53FB3-A961-4EEA-8C30-2387DBF1CC24}
ThefollowingpropertiesareaccessibleforMasterLinkChildFolderobjects.
Name
Description
Attributes
TARGET
ThetargetChildFolderobject.
TheNullvalueisreturnedwhenthetargetDocumentobject
isnotopenedinthecurrentsession.
Type:Object,orNull
value.
Access:Read
TARGETDOCUMENTFULLNAME
Thefullpathtothetargetdocument.ATLfile.
Anerrorisreturnedwhenthetargetfilecannotbelocated.
Type:String
Access:Read
11.14 LinkProperties
LinkChildFolderobjectsarechildrenofMasterLinkChildFolderobjects.
TheTypereturnedbyget_ObjectKindforLinkChildFolderobjectsis:
{232BDB73-A68F-41A6-A954-75112D907BBF}
ThefollowingpropertiesareaccessibleforLinkChildFolderobjects.
Name
TARGET
Description
Attributes
ThetargetChildFolderobject.
Type:Object,orNull
TheNullvalueisreturnedwhenthetargetDocumentobject
value.
isnotopenedinthecurrentsession.
Access:Read
11.15 VectorLayerProperties
ThefollowingpropertiesareaccessibleforVectorLayerChildFolderobjects.
Name
VECTORDATA
DISPLAYPROPERTIES
Description
Thevectortableofthevectorlayer.
Thevectorlayerdisplayproperties.
Attributes
Version :3.2.1
Type:TabularData
object
Version :2.7.0
Type:
PropertyContainer
object
11.15.1 DisplayProperties
Displaypropertiesforvectorlayersareaccessedthroughapropertynamed"DISPLAYPROPERTIES."The"DISPLAYPROPERTIES
"propertyisacontainerobjectusedtocontainindividualdisplayproperties.
150
AT321_TAG_E1
Thepropertiesavailableinthe"DISPLAYPROPERTIES"propertycontainerare,forallkindsofvectorlayers:
REPRESENTATIONtabulardataobject
The"REPRESENTATION"tabulardataobjectcontainsattributesofintervalsorvaluesusedtodisplaythevectorlayeronthe
map.Thistabulardataobjectcanbeeditedtochange,remove,oradddisplayintervalsordisplayvalues.
The"REPRESENTATION"tabulardataobjectisavailableasa"DISPLAYPROPERTIES"propertynamed"REPRESENTATION"
DISPLAYPROPERTIES
PropertyName
Attributes
REPRESENTATION
Version :3.2.1
Theschemaofthe"REPRESENTATION"tabulardataobjectis:
TabularDataColumnName
Description
Attributes
LINESTYLE
Thestyleofthelineusedtodisplaytheintervalorthevalue.
Thevaluesare:5=None;0=Solid;128=SolidDoubleLine;
1=Dash;2=DashDot;4=DashDotDot;
Version :3.2.1
Type:Integer
Access:Read/Write
LINEWIDTH
Thewidthofthelineusedtodisplaytheintervalorthe
value,expressedintenthofapoint.Forinstance,tohavea
linewidthof0,5pt,theLINEWIDTHpropertyvaluemustbe
setto5.
Version :3.2.1
Type:Integer
Access:Read/Write
FILLSTYLE
Thegraphicalstyleusedtofilltheinteriorofthesurface
definedbythedisplayintervalorthedisplayvalue.The
valuesare:0=None;1=Full;2=Horizontal;3=Vertical;
4=DownDiagonal;5=UpDiagonal;6=Grid;7=Treillis;
Version :3.2.1
Type:Integer
Access:Read/Write
MAINCOLOR
Themaincolorassignedtothedisplayintervalorthedisplay
value.ThecolorformatisRGB.
page 141.
Version :3.2.1
Type:Integer
Access:Read/Write
SECONDARYCOLOR
Thesecondarycolorassignedtothedisplayintervalorthe
displayvalue.ThecolorformatisRGB.
page 141.
Version :3.2.1
Type:Integer
Access:Read/Write
SYMBOL
Thispropertyisnotusedtodisplayavectorlayerintervalor
avectorlayervalue.
Version :3.2.1
Type:Integer
Access:Read/Write
SYMBOLSIZE
Thispropertyisnotusedtodisplayavectorlayerintervalor
avectorlayervalue.
Version :3.2.1
Type:Integer
Access:Read/Write
VALUE
Thetextassignedtothedisplayvalue.Whenthedisplay
typeofthevectorlayerissettointervals,aNullvalueis
returned.
Version :3.2.1
Type:StringorNull
Access:Read/Write
MINVALUE
Theminimumvalueofthedisplayinterval.Whenthe
displaytypeofthevectorlayerissettodisplayuniqueor
Version :3.2.1
Type:DoubleorNull
Access:Read/Write
MAXVALUE
Themaximumvalueofthedisplayinterval.Whenthe
displaytypeofthevectorlayerissettodisplayuniqueor
Version :3.2.1
Type:DoubleorNull
Access:Read/Write
ConvertingIntegerstoRGBandViceversa
ToconvertIntegertoRGBcolorcomponents:
151
Forsk2014
Dim Red
Dim Green
Dim Blue
Let Red = (color And &HFF)
Let Green = ((color \ 256) And &HFF)
Let Blue = ((color \ 65536) And &HFF)
ToconvertRGBcolourcomponentstoInteger:
Dim color
Let color = (Red + Green * 256 + Blue * 65536)
OtherDISPLAYPROPERTIESproperties
152
DISPLAYPROPERTIES
PropertyName
Description
Attributes
TYPE
Avaluebetween0and2usedtochoosewhichvalueclasses
todisplayonthemapforthecurrentvectorlayer:
0=Unique;1=DiscreteValues;2=ValueIntervals;
Version :3.2.1
Type:Integer
Access:Read/Write
FIELD
Thefieldtitleusedtochoosewhichcoveragetodisplayon
themap.Thefieldtitlemustbecompatiblewiththedisplay
typeproperty.
Version :3.2.1
Type:String
Access:Read/Write
TRANSPARENCY
Avaluebetween0and100usedtoadjustthelevelof
transparencyofthedisplayintervalorthedisplayvalue.
Version :3.2.1
Type:Integer
Access:Read/Write
Chapter12
ChildFolderFeature
Objects
154
Forsk2014
Chapter12:ChildFolderFeatureObjects
AT321_TAG_E1
12 ChildFolderFeatureObjects
FeatureobjectsofferfeaturescloselytiedtosomeAtolldocumentfolders.ThefollowingChildFolderFeatureobjectsareavail
ablethroughtheDispatchpropertyofChildFolderobjectsofAtolldocumentfolders:
"ClutterFeatureObject"onpage 155,
"TrafficFeatureObject"onpage 158,
"UMTSTrafficScenarioProviderObject"onpage 161,
"EnvironmentBasedTrafficMapFeatureObject"onpage 163,
"SimulationFeatureObject"onpage 165,
"SimulationGroupFeatureObject"onpage 168.
12.1 ClutterFeatureObject
TheClutterFeatureobjectgivesaccesstoclutterclassesproperties.ItisavailableforallAtolldocuments.Itisassociatedwith
theClutterClassesfolderofanAtolldocument.
TheClutterFeatureobjectprovidesthefollowingpropertiesandmethods:
Name
Description
get_Source
ReturnstheClutterClassesChildFolderobject.
get_ClassAttributes
ReturnsaTabularDataobjectholdingtheclutterclassattributes.
get_DefaultAttributes
ReturnsaTabularDataobjectholdingtheclutterclassdefault
values.
Attributes
12.1.1 HowtoAccesstheClutterFeatureObject
TheObjectKindpropertyfortheClutterClassesfolderis:
{7CB51DE8-A961-11D2-8688-0060086457D1}
SamplecodetoaccesstheClutterFeatureobject:
Returns the clutter feature object of the doc Atoll document object
Public Function ClutterFeatureObject(doc)
Const OBJECTKIND_CLUTTER = "{7CB51DE8-A961-11D2-8688-0060086457d1}"
Const atoGeo = 1
Dim oClutterClasses
Set oClutterClasses = doc.GetRootFolder(atoGeo).Item(OBJECTKIND_CLUTTER)
Set ClutterFeatureObject = oClutterClasses.Dispatch
End Function
12.1.2 get_Source
ReturnstheClutterClassesChildFolderobject.
HRESULT get_Source(IDispatch **ppSource);

Parameters
[out]ppSource:AddressoftheIDispatchinterfacepointerusedtoreturntheClutterClassesChildFolderobject.
155
Forsk2014
12.1.3 get_ClassAttributes
ReturnsaTabularDataobjectholdingtheclutterclassattributes.
HRESULT get_ClassAttributes(ITabularData **ppTable);

Parameters
[out]ppTable:AddressoftheITabularDatainterfacepointerusedtoreturntheclutterclassattributes.Thecontentofthe
TabularDataobjectreturnedisthesameasthecontentofthe"Description"propertypagefortheClutterClassesfolderofan
Atolldocument,itisdependentonthetypeoftheprojecttemplateusedbytheAtolldocument.
Remarks
Thenumberofrowsinthetabulardataobjectreturneddependsonthestateofthe"Useonlydefaultvalues"checkbox.
Whenthe"Useonlydefaultvalues"checkboxischecked,thenumberofrowsreturnedisalways1,thetabulardataobject
returnedisthesameastheonereturnedbyget_DefaultAttributes.
Version: 3.1.0
Theschemaofthetabulardataobjectreturnedbyget_ClassAttributesdoesnotdependonthestateofthe"Useonlydefault
value"checkbox.Whethertheprojectisconfiguredtouseonlydefaultclutterclassvaluesornot,get_ClassAttributesreturns
valuesusedincalculations,inaconsistentmanner:
Thenumberofrowsorcolumnsarethesameinbothcases.
Columnsdatatypesarethesameinbothcases.
To determine whether the "Use only default values" checkbox is checked or not, one can test the value returned by
get_CanEditonthetabulardataobjectreturnedbyget_ClassAttributes.Whenusingonlydefaultvalues,thetabulardata
objectreturnedisreadonly,andget_CanEditoutputvalueisVARIANT_FALSE.
12.1.4 get_DefaultAttributes
ReturnsaTabularDataobjectholdingtheclutterclassdefaultvalues.
HRESULT get_DefaultAttributes(ITabularData **ppTable);

Parameters
[out]ppTable:AddressoftheITabularDatainterfacepointerusedtoreturntheclutterclassdefaultvalues.Thecontentofthe
TabularDataobjectreturnedisthesameasthecontentofthe"DefaultValues"propertypagefortheClutterClassesfolderof
anAtolldocument,itisdependentonthetypeoftheprojecttemplateusedbytheAtolldocument.
12.1.5 AccessingClutterClassAttributes
SamplemacrotooutputthevariousclutterclassattributestotheAtolleventviewer:
Private Function ClutterFeatureObject(doc)

Const OBJECTKIND_CLUTTER = "{7CB51DE8-A961-11D2-8688-0060086457d1}"
Const atoGeo = 1
Dim oClutterClasses
Set oClutterClasses = doc.GetRootFolder(atoGeo).Item(OBJECTKIND_CLUTTER)
Set ClutterFeatureObject = oClutterClasses.Dispatch
End Function
Private Sub DumpTable(t)
156
AT321_TAG_E1
Dim c
Dim r
Dim values()
For r = 0 To t.RowCount
Redim values(t.ColumnCount)
For c = 0 To t.ColumnCount
values(c) = t.GetValue(r, c)
If IsNull(values(c)) Then
values(c) = "(Null)"
End If
If IsEmpty(values(c)) Then
values(c) = "(Empty)"
End If
If IsArray(values(c)) Then
values(c) = "(Array)"
End If
Next
LogMessage Join(values, ";")
Next
End Sub
Public Sub DumpClutterAttributes
Dim f
Set f = ClutterFeatureObject(ActiveDocument)
Dim classattrs
Dim defaultattrs
Set classattrs = f.ClassAttributes
LogMessage "Clutter Class Attributes..."
DumpTable(classattrs)
LogMessage "End Class Attributes."
Set defaultattrs = f.DefaultAttributes
LogMessage "Clutter Class Default Attributes..."
DumpTable(defaultattrs)
LogMessage "End Clutter Class Default Attributes."
157
Forsk2014
End Sub
12.2 TrafficFeatureObject
TheTrafficFeatureobjectgivesaccesstofeaturesassociatedwiththetrafficfolder,suchastheexportofthecumulatedtraf
fic.ItisavailableforallAtolldocumentsexceptMicrowaveLinksdocuments.ItisassociatedwiththeTrafficfolderofanAtoll
document.
TheTrafficFeatureobjectprovidesthefollowingpropertiesandmethods:
Name
Description
get_Source
ReturnstheTrafficChildFolderobject.
get_ScenarioProvider
CreatesanewTrafficScenarioProviderobjectinstance.
ExportCumulatedTraffic
Exportsthecumulatedtraffic.
HasTrafficForService
Determinesifatrafficmapcontainstrafficinformationforagiven
service.
Attributes
12.2.1 HowtoAccesstheTrafficFeatureObject
TheObjectKindpropertyfortheTrafficfolderis:
{B3B25A07-A994-4E8D-BBD1-51556D6C4245}
SamplecodetoaccesstheTrafficFeatureObject:
' Returns the traffic feature object of the doc Atoll document object
Public Function TrafficFeatureObject(doc)
Const OBJECTKIND_TRAFFIC = "{B3B25A07-A994-4E8D-BBD1-51556D6C4245}"
Const atoGeo = 1
Dim oTraffic
Set oTraffic = doc.GetRootFolder(atoGeo).Item(OBJECTKIND_TRAFFIC)
Set TrafficFeatureObject = oTraffic.Dispatch
End Function
12.2.2 get_Source
ReturnstheTrafficChildFolderobject.

Parameters
[out]ppSource:AddressoftheIDispatchinterfacepointerusedtoreturntheTrafficChildFolderobject.
12.2.3 get_ScenarioProvider
CreatesanewTrafficScenarioProviderobjectinstance.See"UMTSTrafficScenarioProviderObject"onpage 161formore
informationontheUMTSTrafficScenarioProviderobject.
HRESULT get_ScenarioProvider(ITrafficScenarioProvider **ppProvider);
158
AT321_TAG_E1
Parameters
[out]ppProvider:AddressoftheITrafficScenarioProviderinterfacepointerusedtoreturnanewTrafficScenarioProvider
objectinstance.
Remarks
AnerrorisreturnedwhenthismethodiscalledforanAtolldocumentnotbasedontheUMTSHSPAtemplate.
12.2.4 ExportCumulatedTraffic
Exportsthecumulatedtraffic.
typedef enum _AtoRegion

{
atoEntireProjectArea = 0,
atoComputationZone = 1
} _AtoRegion;
typedef _AtoRegion AtoRegion;
typedef enum _AtoDirection
{
atoUplinkDownlink = 0,
atoUplink = 1,
atoDownlink = 2,
} _AtoDirection;
typedef _AtoDirection AtoDirection;
HRESULT ExportCumulatedTraffic(
BSTR bstrFileName,
enum _AtoRegion atoRegion,
BSTR bstrTerminal,
BSTR bstrMobility,
BSTR bstrService,
VARIANT vTrafficMaps,
long lResolution,
enum _AtoDirection atoDirection
);
Parameters
[in]bstrFileName:
ABSTRusedtospecifytheabsolutefilepathusedtoexportthecumulatedtraffic.TheBILfileformatisusedtoexportthe
cumulatedtraffic.
[in]atoRegion:
159
Forsk2014
AnAtoRegionenumerationvalueusedtospecifytheareausedtoexportthecumulatedtraffic:
atoEntireProjectArea:Theentireprojectarea
atoComputationZone:Thecomputationzone
[in]bstrTerminal:
ABSTRusedtospecifytheterminalnameusedtoexportthecumulatedtraffic.
If"(ALL)"isspecified,thenallterminalsareusedtoexportthecumulatedtraffic.
[in]bstrMobility:
ABSTRusedtospecifythemobilitynameusedtoexportthecumulatedtraffic.
If"(ALL)"isspecified,thenallmobilitiesareusedtoexportthecumulatedtraffic.
[in]bstrService:
ABSTRusedtospecifytheservicenameusedtoexportthecumulatedtraffic.
If"(ALLCS)"isspecified,thenallcircuitservicesareusedtoexportthecumulatedtraffic.
If"(ALLPS)"isspecified,thenallpacketservicesareusedtoexportthecumulatedtraffic.
[in]vTrafficMaps:
AVARIANTusedtospecifythetrafficmapsusedtoexportthecumulatedtraffic.ThetypeoftheVARIANTmustbeVT_ARRAY
|VT_VARIANTwithVARIANTsoftypeVT_BSTR.TheVARIANTarraycontainsthenamesofthetrafficmaps.
[in]lResolution:
Alongusedtospecifytheresolutioninmeterusedtoexportthecumulatedtraffic.
[in]atoDirection:
AnAtoDirectionenumerationvalueusedtospecifythekindoftrafficusedtoexportthecumulatedtraffic.
12.2.5
Determinesifatrafficmapcontainstrafficinformationforagivenservice.
HRESULT HasTrafficForService(
BSTR bstrServiceName,
enum _AtoDirection atoDirection,
IChildFolder* pTrafficMap,
VARIANT_BOOL* pHasTraffic
);
Parameters
[in]bstrServiceName:
ABSTRusedtospecifytheaservicename.
[in]atoDirection:
AnAtoDirectionenumerationvalueusedtospecifythekindoftraffictolookfor:
atoUplinkDownlink(=0):Uplinkanddownlinktraffic
atoUplink(=1):Uplinktraffic
atoDownlink(=2):Downlinktraffic
[in]pTrafficMap:
AIChildFolderinterfacepointerusedtospecifythetrafficmapChildFolderobject.Thetrafficmapissearchedfortrafficinfor
mationrelatedtothebstrServiceNameservice.
ThisparametermaybeNULL.Inthiscase,alltrafficmapsinthetrafficmapfolderaresearched.
160
AT321_TAG_E1
[out]pHasTraffic:
ApointertoaVARIANT_BOOLvalueusedtoreturnwhetherthetrafficmapspecifiedbypTrafficMap has some traffic information for the service specified by bstrServiceName.
Remark
WhenHasTrafficForServicereturnsVARIANT_FALSE,thetrafficmapisguaranteednottocontaintrafficinformationforthe
When HasTrafficForService returns VARIANT_TRUE, the traffic map still may not contain traffic information for the given
service.
12.3 UMTSTrafficScenarioProviderObject
ThetrafficscenarioproviderallowsdevelopingexternalUMTSsimulationmodules.RawmobiledataisgeneratedbyAtolland
providedtotheexternalUMTSsimulatorthroughthisobject.
TheTrafficScenarioProviderobjectprovidesthefollowingpropertiesandmethods:
Name
Description
GetMeanSize
Returnstheaveragecountofmobiles.
Create
Createsrawmobiledata.
Attributes
12.3.1 GetMeanSize
Returnstheaveragecountofmobiles.
HRESULT GetMeanSize(
const VARIANT aSelectedMapsNames,
double dScale,
const VARIANT aReserved,
ULONG *pMobilesCount
);
Parameters
[in]aSelectedMapsNames:
AVARIANTvalueusedtospecifythenamesofthetrafficenvironmentmaps.ThetypeoftheVARIANTmustbeVT_ARRAY|
VT_UI1,itcontainsthenamesofthetrafficenvironmentmaps,separatedbytheASCIIcharactercode0.
[in]dScale:
Adoublevalueusedtospecifythescalingfactorusedinthedeterminationofthemobilescount.
[in]aReserved:
AVARIANTvaluereservedforfutureuse.TheVARIANTtypemustbeVT_EMPTY.
[out]pMobilesCount:
AddressoftheULONGintegerusedtoreturntheaveragecountofmobiles.
12.3.2 Create
Createsrawmobiledata.ThemobilesdataisreturnedasaTabularDataobjectcontainingthepositionofthemobilesand
otherinformationrelatedtothestateofmobiles.
161
Forsk2014
HRESULT Create(
const VARIANT aSelectedMapsNames,
double dScale,
enum AtoTrafficScenarioLaw aLaw,
const VARIANT aRreserved,
ITabularData **ppMobiles
);
Parameters
[in]aSelectedMapsNames:
AVARIANTvalueusedtospecifythenamesofthetrafficmaps.ThetypeoftheVARIANTmustbeVT_ARRAY|VT_UI1,it
containsthenamesofthetrafficmaps,separatedbytheASCIIcharactercode0.
[in]dScale:
Adoublevalueusedtospecifythescalingfactorusedinthedeterminationofthemobilescount.
Thescalingfactorisrelativetotheaveragesizeofmobiles,asreturnedbyGetMeanSize.
[in]aLaw:TheAtoTrafficScenarioLawenumerationvalueusedtospecifythelawofprobabilityusedtogetarandomcountof
mobiles.
[in]aReserved:AVARIANTvalueusedtospecifyadditionalparameters.
Atollversion<2.7.0:
TheVARIANTtypemustbeVT_EMPTY.
Atollversion>=2.7.0:
When the VARIANT type is VT_DISPATCH, it is interpreted as a PropertyContainer object, implementing the
IPropertyContainer2interface.
Thepropertycontainerobjectmaycontaintheproperties:
Name:RANDOMSEED
Type:VT_I4
Description:Anintegervalueusedtospecifytherandomseedofthepseudorandomnumbergeneratorusedtodeter
minetheaveragecountofmobiles,andthemobilespositions.
[out]ppMobiles:
AddressoftheITabularDatainterfacepointerusedtoreturnthepositionofthemobilesandotherinformationrelatedtothe
stateofmobiles.Thetabulardataschemais:
162
ColumnName
Value
Type
Description
Xcoordinate
Long
Expressedinthedocumentprojectioncoordinatesystem
Ycoordinate
Long
Expressedinthedocumentprojectioncoordinatesystem
SERVICE
Servicename
String
FromtheUMTSServicestable
TERMINAL
Terminalname
String
FromtheUMTSTerminalstable
MOBILITY
Mobilitytype
String
FromtheUMTSMobilitytable
CLUTTER
Cluttercode
Short
FromtheIClutterinterface
ACTIVITY
Mobileactivity
String
"ActiveDL","UL","UL+DL"
AT321_TAG_E1
12.4 EnvironmentBasedTrafficMapFeatureObject
Userprofileenvironmentbasedtrafficmapfeatureobjectsgiveaccesstouserprofileenvironmentbasedtrafficmapsattrib
utes.TheyareavailableforallAtolldocumentsexceptMicrowaveLinksdocuments.Theyareassociatedwithuserprofile
environmentbasetrafficmapscontainedintheTrafficfolderofanAtolldocument.
TheUserProfileEnvironmentBasedTrafficMapFeatureobjectprovidesthefollowingpropertiesandmethods:
Name
Description
get_Source
ReturntheTrafficMapChildFolderobjectassociatedwiththe
TrafficMapperEnvironmentFeatureobject.
get_ClassAttributes
ReturnsaTabularDataobjectholdingthetrafficmapenvironment
attributes.
get_DefaultAttributes
Notimplemented
Attributes
12.4.1 HowtoAccessEnvironmentBasedTrafficMapFeature
Objects
TheObjectKindpropertyforUserProfileEnvironmentBasedTrafficMapsis:
{E8784A75-AE03-4F4F-B923-6E8BF20725C5}
TheUserProfileEnvironmentBasedTrafficMapFeatureobjectforauserprofileenvironmentbasedtrafficmapisreturned
bytheDispatchpropertyoftheuserprofileenvironmentbasedtrafficmapChildFolderobject.
12.4.2 get_Source
ReturntheUserProfileEnvironmentBaseTrafficMapChildFolderobjectassociatedwiththeUserProfileEnvironmentBased
TrafficMapFeatureObject.

Parameters
[out]ppSource:AddressoftheIDispatchinterfacepointerusedtoreturntheUserProfileEnvironmentBasedTrafficMap
ChildFolderObject.
12.4.3 get_ClassAttributes
ReturnsaTabularDataobjectholdingtheuserprofileenvironmentbasedtrafficmapattributes.
HRESULT get_ClassAttributes(ITabularData **ppTable);

Parameters
[out]ppTable:AddressoftheITabularDatainterfacepointerusedtoreturntheuserprofileenvironmentbasedtrafficmap
attributes.ThecontentoftheTabularDataobjectisthesameastheoneshownonthe"Description"propertypageofuser
profileenvironmentbasedtrafficmapspropertysheet.
12.4.4 get_DefaultAttributes
HRESULT get_DefaultAttributes(ITabularData **ppTable);
Remarks
Thismethodisnotimplemented.Pleasedontusethismethod.
163
Forsk2014
12.4.5 AccessingEnvironmentBasedTrafficMapsAttributes
Private Function TrafficMapPerEnvironmentFeatureObjects(doc)
Const SID_TRAFFICFOLDER = "{B3B25A07-A994-4E8D-BBD1-51556D6C4245}"
Const OKIND_MAP_PER_ENVIRONMENT = "{E8784A75-AE03-4F4F-B923-6E8BF20725C5}"
Const atoGeo = 1
Dim maps()
Dim oTrafficFolder
Set oTrafficFolder = doc.GetRootFolder(atoGeo).Item(SID_TRAFFICFOLDER)
If Err Then
On Error Goto 0
Else
On Error Goto 0
Dim i
Dim n
n = 0
For i = 0 To oTrafficFolder.Count - 1
Dim map
Set map = oTrafficFolder.Item(i)
If map.ObjectKind = OKIND_MAP_PER_ENVIRONMENT Then
Redim Preserve maps(n)
Set maps(n) = map.Dispatch
n = n + 1
End If
Next
End If
TrafficMapPerEnvironmentFeatureObjects = maps
End Function
Dim c
Dim r
Dim values()
164
AT321_TAG_E1
End If
End If
End If
Next
Next
End Sub
Public Sub DumpTrafficMapPerEnvironmentAttributes
Dim maps
maps = TrafficMapPerEnvironmentFeatureObjects(ActiveDocument)
Dim oFeature
For Each oFeature In maps
LogMessage "Traffic Map Per Environment [" & oFeature.Source.Name &
"]..."
Dim attrs
Set attrs = oFeature.ClassAttributes
DumpTable(attrs)
LogMessage "End Traffic Map Per Environment."
Next
End Sub
12.5 SimulationFeatureObject
SimulationFeatureobjectsgiveaccesstosimulationresults.TheyareassociatedwithSimulationChildFolderobjects.
165
Forsk2014
SimulationFeatureobjectsareavailableinAtolldocumentsbasedonthetemplates:
UMTSHSPA
LTE
CDMA20001xRTT1xEVDO
WiMAX802.16e
TDSCDMA
TheSimulationFeatureobjectprovidesthefollowingpropertiesandmethods:
Name
Description
get_Source
ReturnstheassociatedSimulationChildFolderobject.
get_Statistics
ReturnsaTabularDataobjectholdingtheresultsaspresentedin
the"Statistics"propertypageofthesimulationpropertysheet.
get_Cells
the"Cells"propertypageofthesimulationpropertysheet.
get_Sites
the"Sites"propertypageofthesimulationpropertysheet.
get_Mobiles
the"Mobiles"propertypageofthesimulationpropertysheet.
get_Results
ReturnsaTabularDataobjectholdingtherequiredresults,
dependingontheparameterpassedtothismethod.
Attributes
12.5.1 HowtoAccessSimulationFeatureObjects
TheObjectKindpropertyfortheSimulationChildFolderobjectsis:
{095C5D90-96F1-4BA8-85BB-B2F990AC2DD9}
SimulationChildFolderobjectsarechildofSimulationGroupsChildFolderobjects.
SimulationFeatureobjectsareavailablethroughtheDispatchpropertyofSimulationChildFolderobjects:
Dim oSimulation
Dim oSimulationChildFolder
Set oSimulation = oSimulationChildFolder.Dispatch
12.5.2 get_Source
ReturnstheassociatedSimulationChildFolderobject.

Parameters
[out]ppSource:AddressoftheIDispatchinterfacepointerusedtoreturntheassociatedSimulationChildFolderobject.
Remarks
ForaSimulationFeatureobjectreturnedbyaSimulationGroupFeatureobjectmethod,thereisnoassociatedChildFolder
object,andthebehaviourofthismethodisundefined.
12.5.3 get_Statistics
eturnsaTabularDataobjectholdingtheresultsaspresentedinthe"Statistics"propertypageofthesimulationpropertysheet.
166
AT321_TAG_E1
HRESULT get_Statistics(ITabularData **ppTable);

Remarks
12.5.4 get_Cells
ReturnsaTabularDataobjectholdingtheresultsaspresentedinthe"Cells"propertypageofthesimulationpropertysheet.
HRESULT get_Cells(ITabularData **ppResults);

Parameters
[out]ppResults:AddressoftheITabularDatainterfacepointerusedtoreturnthe"Cells"simulationresults.
12.5.5 get_Sites
ReturnsaTabularDataobjectholdingtheresultsaspresentedinthe"Sites"propertypageofthesimulationpropertysheet.
HRESULT get_Sites(ITabularData **ppResults);

Parameters
[out]ppResults:AddressoftheITabularDatainterfacepointerusedtoreturnthe"Sites"simulationresults.
12.5.6 get_Mobiles
ReturnsaTabularDataobjectholdingtheresultsaspresentedinthe"Mobiles"propertypageofthesimulationproperty
sheet.
HRESULT get_Mobiles(ITabularData **ppResults);

Parameters
[out]ppResults:AddressoftheITabularDatainterfacepointerusedtoreturnthe"Mobiles"simulationresults.
Remarks
ThecontentoftheTabularDataobjectreturneddependsonthe"Informationtoretain"settingofthesimulation.Inparticular,
whentheinformationtoretainis"NoInformationAboutMobiles",thenumberofmobilesreturnedintheTabularDataobject
is0.
Allmobilesarereturned,thefocuszoneisnottakenintoaccount.
12.5.7 get_Results
ReturnsaTabularDataobjectholdingtherequiredresults.
HRESULTget_Results(enumAtoSimulationResultsType aType, ITabularData **ppResults);
Parameters
[in]aType:AnAtoSimulationResultsTypeenumerationvalue,usedtospecifythesimulationresultstoreturn.
Enumerationvaluesare:
167
Forsk2014
atoSimulationResultsStatistics
atoSimulationResultsCells
atoSimulationResultsSites
atoSimulationResultsMobiles
atoSimulationResultsGsmSubCells
100
atoSimulationResultsGsmTRXs
101
Returns a TabularData object holding the results as presented in the

"Statistics"propertypageofthesimulationpropertysheet.
"Cells"propertypageofthesimulationpropertysheet.
"Sites"propertypageofthesimulationpropertysheet.
"Mobiles"propertypageofthesimulationpropertysheet.
"SubCells"propertypageofthesimulationpropertysheet.
"TRXs"propertypageoftheGSMsimulationpropertysheet.
[out]ppResults:AddressoftheITabularDatainterfacepointerusedtoreturnthesimulationresults.
12.6 SimulationGroupFeatureObject
SimulationGroupFeatureobjectsgiveaccesstogroupofsimulationsproperties.AnAtolldocumentcancontainzero,one,or
moregroupofsimulations.Inturn,simulationgroupscancontainzeroormoresimulations.Theyarelocatedinthe"Simula
tions"folderoftheAtolldocument.SimulationGroupFeatureobjectsareassociatedwithgroupofsimulationsChildFolder
objectsofanAtolldocument.
SimulationGroupFeatureobjectsareavailableinAtolldocumentsbasedonthetemplates:
UMTSHSPA
LTE
CDMA20001xRTT1xEVDO
WiMAX802.16e
TDSCDMA
TheSimulationGroupFeatureobjectprovidesthefollowingpropertiesandmethods:
Name
Description
get_Source
ReturnstheassociatedSimulationGroupChildFolder
object.
get_Statistics
ReturnsaTabularDataobjectholdingthestatisticsofthe
simulationgroup.
get_MeanSimulation
ReturnsaSimulationFeatureobjectgivingaccesstothe
averagesimulationproperties.
get_StdDevSimulation
ReturnsaSimulationFeatureobjectusedtoaccessthe
standarddeviationsimulationproperties.
12.6.1 HowtoAccessSimulationGroupFeatureObjects
TheObjectKindpropertyforGroupofSimulationsfolderis:
{AF5E2B98-1D54-48FA-89C5-8BFA2936ABF2}
SamplecodetoaccessSimulationGroupFeatureobjects:
Returns True if there is at least one group of simulations in doc,

False otherwise
Params:
168
[in] doc : Atoll document object
[out] array: Array of simulation group feature objects
Attributes
AT321_TAG_E1
Private Function SimulationGroupFeatureObjects(doc, ByRef array)

Const OBJECTKIND_SIMULATIONS = "{CDDF1E1D-1963-4D80-A057-D23A19570984}"
Const
OBJECTKIND_SIMULATIONGROUP
8BFA2936ABF2}"
"{AF5E2B98-1D54-48FA-89C5-
Const atoData = 0
Dim oSimulations
oSimulations is the "Simulations" ChildFolder object
Set oSimulations = doc.GetRootFolder(atoData).Item(OBJECTKIND_SIMULATIONS)
If Err Then
There is no "Simulations" folder
On Error Goto 0
SimulationGroupFeatureObjects = False
Exit Function
End If
On Error Goto 0
If oSimulations.Count = 0 Then
Exit Function
End If
Redim array(oSimulations.Count - 1)
Dim oSimulationGroup
Dim n
n = 0
"Simulation Group" ChildFolder objects are located
in the "Simulations" folder
For Each oSimulationGroup In oSimulations
If oSimulationGroup.ObjectKind = OBJECTKIND_SIMULATIONGROUP Then
Set array(n) = oSimulationGroup.Dispatch
n = n + 1
End If
Next
SimulationGroupFeatureObjects = True
End Function
169
Forsk2014
12.6.2 get_Source
ReturnstheassociatedSimulationGroupChildFolderobject.

Parameters
[out]ppSource:AddressoftheIDispatchinterfacepointerusedtoreturntheassociatedSimulationGroupChildFolderobject.
ReturnsaTabularDataobjectholdingthestatisticsofthesimulationgroup.
HRESULT get_Statistics(ITabularData **ppTable);

Remarks
12.6.4 get_MeanSimulation
ReturnsaSimulationFeatureobjectgivingaccesstotheaveragesimulationproperties.
HRESULT get_MeanSimulation(ISimulation **ppMeanValues);

Parameters
[out]ppMeanValues:AddressoftheISimulationinterfacepointerusedtoreturntheSimulationFeatureobjectcorresponding
totheaveragesimulation.
Remarks
ThereturnedSimulationFeatureobjectisnotassociatedwithaparticularChildFolderobjectintheAtolldocument.
Anerrorisreturnedwhennosimulationinthesimulationgrouphasconverged.Theaveragesimulationisnotavailablewhen
nosimulationinthesimulationgrouphasconverged.
Anerrorisreturnedwhenthesimulationgrouphasnotbeencalculatedyet,forinstancewhenthesimulationgrouphasbeen
createdwiththecheckbox"ExecuteLater"set.
12.6.5 get_StdDevSimulation
ReturnsaSimulationFeatureobjectusedtoaccessthestandarddeviationsimulationproperties.
HRESULT get_StdDevSimulation(ISimulation **ppStdDevValues);

[out]ppStdDevValues:AddressoftheISimulationinterfacepointerusedtoreturntheSimulationFeatureobjectcorrespond
ingtothestandarddeviationsimulation.
Remarks
Anerrorisreturnedwhennosimulationinthesimulationgrouphasconverged.Thestandarddeviationsimulationisnotavail
ablewhennosimulationinthesimulationgrouphasconverged.
AnerrorisreturnedwhentheAtolldocumentisbasedontheLTE,WiMAX802.16etemplates.Thestandarddeviationsimu
lationisnotavailableforLTEandWiMAX.
170
AT321_TAG_E1
12.6.6 AccessingMobiles,Cells,Sites,forSimulationsandSimula
tionGroups
HereisasamplemacrousedtodisplaythevariousavailableresultsforsimulationgroupsandsimulationsintheAtollevent
viewer,fortheactivedocument:
Returns True if there is at least one group of simulation in doc,

False otherwise
' Params:
'
[in] doc : Atoll document object
'
[out] array: Array of simulation group feature objects
Private Function SimulationGroupFeatureObjects(doc, ByRef array)

Const OBJECTKIND_SIMULATIONS = "{CDDF1E1D-1963-4D80-A057-D23A19570984}"
Const
OBJECTKIND_SIMULATIONGROUP
8BFA2936ABF2}"
"{AF5E2B98-1D54-48FA-89C5-
Const atoData = 0
Dim oSimulations
' oSimulations is the "Simulations" ChildFolder object
Set oSimulations = doc.GetRootFolder(atoData).Item(OBJECTKIND_SIMULATIONS)
If Err Then
' There is no "Simulations" folder
On Error Goto 0
Exit Function
End If
On Error Goto 0
If oSimulations.Count = 0 Then
Exit Function
End If
Redim array(oSimulations.Count - 1)
Dim n
n = 0
"Simulation Group" ChildFolder objects are located
171
Forsk2014
in the "Simulations" folder

For Each oSimulationGroup In oSimulations
If oSimulationGroup.ObjectKind = OBJECTKIND_SIMULATIONGROUP Then
Set array(n) = oSimulationGroup.Dispatch
n = n + 1
End If
Next
SimulationGroupFeatureObjects = True
End Function
Returns 'True' if there is at least one simulation in 'oSimulationGroup',
False otherwise
Params:
[in] oSimulationGroup : Group of simulations ChildFolder object
[out] array: Array of simulation feature objects
Private Function SimulationFeatureObjects(oSimulationGroup, ByRef array)

If oSimulationGroup.Count = 0 Then
SimulationFeatureObjects = False
Exit Function
End If
Redim array(oSimulationGroup.Count - 1)
Dim oSimulation
Dim n
n = 0
For Each oSimulation In oSimulationGroup
Const OBJECTKIND_SIMULATION = "{095C5D90-96F1-4BA8-85BB-B2F990AC2DD9}"
If oSimulation.ObjectKind = OBJECTKIND_SIMULATION Then
Set array(n) = oSimulation.Dispatch
n = n + 1
End If
Next
SimulationFeatureObjects = True
End Function
172
AT321_TAG_E1
Dim c
Dim r
Dim values()
End If
End If
End If
Next
Next
End Sub
Private Sub DumpSimulation(oSimulation, name)
LogMessage name
LogMessage "Cells..."
DumpTable(oSimulation.Cells)
LogMessage "End Cells."
LogMessage "Sites..."
DumpTable(oSimulation.Sites)
LogMessage "End Sites."
LogMessage "Mobiles..."
DumpTable(oSimulation.Mobiles)
LogMessage "End Mobiles."
LogMessage "End " & name & "."
End Sub
173
Forsk2014
Public Sub DumpSimulationGroupAttributes

Dim f()
Dim arraySimulations()
If (SimulationGroupFeatureObjects(ActiveDocument, f) = False) Then
LogMessage "No Group of Simulations found in the document."
Exit Sub
End If
Dim oFeature
For Each oFeature In f
LogMessage "Group of Simulations [" & oFeature.Source.Name & "]..."
Dim average
Dim stddev
Set average = oFeature.MeanSimulation
If Err Then
The average simulation is not available when
no simulation has converged in the group.
LogMessage "The average simulation is not available."
On Error Goto 0
Else
On Error Goto 0
DumpSimulation average, "Average Simulation"
Set stddev = oFeature.StdDevSimulation
If Err Then
' The standard deviation simulation is not available
for LTE and WiMAX projects.
On Error Goto 0
Else
On Error Goto 0
DumpSimulation stddev, "Stddev Simulation"
End If
End If
174
AT321_TAG_E1
' Dump all simulation in the group of simulations

Set oSimulationGroup = oFeature.Source
If (SimulationFeatureObjects(oSimulationGroup,
False) Then
arraySimulations)
LogMessage "There are no simulations in this group of simulations."

Else
Dim oSimulation
For Each oSimulation In arraySimulations
DumpSimulation oSimulation, oSimulation.Source.Name
Next
End If
LogMessage "End Group of Simulations."
Next
End Sub
12.7 3GPPMultiRATSimulationGroupFeatureObject
MultiRATSimulationGroupFeatureobjectsareavailableinAtolldocumentsbasedonthetemplates:
3GPPMultiRAT
3GPPMultiRATSimulationGroupFeatureobjectsaresimilartoSimulationGroupFeatureobjectsavailableinsingleRAT
documents,exceptsomemethodsin3GPPMultiRATSimulationGroupFeatureobjectsrequirethenameofthetechnology
tobespecified.MultiRATSimulationGroupFeatureobjectsprovidethefollowingpropertiesandmethods:
Name
Description
get_Source
Returnstheassociated3GPPSimulationGroupChildFolder
object.
get_Statistics
ReturnsaTabularDataobjectholdingthestatisticsofthe
simulationgroupforthespecifiedtechnology.
get_MeanSimulation
ReturnsaSimulationFeatureobjectgivingaccesstothe
averagesimulationpropertiesforthespecifiedtechnology.
get_StdDevSimulation
ReturnsaSimulationFeatureobjectusedtoaccessthe
standarddeviationsimulationpropertiesforthespecified
technology.
Attributes
12.7.1 get_Source
Returnstheassociated3GPPMultiRATSimulationGroupChildFolderobject.

Parameters
[out]ppSource:AddressoftheIDispatchinterfacepointerusedtoreturntheassociated3GGPMultiRATSimulationGroup
ChildFolderobject.
175
Forsk2014
ReturnsaTabularDataobjectholdingthestatisticsofthesimulationgroupforthespecifiedtechnology.
HRESULT get_Statistics(const BSTR bstrTechno, ITabularData **ppTable);

Remarks
12.7.3 get_MeanSimulation
ReturnsaSimulationFeatureobjectgivingaccesstotheaveragesimulationpropertiesforthespecifiedtechnology.
HRESULT get_MeanSimulation(
const BSTR bstrTechno,
ISimulation **ppMeanValues
);
Parameters
[in]bstrTechno:Astringusedtospecifytherequestedtechnology.Availablevaluesare"GSM,UMTS,orLTE.
[out]ppMeanValues:AddressoftheISimulationinterfacepointerusedtoreturntheSimulationFeatureobjectcorresponding
totheaveragesimulation.
Remarks
Anerrorisreturnedwhennosimulationinthesimulationgrouphasconverged.Theaveragesimulationisnotavailablewhen
nosimulationinthesimulationgrouphasconverged.
Anerrorisreturnedwhenthesimulationgrouphasnotbeencalculatedyet,forinstancewhenthe3GPPsimulationgrouphas
beencreatedwiththecheckbox"ExecuteLater"set.
12.7.4 get_StdDevSimulation
ReturnsaSimulationFeatureobjectusedtoaccessthestandarddeviationsimulationpropertiesforthespecifiedtechnology.
HRESULT get_StdDevSimulation(
const BSTR bstrTechno,
ISimulation **ppStdDevValues
);
[in]bstrTechno:Astringusedtospecifytherequestedtechnology.Availablevaluesare"GSM,UMTS,orLTE.
[out]ppStdDevValues:AddressoftheISimulationinterfacepointerusedtoreturntheSimulationFeatureobjectcorrespond
ingtothestandarddeviationsimulation.
Remarks
Anerrorisreturnedwhennosimulationinthesimulationgrouphasconverged.Thestandarddeviationsimulationisnotavail
ablewhennosimulationinthesimulationgrouphasconverged.
AnerrorisreturnedwhentheAtolldocumentisbasedontheLTE,WiMAX802.16etemplates.Thestandarddeviationsimu
lationisnotavailableforLTEandWiMAX.
176
AT321_TAG_E1
12.8 GSMInterferenceMatrixFeatureObject
GSMInterferenceMatrixFeatureobjectsgiveaccesstoGSMinterferencematrices.Adocumentcancontainzero,one,or
moreinterferencematrices.Theyarelocatedinthe"Interferencematrices"folderofthedocument.
GSMInterferenceMatrixFeatureobjectsareavailableindocumentsbasedontheGSMGPRSEDGEtemplate.
GSMInterferenceMatrixFeatureobjectsprovidethefollowingpropertiesandmethods:
Name
Description
Attributes
get_Source
Returnsthe"InterferenceMatrices"ChildFolderobject.
Type:ChildFolder
object
Access:Read
Load
Loadsaninterferencematrix.
CompleteScopeInfo
Completesscopeinformation.
get_Scope
Returnsthescopeoftheinterferencematrix.
Type:TabularData
object
Access:Read
get_Active
Returnstheinterferencematrixactivestate.
Type:Boolean
Access:Read/Write
put_Active
Setstheinterferencematrixactivestate.
Type:Boolean
Access:Read/Write
get_Type
Returnsthetypeoftheinterferencematrix.
Type:Integer
Access:Read/Write
put_Type
Setsthetypeoftheinterferencematrix.
Type:Integer
Access:Read/Write
get_BasedOnTraffic
Type:Boolean
Access:Read/Write
put_BasedOnTraffic
Type:Boolean
Access:Read/Write
get_Resolution
Returnstheresolutionoftheinterferencematrix
calculation.
Type:Integer
Access:Read/Write
put_Resolution
Setstheresolutionoftheinterferencematrixcalculation.
Type:Integer
Access:Read/Write
get_StdDev
Returnstheinterferencematrixstandarddeviation.
Type:Single
Access:Read/Write
put_StdDev
Setstheinterferencematrixstandarddeviation.
Type:Single
Access:Read/Write
get_InfoQuantityIndicator
Returnstheinterferencematrixinformationquantity
indicator.
Type:Integer
Access:Read/Write
put_InfoQuantityIndicator
Setstheinterferencematrixinformationquantity
indicator.
Type:Integer
Access:Read/Write
get_CdfTab
ReturnstheinterferencematrixCDFtabulardata.
Type:TabularData
object
Access:Read
12.8.1 HowtoAccessGSMInterferenceMatrixFeatureObjects
TheObjectKindpropertyforanInterferenceMatrixChildFolderobjectsis:
{5144E1F9-E539-4F8C-BC0C-49A11C6389E8}
InterferenceMatrixChildFolderobjectsarechildrenofthefoldernamed"InterferenceMatrices".
177
Forsk2014
GSM Interference Matrix Feature objects are available through the Dispatch property of Interference Matrix ChildFolder
objects:
Dim oInterferenceMatrix
Dim oInterferenceMatricesChildFolder
Set oInterferenceMatricesChildFolder
= oDocument.GetRootFolder(atoData).Item("Interference Matrices")
Set oInterferenceMatrix = oInterferenceMatricesChildFolder.Dispatch
12.8.2 get_Source
Returnsthe"InterferenceMatrices"ChildFolderobject.

Parameters
[out]ppSource:AddressoftheIDispatchinterfacepointerusedtoreturnthe"InterferenceMatrices"ChildFolderobject.
12.8.3 Load
Loadsaninterferencematrix.
HRESULT Load();
Remarks
Thismethodmustbecalledbeforeanyaccesstoaninterferencematrix.
12.8.4 CompleteScopeInfo
Completesscopeinformation.
HRESULT CompleteScopeInfo();
Remarks
Thismethodmustbecalledaftertransmittersareaddedtothescope.
12.8.5 get_Scope
Returnsthescopeoftheinterferencematrix.
HRESULT get_Scope(ITabularData **ppTable);
Parameters
[out]ppTable:TheaddressoftheITabularDatainterfacepointerusedtoreturnthescopeoftheinterferencematrix.
Remarks
ThescopeofaninterferencematrixisaTabularDataobjectcontainingamappingfromtherowidentifierforatransmitter
tothefollowinginformation:
Thecoveragepercentageasvictim,andasinterferer.Thedefaultvaluesare100.
TheBSICandBCCHwhentheinterferencematrixinformationwascollected.Thedefaultvaluesare1.
178
AT321_TAG_E1
12.8.6 put_Active
Setstheactivestate.
HRESULT put_Active( VARIANT_BOOL isActiveVal);

Parameters
[in]isActiveVal:TheVARIANT_BOOLvalueusedtospecifytheactivestateoftheinterferencematrix.
Remarks
Anactiveinterferencematrixisusedbytheautomaticfrequencyplanningprocesswhentheinterferencematrixscopeinter
sectstheautomaticfrequencyplanningscope.
12.8.7 get_Active
Returnstheactivestate.
HRESULT get_Active(VARIANT_BOOL *pIsActiveVal);
Parameters
[out]pIsActiveVal:AddressoftheVARIANT_BOOLusedtoreturntheactivestateoftheinterferencematrix.
Remarks
Anactiveinterferencematrixisusedbytheautomaticfrequencyplanningprocesswhentheinterferencematrixscopeinter
sectstheautomaticfrequencyplanningscope.
12.8.8 get_Type
Returrnstheinterferencematrixtype.
HRESULT get_Type(IM_TYPE *pImTypeVal);
Parameters
[out]pImTypeVal:Addressoftheenumerationvalueusedtoreturntheinterferencematrixtype.
Remarks:
Availableenumerationvaluesusedtospecifyaninterferencematrixtypeare:
1:PROPAG_IM
Forinterferencematricesbasedonpropagationdata.Theirreliabilitydependsontheaccuracyandcorrectnessofnetwork
andgeogrpahicaldata.
2:OMC_RESELCTION_IM
ForinterferencematricesbasedonreselectionstatisticsfromtheOMC.Theirreliabilityisusuallylowduetothedifference
betweenthelocationswheremobilesareswitchedonandwheretheyareactuallyusedtoaccessthenetwork.
3:OMC_SIMPLE_HO_IM
Theirreliabilityisusuallylowduetothefactthatinterferenceismeasuredonlyamongexistingneighbours,whichmightnot
becorrectlyassigned.Thistypeofinterferencematrixishighlycorrelatedwiththeneighbourrelations.Itcanbeusedto
removeexcessiveneighbourconstraints.However,itcannotbeusedtocompleteanymissingneighbourinformation.Another
reasonforlowreliabilityisthatinterferenceinformationiscollectedfromhandoverregionsonly,insteadoffromtheservice
area.
4:OMC_NEI_EXT_HO_IM
InterferencematricesbasedonRXLEVstatisticsfromtheOMC(neighbours,aswellastemporaryneighbours).
Theycanbeaverygoodsourceofinterferenceinformationiftheyarestatisticallystablebecausetheyarenotsensitiveto
dataerrors.Ontheotherhand,theyhavemanydisadvantages,suchas:
179
Forsk2014
TransmitterswiththesameBSICandBCCHcannotbedifferentiated.
TransmittershavingthesameBCCHwillneverhaveaninterferenceentry.
Informationislostwhenmorethan6interferersexistatanylocation.
IfmanyinterfererssharethesameBCCH,theyincreaseeachothersinterferencelevels.
HCSlayerscancauseproblemsbecausetherearemoreserversatanypoint,macrolayerserversarestronger,oracorrection
marginmightbeintroducedforsomeequipment.
Thistypeofinterferencematrixcanbecreatedusinganextendedneighbourslist.
5:TEST_MOBILE_DATA_IM
Interferencematricesbasedontestmobiledata.
Reliabilitycanbelowbecauseusuallythetestmobiledatasamplingzoneandthetrafficmodelarenotrelated.Secondly,the
measurementsarecarriedoutforexistingneighboursonly.
6:CW_IM
InterferencematricesbasedonCWmeasurements.
Theirreliabilitycanbelowbecausethemeasurementsusuallydonotreflectthetrafficmodel.However,thissourceofinfor
mationcanbeveryreliableforasubsetoftransmittersthatwereproperlyscanned.CarryingoutCWmeasurementsisexpen
sivewhichmeansthatthecollectedinformationisoftenpartialoroutofdate.
7:SCAN_DATA_IM
Interferencematricesbasedonscandatadrivetests.
Theyarehighlyreliableandanexcellentsourceofinformation,butarenotusefulinaradioplanningtoolbecausenoinfor
mationisavailabletomaptransmitterstothereceivedsignalsatanypixel.
8:UPPER_BOUND_ENTRY_COLLECTION
Upperboundinterferencematrix.
Thesourceofthistypeofinterferencematrixisnotdefined.Itcanbebasedonuserexperience.Theinformationcontained
inthisinterferencematrixisusedasanupperlimit,i.e.,ifthisinterferencematrixindicatesacertainlevelofinterference,it
shouldnotbeexceededbecauseotherinterferencematricesshowhigherinterference.Ifanupperboundinterferencematrix
doesnotcontaininformationaboutanentry,itisignored.
9:LOWER_BOUND_ENTRY_COLLECTION
Lowerboundinterferencematrix.
Thesourceofthistypeofinterferencematrixisnotdefined.Itcanbebasedonuserexperience.Theinformationcontained
inthisinterferencematrixisusedasalowerlimit.Thistypeofinterferencematrixcanbeveryusefulbecauseyoucanedit
entriesinthisinterferencematrix,andbecertainthattheinterferencewillbeatleastashighasthevalueyouentered.This
approachcanbeusedwhenuserexperienceshowsacertainlevelofinterferencewhichtheradionetworkplanningtoolis
unabletocalculate.
12.8.9 put_Type
Setstheinterferencematrixtype.
HRESULT put_Type(IM_TYPE imTypeVal);
Parameters
[in]imTypeVal:Theenumerationvalueusedtospecifytheinterferencematrixtype.
12.8.10 get_BasedOnTraffic
Returnsbasedontraffic.
HRESULT get_BasedOnTraffic(VARIANT_BOOL *pbBasedOntraf) ;
Parameters
[out]pbBasedOntraf:TheaddressoftheVARIANT_BOOLvalueusedtoreturnbasedontraffic.
180
AT321_TAG_E1
Remark
ThismethodonlymakessenseforinterferencematricesoftypePROPAG_IM.Inthatcase,thereturnvalueindicateswhether
theinterferencematrixtakesintoaccountnonuniformtrafficdistributionswithineachcell.
12.8.11 put_BasedOnTraffic
Setsbasedontraffic.
HRESULT put_BasedOnTraffic(VARIANT_BOOL bBasedOntraf) ;
Parameters
[in]bBasedOntraf:TheVARIANT_BOOLvalueusedtospecifybasedontraffic.
12.8.12 get_Resolution
Returnstheresolutionoftheinterferencematrixcalculation.
HRESULT get_Resolution(long *piResolutionParamVal);
Parameters
[out]piResolutionParamVal:Theaddressofthelongintegerusedtoreturntheresolutionoftheinterferencematrixcalcula
tion.
Remarks
ForinterferencematricesoftypePROPAG_IM,thereturnvalueistheresolutionoftheinterferencematrixcalculation.
ForinterferencematricesoftypeTEST_MOBILE_DATA_IM,CW_IM,orSCAN_DATA_IM,thereturnvalueisthenumberof
measurementspercalculationpointintheinterferencematrix.
12.8.13 put_Resolution
Setstheresolutionoftheinterferencematrixcalculation.
HRESULT put_Resolution(long iResolutionParamVal) ;
Parameters
[in]:iResolutionParamVal:Thelongintegerusedtospecifytheresolutionoftheinterferencematrixcalculation.
12.8.14 get_StdDev
Returnstheinterferencematrixstandarddeviation.
HRESULT get_StdDev(float *pfStdDevParamVal);
Parameters
[out]pfStdDevParamVal:Addressofthesingleprecisionfloatingpointvalueusedtoreturntheinterferencematrixstandard
deviation.
Remarks
ForinterferencematricesoftypePROPAG_IM,thereturnvalueisthestandarddeviationofthepropagationmodelusedin
theinterferencematrixcalculation.
ForinterferencematricesoftypeTEST_MOBILE_DATA_IM,CW_IM,orSCAN_DATA_IM,thereturnvalueisthestandarddevi
ationofthemeasurementequipment.
181
Forsk2014
12.8.15 put_StdDev
Setstheinterferencematrixstandarddeviation.
HRESULT put_StdDev(float fStdDevParamVal);
Parameters
[in]fStdDevParamVal:Thesingleprecisionfloatingpointvalueusedtospecifytheinterferencematrixstandarddeviation.
12.8.16 get_InfoQuantityIndicator
Returnstheinformationquantityindicator.
HRESULT get_InfoQuantityIndicator(long *piInfoQuantIndic);
Parameters
[out]pilInfoQuantIndic:Addressofthelongintegerusedtoreturntheinformationquantityindicator.
Remarks
ForinterferencematricesoftypePROPAG_IM,thereturnvalueisaninformationabouttheinterferencematrixcalculation
parameters.
ForinterferencematricesoftypeTEST_MOBILE_DATA_IM,CW_IM,orSCAN_DATA_IM,thereturnvalueisthenumberof
calculationpointspervictim.
ForinterferencematricesoftypeOMC_RESELCTION_IM,OMC_SIMPLE_HO_IM,orOMC_NEI_EXT_HO_IM,thereturnvalue
isthenumberofdayssincetheOMCstatisticswerecollected.
12.8.17 put_InfoQuantityIndicator
Setstheinformationquantityindicator.
HRESULT put_InfoQuantityIndicator(long iInfoQuantIndic) ;
Parameters
[in]ilInfoQuantIndic:Thelongintegerusedtospecifytheinformationquantityindicator.
12.8.18 get_CdfTab
ReturnstheinterferencematrixCDFtabulardata.
HRESULT get_CdfTab(ITabularData **ppTable) ;
Parameters
[out]ppTable:AddressoftheITabularDatainterfacepointerusedtoreturntheinteferencematrixtabulardata.
Remarks
ThestructureoftheTabularDataobjectreturnedis:
Column1:Rowidentifierofthevictimtransmitter
Column2:Rowidentifieroftheinterferertransmitter
Column3:Amaximumlossvalue
Column4:
AsafearrayoftypeVT_ARRAY|VT_R4,VT_ARRAY|VT_R8,orVT_VARIANThaving1dimensionandcontainingtheC/Ivalues
oftheCDF.
182
AT321_TAG_E1
Column5:
AsafearrayoftypeVT_ARRAY|VT_R4,orVT_ARRAY|VT_R8,orVT_VARIANThaving1dimensionandcontainingtheproba
bilityvaluesoftheCDF.
Performanceconsiderations:
Whendeletingelements,trytoalwaysdeletethelastelementfirst.
Wheneditinganexistingelement,donotchangecolumns1,2,or3.
183
184
Forsk2014
Chapter13
DocumentCommands
186
Forsk2014
Chapter13:DocumentCommands
AT321_TAG_E1
13 DocumentCommands
TheAtollAPIenablesexecutingcommandsonAtolldocuments.
Commandsareinvokedbytheirnames,whichmustbeknowninadvance.
ThefollowingcommandsareavailableforallAtolldocuments:
Name
Description
Attributes
IMPORTXML
ThiscommandperformsthesametaskastheAtoll"File >Data
Exchange >XMLFileImport..."mainmenucommand.
Version: 2.7.1
EXPORTXML
ThiscommandperformsthesametaskastheAtoll"File >Data
Exchange >XMLFileExport..."mainmenucommand.
Version: 2.7.0
APPENDTABLECOLUMN
Thiscommandaddsanewcolumntoadatabasetable.This
commandisonlyavailableforAtolldocumentsthatarenot
connectedtodatabases.
Version: 2.8.0
Thefollowingcommandsareavailableforradionetworktechnologydocuments:
Name
Description
Attributes
CALCULATEPOINTS
ThiscommandreturnssignallevelsindBmforagivensetofpoints
andasetoftransmitters.
Version: 2.6.0
IMPORTTESTMOBILEDATA
ThiscommandimportsasetofdrivetestdatafilesintoanAtoll
document.
Version: 2.6.1
RUNNEIGHBOURALLOCATI
ON
PerformsneighbourallocationonaGSMnetwork.
Version: 2.6.1
RUNINTERTECHNOLOGYNE
IGHBOURALLOCATION
PerformsintertechnologyneighbourallocationonaGSMorUMTS
network.
Version: 2.6.1
RUNINTRACARRIERNEIGHB
OURALLOCATION
PerformsintracarrierneighbourallocationonaUMTSnetwork.
Version: 2.6.1
RUNINTERCARRIERNEIGHB
OURALLOCATION
PerformsintercarrierneighbourallocationonaUMTSnetwork.
Version: 2.6.1
CLONESTUDY
Thiscommandclonesacoverageprediction.
Version: 2.7.0
DUPLICATESTUDY
Thiscommandduplicatesacoverageprediction.
Version: 2.7.0
COMPARESTUDY
Thiscommandcomparestwocoveragepredictions.
Version: 2.7.0
CALCULATEEQUIPMENTLO
SSES
Thiscommandcalculatesequipmentlossesandnoisefigureforall
transmittersinthedocumenttransmittersfolder.
Version: 2.7.0
CALCULATEREPEATERS
Thiscommandcalculatespropagationlosses,azimuth,mechanical
tilt,orgainsforallrepeatersinthedocumenttransmittersfolder.
Version: 2.7.0
CALCULATEREMOTEANTEN
NAS
Thiscommandcalculatespropagationlosses,azimuth,mechanical
tilt,orgainsforallremoteantennasinthedocumenttransmitters
folder.
Version: 2.7.0
EXPORTACTIVESETANALYSI
S
Thiscommandexportstheactivesetanalysistotextfiles.
Version: 2.7.0
CALCULATEPOINTSECI0
ThiscommandreturnsEc/I0valuesindBforagivensetofpointsand
asetoftransmitters.
Version: 2.7.0
RUNALLCARRIERSALLOCATI
ON
PerformsallcarriersallocationonaTDSCDMAnetwork.
Version: 2.8.1
RUNMASTERCARRIERALLO
CATION
PerformsmastercarrierallocationonaTDSCDMAnetwork.
Version: 2.8.1
187
Forsk2014
Name
Description
Attributes
MWRun
Thiscommandrunsanalysisforagivensetoflinks.
Version: 2.6.1
EXPORTMAPWINDOW
Exportsaregionofthemapwindowasanimage
Version: 3.1.0
IMPORTPLANETDATAFILE
Importsaplanetdatafile
Version: 3.1.0
EXPORTMWLINKANALYSISP
ROFILEPICTURE
ExportsamicrowavelinkanalysisprofilepicturetoaWindows
bitmapfile.
Version: 3.1.0
InputParameters
Commands may have input parameters. The types and names of input parameters are unique and are specific to each
command.PropertyContainerobjectsareusedtoholdinputparameters.
Results
Commandsmayreturnresults.Resultsarespecifictoeachcommand.TheresultsofacommandarereturnedusingaProper
tyContainerobject.Eachresulthasauniquenameandanassociatedtype.
13.1 HowtoInvokeaDocumentCommand
Thestepstoinvokeacommandarethesameforallcommands.
SamplescriptinvokinganAtolldocumentcommand:
Public Function ExecuteCommand(oDocument, strCommand, oParameters)

Set ExecuteCommand = oDocument.InvokeCommand(strCommand, oParameters)
End Function
oDocumentisanAtollDocumentObject.Itcanbetheactivedocument,oranydocumentintheDocumentscollection.
strCommandisastringholdingtheAtollcommandname.
oParametersisanAtollPropertyContainerobjectusedtoholdtheparametersspecifictostrCommandName.ItcanbeaProp
ertyContainer object holding the default parameters obtained with the GetCommandDefaults method available on the
IDocument4interface.
TheExecuteCommandfunctionreturnsthecommandresultsasaPropertyContainerobject.
13.2 IMPORTXML
ThiscommandperformsthesametaskastheAtoll"File >DataExchange >XMLFileImport..."mainmenucommand.
Version
2.7.1
InputParameters
Name
Description
Attributes
PATH
ThePATHinputparameterisusedtospecifythesourcefolder
containingXMLfilestoimport.
Version: 2.7.1
Type:String
DefaultParameters
None.GetCommandDefaultsonIDocument4interfaceforthecommandIMPORTXMLreturnsanemptyPropertyContainer
object.
Results
None.ThedataintheAtolldocumentareupdatedwiththecontentofXMLfiles.
188
AT321_TAG_E1
13.3 EXPORTXML
ThiscommandperformsthesametaskastheAtoll"File >DataExchange >XMLFileExport..."mainmenucommand.
Version
2.7.1
InputParameters
Name
Description
Attributes
PATH
ThePATHinputparameterisusedtospecifythedestinationfolder
whereXMLfileswillbeexported.
Version: 2.7.1
Type:String
DefaultParameters
None.GetCommandDefaultsforthecommandEXPORTXMLreturnsanemptyPropertyContainerobject.
Results
None.ThedataintheAtolldocumentareexportedtoasetofXMLfiles.
13.4 APPENDTABLECOLUMN
This command addsa newcolumnto a databasetable. This command isonlyavailableforAtoll documentsthatarenot
connectedtodatabases.
Version
2.8.0
InputParameters
Name
Description
Attributes
TABLE
TheTABLEinputparameterisusedtospecifyatablename.Thenew
columnwillbeaddedtothetablenamedTABLE.
Version: 2.8.0
Type:String
NAME
TheNAMEinputparameterisusedtospecifythedatabasenameof
thenewcolumntoaddtotheTABLEtable.Thevalueiscase
insensitiveandmustnotincludespacesanddotcharacters.
Version: 2.8.0
Type:String
LEGEND
TheLEGENDinputparameterisusedtospecifythedisplaynameof
thenewcolumntoaddtotheTABLEtable.Thevalueiscasesensitive
andspacescharactersareallowed.
Version: 2.8.0
Type:String
TYPE
TheTYPEinputparameterisusedtospecifythedatatypeofthenew
columntoaddtothetable.Validvaluesare:0=Text;1=Shortinteger;
2=Longinteger;3=Single;4=Double;5=True/False;6=Date/Time;
7=Currency;
Version: 2.8.0
Type:Integer
SIZE
TheSIZEinputparameterisusedtospecifythesize,inbytes,fora
columnoftype0(Text).TheSIZEinputparameterisspecifictothe
textdatatype.
Version: 2.8.0
Type:Integer
DEFAULT
TheDEFAULTinputparameterisusedtospecifythedefaultvalueof
thenewcolumn.Thedefaultvalueisthecolumnvaluefornewrows,
whenthecolumnvalueisnotsetexplicitly.WhentheDEFAULTinput
parameterisnotspecified,thedefaultvalueforthenewcolumnis
Null(VT_NULL).ThetypeoftheDEFAULTinputparametervalue
mustmatchthedatatypeofthenewcolumn,asspecifiedbythe
TYPEinputparameter.
Version: 2.8.0
Type:Null,String,
Integer,Boolean,
Single,Double,
Currency,orDate
GROUP
TheGROUPinputparameterisusedtospecifythenameofthegroup
thenewcolumnbelongsto.
Version: 2.8.0
Type:String
189
Forsk2014
Name
Description
Attributes
CHOICELIST
TheCHOICELISTinputparameterisusedtospecifythelistofpossible
valuesforanewcolumnoftype0(Text).TheCHOICELISTinput
parameterisspecifictotextcolumns.Pleasenotethattheactual
columnvalueisnotrestrictedtothevaluesdefinedinthechoicelist.
TheCHOICELISTparametermaybeusedbyAtolltodisplaypreferred
valuestotheuser,forinstanceinacomboboxcontrol.
Version: 2.8.0
Type:ArrayofStrings
DefaultParameters
TheTABLE,NAME,LEGEND,andTYPEinputparametershavenodefaultvalues,theymustbespecified.Defaultvaluesfor
otherinputparametersarereturnedbyGetCommandDefaultsforthecommandAPPENDTABLECOLUMN:
InputParameterName
DefaultValue
LEGEND
Empty.
SIZE
10bytes.
DEFAULT
Null
GROUP
Empty.
CHOICELIST
Empty.
Results
None.Uponsuccessfulcompletionthenewcolumnisaddedtothetable.
13.5 CALCULATEPOINTS
ThiscommandreturnssignallevelsindBmforagivensetofpointsandasetoftransmitters.
Pathlossmatrices,whethertheyarevalidornot,arenotused.ThereforetheCalculatePointscommandisnotdependenton
thepathlossmatricesresolution.Signallevelsarecalculatedusingthepropagationmodelofeachtransmitter.
Version
2.6.0
InputParameters
Name
Description
Attributes
POINTS
ThePOINTSinputparameterisusedtodefineasetofpoints.
Version: 2.6.1
Type:ArrayofIntegers
TRANSMITTERS
TheTRANSMITTERSinputparameterisusedtodefineasetof
transmitters.
Version: 2.6.1
Type:ArrayofStrings
TheTECHNOLOGYinputparameterisusedtospecifythetechnology
oftransmittersspecifiedbytheTRANSMITTERSinputparameter.
Availablevaluesare:
"GSM"
"UMTS"
"LTE"
"CDMA2000"
Version: 3.2.0
Type:String
TECHNOLOGY
ThisparameterisignoredforsingleRATdocuments.
ThePOINTSarraymusthave2dimensions,0and1.Thesizeofdimension0isthenumberofpoints.Thesizeofdimension1
is2,index0and1fordimension1aretheXandYcoordinates,respectively.Thecoordinatesofpointsareexpressedinthe
projectioncoordinatesystemoftheAtolldocument.
TheTRANSMITTERSarraymusthave1dimension.Thesizeofthearrayisthenumberoftransmitters.Arrayvaluesaretrans
mittersIDs,astheyappearintheTX_IDfieldoftheTransmitterstable
190
AT321_TAG_E1
DefaultParameters
None.GetCommandDefaultsforthecommandCALCULATEPOINTSreturnsanemptyPropertyContainerobject.
Results
Name
Description
Attributes
SIGNALS
TheSIGNALSresultisusedtoreturnsignalslevels.
Version: 2.6.1
Type:TabularData
object
TheSIGNALSTabularDataobjecthasonerecordforeachtransmitterbelongingtotheTRANSMITTERSinputparameter.The
rownumberngivesthesignalreceivedonthepointnumbern.TheSIGNALSTabularDataobjecthasthefollowingstructure:
ColumnName
Description
Attributes
TX_ID
Astringholdingatransmitteridentifier.
Type:String
Pn
Thesignallevelreceivedonpointnumbernfromthetransmitter
identifiedbythefieldTX_ID.
Whenthesignallevelislessthan200dBm,thetypeofthevariant
returnedforthefieldPnisVT_NULL.
Type:SingleorNull
13.6 IMPORTTESTMOBILEDATA
ThiscommandimportsasetofdrivetestdatafilesintoanAtolldocument.
Version
2.6.1
InputParameters
Name
Description
Attributes
NAME
NameoftheAtollExploreritemwherethedrivetestdatais
imported.
Version: 2.6.1
Type:String
RECEIVERHEIGHT
Receiverheight.
Version: 2.6.1
Type:Double
RECEIVERGAIN
Receivergain.
Version: 2.6.1
Type:Double
RECEIVERLOSSES
Receiverlosses.
Version: 2.6.1
Type:Double
MEASUREMENTUNIT
Measurementunit.Validvaluesare:0=dBm;1=dBV;2=dBV/m
Version: 2.6.1
Type:Integer
MEASUREMENTCSCODE
Codeofthecoordinatesystemusedformeasurementpointsinthe
drivetestdatatoimport.
ThecodeforacoordinatesystemisreportedintheAtollproperties
dialogueofthecoordinatesystem.
Version: 2.6.1
Type:Integer
CONFIGURATIONNAME
Atollconfigurationname,asreportedintheAtolldrivetestdata
importdialogue.
Beforeimportingdrivetestdata,adrivetestdataconfigurationhas
tobedefinedinAtoll.CONFIGURATIONNAMEisthenamegivento
thedrivetestdataconfiguration.
Version: 2.6.1
Type:String
FILES
TheFILESinputparameterisusedtodefinethesetoffilestoimport.
Eachfilemustbespecifiedusingitsabsolutepath.
Version: 2.6.1
Type:ArrayofStrings
191
Forsk2014
Name
Description
Attributes
Version: 3.2.0
CONFIGURATIONFILE
TheCONFIGURATIONFILEinputparameterisusedtospecifythefull
pathtotheinitializationfile(.ini)containingthe
CONFIGURATIONNAME.Thisparameterisoptional.Whenitisnot
specifiedtheconfigurationfileusedistheoneusedintheproject.
Type:String
DefaultParameters
None.GetCommandDefaultsforthecommandIMPORTTESTMOBILEDATAreturnsanemptyPropertyContainerobject.
Results
None.
13.7 RUNNEIGHBOURALLOCATION
PerformsneighbourallocationonaGSMnetwork.
Version
2.6.1
InputParameters
Name
Description
Attributes
TRANSMITTERFOLDER
Asubfolderofthetransmittersfolder,orthetransmittersfolder
itself.
Version: 2.6.1
Type:ChildFolder
object
DefaultParameters
None. GetCommandDefaults for the command RUNNEIGHBOURALLOCATION returns an empty PropertyContainer object.
TheneighbourallocationparametersusedtocomputeneighboursaretheonessetintotheAtolldocument.Theneigbour
allocationparameterscanbesetbyimportingauserconfigurationfilecontainingneighbourallocationparameters.Usethe
AtollDocumentobjectSetConfigmethodtoimporttheneighbourallocationparameters.
Results
Name
Description
Attributes
NEIGHBOURS
TheNEIGHBOURSresultisusedtoreturnneighbourrelations.
Version: 2.6.1
Type:TabularData
object
TheNEIGHBOURSTabularDataobjecthasonerecord for eachneighbourrelationbetweentwo transmittersbelongingto

TRANSMITTERFOLDER.
Name
192
Description
Attributes
Transmitter
Type:String
Number
Type:Integer
Maximumnumber
Type:Integer
Neighbour
Type:String
Importance(%)
Type:Single
Cause
Type:String
Coverage(%)
Type:Single
Coverage(km)
Type:Single
AT321_TAG_E1
13.8 RUNINTERTECHNOLOGYNEIGHBOURALLOCATION
Performsintertechnologyneighbourallocation.
Version
2.6.1
InputParameters
Name
Description
Attributes
TRANSMITTERFOLDER
Asubfolderofatransmittersfolder,oratransmittersfolder
itself.
Version: 2.6.1
NeighbourTechnologyName
Astringusedtospecifythetechnologyofallocated
neighbours.
Availablevaluesare:
"GSM",
"UMTS",
"LTE"
Version: 3.1.0
Type:String
DefaultParameters
None.GetCommandDefaultsforthecommandRUNINTERTECHNOLOGYNEIGHBOURALLOCATIONreturnsanemptyProperty
Containerobject.TheneighbourallocationparametersusedtocalculateneighboursaretheonessetintheAtolldocument.
Theneigbourallocationparameterscanbesetbyimportingauserconfigurationfilecontainingneighbourallocationparam
eters.UsetheAtollDocumentobjectSetConfigmethodtoimporttheneighbourallocationparameters.
Results
Name
Description
Attributes
NEIGHBOURS
Version: 2.6.1
Type:TabularData
object
TheNEIGHBOURSTabularDataobjecthasonerecordforeachneighbourrelationbetweentwotransmittersbelongingto
TRANSMITTERFOLDER.
Name
Description
Attributes
Transmitter
Type:String
Number
Type:Integer
Maximumnumber
Type:Integer
Neighbour
Type:String
Cause
Type:String
Coverage(%)
Type:Single
Coverage(km)
Type:Single
Distance(m)
Type:Single
13.9 RUNINTRACARRIERNEIGHBOURALLOCATION
PerformsintracarrierneighbourallocationonaUMTSnetwork.
Version
2.6.1
193
Forsk2014
InputParameters
Name
Description
Attributes
TRANSMITTERFOLDER
itself.
Version: 2.6.1
Type:ChildFolder
object
DefaultParameters
None.GetCommandDefaultsforthecommandRUNINTRACARRIERNEIGHBOURALLOCATIONreturnsanemptyPropertyCon
tainerobject.TheneighbourallocationparametersusedtocalculateneighboursaretheonessetintheAtolldocument.The
neigbourallocationparameterscanbesetbyimportingauserconfigurationfilecontainingneighbourallocationparameters.
UsetheAtollDocumentobjectSetConfigmethodtoimporttheneighbourallocationparameters.
Results
Name
Description
Attributes
NEIGHBOURS
Version: 2.6.1
Type:TabularData
object
TheNEIGHBOURSTabularDataobjecthasonerecord for eachneighbourrelationbetweentwo transmittersbelongingto

TRANSMITTERFOLDER.
ColumnName
Description
Attributes
Cell
Type:String
Number
Type:Integer
Maximumnumber
Type:Integer
Neighbour
Type:String
Cause
Type:String
Coverage(%)
Type:Single
Coverage(km)
Type:Single
Distance(m)
Type:Single
13.10 RUNINTERCARRIERNEIGHBOURALLOCATION
PerformsintercarrierneighbourallocationonaUMTSnetwork.
Version
2.6.1
InputParameters
Name
Description
Attributes
TRANSMITTERFOLDER
itself.
Version: 2.6.1
Type:ChildFolder
object
DefaultParameters
None.GetCommandDefaultsforthecommandRUNINTERCARRIERNEIGHBOURALLOCATIONreturnsanemptyPropertyCon
tainerobject.TheneighbourallocationparametersusedtocomputeneighboursaretheonessetintotheAtolldocument.
Theneigbourallocationparameterscanbesetbyimportingauserconfigurationfilecontainingneighbourallocationparam
eters.UsetheAtollDocumentobjectSetConfigmethodtoimporttheneighbourallocationparameters.
194
AT321_TAG_E1
Results
Name
Description
Attributes
NEIGHBOURS
Version: 2.6.1
Type:TabularData
object
TheNEIGHBOURSTabularDataobjecthasonerecordforeachneighbourrelationbetweentwotransmittersbelongingto
TRANSMITTERFOLDER.
ColumnName
Description
Attributes
Cell
Cell
Type:String
Number
Type:Integer
Maximumnumber
Type:Integer
Neighbour
Type:String
Cause
Type:String
Coverage(%)
Type:Single
Coverage(km)
Type:Single
Distance(m)
Type:Single
13.11 CLONESTUDY
Thiscommandclonesacoverageprediction.
Version
2.7.0
InputParameters
Name
Description
Attributes
STUDY
TheSTUDYinputparameterholdsthestudytoclone.Thestudyto
cloneisastudyobjectcontainedinthePredictionsfolderoftheAtoll
document.
Version: 2.7.0
Type:ChildFolder
object
NEWSTUDYNAME
TheNEWSTUDYNAMEinputparameterisusedtodefinethenameof
thenewclonedstudy.
Version: 2.7.0
Type:String
DefaultParameters
None.GetCommandDefaultsforthecommandCLONESTUDYreturnsanemptyPropertyContainerobject.
Results
Name
Description
Attributes
NEWSTUDY
TheNEWSTUDYresultisusedtoreturnthenewcloned
studyobject.
Version: 2.7.0
13.12 DUPLICATESTUDY
Thiscommandduplicatesacoverageprediction.
195
Forsk2014
Version
2.7.0
InputParameters
Name
Description
Attributes
STUDY
TheSTUDYinputparameterholdsthestudytoduplicate.Thestudy
toduplicateisastudyobjectcontainedinthePredictionsfolderof
theAtolldocument.
Version: 2.7.0
Type:ChildFolder
object
NEWSTUDYNAME
thenewduplicatedstudy.
Version: 2.7.0
Type:String
NEWSTUDYPARENT
TheNEWSTUDYPARENTinputparameterisusedtospecifyasub
folderofthePredictionsfolder.Thenewstudywillbecreatedinthe
NEWSTUDYPARENTsubfolderofthePredictionsfolder.
Thisparameterisoptional.Ifnotspecifiedthenewstudywillbe
createdattherootofthePredictionsfolder.
Version: 3.2.1
Type:ChildFolder
object
DefaultParameters
None.GetCommandDefaultsforthecommandDUPLICATESTUDYreturnsanemptyPropertyContainerobject.
Results
Name
Description
Attributes
NEWSTUDY
TheNEWSTUDYresultisusedtoreturnthenewduplicatedstudy
object.
Version: 2.7.0
Type:ChildFolder
object
13.13 COMPARESTUDY
Thiscommandcomparestwocoveragepredictions.
Version
2.7.0
InputParameters
Name
Description
Attributes
STUDY1
TheSTUDY1inputparameterholdsthefirststudyinvolvedinthe
comparison.ItisastudyobjectcontainedinthePredictionsfolderof
theAtolldocument.
Version: 2.7.0
Type:ChildFolder
object
STUDY2
TheSTUDY2inputparameterholdsthesecondstudyinvolvedinthe
comparison.ItisastudyobjectcontainedinthePredictionsfolderof
theAtolldocument.
Version: 2.7.0
Type:ChildFolder
object
NEWSTUDYNAME
thecomparisonstudy.
Version: 2.7.0
Type:String
DefaultParameters
None.GetCommandDefaultsonIDocument4interfaceforthecommandCOMPARESTUDYreturnsanemptyPropertyCon
tainerobject.
196
AT321_TAG_E1
Results
Name
Description
Attributes
NEWSTUDY
TheNEWSTUDYresultisusedtoreturnthecomparisonstudyobject.
Version: 2.7.0
Type:ChildFolder
object
13.14 CALCULATEEQUIPMENTLOSSES
Thiscommandcalculatesequipmentlossesandnoisefigureforalltransmittersinadocumenttransmittersfolder.
Version
2.7.0
InputParameters
Name
Description
Attributes
TRANSMITTERFOLDER
Asubfolderofatransmittersfolder,oratransmittersfolderitself.
Version: 3.1.0
Type:ChildFolder
object
None.
DefaultParameters
None.GetCommandDefaultsforthecommandCALCULATEEQUIPMENTLOSSESreturnsanemptyPropertyContainerobject.
Results
None.Thefield"LOSSES"ofthe"TRANSMITTERS"tableisupdatedforalltransmittersinthedocumenttransmittersfolder.
Thiscommandisthesameasthe"Equipment|RecalculateLosses"orthe"Equipment|RecalculateLossesandNoiseFigure"
menuoptionavailableinAtollonthedocumenttransmittersfolder.
13.15 CALCULATEREPEATERS
Thiscommandcalculatespropagationlosses,azimuth,mechanicaltilt,orgainsforallrepeatersinadocumenttransmitters
folder.
Version
2.7.0
InputParameters
Name
Description
Attributes
PROPAGATIONLOSSES
ThePROPAGATIONLOSSESinputparameterisusedtospecify
whetherrepeatersdonorsidepropagationlosseswillbecalculated.
Version: 2.7.0
Type:Boolean
AZIMUTHSANDTILTS
TheAZIMUTHSANDTILTSinputparameterisusedtospecifywhether
repeatersdonorsideazimuthsandtiltswillbecalculated.
Version: 2.7.0
Type:Boolean
GAINS
TheGAINSinputparameterisusedtospecifywhetherrepeaters
gainswillbecalculated.
Version: 2.7.0
Type:Boolean
TRANSMITTERFOLDER
Version: 3.1.0
Type:ChildFolder
object
197
Forsk2014
DefaultParameters
GetCommandDefaultsforthecommandCALCULATEREPEATERSreturnsaPropertyContainerobjectwiththeproperties:
Name
Description
Attributes
PROPAGATIONLOSSES
Boolean
True
AZIMUTHSANDTILTS
Boolean
True
GAINS
Boolean
True
Results
None. The "TRANSMITTERS" table content and the "REPEATERS" table content are updated depending on the requested
calculation.
IfthePROPAGATIONLOSSESinputparameterissettoTrue,thenthecalculationtask"Repeaters|CalculateDonorSideProp
agationLosses"onthedocumenttransmittersfolderisperformed.
If the AZIMUTHSANDTILTS input parameter is set to True, then the calculation task "Repeaters | Calculate Donor Side
AzimuthsandTilts"onthedocumenttransmittersfolderisperformed.
IftheGAINSinputparameterissettoTrue,thenthecalculationtask"Repeaters|CalculateGains"onthedocumenttrans
mittersfolderisperformed.
13.16 CALCULATEREMOTEANTENNAS
Thiscommandcalculatespropagationlosses,azimuth,mechanicaltilt,orgainsforallremoteantennasinadocumenttrans
mittersfolder.
Version
2.7.0
InputParameters
Name
Description
Attributes
PROPAGATIONLOSSES
ThePROPAGATIONLOSSESinputparameterisusedtospecify
whetherremoteantennasdonorsidepropagationlosseswillbe
calculated.
Version: 2.7.0
Type:Boolean
AZIMUTHSANDTILTS
TheAZIMUTHSANDTILTSinputparameterisusedtospecifywhether
remoteantennasdonorsideazimuthsandtiltswillbecalculated.
Version: 2.7.0
Type:Boolean
GAINS
TheGAINSinputparameterisusedtospecifywhetherremote
antennasgainswillbecalculated.
Version: 2.7.0
Type:Boolean
TRANSMITTERFOLDER
Version: 3.1.0
Type:ChildFolder
object
DefaultParameters
GetCommandDefaultsforthecommandCALCULATEREMOTEANTENNASreturnsaPropertyContainerobjectwiththeproper
ties:
198
PropertyName
Type
Value
PROPAGATIONLOSSES
Boolean
True
AZIMUTHSANDTILTS
Boolean
True
GAINS
Boolean
True
AT321_TAG_E1
Results
None. The "TRANSMITTERS" table content and the "REPEATERS" table content are updated depending on the requested
calculation.
IfthePROPAGATIONLOSSESinputparameterissettoTrue,thenthecalculationtask"RemoteAntennas|CalculateDonor
SidePropagationLosses"onthedocumenttransmittersfolderisperformed.
IftheAZIMUTHSANDTILTSinputparameterissettoTrue,thenthecalculationtask"RemoteAntennas|CalculateDonorSide
AzimuthsandTilts"onthedocumenttransmittersfolderisperformed.
IftheGAINSinputparameterissettoTrue,thenthecalculationtask"RemoteAntennas|CalculateGains"onthedocument
transmittersfolderisperformed.
13.17 EXPORTACTIVESETANALYSIS
Thiscommandexportstheactivesetanalysistotextfiles.
Version
2.7.1
InputParameters
Input parameters include general parameters, simulation conditions (SIMULATIONCONDITIONS), shadowing and indoor
coverageconditions(CLUTTERCONDITIONS),andfilteringparameters(RECORDSETCONDITIONS).
Name
Description
Attributes
TheSIMULATIONCONDITIONSPropertyContainerobjectusedhere
hasasubsetoftheSIMULATIONCONDITIONSpropertyofa"Pilot
QualityAnalysis(Ec/Io)"PredictionChildFolderObject.Thereforethe
SIMULATIONCONDITIONSpropertyofa"PilotQualityAnalysis(Ec/
Io)"PredictionChildFolderObjectcanbeuseddirectly,additional
contentinthisPropertyContainerobjectwillbeignored.
Version: 2.7.1
Type:
PropertyContainer
object
Version: 2.7.1
Type:
PropertyContainer
object
CLUTTERCONDITIONS
RECORDSETCONDITIONS
TheRECORDSETCONDITIONSPropertyContainerobjectusedhere
hasasubsetoftheRECORDSETCONDITIONSpropertyofaPrediction
ChildFolderObject.ThereforetheRECORDSETCONDITIONSproperty
ofaPredictionChildFolderObjectcanbeuseddirectly,additional
contentinthisPropertyContainerobjectwillbeignored.
Version: 2.7.1
Type:
PropertyContainer
object
Thegeneralparametersinclude:
Name
Description
Attributes
RESOLUTION
Theresolutioninmeterusedtoexporttheactivesetanalysis.
Version: 2.7.1
Type:Integer
DEPTH
Themaximumnumberofcellsintheactivesetanalysistoexportona
givenpoint.
Version: 2.7.1
Type:Integer
TEXTSEPARATOR
TheASCIIcodeofthecharacterusedasthefielddelimiterinthe
exportedtextfiles.
Version: 2.7.1
Type:Integer
EXPORTFULLPATH
Thefullpathofthefilewheretheactivesetisexported.
Version: 2.7.1
Type:String
SIMULATIONCONDITIONSinclude:
199
Forsk2014
Name
Description
Attributes
TERMINAL
Thenameoftheterminalusedtoexporttheactiveset.
Version: 2.7.1
Type:String
MOBILITY
Thenameofthemobilityusedtoexporttheactiveset.
Version: 2.7.1
Type:String
SERVICE
Thenameoftheserviceusedtoexporttheactiveset.
Version: 2.7.1
Type:String
CARRIER
Thecarriernumberusedtoexporttheactiveset.
Version: 2.7.1
Type:Integer
Name
Description
Attributes
SHADOWING
Whethertocalculateshadowingmarginsrelatedtothedefinedcell
edgecoverageprobabilityandthestandarddeviation(s)perclutter
classornot.WhensettoFalse,noshadowingeffectisconsidered.
Version: 2.7.1
Type:Boolean
INDOORCOVERAGE
Whethertodecreasethereceivedsignallevelatthereceiverofthe
indoorlossdefinedforthecorrespondingclutterclass(clutterclass
properties).
Version: 2.7.1
Type:Boolean
EDGECOVERAGEPROBABILI
TY
Avaluebetween0and100,expressinginpercentagevaluethe
requiredcoverageprobabilityatthecelledge.
Version: 2.7.1
Type:Single
CLUTTERCONDITIONSinclude:
RECORDSETCONDITIONSinclude:
Name
Description
Attributes
FILTER
"Filter"partoftherecordsetconditions,appliedtothetransmitters
table.
Version: 2.7.1
Type:String
DefaultParameters
PropertyName
DefaultValue
ThesameastheSIMULATIONCONDITIONSpropertyofanew"Pilot
QualityAnalysis(Ec/Io)"prediction.
RECORDSETCONDITIONS
ThesameastheRECORDSETCONDITIONSpropertyofanew"Pilot
QualityAnalysis(Ec/Io)"prediction.
RESOLUTION
ThesameastheRESOLUTIONpropertyofanew"PilotQuality
Analysis(Ec/Io)"prediction.
DEPTH
3,iebydefaultthemaximumnumberofcellsoftheactiveset
analysisis3.
TEXTSEPARATOR
59,ietheASCIIcodeofthe;character.Fieldsintheexported
fileswillbeseparatedbythe;character.
Results
None.TheactivesetanalysisisexportedtothefilespecifiedbytheEXPORTFULLPATHinputparameter.
Theareaexportedisthecomputationzoneofthedocument.
Whentheareaonwichtheactivesetanalysishastobeexportedistoolarge,theexportissplittedintoseveraltextfiles.The
numberandthesizeofthesetextfilescannotbecontrolled.Thetextfilesarenumberedstartingfrom0.Forinstance,when
theEXPORTFULLPATHinputparameterissetto"c:\activeset.txt",thefollowingfilesmaybecreated:
c:\activeset0.txt
c:\activeset1.txt
c:\activeset2.txt
200
AT321_TAG_E1
TextFileFormat
Thetextfileinwhichtheactivesetanalysisisexportedhasaheader,followedbythedata.Thedataandtheheaderaresepa
ratedbyablankline.
Header
Theheaderismadeofseveral[key;value]records.Thereisone[key;value]headerrecordperlineintheexportfile:
type;[Technologyofthedocumentusedtoexporttheactiveset]
timestamp;[Dateandtimewhentheactivesethasbeenexported]
resolution;[Resolutioninmeterusedtoexporttheactiveset]
xmin;[MinimumXvalueoftherectangularareaforwhichtheactivesetisexported]
xmax;[MaximumXvalueoftherectangularareaforwhichtheactivesetisexported]
ymin;[MinimumYvalueoftherectangularareaforwhichtheactivesetisexported]
ymax;[MaximumYvalueoftherectangularareaforwhichtheactivesetisexported]
x_num_pixels;[NumberofpixelsoftheexportareaalongtheXaxis]
y_num_pixels;[NumberofpixelsoftheexportareaalongtheYaxis]
Data
Thedataformatismadeofonelineperpixel.Thelineformatforonepixelis:
X;Y;[Carrier;][Transmitter_1;Ec/I0;I0]...[Transmitter_n;Ec/I0;I0]
X:Xcoordinateofthepixel,inmeter
Y:Ycoordinateofthepixel,inmeter
Whentheactivesetisnotempty,itislistedthereafteronthesameline:
Carrier:Carrieroftheactiveset
Thereareatmostntransmittersintheactivesetanalysis,wherenistheDEPTHinputparameter.Transmitternames
arelistedalongwiththeEc/I0andI0value.
Transmitter_n:Nameofthetransmitter
Ec/I0:Ec/I0indB
I0:I0indB
Extractofanactivesetexportfile:
type;UMTS
timestamp;16:15:01 18-July-2008
resolution;50
xmin;23200
xmax;23700
ymin;-14250
ymax;-13650
x_num_pixels;10
y_num_pixels;12
[...]
23200;-14200;
23250;-14200;0;Site3_1;-10.06;-64.88;Site3_3;-12.62;-64.88;Site3_2;-13.56;64.88
201
Forsk2014
23300;-14200;
23350;-14200;
[...]
13.18 CALCULATEPOINTSECI0
ThiscommandreturnsEc/I0valuesindBforagivensetofpointsandasetoftransmitters.
Version
2.7.1
InputParameters
Name
Description
Attributes
POINTS
ThePOINTSinputparameterisusedtodefineasetofpoints.
Version: 2.7.1
Type:ArrayofIntegers
TRANSMITTERS
TheTRANSMITTERSinputparameterisusedtodefineasetof
transmitters.
Version: 2.7.1
Type:ArrayofStrings
STUDY
TheSTUDYinputparameterisusedtodefinetheparametersusedto
calculatetheEc/I0values.Itisastudyobjectcontainedinthe
PredictionsfolderoftheAtolldocument.TheSTUDYinput
parametermustbeastudyoftype"PilotQualityAnalysis(Ec/I0)".
Version: 2.7.1
Type:ChildFolder
object
ThePOINTSarraymusthave2dimensions,0and1.Thesizeofdimension0isthenumberofpoints.Thesizeofdimension1
is2,index0and1fordimension1aretheXandYcoordinates,respectively.Thepointscoordinatesareexpressedinthe
projectioncoordinatesystemoftheAtolldocument.
TheTRANSMITTERSarraymusthave1dimension.Thesizeofthearrayisthenumberoftransmitters.Arrayvaluesaretrans
mittersIDs,astheyappearintheTX_IDfieldoftheTransmitterstable.
DefaultParameters
None.GetCommandDefaultsontheIDocument4interfaceforthecommandCALCULATEPOINTSECI0returnsanemptyProp
ertyContainerobject.
Results
Name
Description
Attributes
VALUES
TheVALUESresultisusedtoreturnEc/I0values.
Version: 2.7.1
Type:TabularData
object
TheVALUEStabulardataobjecthasonerecordforeachtransmitterbelongingtotheTRANSMITTERSinputparameter.The
rownumberngivestheEc/I0valueonthepointnumbern.
ColumnName
Description
Attributes
TX_ID
Astringholdingatransmitteridentifier.
Type:String
Pn
TheEc/I0valueonpointnumbernfromthetransmitteridentifiedby
thefieldTX_ID.
Type:SingleorNull
13.19 RUNALLCARRIERSALLOCATION
PerformsallcarriersallocationonaTDSCDMAnetwork.
202
AT321_TAG_E1
Version
2.8.1
InputParameters
Name
Description
Attributes
TRANSMITTERFOLDER
itself.
Version: 2.8.1
Type:ChildFolder
object
CONFREQUENCYALLOCATI AbooleanvalueusedtospecifywhethertoperformCoNfrequency
ON
allocation(True)orDiffNfrequencyallocation(False).
Version: 2.8.1
Type:Boolean
Abooleanvalueusedtospecifywhethertheallocationresultswillbe
commitedinthedocument(True),ornot(False).
Version: 2.8.1
Type:Boolean
COMMITRESULTS
DefaultParameters
None.GetCommandDefaultsforthecommandRUNALLCARRIERSALLOCATIONreturnsanemptyPropertyContainerobject.
Results
Name
Description
Attributes
CARRIERS
TheCARRIERSresultisusedtoreturncarrierallocationinformation.
Version: 2.8.1
Type:TabularData
object
TheCARRIERSTabularDataobjecthasonerecordforeachtransmitterscarrierallocation.
Name
Description
Attributes
Transmitter
Type:String
Carriers
Type:Integer
MasterCarrier
Type:Integer
13.20 RUNMASTERCARRIERALLOCATION
PerformsmastercarrierallocationonaTDSCDMAnetwork.
Version
2.8.1
InputParameters
Name
Description
Attributes
TRANSMITTERFOLDER
itself.
Version: 2.8.1
Type:ChildFolder
object
DELETEEXISTINGALLOCATI
ON
Abooleanvalueusedtospecifywhethertodeletetheexisting
allocation(True),ornot(False).
Version: 2.8.1
Type:Boolean
COMMITRESULTS
Abooleanvalueusedtospecifywhethertheallocationresultswillbe
commitedinthedocument(True),ornot(False).
Version: 2.8.1
Type:Boolean
203
Forsk2014
DefaultParameters
None. GetCommandDefaults for the command RUNMASTERCARRIERALLOCATION returns an empty PropertyContainer
object.
Results
Name
Description
Attributes
CARRIERS
TheCARRIERSresultisusedtoreturncarrier
allocationinformation.
Version: 2.8.1
TheCARRIERSTabularDataobjecthasonerecordforeachtransmitterscarrierallocation.
ColumnName
Description
Attributes
Transmitter
Type:String
MasterCarrier
Type:Integer
13.21 MWRun
Thiscommandrunsanalysisforagivensetoflinks.Theanalysiscantakeintoaccountinterferers.
Theresultsareprovidedinatabulardataformat.Thefieldsareallthecolumnsdisplayedwhenrunninglinkbudgetsorinter
ferencecalculationonawholelinksfolder.
Version
2.6.1
InputParameters
AlltheparametersthattheusercanprovideasinputthroughtheGUIcanbeprovidedtothiscommand.
204
Name
Description
Attributes
LINKS
Arraycontainingthenamesofthelinkstobecalculated.These
includethelinkswhicharefiltered,active,andinsidethefocuszone.
ThisisthesamelistwhichisusedbyAtollwhenrunningcalculation
ontheLinksfolder.
Version: 2.6.1
Type:ArrayofStrings
INTERFERENCE
Defineswhichpropagationmodelistobeusedforinterference.If
true,recommendationITU452isused.Iffalse,themodeldefinedin
thelinkspropertiesisused.
Version: 2.6.1
Type:Boolean
QUALITYMODEL
Defineswhichqualitymodelistobeusedforanalysis.Validvalues
are:0=ITURecommendation5305;1=ITURecommendation5308;
2=ITURecommendation53010;3=VigantsBarnettmethod;4=KQ
Factormethod;
Version: 2.6.1
Type:Integer
QUALITYOBJECTIVE0
QUALITYOBJECTIVE1
QUALITYOBJECTIVE2
QUALITYOBJECTIVE3
DefinesthepriorityofobjectivesthatAtollmustusedtofindthe
appropriatequalityobjective."QualityObjective0"containsthe
objectiveswhicharethehigherpriorityobjectives.
"QualityObjective3"containsthelowestpriorityobjectives.
Each"QualityObjectiveX"issettoaninterger:0="Asafunctionof
Rate";1=ITUTG821;2=ITUTG826;3=Customized;
Version: 2.6.1
Type:Integer
AvailabilityObjective0
DefinesthepriorityofobjectivesthatAtollmustusedtofindthe
appropriateavailabilityobjective."AvailabilityObjective0"contains
theobjectiveswhicharethehigherpriorityobjectives."Q
AvailabilityObjective3"containsthelowestpriorityobjectives.
Each"AvailabilityObjectiveX"issettoaninterger:0="Asafunctionof
Rate";1=ITUTG821;2=ITUTG826;3=Customized;
Version: 2.6.1
Type:Integer
AT321_TAG_E1
Name
Description
Attributes
RainModel
Defineswhichrainmodelistobeusedforanalysis:0=ITU
Recommendation5305;1=ITURecommendation5308;2=ITU
Recommendation53010;3=Cranemethod;
Version: 2.6.1
Type:Integer
RBER
ResidualBER;usedbyRecommendationITU5308andaboveto
calculateperformanceparameters.Typicallyintherangefrom1010
to1013forthebitratesof2to155Mbit/s,respectively.
Version: 2.6.1
Type:Double
ALFA1
UsedbyRecommendationITU5308andabovetocalculate
performanceparameters.
10to30,numberoferrorsperburstfortheBERintherangefrom
103toBERSES
Version: 2.6.1
Type:Integer
ALFA2
performanceparameters.
1to10,numberoferrorsperburstfortheBERintherangefrom
BERSEStoRBER
Version: 2.6.1
Type:Integer
RefDelayM
predictionofoutageinunprotecteddigitalsystems.
RefDelayMisthereferencedelay(ns)usedtoobtainthesignature
forminimumphase.
Version: 2.6.1
Type:Single
RefDelayNM
predictionofoutageinunprotecteddigitalsystems.
RefDelayNMisthereferencedelay(ns)usedtoobtainthesignature
fornonminimumphase.
Version: 2.6.1
Type:Single
EquipPercent
Thispercentisusedtocalculatetheavailabilityobjectivewhichwill
becomparedtotheoutageduetoequipmentfailures.
Itsvalueissupposedtobebetween0and100.
Version: 2.6.1
Type:Single
RainPercent
Thispercentisusedtocalculatetheavailabilityobjectivewhichwill
becomparedtotheavailabilityoutage.
Itsvalueissupposedtobebetween0and100.
Version: 2.6.1
Type:Single
kMoy
Definesthevalueoftheaverageearthcurvatureusedincalculation.
Version: 2.6.1
Type:Single
kMin
Definesthevalueofthesecondearthcurvatureusedtodisplaythe
ellipsoid.(notusedduringlinkbudgetsnorinterferences
calculation).
Version: 2.6.1
Type:Single
UseAtpc
OptionwhichdefinesifpowermustbereducedornotwiththeATPC
value.
Version: 2.6.1
Type:Boolean
Rec530Simple
Defineswhichmethodmustbeusedtocalculategeoclimatic
parameters(usedforquality).Forthesimpleone,Rec530Simple
mustbesettoTrue.
Version: 2.6.1
Type:Boolean
IgnoreXPD
BooleanwhichtellsifthecalculationoffadingduetoXPDmustbe
takenintoaccountornotinthetotalresult.
Version: 2.6.1
Type:Boolean
IgnorePR
Booleanwhichtellsifthecalculationoffadingduetoenhancements
mustbetakenintoaccountornotinthetotalresult.
Version: 2.6.1
Type:Boolean
OneBER
FlagwhichdefinesifthecalculationmustbedonefortheBER
definedinthelinksproperties(OneBER=0/False)orifthe
calculationmustbedonewiththesameBERsforallthelinks
(OneBER=1/True).
Version: 2.6.1
Type:Boolean
BER1
FirstvalueofBERwhichisusedwhenOneBER=1.
Version: 2.6.1
Type:Double
BER2
SecondvalueofBERwhichisusedwhenOneBER=1.
Notethatthisvalueisnotusedwhenrunningcalculationswiththis
API.UsingtheAPImeansthatcalculationsareonlydisplayedwith
BER1.
Version: 2.6.1
Type:Double
205
206
Forsk2014
Name
Description
Attributes
Rec838
DefineswhichreleaseofrecommendationITU838mustbeused:
0=Rec8381;1=Rec8383;
Version: 2.6.1
Type:Double
CALC_LINK_PORTS
Definestheexpectedresults:
"all"meansthatalltheportsofeachlinkarecalculatedand
displayedinthefinalresult.
"worst"meansthatthefinalresultwilldisplayonlytheworstport.
"selected"meansthatthefinalresultwilldisplaytheresultforthe
portdefinedintheportparameter.
Version: 2.6.1
Type:String
CALC_WITH_NOI
Definestheanalysisisalinkanalysiswithoutinterferers(links
budgets,CALC_WITH_NOI=True)oriftotalinterferencemustbe
takenintoaccount(CALC_WITH_NOI=False)
Besidestheinterestofhavingresultswithorwithoutinterference,
thereaderwillseefurtherinthisdocumentthatcalculationwithout
interferenceprovidesmoredetailedresultsonthelinkconfiguration
(sortofreportofthelinkproperties).
Version: 2.6.1
Type:Boolean
InterferenceDistanceMax
Definesthemaximumdistance(inmeters)tosearchpotential
interferers.
Version: 2.6.1
Type:Double
InterferenceDropMin
Definesthethresholdofdropmargin(indB)underwhichan
interferencelevelisnotaddedtothetotalresult.
Version: 2.6.1
Type:Double
InterferenceCalcGo
DefinesiftheA>>Bwaymustbecalculatedanddisplayedornotin
thefinalresult.Thisoptionconcernsnotonlyinterference
calculationbutalsolinksbudgets.
Version: 2.6.1
Type:Boolean
InterferenceCalcReturn
DefinesiftheB>>Awaymustbecalculatedanddisplayedornotin
thefinalresult.Thisoptionconcernsnotonlyinterference
calculationbutalsolinksbudgets.
Version: 2.6.1
Type:Boolean
InterferenceCalcUplink
Definesiftheuplinkinterferencemustbecalculatedanddisplayed
ornotinthefinalresult.
Version: 2.6.1
Type:Boolean
InterferenceCalcDownlink
Definesifthedownlinkinterferencemustbecalculatedand
displayedornotinthefinalresult.
Version: 2.6.1
Type:Boolean
InterferenceRainSurfCorrel
ation
Valueofthearea(km2)whichisusedtocalculatethecorrelation
betweentwolinks.
Version: 2.6.1
Type:Single
InterferenceAutoWeight
Percentwhichdefinesifinterfererlevelismoreimportantornot
thatinterferingeffects.Thispercentisonlyusedforsemiautomatic
channelallocationandhasnoinfluencewhenrunningcalculation
withthisAPI.
Version: 2.6.1
Type:Integer
InterferenceUseAtpc
Optionwhichdefinesifinterfererpowermustbereducedornot
withtheATPCvalue.
Version: 2.6.1
Type:Boolean
InterferenceWidth
Percentofthechannelswidthwhichcaninterfereorbeinterfered.
Version: 2.6.1
Type:Integer
InterferenceOverShoot
Flagwhichdefineshowpassiverepeatersaretakenintoaccount
whenrunninginterference:0=interferencethroughpassivearenot
takenintoaccount;1=linkswithpassiverepeatersmayalsointerfere
throughtheirownpassive;2=anysignalcaninterferethrougha
repeater.;
Version: 2.6.1
Type:Integer
INTERF_DETAIL
Definesifresultsmustcontaindetailsornot.
"none"meansnodetail
"uplink"meansonlyforuplinkresults
"downlink"meansonlyfordownlinkresults
"both"meansalways.
ThisparameterhasnoeffectwhenrunningcalculationwiththisAPI.
Version: 2.6.1
Type:String
COCHANNELONLY
WhenCOCHANNELONLYissettoTrue,INTERFERENCEWIDTHis
ignored.
Version: 2.8.1
Type:Boolean
AT321_TAG_E1
DefaultParameters
ThedefaultvalueslistedbelowarethedefaultvaluessetinAtoll.Ifthesehavebeenmodified,thenewdefaultvalueswillbe
usedinstead.
Name
DefaultValue
Links
Arrayoflinksname
Interference
False
QualityModel
QualityObjective0
QualityObjective1
QualityObjective2
QualityObjective3
RainMod
RBER
1e12
ALFA1
10
ALFA2
RefDelayM
6.3
RefDelayNM
6.3
EquipPercent
33
RainPercent
33
kMoy
1.33
kMin
NULL
UseAtpc
False
Rec530Simple
True
IgnoreXPD
True
IgnorePR
False
OneBER
BER1
1e3
BER2
1e6
Rec838
CALC_LINK_PORTS
"selected"
CALC_WITH_NOI
True
InterferenceDistanceMax
50000
InterferenceDropMin
0.3
InterferenceCalcGo
True
InterferenceCalcReturn
True
207
Forsk2014
Name
DefaultValue
InterferenceCalcUplink
True
InterferenceCalcDownlink
True
InterferenceRainSurfCorrelation
100
InterferenceAutoWeight
50
InterferenceUseAtpc
False
InterferenceWidth
250
InterferenceOverShoot
INTERF_DETAIL
"Both"
AnalysisResultsWithoutInterferenceCalculation
208
Name
Description
Attributes
LINKNAME
Name(primarykey)ofthelinkwhoseresultsaregiven.
Version: 2.6.1
Type:String
BAND
Name(primarykey)ofthefrequencybandofthelink.
Version: 2.6.1
Type:String
LENGTH
LengthofthelinkcalculatedalongtheGreatCircle(withlatitude,
longitudeandheights).
Thisvalueisdisplayedasreadonlyinthefirstpageoflinks
propertiesbutisnotsavedindatabase.
Version: 2.6.1
Type:Single
WAY
Wayofthelinkwhichisconcernedwiththisresult.
"AB"means"go"(=SiteAtowardSiteB)
"BA"means"return"(=SiteBtowardSiteA)
Version: 2.6.1
Type:String
SUBBAND
Name(primarykey)ofthesubbandofthelinkwiththesuffix"[]"or
"[+]"dependingonthehalfsubbandofthelink.
"[]"meanslowestpart
"[+]"meanshighestpart.
Canbenullifthelinkhasmanualfrequencies.
Version: 2.6.1
Type:String
CHANNEL
Thecalculatedchannelnumber.
Ifthelinkhasmanualfrequency,channelnumberis"1".
Version: 2.6.1
Type:String
POLAR
Stringwhichcontainseither"H"forhorizontalpolarization,either
"V"forverticalpolarization.
Thisvaluecanbedeterminedbythelinksproperties(ifnoportsare
defined)orbytheportsconfigurationifany.
Version: 2.6.1
Type:String
SITE_TX
Name(primarykey)ofthetransmittingsiteofthelinkbeing
calculated(siteAisthewayis"AB",siteBifthewayif"BA").
Version: 2.6.1
Type:String
ANT_TX
Name(primarykey)ofthetransmittingantennaofthelink.
(antennaAisthewayis"AB",antennaBifthewayif"BA").
Version: 2.6.1
Type:String
HEIGHT_TX
Valueoftheheightoftransmittingantenna(inmeters).
Version: 2.6.1
Type:Single
AZIMUTH_TX
Valueoftheazimuthofthetransmittingantenna.(indegrees).This
valueiscalculated,notdisplayedinthelinksproperties,norsavedin
database.Ittakesintoaccounttheantennamisalignmentandthe
directionofthereceiver.(latitude,longitudeandheight).
Version: 2.6.1
Type:Single
TILT_TX
Valueofthetiltofthetransmittingantenna.(indegrees).Thisvalue
iscalculated,notdisplayedinthelinksproperties,norsavedin
directionofthereceiver.(latitude,longitudeandheight).
Version: 2.6.1
Type:Single
AT321_TAG_E1
Name
Description
Attributes
ANTGAIN_TX
Valueofthegainofthetransmittingantenna(indB).Thisvalueis
displayedintheantennaproperties.
Version: 2.6.1
Type:Single
SITE_RX
Name(primarykey)ofthereceivingsiteofthelinkbeingcalculated
(siteBisthewayis"AB",siteAifthewayif"BA").
Version: 2.6.1
Type:String
ANT_RX
Name(primarykey)ofthereceivingantennaofthelink.(antennaB
isthewayis"AB",antennaAifthewayif"BA").
Version: 2.6.1
Type:String
HEIGHT_RX
Valueoftheheightofreceivingantenna(inmeters).
Version: 2.6.1
Type:Single
AZIMUTH_RX
Valueoftheazimuthofthereceivingantenna.(indegrees).This
valueiscalculated,notdisplayedinthelinksproperties,norsavedin
directionofthereceiver.(Latitude,longitudeandheight).
Version: 2.6.1
Type:Single
TILT_RX
Valueofthetiltofthereceivingantenna.(indegrees).Thisvalueis
calculated,notdisplayedinthelinksproperties,norsavedin
directionofthereceiver.(Latitude,longitudeandheight).
Version: 2.6.1
Type:Single
ANTGAIN_RX
Valueofthegainofthereceivingantenna(indB).Thisvalueis
displayedintheantennaproperties.
Version: 2.6.1
Type:Single
EQ_TX
Name(primarykey)ofthetransmittingequipment.(equipmentAis
thewayis"AB",equipmentBifthewayif"BA").
Version: 2.6.1
Type:String
POWER_NOM
Valueofthenominaltransmittedpower,usedifATPCisnottaken
intoaccount.
Version: 2.6.1
Type:Single
POWER_COORD
Valueofthecoordinatetransmittedpower,usedifATPCistaken
intoaccount.
Version: 2.6.1
Type:Single
SYS_CFG
Valuethesystemconfigurationoftheequipment.Stringformatted
as:
"n+m"wherenisanintegerwhichcorrespondstothemain
channelsnumber,and"m"anintergerwhichcorrespondstothestad
bychannelsnumber.Ex:"1+1","2+0"
Version: 2.6.1
Type:String
CAPA
Valuethecapacityoftheequipment.Stringisformattedwiththe
numberoftrunks(dependingonthedigitalhierarchy)andthetrunk
name.
Example:"E1"or"3xE1"or"2xSTM16"dependingforifthe
numberoftrunksismorethanoneornot.
Version: 2.6.1
Type:String
TX_LOSS
Valueofthetotallossesonthetransmitterside:Sharedlosses,
Connectionlosses,Shieldingfactor,portlosses(filter+attenuation),
waveguidelosses.
Version: 2.6.1
Type:Single
FSL
Valueofthefreespacelosscalculatedbetweentransmitterand
receiver.
Version: 2.6.1
Type:Single
LA
Valueoftheattenuationduetodryairabsorption.
Version: 2.6.1
Type:Single
LV
Valueoftheattenuationduetovaporabsorption.
Version: 2.6.1
Type:Single
LD
Valueofthetotaldiffractionthroughtheprofilebetweenthe
transmitterandthereceiver.
Version: 2.6.1
Type:Single
LVEG
Valueofthevegetationlossalongtheprofile.
Version: 2.6.1
Type:Single
LBS
Valueofthetroposphericlossalongtheprofile.
Version: 2.6.1
Type:Single
209
210
Forsk2014
Name
Description
Attributes
LTOT
Valueofthetotalpropagationlossalongtheprofile.(Remember
thatvegetationlossisneveradded).
Version: 2.6.1
Type:Single
EQ_RX
Name(primarykey)ofthereceivingequipment.(equipmentBisthe
wayis"AB",equipmentAifthewayif"BA").
Version: 2.6.1
Type:String
RX_LOSS
Valueofthetotallossesonthereceiverside:Sharedlosses,
Connectionlosses,Shieldingfactor,portlosses(filter+attenuation),
waveguidelosses.
Version: 2.6.1
Type:Single
RX_THRESOLD
Valueofthereceiverthreshold(dBm)definedasthesensitivityof
thereceiverfortheBER1value.
Version: 2.6.1
Type:Single
DECOUPLING
Valueofthetotaldecoupling(dB):lossesduecopolarpatternsof
therequestedpolarizationfortransmitterandreceiverantenna.
(Generallynullifantennasarealigned.)
Version: 2.6.1
Type:Single
XPD
Differencebetweenthecrosspolarvalueofthereceiverantenna
anditscopolarvalue(dB).
Version: 2.6.1
Type:Single
XPI
Differencebetweenthecrosspolarvalueofthetransmitterantenna
anditscopolarvalue(dB).
Version: 2.6.1
Type:Single
RX_LEVEL
Wantedsignallevel(dBm)Takesintoaccountthetransmitted
power,transmitterandreceiverlosses,totalpropagationlossesand
decoupling.
Version: 2.6.1
Type:Single
FADE_MARGIN
Calculatedfademargin(uniformmargin)whichtakesintoaccount
thereceivedsignalleveletthereceiverthreshold.
Version: 2.6.1
Type:String
PNS
Percentofoutageduetouniformfadings.
Version: 2.6.1
Type:Single
PS
Percentofoutageduetoselectivefadings.
Version: 2.6.1
Type:Single
pXPD
Percentofoutageduetocrosspolardiscriminationfadings.
Version: 2.6.1
Type:Single
PT
Percentofoutagewhichdeterminedthequalityofthelink(i.e
duringclearairconditions).
Version: 2.6.1
Type:Single
SESR
ProbabilityofSESRoutage.
Version: 2.6.1
Type:Single
BBER
ProbabilityofBBERoutage.
Version: 2.6.1
Type:Single
ESR
ProbabilityofESRoutage.
Version: 2.6.1
Type:Single
PR
Percentoffadingsduetoenhancements.
Version: 2.6.1
Type:Single
P0
Percentofmultipathoccurrence.
Version: 2.6.1
Type:Single
PP
Percentoffadingsduetorainfortheworstmonth.
Version: 2.6.1
Type:Single
PPA
Percentoffadingsduetorainforanaverageyear.
Version: 2.6.1
Type:Single
PXPD
Percentofrainfadingsduetocrosspolardiscrimination.
Version: 2.6.1
Type:Single
AT321_TAG_E1
Name
Description
Attributes
PPT
Totalpercentofunavailabilityforanaverageyear.
Version: 2.6.1
Type:Single
PFAILURES
Percentoffadingsduetoequipmentfailures.
Version: 2.6.1
Type:Single
RAIN_SESR
ProbabilityofrainSESRoutage.
Version: 2.6.1
Type:Single
RAIN_BBER
ProbabilityofrainBBERoutage.
Version: 2.6.1
Type:Single
RAIN_ESR
ProbabilityofRainESRoutage.
Version: 2.6.1
Type:Single
PASSIVE_GAIN
Totalgain(dB)ofthepassiverepeaters.
Version: 2.6.1
Type:Single
AFF_RAIN
Totalrainattenuation(dB)alongthepath.
Version: 2.6.1
Type:Single
SEC_M_Q
Totaltimeofoutageduringclearairfortheworstmonth.Valueis
formattedisunit(hour,mn,sec).Ex:"6sec","19mn27sec".
Version: 2.6.1
Type:String
OBJ_M_Q
Qualityobjectiveduringclearairfortheworstmonth.Valueis
formattedisunit(hour,mn,sec)
Version: 2.6.1
Type:String
SEC_Y_Q
Totaltimeofoutageduringclearairforanaverageyearmonth.
Valueisformattedisunit(hour,mn,sec)
Version: 2.6.1
Type:String
SEC_M_RAIN
Totaltimeofoutageduringrainconditionfortheworstmonth.
Valueisformattedisunit(hour,mn,sec).Ex:"6sec","19mn27sec"
Version: 2.6.1
Type:String
OBJ_M_RAIN
Qualityobjectiveduringrainconditionfortheworstmonth.Valueis
Version: 2.6.1
Type:String
SEC_Y_RAIN
Totaltimeofoutageduringrainconditionforanaverageyear
month.Valueisformattedisunit(hour,mn,sec)
Version: 2.6.1
Type:String
STATUS_Q
Statusofthelinkforquality.Takesintoaccounteachprobabilityand
correspondingobjectiveforSESR,ESRandBBER,accordingtothe
equipmenthierarchytoo.
Thestatuscanhavefollowingvalues:"OK";"NotRespected";"Not
Calculated";"NotDefined";
Version: 2.6.1
Type:String
STATUS_A
Statusofthelinkforavalability.Takesintoaccounteachprobability
andcorrespondingobjectiveforSESR,ESRandBBER,accordingto
theequipmenthierarchytoo.
Version: 2.6.1
Type:String
CFM
Valueofthecompositefademargin(dB)whichtakesintoaccountall
themargins;CorrespondstotheSESRprobability.
Version: 2.6.1
Type:String
REQ_CFM_Q
Valueofthecompositefademargin(dB)calculatedfromthequality
objectivessetforthelink.
Version: 2.6.1
Type:String
REQ_TFM
Valueoftheuniformmargin(dB)calculatedfromthequality
objectivessetforthelink.Correspondstothenonselectiveoutage
probability.
Version: 2.6.1
Type:String
REQ_CFM_A
Valueofthecompositefademargin(dB)calculatedfromthe
availabilitysetforthelink.
Version: 2.6.1
Type:String
TX_PORT
Transmissionport.
Version: 3.1.0
Type:String
211
Forsk2014
Name
Description
Attributes
RX_PORT
Receptionport.
Version: 3.1.0
Type:String
Name
Description
Attributes
LINKNAME
Name(primarykey)ofthelinkwhoseresultsaregiven.
Version: 2.6.1
Type:String
WAY
Wayofthelinkwhichisconcernedwiththisresult.
"AB"means"go"(=SiteAtowardSiteB)
"BA"means"return"(=SiteBtowardSiteA)
Version: 2.6.1
Type:String
CHANNEL_IRX
Calculatedinterferedchannelnumber.
Ifthelinkhasmanualfrequency,channelnumberis"1".
Version: 2.6.1
Type:String
SUBBAND
Name(primarykey)ofthesubbandofthelinkwiththesuffixe"[]"
or"[+]"dependingonthehalfsubbandofthelink.
"[]"meanslowestpart
"[+]"meanshighestpart.
Canbenullifthelinkhasmanualfrequencies.
Version: 2.6.1
Type:String
Wantedsignallevel(dBm)Takesintoaccountthetransmitted
power,transmitterandreceiverlosses,totalpropagationlossesand
decoupling.SamevalueasRX_LEVELwhenrunninganalysiswithout
interference.
Version: 2.6.1
Type:Single
FLAT_MARGIN
Valueoftheuniformmargin(dB)calculatedfromthewantedsignal
levelandthereceiverthreshold.
Version: 2.6.1
Type:Single
Aggregationofalltheinterferences(dBm)receivedfromotherlinks
andreceiverthermalnoise(FKTB).
Version: 2.6.1
Type:Single
MARGIN_REDUCT
Valueofthedifferencesbetweenmarginwithoutinterferenceand
marginwithinterferences.
Version: 2.6.1
Type:String
C_OVER_I
ValueofC/I(dB)whereCisthewantedsignallevelandIthetotal
interferencelevel.
Version: 2.6.1
Type:Single
IRAIN
Valueofthetotalinterferencelevelduringrainconditionwhichcan
bedifferentfromthe"general"interferenceleveldependingon
correlationbetweenlinks.
Version: 2.6.1
Type:Single
MARGIN_REDUCT_RAIN
Valueofthedifferencesbetweenmarginwithoutraininterference
andmarginwithinterferences.
Version: 2.6.1
Type:String
EFF_MARGIN
Valueofthemargincalculatedfromthereceiverthresholdandthe
receivedlevelwheninterferencearetakenintoaccount.
Version: 2.6.1
Type:Single
BER
ValueoftheBERwithwhichthecurrentanalysisisrun.
Version: 2.6.1
Type:Single
QUALITY
Percentofoutagewhichdeterminedthequalityofthelink.(i.e
duringclearairconditions,andwithinterference).
Version: 2.6.1
Type:Single
AVAIL
Percentoffadingsduetorainfortheworstmonth,when
interferencearetakenintoaccount.
Version: 2.6.1
Type:Single
SEC_M_Q
Totaltimeofoutagewithinterferenceduringclearairfortheworst
month.Valueisformattedisunit(hour,mn,sec).Ex:"6sec","19mn
27sec"
Version: 2.6.1
Type:String
OBJ_M_Q
Qualityobjectiveduringclearairfortheworstmonth.Valueis
Version: 2.6.1
Type:String
AnalysisResultsWithInterferenceCalculation
212
AT321_TAG_E1
Name
Description
Attributes
SEC_Y_Q
Totaltimeofoutagewithinterferenceduringclearairforanaverage
yearmonth.Valueisformattedisunit(hour,mn,sec)
Version: 2.6.1
Type:String
SEC_M_RAIN
Totaltimeofoutagewithinterferenceduringrainconditionforthe
worstmonth.Valueisformattedisunit(hour,mn,sec).Ex:"6sec",
"19mn27sec"
Version: 2.6.1
Type:String
OBJ_M_RAIN
Qualityobjectiveduringrainconditionfortheworstmonth.Valueis
Version: 2.6.1
Type:String
SEC_Y_RAIN
Totaltimeofoutagewithinterferenceduringrainconditionforan
averageyearmonth.Valueisformattedisunit(hour,mn,sec)
Version: 2.6.1
Type:String
STATUS_Q
Statusofthelinkforquality.Takesintoaccounteachprobabilityand
correspondingobjectiveforSESR,ESRandBBER,accordingtothe
equipmenthierarchytoo.
Version: 2.6.1
Type:String
STATUS_A
Statusofthelinkforavalability.Takesintoaccounteachprobability
andcorrespondingobjectiveforSESR,ESRandBBER,accordingto
theequipmenthierarchytoo.
Version: 2.6.1
Type:String
PORT_IRX
InterferencedPort
Version: 3.1.0
Type:Single
Name
Description
Attributes
REGION
Theregiontoexport.Availablevaluesare:
0:TheregiontoexportisspecifiedbySELECTIONXMIN,
SELECTIONXMAX,SELECTIONYMIN,andSELECTIONYMAXinput
parameters.
1:Theregiontoexportisthegeographicexportzone.
2:Theregiontoexportistheprintingzone.
Version: 3.1.0
Type:Integer
SELECTIONXMIN
Thewestcoordinateoftheregiontoexport,expressedinmeterin
theprojectioncoordinatesystemofthedocument.
OnlyusedwhentheREGIONinputparameterissetto0.
Version: 3.1.0
Type:Double
SELECTIONXMAX
Theeastcoordinateoftheregiontoexport,expressedinmeterin
Version: 3.1.0
Type:Double
SELECTIONYMIN
Thesouthcoordinateoftheregiontoexport,expressedinmeterin
Version: 3.1.0
Type:Double
SELECTIONYMAX
Thenorthcoordinateoftheregiontoexport,expressedinmeterin
Version: 3.1.0
Type:Double
13.22 EXPORTMAPWINDOW
Exportsaregionofthemapwindowasanimage.
Version
3.1.0
InputParameters
213
Forsk2014
Name
Description
Attributes
PATH
Theabsolutepathofthefilewherethemapwindowimageis
exported.
Version: 3.1.0
Type:String
FORMAT
Thefileformatusedtoexportthemapwindowimage.Available
valuesare:
BMP:BMPfileformat
PNG:PNGfileformat
ARCVIEWGRIDASCII:ArcViewgridfileformat
TIF:TIFFfileformat
BIL:BILfileformat
JP2:JPEG2000fileformat
Version: 3.1.0
Type:String
PIXELSIZE
Pixelsize(meters),usedtoexportthemapwindowimage.
Whenthevaluespecifiediszero(0),thenSCALEandRESOLUTION
inputparametersareusedtodeterminethepixelsize.
Version: 2.8.1
Type:Integer
SCALE
Scaleofthemapwindowusedtoexportthemapwindowimage.
OnlyusedwhenthePIXELSIZEinputparameterissetto0.
Version: 3.1.0
Type:Integer
RESOLUTION
Resolutionofthemapwindowusedtoexportthemapwindow
image,indotperinch.
Version: 3.1.0
Type:Integer
INCLUDERULERS
Booleanvalueusedtospecifywhethertoincluderulersinthe
exportedimage,ornot.
Version: 3.1.0
Type:Boolean
INCLUDESCALE
Booleanvalueusedtospecifywhethertoincludethescaleinthe
exportedimage,ornot.
Version: 3.2.1
Type:Boolean
DefaultParameters
None.GetCommandDefaultsforthecommandEXPORTMAPWINDOWreturnsanemptyPropertyContainerobject.
Results
None.ThemapwindowimageisexportedtothefilespecifiedbythePATHinputparameter.
13.23 IMPORTPLANETDATAFILE
Importsaplanetdatafile.
Version
3.1.0
InputParameters
214
Name
Description
Attributes
PATH
Theabsolutepathoftheplanetdatafiletoimport.
Version: 3.1.0
Type:String
EMBED
Whethertoembeddata,ornot.
Version: 3.1.0
Type:Boolean
AT321_TAG_E1
Name
Description
Attributes
TYPE
Thetypeoftheplanetdatafiletoimport.
Availablevaluesare:
0:Digitalterrainmodel
1:Digitalheightmodel
2:Clutterclasses
3:Environmentbasedtrafficmap
4:Planetvectors
5:Planettextdata
6:Images
7:Antennas
8:Microwaveantennas
Version: 3.1.0
Type:Integer
DefaultParameters
None.GetCommandDefaultsforthecommandIMPORTPLANETDATAFILEreturnsanemptyPropertyContainerobject.
Results
None.Theplanetdataisimported.
13.24 EXPORTMWLINKANALYSISPROFILEPICTURE
ExportsamicrowavelinkanalysisprofilepicturetoaWindowsbitmapfile.
Version
3.1.0
InputParameters
Name
Description
Attributes
LINKNAME
Nameofthelink.
Version: 3.1.0
Type:String
LINKTYPE
Linktype.Availablevaluesare:
0:A>B
1:B>A
Version: 3.1.0
Type:Integer
PICTUREWIDTH
Picturewidth,inpixels.
Version: 3.1.0
Type:Integer
PICTUREHEIGHT
Pictureheight,inpixels.
Version: 3.1.0
Type:Integer
FILEPATH
TheabsolutepathoftheWindowsbitmapfilewherethelinkanalysis
pictureisexported.
Version: 3.1.0
Type:String
DefaultParameters
None.GetCommandDefaults for the command EXPORTMWLINKANALYSISPROFILEPICTURE returns an empty PropertyCon
tainerobject.
Results
None.ThepictureofthelinkprofileisexportedtothefilespecifiedbyFILEPATHinputparameter.
13.25 GETPOWERMODE
Retreivesthedocumentcurrentpowermode.
ThiscommandisonlyavailableforUMTSorLTEtechnologies.
215
Forsk2014
Version
3.1.0
InputParameters
Name
Description
Attributes
TECHNOLOGY
ForsingleRATdocuments,thisparameterisnotused.FormultiRAT
parameter,astringusedtospecifythetechnology.Availablevalues
are:
"UMTS",
"LTE"
Version: 3.1.0
Type:String
DefaultParameters
None.GetCommandDefaultsforthecommandGETPOWERMODEreturnsanemptyPropertyContainerobject.
Results
Name
Description
Attributes
POWERMODE
Thepowermode.Availablevaluesare:
0:default
1:EIRPiscalculatedusingthemaxpower
Version: 3.1.0
Type:Integer
13.26 SETPOWERMODE
Setsthedocumentpowermode.
ThiscommandisonlyavailableforUMTSorLTEtechnologies.
Version
3.1.0
InputParameters
Name
Description
Attributes
TECHNOLOGY
ForsingleRATdocuments,thisparameterisnotused.FormultiRAT
parameter,astringusedtospecifythetechnology.Availablevalues
are:
"UMTS",
"LTE"
Version: 3.1.0
Type:String
POWERMODE
Thepowermode.Availablevaluesare:
0:default
1:EIRPiscalculatedusingthemaxpower
Version: 3.1.0
Type:Integer
DefaultParameters
None.GetCommandDefaultsforthecommandSETPOWERMODEreturnsanemptyPropertyContainerobject.
Results
None.Thedocumentpowermodeischanged.
13.27 APPENDVECTORDATACOLUMN
Thiscommandaddsanewcolumntoavectordatatable.
Version
3.1.1
216
AT321_TAG_E1
InputParameters
Name
Description
Attributes
CHILDFOLDER
TheCHILDFOLDERinputparameterisusedtospecifyavectordata
table.TheChildFolderobjectspecifiedmustsupportthe
VECTORDATAproperty.
Version: 3.1.1
Type:ChildFolder
object
NAME
TheNAMEinputparameterisusedtospecifythenameofthenew
columntoaddtothevectordatatable.Thevalueiscaseinsensitive
andmustnotincludespacesanddotcharacters.
Version: 3.1.1
Type:String
LEGEND
TheLEGENDinputparameterisusedtospecifythedisplaynameof
thenewcolumntoaddtothevectordatatable.Thevalueiscase
sensitiveandspacecharactersareallowed.
Version: 3.1.1
Type:String
TYPE
TheTYPEinputparameterisusedtospecifythedatatypeofthenew
columntoaddtothevectordatatable.Validvaluesare:
0=Text
1=Shortinteger
2=Longinteger
3=Single
4=Double
5=True/False
6=Date/Time
7=Currency
Version: 3.1.1
Type:Integer
SIZE
TheSIZEinputparameterisusedtospecifythesize,inbytes,fora
columnoftype0(Text).
TheSIZEinputparameterisspecifictothetextdatatype.
Version: 3.1.1
Type:Integer
DEFAULT
TheDEFAULTinputparameterisusedtospecifythedefaultvalueof
thenewcolumn.Thedefaultvalueisthecolumnvaluefornewrows,
whenthecolumnvalueisnotsetexplicitly.WhentheDEFAULTinput
parameterisnotspecified,thedefaultvalueforthenewcolumnis
Null(VT_NULL).ThetypeoftheDEFAULTinputparametervalue
mustmatchthedatatypeofthenewcolumn,asspecifiedbythe
TYPEinputparameter.
Version: 3.1.1
Type:Null,String,
Integer,Boolean,
Single,Double,
Currency,orDate
CHOICELIST
TheCHOICELISTinputparameterisusedtospecifythelistofpossible
valuesforanewcolumnoftype0(Text).
TheCHOICELISTinputparameterisspecifictotextcolumns.
Pleasenotethattheactualcolumnvalueisnotrestrictedtothe
valuesdefinedinthechoicelist.TheCHOICELISTparametermaybe
usedbyAtolltodisplaypreferredvaluestotheuser,forinstanceina
comboboxcontrol.
Version: 3.1.1
Type:ArrayofStrings
DefaultParameters
None.
Results
None.Uponsuccessfulcompletionthenewcolumnisaddedtothetable.
13.28 LOADSAVEPRINTSETUP
Thiscommandloadsorsavestheprintsetupconfiguration.
Version
3.1.1
217
Forsk2014
InputParameters
Name
Description
Attributes
DIRECTION
TheDIRECTIONinputparameterisusedtospecifywhethertoloador
savetheprintsetupconfiguration.
Toloadtheprintsetupconfiguration,specifythevalue1.
Tosavetheprintsetupconfiguration,specifythevalue0.
Version: 3.1.1
Type:Integer
PRINTERNAME
ThePRINTERNAMEinputparameterisusedtospecifythedefault
printertouseintheprintsetupconfiguration.
Thisinputparameterisnotusedwhensavingtheprintsetup
configuration.
Version: 3.1.1
Type:String
CFGPATH
Whenloadingtheprintsetupconfiguration,theCFGPATHinput
parameterisusedtospecifythefileusedtoloadtheprintsetup
configuration.
Whensavingtheprintsetupconfiguration,theCFGPATHinput
parameterisusedtospecifythefileusedtosavetheprintsetup
configuration.
Version: 3.1.1
Type:String
DefaultParameters
None.
Results
Name
Description
Attributes
PRINTERNAME
ThePRINTERNAMEoutput
parameterisusedtoreturnthedefaultprinterused
inttheprintsetupconfigurationfile.
.
Version: 3.1.1
Type:String
13.29 CALCULATEPATHLOSS
Performspathlossmatrixcalculationonatransmitterfolder.
Version
3.2.0
InputParameters
Name
Description
Attributes
TRANSMITTERFOLDER
itself.
Version: 2.6.1
Type:ChildFolder
object
FORCECALCULATION
WhenTrue,thecalculationisforcedevenfortransmittershaving
availablevalidresults.When
False,thecalculationismadeonlyfortransmittershaving
unavailableorinvalidresults.
Version: 3.2.0
Type:Boolean
BLOCKING
Thebooleanvalueusedtospecifywhetherthecalculationswill
occurinthebackground
(False),orifthemethodshouldwaitforthecalculationstofinish
beforereturning(True).
Version: 3.2.0
Type:Boolean
FILTERED
WhenFalse,thecalculationismadeforallactivetransmittersinthe
transmitterfolder.WhenTrue,only
filteredtransmittersarecalculated
Version: 3.2.0
Type:Boolean
DefaultParameters
None.GetCommandDefaultsforthecommandCALCULATEPATHLOSSreturnsanemptyPropertyContainerobject.
218
AT321_TAG_E1
13.30 MWLinksCustomExport
Performsmicrowavelinkscustomexport.
Version
3.2.0
InputParameters
Name
Description
Attributes
EXPORTPATH
Fullpathtothefolderwherelinkreportsareexported.
Version: 2.6.1
Type:String
TEMPLATEFILEPATH
Fullpathtothecustomtemplateusedtoperformtheexport.
Version: 3.2.0
Type:String
LINKSFOLDER
Themicrowavelinksfoldercontaininglinkstoexporttothe
EXPORTPATHfolder,usingtheTEMPLATEFILEPATHcustom
template.
Version: 3.2.0
Type:ChildFolder
object
DefaultParameters
None.GetCommandDefaultsforthecommandMWLinksCustomExportreturnsanemptyPropertyContainerobject.
219
220
Forsk2014
Chapter14
Enumerations,
Structures,and
Interfaces
222
Forsk2014
Chapter14:Enumerations,Structures,andInterfaces
AT321_TAG_E1
14 Enumerations,Structures,andInterfaces
14.1 Enumerations
Enumerationsareusedtospecifyconstants.Twocategoriesofenumerationsaredefinedhereafter.
ThefirstcategoryreferstoallenumerationsdefinedintheAtolltypelibrary.AllofthemareprefixedwithAto.
ThesecondcategoryreferstoallenumerationsdefinedinFSKGISLiblibrary.Allofthemareprefixedwithfg.
14.1.1 AtollTypeLibraryEnumerations
14.1.1.1 AtoSaveStatus
Constant
Value
Description
atoSaveSucceeded
Documenthasbeensuccessfullysaved.
atoSaveCanceled
Changesinthedocumenthasbeencancelledbytheuser.
Constant
Value
Description
atoSaveNo
Documentisclosedwithoutbeingsaved.
atoSaveYes
Documentissavedbeforebeingclosed.
atoSavePrompt
Theuserispromptedwhetherthedocumentmustbesavedbefore
closed.
Constant
Value
Description
atoCancelChanges
Allchangesarecancelledbeforethedocumentisrefreshedfromthe
database.
atoSkipChanges
Onlyrefreshesdatathathavenotbeenmodified.
Constant
Value
Description
atoArchiveSaveSucceeded
Archivinghassucceededwithoutconflicts.
atoArchiveCanceled
Archivinghasbeencancelled,eitherbytheuserorbecauseconflicts
occurred.
Constant
Value
Description
atoMaximized
Maximized(enlargedtomaximumsize).
atoNormal
Normal(Default).
atoMinimized
Minimized(minimizedtoaniconinthetaskbar).
14.1.1.2 AtoSaveChanges
14.1.1.3 AtoRefreshPriority
14.1.1.4 AtoArchiveStatus
14.1.1.5 AtoWindowStatus
223
Forsk2014
14.1.1.6 AtoLogType
Constant
Value
Description
atoInfo
Information.
atoError
Error.
atoWarning
Warning.
Constant
Value
Description
atoEQ
(Equal)ThefirstvalueequaltosearchValissearchedfor.
atoLT
(StrictlyLowerThan)ThefirstvaluelessthansearchValissearched
for.
atoLE
(LowerorEqual)ThefirstvaluelessthanorequaltosearchValis
searchedfor.
atoGE
(GreaterorEqual)ThefirstvaluegreaterthanorequaltosearchVal
issearchedfor.
atoGT
(StrictlyGreaterThan)ThefirstvaluegreaterthansearchValis
searchedfor.
atoNE
(NotEqual)ThefirstvaluenotequaltosearchValissearchedfor.
Constant
Value
Description
atoDbm
TransmissionunitisdBm.
atoWatt
TransmissionunitisWatt.
atoKWatt
TransmissionunitiskWatt.
Constant
Value
Description
atoDbmRx
ReceptionunitisdBm.
atoDbMicroVolt
ReceptionunitisdBV.
atoDbMicroVoltMeter
ReceptionunitisdBV/meter.
Constant
Value
Description
atoM
Distanceunitismeter.
atoKm
Distanceunitiskilometer.
atoMiles
Distanceunitismiles.
14.1.1.7 AtoCompareOp
14.1.1.8 AtoTransmissionUnit
14.1.1.9 AtoReceptionUnit
14.1.1.10 AtoDistanceUnit
224
AT321_TAG_E1
14.1.1.11 AtoRadiatedPowerUnit
Constant
Value
Description
atoRadiatedPowerEIRP
RadiatedpowerisEIRP.
atoRadiatedPowerERP
RadiatedpowerisERP.
Constant
Value
Description
atoAntennaGainDbi
AntennagainunitisdBi.
atoAntennaGainDbd
AntennagainunitisdBd.
Constant
Value
Description
atoHeightOffsetM
Heightoffsetunitismeter.
atoHeightOffsetFeet
Heightoffsetunitisfeet.
Constant
Value
Description
atoData
Atollexplorerwindowdatatab.
atoGeo
Atollexplorerwindowgeotab.
atoModule
Atollexplorerwindowmodulestab.
atoParameters
Atollexplorerwindowparameterstab.
14.1.1.12 AtoAntennaGainUnit
14.1.1.13 AtoHeightOffsetUnit
14.1.1.14 AtoRootType
14.1.1.15 AtoRowFilter
Constantstofilteronlymodified,added,ordeletedrows.
Constant
Value
Description
atoRowFilterNone
Nofilter.
atoRowFilterModifiedOrNew
Filtertoretainonlymodifiedornewrows.
atoRowFilterDeleted
Filtertoretainonlydeletedrows.
Constant
Value
Description
atoRowStatusNew
Rowhasbeenadded.
atoRowStatusModified
Rowhasbeenmodified.
atoRowStatusDeleted
Rowhasbeendeleted.
atoRowStatusUnmodified
Rowisunmodified.
14.1.1.16 AtoRowStatus
Allpossiblerowstatuses.
225
Forsk2014
14.1.1.17 AtoTemperatureUnit
Constant
Value
Description
atoTempCelcius
TemperatureunitisdegreeCelsius(C).
atoTempFarenheit
TemperatureunitisdegreeFarenheit(F).
14.1.2 FSKGISLibTypeLibraryEnumerations
14.1.2.1 GeographicUnit
Constant
Value
Description
fgUnspecifiedUnit
Valuewhennothinghasbeendefined.
fgMeter
Lengthunitismeter.
fgKilometer
Lengthunitiskilometre.
fgFoot
Lengthunitisfoot.
fgLink
fgChain
fgYard
Lengthunitisyard.
fgNauticalMile
Lengthunitisnauticalmile.
fgMile
Lengthunitismile.
fgRadian
100
Longitude/Latitudeunitsareradian.
fgDegree
101
Longitude/Latitudeunitsaredegree.
fgGrad
102
Longitude/Latitudeunitsaregrads.
fgArcMinute
103
Longitude/Latitudeunitsareminutes.
fgArcSecond
104
Longitude/Latitudeunitsareseconds.
Constant
Value
Description
fgUndefinedProjection
Valuewhennothinghasbeendefined.
fgNoProjection
Thissystemhasnoprojectionmethod.
fgLambertConfConic1SP
LambertConfConic1SP.
fgLambertConfConic2SP
LambertConfConic2SP.
fgMercator
Mercator.
fgCassiniSoldner
CassiniSoldner.
fgTransverseMercator
TransverseMercator.
fgTransvMercatorSouthOriented
TransverseMercatorSouthOriented.
fgObliqueStereographic
ObliqueStereographic.
fgNewZealandMapGrid
NewZealandMapGrid.
fgHotineObliqueMercator
10
HotineObliqueMercator.
fgLabordeObliqueMercator
11
LabordeObliqueMercator.
14.1.2.2 ProjectionMethod
226
AT321_TAG_E1
Constant
Value
Description
fgSwissObliqueCylindrical
12
SwissObliqueCylindrical.
fgObliqueMercator
13
ObliqueMercator.
fgUTMProjection
14
UTMProjection.
Constant
Value
Description
fgUTMZoneNumber
NumberofUTMzone.
fgLongitudeOfOrigin
Longitudeoftheoriginofthezone.
fgLatitudeOfOrigin
Latitudeoftheoriginofthezone.
fgFalseEasting
False"easting".
fgFalseNorthing
False"northing".
fgScaleFactorAtOrigin
Scalingfactorattheorigin.
fgLatitudeOf1stParallel
Latitudeofthefirstparallel.
fgAzimuthOfCentralLine
Azimuthofthecentralline.
fgLatitudeOf2ndParallel
Latitudeofthesecondparallel.
fgAngleFromRecttifiedToSkewed
Grid
Constant
Value
Description
EXTRACT_DEFAULT
Allthegeographicdatapresentinthedocumentwillbeused.
Constant
Value
Description
PIXEL_POINT
Thevalueispointwiseandisassociatedwiththecentreofagrid
mesh(cornersofa4pointgrid).
PIXEL_AREA
Thevalueissurfaceareawiseandassociatedwithameshgrid.
Constant
Value
Description
POLAR_NONE
Nopolarizationorunknownpolarization.
POLAR_HORIZ
Horizontalpolarization.
POLAR_VERT
Verticalpolarization.
14.1.2.3 ProjParameterIndices
227
228
Forsk2014
AT321_TAG_E1
229
HeadOffice
7ruedesBriquetiers
31700Blagnac,France
Tel:+33562747210
Fax:+33562747211
AT321_TAG_E1
USOffice
ChinaOffice
200SouthWackerDriveSuite3100
Chicago,IL60606,USA
Tel:+13126744800
Fax:+13126744847
Suite302,3/F,WestTower,JiaduCommercialBuilding,
No.66JianzhongRoad,TianheHiTechIndustrialZone,
Guangzhou,510665,P.R.ofChina
Tel:+862085538938 Fax:+862085538285
www.forsk.com
January2014

Atoll 3.2.1 Task Automation Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Atoll 3.2.1 Task Automation Guide

Uploaded by

Copyright:

Available Formats

Version3.2.

Atoll 3.2.1 Task Automation Guide

CoordSystemObject .......................................................................... 103

Description ........................................................................................... 105

Ellipsoid ............................................................................................. 105

EllipsoidName ........................................................................................ 105

Name ............................................................................................... 106

ProjMethod .......................................................................................... 106

Unit ................................................................................................. 107

HowtoAccessaChildFolderObject ...................................................................... 112

put_Name ........................................................................................... 113

get_Item ............................................................................................. 114

get__NewEnum ....................................................................................... 114

put_Visible ........................................................................................... 115

get_Selected ......................................................................................... 115

put_Selected ......................................................................................... 116

Export ............................................................................................... 116

CentreOnMap ........................................................................................ 118

Redraw .............................................................................................. 118

AddChild ............................................................................................. 118

get_position .......................................................................................... 119

get_ObjectKind ....................................................................................... 120

GetProperty .......................................................................................... 121

SetProperty .......................................................................................... 122

LoadProperties ....................................................................................... 122

RemoveItem ......................................................................................... 123

SetCustomIcon ....................................................................................... 123

PropertyContainerObject ................................................................... 127

GetInfo ............................................................................................. 128

Save ................................................................................................ 129

Remove ............................................................................................. 129

ChildFolderObjectProperties .............................................................. 133

HowtoAccessChildFolderObjectProperties .............................................................. 133

CommonChildFolderObjectProperties .................................................................. 134

CoveragePredictionProperties ......................................................................... 135

DriveTestDataProperties ............................................................................. 149

MasterLinkProperties ................................................................................ 150

VectorLayerProperties ................................................................................ 150

ChildFolderFeatureObjects ................................................................. 155

ClutterFeatureObject ................................................................................. 155

TrafficFeatureObject .................................................................................. 158

UMTSTrafficScenarioProviderObject .................................................................... 161

SimulationFeatureObject .............................................................................. 165

SimulationGroupFeatureObject ........................................................................ 168

3GPPMultiRATSimulationGroupFeatureObject .......................................................... 175

DocumentCommands ......................................................................... 187

HowtoInvokeaDocumentCommand ................................................................... 188

EXPORTXML ......................................................................................... 189

IMPORTTESTMOBILEDATA ............................................................................. 191

RUNNEIGHBOURALLOCATION .......................................................................... 192

RUNINTRACARRIERNEIGHBOURALLOCATION .............................................................. 193

CLONESTUDY ........................................................................................ 195

COMPARESTUDY ..................................................................................... 196

CALCULATEEQUIPMENTLOSSES ......................................................................... 197

CALCULATEREPEATERS ................................................................................ 197

EXPORTACTIVESETANALYSIS ............................................................................ 199

CALCULATEPOINTSECI0 ................................................................................ 202

RUNALLCARRIERSALLOCATION .......................................................................... 202

MWRun ............................................................................................. 204

GETPOWERMODE .................................................................................... 215

SETPOWERMODE ..................................................................................... 216

APPENDVECTORDATACOLUMN ......................................................................... 216

MWLinksCustomExport ................................................................................ 219

Enumerations,Structures,andInterfaces ............................................... 223