Atoll 3.2.1 Task Automation Guide PDF

Version3.2.
1
TaskAutomationGuide
AT321_TAG_E2
AT321_TAG_E2
Atoll3.2.1TaskAutomationGuide
Release:AT321_TAG_E2(June2014)
Copyright19972014Forsk.AllRightsReserved.
Publishedby:
Forsk
7ruedesBriquetiers
31700Blagnac,France
Tel:+33562747210
Fax:+33562747211
Thesoftwaredescribedinthisdocumentisprovidedunderalicenceagreement.Thesoftwaremayonlybeusedorcopiedunderthetermsandconditionsofthelicenceagreement.
Nopartofthecontentsofthisdocumentmaybereproducedortransmittedinanyformorbyanymeanswithoutwrittenpermissionfromthepublisher.
Theproductorbrandnamesmentionedinthisdocumentaretrademarksorregisteredtrademarksoftheirrespectiveregisteringparties.
Thepublisherhastakencareinthepreparationofthisdocument,butmakesnoexpressedorimpliedwarrantyofanykindandassumesnoresponsibilityforerrorsoromissions.No
liabilityisassumedforincidentalorconsequentialdamagesinconnectionwithorarisingoutoftheuseoftheinformationcontainedherein.
4
Atoll 3.2.1 Task Automation Guide 2014 Forsk
AT321_TAG_E2 TableofContents
5
TableofContents
1 GettingStarted................................................................................... 17
1.1 SupportedExtensions ................................................................................... 17
1.2 ScriptTutorial.......................................................................................... 17
1.2.1 WritingaVBScriptFile ................................................................................. 17
1.2.2 TestingtheScript..................................................................................... 18
1.2.3 SchedulingtheScript .................................................................................. 18
1.2.4 DebuggingtheScript.................................................................................. 21
1.2.5 ErrorManagement.................................................................................... 21
1.3 MacroTutorial ......................................................................................... 23
1.3.1 AddingMacrostoAtoll ................................................................................ 24
1.3.2 RunningaMacro ..................................................................................... 25
1.3.3 SavingaListofMacros ................................................................................ 25
1.4 WindowsScriptHost,32bitvs64bit...................................................................... 25
2 ObjectModel..................................................................................... 29
2.1 InterfacesImplementedbyObjects........................................................................ 29
2.2 PropertiesandMethodsProvidedbyObjects ............................................................... 30
2.2.1 Parameters.......................................................................................... 30
2.2.2 ErrorInformation ..................................................................................... 30
3 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
6
TableofContents Forsk2014
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 ApplicationEvents......................................................................................42
3.29.1 WillQuitApp..........................................................................................42
3.29.2 DocumentOpenComplete ..............................................................................43
3.29.3 WillCloseDocument ...................................................................................43
3.29.4 WillSaveDocument ....................................................................................43
3.29.5 DocumentSaveComplete...............................................................................43
3.29.6 DocumentNewComplete...............................................................................43
3.29.7 WillRefreshDocument .................................................................................44
3.29.8 RefreshDocumentComplete ............................................................................44
3.29.9 WillArchiveDocument..................................................................................44
3.29.10 ArchiveDocumentComplete.............................................................................44
3.29.11 WillRun .............................................................................................44
3.29.12 RunComplete.........................................................................................45
3.29.13 LicenceAcquireComplete...............................................................................45
3.29.14 LicenceReleaseComplete...............................................................................46
3.29.15 WillNewDocumentFromDatabase........................................................................47
4 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
5 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
7
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
8
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
6 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
7 ZonesandPredictionsTabularDataObjects..............................................97
7.1 ZonesTabularDataObject ...............................................................................97
7.2 PredictionsTabularDataObject ..........................................................................98
8 CoordSystemObject .......................................................................... 103
8.1 HowtoAccessaCoordSystemObject.................................................................... 103
9
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
9 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
10
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
9.32 OpenPropertySheet ................................................................................... 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 CoveragePredictionProperties ......................................................................... 135
11.4.1 GeneralProperties.................................................................................. 137
11.4.2 Group,Filter,andSortProperties ...................................................................... 137
11.4.3 NonSimulationbasedCoverageConditions............................................................. 138
11.4.4 SimulationbasedCoverageConditions ................................................................. 139
11.4.5 ShadowingandIndoorCoverageConditions............................................................. 140
11.4.6 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 VectorLayerProperties................................................................................ 150
11.15.1 DisplayProperties................................................................................... 150
11.16 UserDensityTrafficMapProperties ..................................................................... 152
11
12 ChildFolderFeatureObjects................................................................. 157
12.1 ClutterFeatureObject ................................................................................. 157
12.1.1 HowtoAccesstheClutterFeatureObject................................................................ 157
12.1.2 get_Source......................................................................................... 157
12.1.3 get_ClassAttributes .................................................................................. 158
12.1.4 get_DefaultAttributes................................................................................ 158
12.1.5 AccessingClutterClassAttributes ...................................................................... 158
12.2 TrafficFeatureObject .................................................................................. 160
12.2.1 HowtoAccesstheTrafficFeatureObject................................................................ 160
12.2.2 get_Source......................................................................................... 160
12.2.3 get_ScenarioProvider................................................................................. 160
12.2.4 ExportCumulatedTraffic............................................................................... 161
12.2.5 HasTrafficForService ................................................................................. 162
12.3 UMTSTrafficScenarioProviderObject .................................................................... 163
12.3.1 GetMeanSize........................................................................................ 163
12.3.2 Create............................................................................................. 163
12.4 EnvironmentBasedTrafficMapFeatureObject............................................................. 165
12.4.1 HowtoAccessEnvironmentBasedTrafficMapFeatureObjects ............................................. 165
12.4.2 get_Source......................................................................................... 165
12.4.3 get_ClassAttributes .................................................................................. 165
12.4.4 get_DefaultAttributes................................................................................ 165
12.4.5 AccessingEnvironmentBasedTrafficMapsAttributes ..................................................... 166
12.5 SimulationFeatureObject .............................................................................. 167
12.5.1 HowtoAccessSimulationFeatureObjects............................................................... 168
12.5.2 get_Source......................................................................................... 168
12.5.3 get_Statistics ....................................................................................... 168
12.5.4 get_Cells........................................................................................... 169
12.5.5 get_Sites........................................................................................... 169
12.5.6 get_Mobiles ........................................................................................ 169
12.5.7 get_Results ......................................................................................... 169
12.6 SimulationGroupFeatureObject ........................................................................ 170
12.6.1 HowtoAccessSimulationGroupFeatureObjects......................................................... 170
12.6.2 get_Source......................................................................................... 172
12.6.3 get_Statistics ....................................................................................... 172
12.6.4 get_MeanSimulation................................................................................. 172
12.6.5 get_StdDevSimulation ................................................................................ 172
12.6.6 AccessingMobiles,Cells,Sites,forSimulationsandSimulationGroups........................................ 173
12.7 3GPPMultiRATSimulationGroupFeatureObject .......................................................... 177
12.7.1 get_Source......................................................................................... 177
12.7.2 get_Statistics ....................................................................................... 178
12.7.3 get_MeanSimulation................................................................................. 178
12.7.4 get_StdDevSimulation ................................................................................ 178
12.8 GSMInterferenceMatrixFeatureObject.................................................................. 179
12.8.1 HowtoAccessGSMInterferenceMatrixFeatureObjects ................................................... 179
12.8.2 get_Source......................................................................................... 180
12.8.3 Load............................................................................................... 180
12.8.4 CompleteScopeInfo.................................................................................. 180
12.8.5 get_Scope .......................................................................................... 180
12.8.6 put_Active.......................................................................................... 181
12.8.7 get_Active.......................................................................................... 181
12.8.8 get_Type ........................................................................................... 181
12.8.9 put_Type........................................................................................... 182
12.8.10 get_BasedOnTraffic.................................................................................. 182
12.8.11 put_BasedOnTraffic .................................................................................. 183
12.8.12 get_Resolution...................................................................................... 183
12.8.13 put_Resolution...................................................................................... 183
12.8.14 get_StdDev......................................................................................... 183
12.8.15 put_StdDev ......................................................................................... 184
12.8.16 get_InfoQuantityIndicator............................................................................. 184
12.8.17 put_InfoQuantityIndicator ............................................................................ 184
12.8.18 get_CdfTab......................................................................................... 184
12
13 DocumentCommands ........................................................................ 189
13.1 HowtoInvokeaDocumentCommand ................................................................... 190
13.2 IMPORTXML......................................................................................... 190
13.3 EXPORTXML ......................................................................................... 191
13.4 APPENDTABLECOLUMN................................................................................ 191
13.5 CALCULATEPOINTS.................................................................................... 192
13.6 IMPORTTESTMOBILEDATA............................................................................. 193
13.7 RUNNEIGHBOURALLOCATION .......................................................................... 194
13.8 RUNINTERTECHNOLOGYNEIGHBOURALLOCATION.......................................................... 195
13.9 RUNINTRACARRIERNEIGHBOURALLOCATION.............................................................. 196
13.10 RUNINTERCARRIERNEIGHBOURALLOCATION.............................................................. 196
13.11 CLONESTUDY ........................................................................................ 197
13.12 DUPLICATESTUDY..................................................................................... 198
13.13 COMPARESTUDY ..................................................................................... 198
13.14 CALCULATEEQUIPMENTLOSSES......................................................................... 199
13.15 CALCULATEREPEATERS ................................................................................ 199
13.16 CALCULATEREMOTEANTENNAS......................................................................... 200
13.17 EXPORTACTIVESETANALYSIS ............................................................................ 201
13.18 CALCULATEPOINTSECI0 ................................................................................ 204
13.19 RUNALLCARRIERSALLOCATION.......................................................................... 205
13.20 RUNMASTERCARRIERALLOCATION....................................................................... 205
13.21 MWRun............................................................................................. 206
13.22 EXPORTMAPWINDOW................................................................................. 215
13.23 IMPORTPLANETDATAFILE.............................................................................. 216
13.24 EXPORTMWLINKANALYSISPROFILEPICTURE............................................................... 217
13.25 GETPOWERMODE .................................................................................... 218
13.26 SETPOWERMODE..................................................................................... 218
13.27 APPENDVECTORDATACOLUMN......................................................................... 219
13.28 LOADSAVEPRINTSETUP................................................................................ 220
13.29 CALCULATEPATHLOSS................................................................................. 220
13.30 MWLinksCustomExport ................................................................................ 221
13.31 ARCHIVETODATABASE................................................................................. 221
14 Enumerations,Structures,andInterfaces............................................... 225
14.1 Enumerations ........................................................................................ 225
14.1.1 AtollTypeLibraryEnumerations ....................................................................... 225
14.1.1.1 AtoSaveStatus.................................................................................... 225
14.1.1.2 AtoSaveChanges .................................................................................. 225
14.1.1.3 AtoRefreshPriority................................................................................. 225
14.1.1.4 AtoArchiveStatus .................................................................................. 225
14.1.1.5 AtoWindowStatus................................................................................. 225
14.1.1.6 AtoLogType ...................................................................................... 226
14.1.1.7 AtoCompareOp................................................................................... 226
14.1.1.8 AtoTransmissionUnit............................................................................... 226
13
14.1.1.9 AtoReceptionUnit .................................................................................. 226
14.1.1.10 AtoDistanceUnit ................................................................................... 226
14.1.1.11 AtoRadiatedPowerUnit.............................................................................. 227
14.1.1.12 AtoAntennaGainUnit ............................................................................... 227
14.1.1.13 AtoHeightOffsetUnit................................................................................ 227
14.1.1.14 AtoRootType...................................................................................... 227
14.1.1.15 AtoRowFilter...................................................................................... 227
14.1.1.16 AtoRowStatus..................................................................................... 227
14.1.1.17 AtoTemperatureUnit ............................................................................... 228
14.1.2 FSKGISLibTypeLibraryEnumerations ................................................................... 228
14.1.2.1 GeographicUnit .................................................................................... 228
14.1.2.2 ProjectionMethod.................................................................................. 228
14.1.2.3 ProjParameterIndices ............................................................................... 229
14
Chapter1
GettingStarted
16
Atoll3.2.1TaskAutomationGuide Forsk2014
AT321_TAG_E2 Chapter1:GettingStarted
17
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:
Opt i on Expl i ci t
Di mvar
Di mmyapp
Di mdoc
Sub At ol l _RunCompl et e( ar g1, ar g2)
var = 1
End Sub
Set myapp = Cr eat eObj ect ( " At ol l . Appl i cat i on" )
WScr i pt . Connect Obj ect myapp, " At ol l _"
18
Chapter1:GettingStarted Forsk2014
Youmustreplacealltheparametersbeginningwith"my"withyourownvaluesintheaboveconnectionstring.Thisscript:
1. StartsaninvisibleAtollsession.
2. Opensanewdocumentfromanexistingdatabase.
3. Runsallthecalculationsinthisdocument.
4. Waitsfortheendofcalculations.
EventRunCompleteisthrownwhencalculationsaredone.Thesyntaxforcatchinganyeventistoconcatenatethe
nameoftheeventtothestring"Atoll_".Astheseparametershavenotbeenusedintheaboveexample,theyhave
been named "arg1" and "arg2". Moreover,weconnect anddisconnectthescript using the appropriate method of
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.
myapp. Vi si bl e = Fal se
Set doc = myapp. Document s. OpenFr omDat abase(
" Pr ovi der =SQLOLEDB. 1; User I D=myNameName; Passwor d=myPwd; I ni t i al Cat al og=myA-
t ol l DbName; Dat a Sour ce=mySer ver ; " , " " )
doc. Run Tr ue
var = 0
Do Whi l e var = 0
WScr i pt . Sl eep 1000
Loop
doc. Save( " C: \ mydoc. at l " )
WScr i pt . Di sconnect Obj ect myapp
doc = Nul l
Const at oSaveNo = 0
myapp. Document s. Cl oseAl l at oSaveNo
myapp. Qui t at oSaveNo
myapp = Nul l
WScr i pt . Qui t 0
19
3. DoubleclicktheAddScheduledTaskicon.TheScheduledTaksWizardopens.
4. ClickNext.
5. ClicktheBrowsebutton.
6. Selectcscript.exe.
7. ClickNext.
8. Changethenameofthetask,forexample"Atolltutorial".
9. Chooseyourpreferredperiodicity.
10. ClickNext.
Thefollowingwizardpagesenableyoutodefinemorepreciselywhenyourtaskshouldrunandwhichuserstartsit.
11. Inthelastpage,selecttheOpenadvancedpropertiesforthistaskwhenIclickFinishcheckbox.
12. ClickFinish.TheadvancedpropertiesAtollTutorialdialogueopens.
Figure 1.1:ScheduledTasksWizard
20
13. IntheAtollTutorialdialogue,addyourVBScriptfilenameintheRunfieldandappend"\\B"optiontospecifybatch
mode.Thissuppressesdialogueboxessuchasalertsandscripterrors.
14. Setaccountinformationifneeded.
15. ClickOK.YourtaskwillbedisplayedintheScheduledTaskswindow:
Tomodifythetaskproperties:
1. RightclicktheAtollTutorialtask.Thecontextmenuopens.
2. SelectPropertiesfromthecontextmenu.
Figure 1.4:AtollTutorial
Figure 1.5:ScheduledTasks
21
Tocontrolthecurrentstatusofthetask:
SelectView>Details.
Toopenthelogfile:
SelectAdvanced>ViewLog.
Totestthenewtask:
1. RightclicktheAtollTutorialtask.Thecontextmenuopens.
2. SelectRunfromthecontextmenu.
1.2.4 DebuggingtheScript
Todebugthescript,useacommandpromptconsoleandthewscript"//X"commandlineoption:
Youwillbepromptedforthedebuggeryouwanttouse.MicrosoftprovidesaspecialisedscriptdebuggertodebugVBScript
code, which is available in the free downloads section of Microsofts website. You can set breakpoints and inspect the
contentsofvariablesusingthisdebugger.
Whiledebugging,youcantemporarilymakeAtollvisibleonthedesktopusing:
1.2.5 ErrorManagement
It is important to check for any error that might occur during the execution of the script. Microsoft Visual Basic scripting
languageprovides"OnErrorResumeNext"alongwiththe"Err"objecttomanageerrors.Hereisoursamplescriptwitherror
management:
wscr i pt t ut or i al . vbs / / X
Myapp. Vi si bl e = Tr ue
Opt i on Expl i ci t
Di mvar
Di mmyapp
Di mdoc
On Er r or Resume Next
Sub Cat chEr r or
I f Er r Then
myapp. LogMessage Er r . Descr i pt i on, 1
WScr i pt . Echo Er r . Descr i pt i on
End I f
WScr i pt . Echo " Scr i pt f ai l ed. "
myapp. LogMessage " Scr i pt f ai l ed. " , 1
Const at oSaveNo = 0
I f I sObj ect ( doc) Then
doc. Cl ose at oSaveNo
doc = Nul l
22
End I f
I f I sObj ect ( myapp) Then
myapp. Qui t 0
myapp = Nul l
End I f
WScr i pt . Qui t - 1
End Sub
Sub At ol l _RunCompl et e( ar g1, ar g2)
var = 1
End Sub
Set myapp = Cr eat eObj ect ( " At ol l . Appl i cat i on" )
I f Er r Then
WScr i pt . Echo " Can' t cr eat e ' At ol l . Appl i cat i on' obj ect . "
Er r . Cl ear
Cal l Cat chEr r or
End I f
WScr i pt . Connect Obj ect myapp, " At ol l _"
myapp. Vi si bl e = Fal se
Set doc = myapp. Document s. OpenFr omDat abase(
" Pr ovi der =SQLOLEDB. 1; User I D=myName; Passwor d=myPwd; I ni t i al Cat al og=myAt ol l Db-
Name; Dat aSour ce=mySer ver ; " , "" )
I f Er r Then Cal l Cat chEr r or End I f
doc. Run Tr ue
var = 0
Do Whi l e var = 0
Loop
doc. Save( " C: \ mydoc. at l " )
WScr i pt . Di sconnect Obj ect myapp
doc = Nul l
23
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:
ThescriptlevelvariablenamefortheAtollApplicationobjectis"Atoll"anditisoptional.So,theabovelineisequivalentto:
Macroscanalsobeinvokedinresponsetoapplicationevents.
Example
myapp. Qui t at oSaveNo
myapp = Nul l
WScr i pt . Qui t 0
mydoc = At ol l . Act i veDocument
mydoc = Act i veDocument
Sub At ol l _Document SaveCompl et e( doc)
LogMessage " Ar chi ve on save r unni ng . . . "
Di mst at us
st at us = doc. Ar chi ve
Const at oEr r or = 1
Const at oAr chi veCancel ed = 1
I f Er r . Number <> 0 Then
LogMessage " Ar chi ve on save f ai l ed. " & Er r . Descr i pt i on & " . " , at oEr r or
El se
I f st at us = at oAr chi veCancel ed Then
LogMessage " Ar chi ve on save f ai l ed. " , at oEr r or
LogMessage " You must r esol ve t he conf l i ct s manual l y. " , at oEr r or
MsgBox " Ar chi ve on save f ai l ed. You must r esol ve t he conf l i ct s manual -
l y. "
El se
LogMessage " Ar chi ve on save compl et ed successf ul l y. "
24
Theaboveexampleshowsamacrousedtoautomaticallyarchiveadocumentonceithasbeensaved.
1.3.1 AddingMacrostoAtoll
YoucanaddamacrotoyourAtollsessionasfollows:
1. SelectTools>AddinsandMacros.TheAddinsandMacrosdialogueopens.
2. UnderMacros,clicktheAddbutton.
Browseforyourscriptfile.Youcancreateanewmacrofilebytypinganameforthenew(empty)macrofileinthefile
selectionbox.AtollwillinitializethisnewfilewithminimalVBScriptscript.Atollinterpretsyourfileandlistsallpublic
macrosfoundinthefileinanexplorer.
Ifyoucreateanemptymacrofile,itisinitialisedwiththefollowingcode:
YoucantheneditthefileandaddanycommandinthesubMain,oraddanothersubandexecuteit..
3. Expandtheexplorerentry,selectamacroandclicktheRunbuttontostartthemacro.
Toeditamacrofile:
1. UnderMacros,selectthemacrointhelistofmacros.
2. ClicktheEditbutton.Themacrofileisopenedinthedefaulteditor.
3. Modifythecode.
4. Savethefile.
5. Closethefileeditor
6. IntheAddinsandMacrosdialogue,clicktheRefreshbutton.Atollwillupdatethemacro.
Toassociateaniconfiletoamacro:
1. UnderMacros,selectthemacrointhelistofmacros.
2. ClicktheIconbutton.
End I f
End I f
End Sub
Publ i c Sub Mai n
End Sub
Figure 1.6:AddingMacrosinAtoll
25
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:
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:
You need to explicitly use 32bit or 64bit Windows Script Host on machines where both 32bit Atoll and 64bit Atoll are
installed.
Funct i on At ol l _Wi l l Run( doc, success)
doc. Save
At ol l _Wi l l Run = Fal se I nt er cept s t he r un or der and cancel s
i t by r et ur ni ng Fal se
End Funct i on
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 Atoll is launched 32-bit Atoll is launched
64-bit WSH used to run
the script
32-bit Atoll is launched 64-bit Atoll is launched 64-bit Atoll is launched
26
Chapter2
ObjectModel
28
AT321_TAG_E2 Chapter2:ObjectModel
29
2 ObjectModel
ThischapterdescribestheAtollobjectmodel.Figure 2.1onpage 29providesanoverviewoftheAtollobjectmodel.
Atollexposesanumberofobjectsofvarioustypes.TheseobjectsprovideaccesstoAtollcomponentsthroughpropertiesand
methods.Propertiesandmethodsusuallyhaveinputandoutputparameters.
TheobjectsexposedbyAtollare:
2.1 InterfacesImplementedbyObjects
AtollobjectsprovideaccesstoAtollcomponentsthroughpropertiesandmethods.
Figure 2.1:AtollObjectModel
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.
Application
Documents
Document1 Document2 PropertyContainer1
PropertyContainer2
TabularData1
TabularData2
ChildFolder1
ChildFolder2
CoordSystem
TabularData1
TabularData2
ChildFolder1
ChildFolder2
CoordSystem
30
Chapter2:ObjectModel Forsk2014
2.2 PropertiesandMethodsProvidedbyObjects
Access to Atoll components is available through properties and methods. Properties and methods usually have input and
outputparameters.
Forreadingandwritingaproperty,youwrite:
Forcallingamethod,youwrite:
2.2.1 Parameters
Propertiesandmethodsmayhaveparameters.
InputParameters
Inputparametersaremarkedwith[in].Inputparametersarenotmutatedbymethodsorpropertysettersimplementation.
Inputparametersarespecifiedbyvalue.
OutputParameters
Output parameters are marked with [out]. Output parameters are specified by reference. Upon successful completion 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
PleaserefertotheVBScriptLanguageReferenceformoreinformationaboutVBScript,errorhandling,andtheErrscriptlevel
variable.
val ue = obj ect . pr oper t y f or r eadi ng a pr oper t y
obj ect . pr oper t y = val ue f or wr i t i ng a pr oper t y
obj ect . met hod
Di mst r Descr i pt i on
I f Er r Then
st r Descr i pt i on = Er r . Descr i pt i on
End I f
Chapter3
ApplicationObject
32
AT321_TAG_E2 Chapter3:ApplicationObject
33
3 ApplicationObject
TheApplicationobjectprovidesanentrypointforclientstoretrieveandnavigatethroughtheAtollobjectmodel.
TheApplicationobjectprovidesthefollowingpropertiesandmethods:
Name Description Attributes
get_Application ReturnstheAtollApplicationobject.
Type:Applicationobject
Access:Read
get_Parent ReturnstheAtollApplicationobject.
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.
34
Chapter3:ApplicationObject Forsk2014
TheApplicationobjectfiresthefollowingevents:
3.1 HowtoAccesstheApplicationObject
Theapplicationobjectisthetoplevelobject.Subobjectsareobtainedthroughpropertiesoftheapplication.Togetanappli
cationobjectinVBScript,useoneofthefollowing:
BecauseAtollregistersitselfintheRunningObjectsTablewhenanAtollsessionisrunning,youcanuse:
Inthecontextofmacros,aninstanceofthemainobjectApplicationisautomaticallyaddedasaglobalvariableofthemacro
code.Therefore,itmustnotcallCreateObjectorGetObjecttogetanApplicationobject.
TheglobalvariableoftypeApplicationobjectavailabletomacrosisnamed"Atoll".
3.2 get_Application
ReturnstheAtollApplicationobject.
Sleep
Suspendstheapplicationapartment
execution.
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.
Set app = Cr eat eObj ect ( "At ol l . Appl i cat i on" )
Set app = Get Obj ect ( , " At ol l . Appl i cat i on" )
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.
35
Parameters
[out]ppVal:AddressoftheIApplicationinterfacepointerusedtoreturntheAtollApplicationobject.
3.3 get_Parent
Parameters
3.4 get_Active
ReturnswhethertheAtollwindowisactiveornot.
Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturnwhethertheAtollwindowsapplicationisactiveornot.
Example
3.5 put_Active
Setsthemainapplicationwindowactive.
Parameters
[in]aNewVal:
VARIANT_TRUE:Activatesthemainwindowapplication.
Example
See"get_Active"onpage 35.
3.6 get_Documents
ReturnstheDocumentsobject.
HRESULT get _Appl i cat i on( I Appl i cat i on **ppVal ) ;
HRESULT get _Par ent ( I Appl i cat i on **ppVal ) ;
HRESULT get _Act i ve( VARI ANT_BOOL *pVal ) ;
Di mapp
Di mact
Set app = Cr eat eObj ect ( " At ol l . Appl i cat i on" )
act = app. Act i ve
app. Act i ve = Tr ue
HRESULT put _Act i ve( VARI ANT_BOOL aNewVal ) ;
36
Parameters
[out]ppDocVal:AddressoftheIDocumentsinterfacepointerusedtoreturntheDocumentsobject.
Example
3.7 get_Name
Returnstheapplicationname.Theapplicationnameisalways"Atoll".
Parameters
[out]pVal:AddressoftheBSTRusedtoreturntheapplicationname.
3.8 get_FullName
Returnsthefullpathoftheexecutable.
Parameters
[out]pVal:AddressoftheBSTRusedtoreturntheapplicationfullpath.
Remarks
Thepathnamereturnedisthefullpath,forexample,"C:\ProgramFiles\Forsk\Atoll\Atoll.exe".
3.9 get_Path
Returnsthepathoftheexecutable.
Parameters
[out]pVal:AddressoftheBSTRusedtoreturntheapplicationpath.
Remarks
Thepathreturnedisprovidedasanabsolutepath,forexample,"C:\ProgramFiles\Forsk".
3.10 get_ActiveDocument
Returnstheactivedocument.
HRESULT get _Document s( I Document s **ppDocVal ) ;
Di mapp
Di mdocs
Set docs = app. Document s
HRESULT get _Name( BSTR *pVal ) ;
HRESULT get _Ful l Name( BSTR *pVal ) ;
HRESULT get _Pat h( BSTR *pVal ) ;
37
Parameters
[out]ppDocVal:AddressoftheIDocumentinterfacepointerusedtoreturntheDocumentobject.
Example
3.11 get_WindowStatus
ReturnsthewindowstatusoftheAtollapplication.
Parameters
[out]pVal:AddressoftheAtoWindowStatusenumerationusedtoreturnthewindowstatus.
Example
3.12 put_WindowStatus
SetsthewindowstatusoftheAtollapplication.
Parameters
[in]newVal:Thewindowstatus.
Example
See"get_WindowStatus"onpage 37.
3.13 put_StatusBar
SetsthestatusbartextoftheAtollapplication.
HRESULT get _Act i veDocument ( I Document **ppDocVal ) ;
Di mapp
Di mdoc
Set doc = app. Act i veDocument
HRESULT get _Wi ndowSt at us( enumAt oWi ndowSt at us *pVal ) ;
Di mapp
Di mst at us
st at us = app. Wi ndowSt at us
Const at oMi ni mi zed = 2
app. Wi ndowSt at us = at oMi ni mi zed
HRESULT put _Wi ndowSt at us( enumAt oWi ndowSt at us aNewVal ) ;
38
Parameters
[in]bstrNewVal:Thetexttodisplayinthestatusbar.
Example
3.14 get_Visible
Returnstheapplicationvisiblestate.
Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturntheapplicationvisiblestate.
Remarks
WhenAtollisnotvisible,adialoguethatwouldnormallyrequireuserinputisautomaticallyclosedasiftheuserhasclicked
itsdefaultbuttonwithoutchanginganyofthedialoguecontrols.
3.15 put_Visible
Setstheapplicationvisiblestate.
Parameters
[in]aNewVal:
VARIANT_TRUE:MakesAtollvisible.
VARIANT_FALSE:HidesAtoll.
Remarks
WhenAtollisnotvisible,adialoguethatwouldnormallyrequireuserinputisautomaticallyclosedasiftheuserhasclicked
itsdefaultbuttonwithoutchanginganyofthedialoguecontrols.
3.16 get_Version
Returnstheapplicationversion.
Parameters
[out]pVal:AddressoftheBSTRusedtoreturntheversion.
HRESULT put _St at usBar ( const BSTR bst r NewVal ) ;
Di mapp
app. St at usBar = Thi s i s my message
HRESULT get _Vi si bl e( VARI ANT_BOOL *pVal ) ;
HRESULT put _Vi si bl e( VARI ANT_BOOL aNewVal ) ;
HRESULT get _Ver si on( BSTR *pVal ) ;
39
Remarks
ThestringisformattedlikeintheAtollaboutdialogue,forexample,"2.6.1".
Atoll3.1.0andabove:
Theapplicationbuildnumberisincludedinthestring,forexample,"3.1.0(Build3730)"
3.17 Quit
Quitstheapplication.
Parameters
[in]aSaveChanges:
atoSaveNo:Discardsdocumentchanges,thenclosestheapplication.
atoSaveYes:Savesdocumentchanges,thenclosestheapplication.
atoSavePrompt:Theuserispromptedtosavedocumentchanges,thentheapplicationisclosed.
[out]pStatus:TheAtoSaveStatusenumerationpointerusedtoreturnwhetherchangesweresuccessfullysavedornot.
ReturnsatoSaveCanceledwhentheuserwaspromptedandhaschosennottosavethechanges,otherwisereturns
atoSaveSucceeded.
3.18 LogMessage
DisplaysamessageintheAtolleventobserverwindow.
Parameters
[in]bstrMsg:Thetexttodisplay.
[in]aLogType:
atoInfo:Aninformationmessageisdisplayed.
atoError:Anerrormessageisdisplayed.
atoWarning:Awarningmessageisdisplayed.
:
4.
5.
:
3.19 CreatePropertyContainer
ReturnsanemptyPropertyContainerobject.
Parameters
[out]pProperties:AddressoftheVARIANTusedtoreturntheemptyPropertyContainerobject.
HRESULT Qui t ( enumAt oSaveChanges aSaveChanges, enumAt oSaveSt at us *pSt at us) ;
HRESULT LogMessage( const BSTR bst r Msg, enumAt oLogType aLogt ype = at oI nf o) ;
HRESULT Cr eat ePr oper t yCont ai ner ( VARI ANT *pPr oper t i es)
40
Remarks
The VARIANT returned if of type VT_DISPATCH, and it implements the IPropertyContainer interface. The empty container
returned can be used to hold default parameters specific to an Atoll document command or to hold an Atoll ChildFolder
Objectproperties.
3.20 get_IniFileFullPath
ReturnsthefullpathtotheAtollInitialisationFile.
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.
Parameters
[in]bstrFile:ABSTRusedtospecifythefullpathtotheAtollInitialisationFile.
Remarks
TheAtollInitialisationFileisusuallynamed"Atoll.ini"anditislocatedinthedirectorywhereAtollwasinstalled.
usage.AfterthepathtotheInitialisationFilehasbeenchanged,andinorderforsomeoptionstobeused,itisnecessaryto
quitAtollandstartitagain.Therefore,itisrecommendedtochangethefullpathtotheInitialisationFileassoonastheAtoll
ApplicationObjecthasbeencreated.
PleaserefertotheAtollAdministratorManualforthelistofavailableoptions.
3.22 GetOption
ReturnsanoptionreadfromtheAtollInitialisationFile.
Parameters
[in]bstrSection:ABSTRusedtospecifythenameofanAtollInitialisationFilesection.
[in]bstrOption:ABSTRusedtospecifythenameofanAtollInitialisationFileoption.
[out]pVal:AddressoftheVARIANTusedtoreturntheoptionvalue.ThetypeoftheVARIANTreturnedisVT_NULLwhenthe
optionbstrOptionis notfoundunderthesection bstrSectionin the Initialisation File.The type of the returnedVARIANT is
VT_I4whentheoptionbstrOptionisaninteger,otherwisethetypeoftheVARIANTreturnedisVT_BSTR.IfbstrOptionisleft
empty,pValwillbeusedtoreturntheentiresectionwhosenameisspecifiedinbstrSection.
HRESULT get _I ni Fi l eFul l Pat h( BSTR *pVal ) ;
HRESULT put _I ni Fi l eFul l Pat h( BSTR bst r Fi l e) ;
HRESULT Get Opt i on( BSTR bst r Sect i on, BSTR bst r Opt i on, VARI ANT *pVal ) ;
41
Remarks
PleaserefertotheAtollAdministratorManualforthelistofavailablesectionsandoptions.
3.23 SetOption
SetsanoptionintheAtollInitialisationFile.
Parameters
[in]bstrSection:ABSTRusedtospecifythenameofanAtollInitialisationFilesection.
[in]bstrOption:ABSTRusedtospecifythenameofanAtollInitialisationFileoption.
[in]varValue:AVARIANTusedtospecifytheoptionvaluetowritetotheInitialisationFile.
Remarks
ThecallermusthavewriteaccesspermissiontotheInitialisationFile.
usage.Therefore,itisrecommendedtosetoptionsassoonastheAtollApplicationObjecthasbeencreated.
PleaserefertotheAtollAdministratorManualforthelistofavailablesectionsandoptions.
3.24 Sleep
Suspendstheapplicationapartmentexecution.
Parameters
[in]lMilliseconds:Alongintegerusedtospecifythetime,inmilliseconds,tosleep.
Example
Remarks
Applicationeventscanstillbeprocessedwhiletheapplicationapartmentexecutionissuspended.
ApplicationVersion
2.8.1
3.25 SetAddinInfoEx
Reservedforfutureuse.
HRESULT Set Opt i on( BSTR bst r Sect i on, BSTR bst r Opt i on, VARI ANT var Val ue) ;
HRESULT Sl eep( l ong l Mi l l i seconds) ;
Sl eep 5 seconds
At ol l . Sl eep 5000
HRESULT Set Addi nI nf oEx(

LONGLONG hI nst ance,
LPDI SPATCH di spat ch,
l ong i dr ,
l ong cooki e
) ;
42
Parameters
3.26 put_OLENotRespondingDialog
EnablesordisablesOLEnotrespondingdialog.
Parameters
[in]newVal:AVARIANT_BOOLusedtospecifywhethertheOLEnotrespondingdialogisenabled(VARIANT_TRUE),ordisabled
(VARIANT_FALSE).
3.27 put_OLEBusyDialog
EnablesordisablesOLEbusydialog.
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.
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.
HRESULT put _OLENot Respondi ngDi al og( VARI ANT_BOOL newVal ) ;
HRESULT put _OLEBusyDi al og( VARI ANT_BOOL newVal ) ;
HRESULT put _OLEMessagePendi ngDel ay( LONG newVal ) ;
43
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.
Parameters
[in]document:TheIDocumentinterfacepointerofthedocumentobjectwhichhasbeenopened.
3.29.3 WillCloseDocument
Eventfiredwhentheuserwantstocloseadocument.Itoccursjustbeforethedocumentcloses,i.e.,afterallconfirmations
requestedbyAtollhavebeenanswered(stoprunningtasks,savechanges,etc...).
Parameters
[in]document:TheIDocumentinterfacepointerofthedocumentobjectbeingclosed.
[out]evtStatus:AVARIANT_BOOLpointerusedtoreturnwhetherthedocumentisallowedtobeclosed(VARIANT_TRUE)or
not(VARIANT_FALSE).
3.29.4 WillSaveDocument
Eventfiredwhentheuserwantstosaveadocument.Itoccursjustbeforethedocumentfileissavedbutafteravalidfilename
isset.
Parameters
[in]document:TheIDocumentinterfacepointerofthedocumentobjectbeingsaved.
[out]evtStatus:AVARIANT_BOOLpointerusedtoreturnwhenthedocumentisallowedtobesaved(VARIANT_TRUE)ornot
(VARIANT_FALSE).
3.29.5 DocumentSaveComplete
Eventfiredjustafteradocumenthasbeensaved.
Parameters
[in]document:TheIDocumentinterfacepointerofthedocumentwhichhasbeensuccessfullysaved.
3.29.6 DocumentNewComplete
Eventfiredwhenanewdocumenthasbeencreated.
HRESULT Wi l l Qui t App( VARI ANT_BOOL* evt St at us) ;
HRESULT Document OpenCompl et e( I Document * document ) ;
HRESULT Wi l l Cl oseDocument ( I Document * document , VARI ANT_BOOL* evt St at us) ;
HRESULT Wi l l SaveDocument ( I Document * document , VARI ANT_BOOL* evt St at us) ;
HRESULT Document SaveCompl et e ( I Document * document ) ;
44
Parameters
[in]document:TheIDocumentinterfacepointerofthedocumentwhichhasbeencreated.
3.29.7 WillRefreshDocument
Eventfiredwhentheuserwantstorefreshadocumentfromdatabase.Itoccursjustbeforetheconnectionwiththedatabase
ischecked.
Parameters
[in]document:TheIDocumentinterfacepointerofthedocumentbeingrefreshed.
[out]evtStatus:AVARIANT_BOOLpointerusedtoreturnwhetherthedocumentisallowedtoberefreshed(VARIANT_TRUE)
ornot(VARIANT_FALSE).
3.29.8 RefreshDocumentComplete
Eventfiredwhenadocumenthasbeenrefreshedfromdatabase.
Parameters
[in]document:TheIDocumentinterfacepointerofthedocumentwhichhasbeenrefreshed.
3.29.9 WillArchiveDocument
Eventfiredwhentheuserwantstoarchiveadocumenttothedatabase.Itoccursjustaftertheconnectionwiththedatabase
issetupandafterAtollhascheckedifanychangeshavetobearchived.Ifnothingrequiresarchiving,thiseventisnotfired.
Parameters
[in]document:TheIDocumentinterfacepointerofthedocumentbeingarchived.
[out]evtStatus:AVARIANT_BOOLpointerusedtoreturnwhetherthedocumentisallowedtobearchived(VARIANT_TRUE)
ornot(VARIANT_FALSE).
3.29.10 ArchiveDocumentComplete
Event fired when the document has been archived in database. It occurs just before the connection with the database is
broken.
Parameters
[in]document:TheIDocumentinterfacepointerofthedocumentwhichhasbeenarchived.
3.29.11 WillRun
Event fired when the user wants to start a calculation. If all is set to VARIANT_TRUE, this event occurs after the user has
confirmedthatallpreviouscalculationsmustbedeleted.
HRESULT Document NewCompl et e( I Document * document ) ;
HRESULT Wi l l Ref r eshDocument ( I Document * document , VARI ANT_BOOL* evt St at us) ;
HRESULT Ref r eshDocument Compl et e( I Document * document ) ;
HRESULT Wi l l Ar chi veDocument ( I Document * document , VARI ANT_BOOL* evt St at us) ;
HRESULT Ar chi veDocument Compl et e( I Document * document ) ;
45
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.
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.
Parameters
[in]pDocument:TheIDocumentinterfacepointerofthedocumentthatneededonelicencetoken.
[in]lModuleID:ThelongintegerusedtospecifytheIDofthelicencetokenthathasjustbeenacquired.
HRESULT Wi l l Run(
I Document * document ,
VARI ANT_BOOL al l ,
VARI ANT_BOOL* evt St at us
) ;
HRESULT RunCompl et e( I Document * document , VARI ANT_BOOL succeeded) ;
HRESULT Li cenceAcqui r eCompl et e(
I Document *pDocument ,
l ong l Modul eI D
) ;
46
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:
3.29.14 LicenceReleaseComplete
ThisfeatureenablestheusertologAtolllicencetokenusagefromanaddin.Licencetokenconsumptionisavailableglobally
forallAtollinstancesrunningononelicenceserverusingadedicatedapplication(monitor.exe).
Externallicencetokensarenottrackedbythisevent.LicenceeventsfortheMeasurements(Measures)modulewillbeavail
ableforautoconnectedaddinsonly.
Firedwhenonelicencetokenisreleased.
Parameters
[in]pDocument:TheIDocumentinterfacepointerofthedocumentthatjustreleasedthelicencetoken.
[in]lModuleID:ThelongintegerusedtospecifytheIDofthelicencetokenthathasjustbeenreleased.
Remarks
lModuleIDwillbeoneoftheseconstantvalues:
LICENCE_GSMTDMA
const l ong LI CENCE_GSMTDMA = 2;
const l ong LI CENCE_MW= 4;
const l ong LI CENCE_MEASURES = 8;
const l ong LI CENCE_AFP = 16;
const l ong LI CENCE_PACK3G = 32;
const l ong LI CENCE_UMTS = 64;
const l ong LI CENCE_CDMA = 128;
const l ong LI CENCE_TDSCDMA = 256;
const l ong LI CENCE_WI MAX = 512;
const l ong LI CENCE_LTE = 2048;
HRESULT Li cenceRel easeCompl et e(
I Document *pDocument ,
l ong l Modul eI D
) ;
47
LICENCE_MW
LICENCE_PACK3G
LICENCE_UMTS
LICENCE_CDMA
LICENCE_TDSCDMA
LICENCE_WIMAX
LICENCE_LTE
3.29.15 WillNewDocumentFromDatabase
3.2.0
Firedjustbeforeanewdocumentiscreatedfromanexistingdatabase.
Parameters
[in]connexion:Thedatabaseconnexionstring.
[in]schema:Thedatabaseschema.
[out]evtStatus:AVARIANT_BOOLpointerusedtoreturnwhetherthecreationofthenewdocumentfromthedatabaseiden
tifiedbytheconnexionandschemaparametersisallowed(VARIANT_TRUE)ornot(VARIANT_FALSE).
HRESULT Wi l l NewDocument Fr omDat abase(
BSTR connexi on,
BSTR schema,
VARI ANT_BOOL *pEvt St at us
) ;
48
Chapter4
DocumentsObject
50
AT321_TAG_E2 Chapter4:DocumentsObject
51
4 DocumentsObject
TheDocumentsobjectisusedtocreateanewdocumentortoiteratethroughopendocumentsinanAtollsession.
TheDocumentsobjectprovidesthefollowingpropertiesandmethods:
4.1 HowtoAccessaDocumentsObject
ToaccessaDocumentsobject:
The"ForEach"VBScriptstatementcanbeusedwiththeDocumentscollectionobject:
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 ReturnstheAtollapplicationobject.
Type:Application
object
Access:Read
Open
Opensanexistingdocumentandaddsittothecollectionof
opendocuments.
Add
Createsanewdocumentandaddsittothecollectionof
opendocuments.
OpenFromDatabase
Createsanewdocumentfromadatabaseandaddsitto
thecollectionofopendocuments.
CloseAll Closesallopendocuments.
SaveAll Savesallopendocuments.
Di mal l Docs
Set al l Docs = At ol l . Document s
Di mal l Docs
Di mdoc
Set al l Docs = At ol l . Document s
For Each doc I n al l Docs
do some wor k wi t h doc
. . .
Next
52
Chapter4:DocumentsObject Forsk2014
4.2 get_Count
ReturnsthenumberofcurrentlyopendocumentsinanAtollsession.
Parameters
[out]pVal:ALONGpointerusedtoreturnthenumberofopendocuments.
Example
4.3 get_Item
ReturnsonedocumentcurrentlyopeninanAtollsession.
Parameters
[in]vIdx:AVARIANToftypeVT_I4orVT_BSTRidentifyingthereturneddocument.AvariantoftypeVT_I4isinterpretedasa
zerobasedindexinthedocumentscollection.AvariantoftypeVT_BSTRisinterpretedasthenameofadocument.
[out]ppDoc:AddressoftheIDocumentinterfacepointerusedtoreturntheAtolldocumentobject.
Remarks
Thenameofadocumentisthedocumentfilename,asreturnedbyget_Name().
4.4 get_Application
ReturnstheAtollapplicationobject.
Parameters
[out]ppVal:AddressoftheIApplicationinterfacepointerusedtoreturntheAtollapplicationobject.
4.5 get_Parent
ReturnstheAtollapplicationobject.
Parameters
[out]ppVal:AddressoftheIApplicationinterfacepointerusedtoreturntheAtollapplicationobject.
4.6 Open
Opensanexistingdocumentandaddsittothecollectionofopendocuments.
HRESULT get _Count ( LONG *pVal ) ;
Di mnDocs
nDocs = At ol l . Document s. Count
HRESULT get _I t em( const VARI ANT vI dx, I Document **ppDoc) ;
HRESULT get _Par ent ( I Appl i cat i on **ppVal ) ;
53
Parameters
[in]bstrPathName:Theabsolutepathofthedocumenttoopen.
[in]readOnly:VARIANT_TRUEmeansthedocumentwillbeopenedinreadonlymode.VARIANT_FALSEmeansthedocument
willbeopenedinreadwritemode.
[out]pDoc:AddressoftheIDocumentinterfacepointerusedtoreturntheopenDocumentobject.
Example
4.7 Add
Createsanewdocumentandaddsittothecollectionofopendocuments.
Parameters
[in]templateName:ThenameofanAtolltemplate.
[out]pDoc:AddressoftheIDocumentinterfacepointerusedtoreturnthenewDocumentobject.
Example
4.8 OpenFromDatabase
Createsanewdocumentfromadatabaseandaddsittothecollectionofopendocuments.
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:
Availablepropertiesare:
HRESULT Open( const BSTR bst r Pat hName, VARI ANT_BOOL aReadOnl y, I Document
**pDoc) ;
Di mdoc
Set doc = app. Document s. Open( C: \ Temp\ myPr oj ect . at l )
HRESULT Add( BSTR t empl at eName, I Document **pDoc) ;
Di mdoc
Set doc = app. Document s. Add( UMTS)
HRESULT OpenFr omDat abase( VARI ANT connect i on, BSTR schema, I Document **pDoc) ;
Pr oper t yName = Val ue[ ; Pr oper t yName = Val ue]
PropertyName Value Version Description
Project string 2.6.0 Databaseschema
54
[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:
Creatinganewdocumentfromadatabase,specifyingasitelisttoload:
CreatinganewdocumentfromanOracledatabase,withnodialoguebox:
Creatinganewdocumentfroma3GPPMultiRATOracledatabase,loadingLTEandUMTSinformationonly:
4.9 CloseAll
Closesallopendocuments.
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
Systems system,[system] 3.1.2
Commaseparatedvaluesofsystems.
Whencreatinganewdocumentfroma3GPPMultiRAT
database,itisusedtospecifytheradioaccesstechnologies
toload.
Availablevaluesforsystemsare:
GSM
UMTS
LTE
Whennopropertynamed"Systems"isspecifiedinthe
schemastring,allradiotechnologiesareloaded.
Publ i c Sub OpenMSAccessDat abase
conn = " Pr ovi der =Mi cr osof t . J et . OLEDB. 4. 0; Dat a Sour ce=C: \ mypr oj ect . mdb"
At ol l . Document s. OpenFr omDat abase conn, " "
End Sub
Publ i c Sub OpenSi t eLi st
conn = " Pr ovi der =Mi cr osof t . J et . OLEDB. 4. 0; Dat a Sour ce=C: \ mypr oj ect . mdb"
At ol l . Document s. OpenFr omDat abase conn, " Si t e Li st s=MySi t eLi st "
End Sub
HRESULT Cl oseAl l ( At oSaveChanges saveChanges, At oSaveSt at us *st at us) ;

55
Parameters
[in]saveChanges:
atoSaveNo:Discardsdocumentchanges,thenclosesallopendocuments.
atoSaveYes:Savesdocumentchanges,thenclosesallopendocuments.
atoSavePrompt:Theuserispromptedtosavedocumentchanges,thenallopendocumentsareclosed.
[out]status:TheAtoSaveStatusenumerationpointerusedtoreturnwhetherchangesweresuccessfullysavedornot.
ReturnsatoSaveCanceledwhentheuserwaspromptedandhaschosennottosavethechanges,otherwisereturns
atoSaveSucceeded.
4.10 SaveAll
Savesallopendocuments.
HRESULT SaveAl l ( ) ;
56
Chapter5
DocumentObject
58
AT321_TAG_E2 Chapter5:DocumentObject
59
5 DocumentObject
TheDocumentobjectprovidesaccesstoATLdocumentsanddatabaseconnections.Adocumentcanbemanaged(open,save,
close,etc.)usingitspropertiesandmethods.Adocumentisalsothemainentrytomanageallthedataitcontains.
TheDocumentobjectprovidesthefollowingpropertiesandmethods:
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
60
Chapter5:DocumentObject Forsk2014
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
61
5.1 HowtoAccessaDocumentObject
Toaccessadocument,youcaneither:
1. Requesttheactivedocumentfromtheapplication:
2. Or,usetheDocumentsobject:
5.2 get_Application
ReturnstheAtollApplicationObject.
Parameters
[out]ppVal:AddressoftheIApplicationinterfacepointerusedtoreturntheAtollApplicationObject.
5.3 get_Parent
ReturnstheAtollDocumentscollection.
Parameters
[out]ppDocVal:AddressoftheIDocumentsinterfacepointerusedtoreturntheAtollDocumentscollection.
5.4 get_FullName
Returnsthedocumentfullpath.
Parameters
[out]pVal:AddressoftheBSTRusedtoreturnthedocumentfullpath.
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
Set myDoc = At ol l . Act i veDocument
Set myDoc = At ol l . Document s. Open( C: \ t emp\ mypr oj ect . at l )
HRESULT get _Par ent ( I Document s **ppDocVal ) ;
HRESULT get _Ful l Name( BSTR *pVal ) ;
62
Remarks
Withanewdocumentthathasneverbeensaved,oradocumentopenedfromadatabase,anemptystringisreturned.
5.5 get_Name
Returnsthedocumentfilenamewithouttheextension.
Parameters
[out]pVal:AddressoftheBSTRusedtoreturnthedocumentfilenamewithouttheextension.
Remarks
5.6 get_Path
Returnsthedocumentpath.
Parameters
[out]pVal:AddressoftheBSTRusedtoreturnthedocumentpath.
Remarks
5.7 get_ReadOnly
Returnstrueifthedocumentisreadonly,falseotherwise.
Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturnthereadonlystatusofthedocument.
5.8 get_Saved
Returnsfalseifthedocumentcontainsunsavedchanges,trueotherwise.
Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturnwhetherthedocumentcontainsunsavedchangesornot.
5.9 get_CoordSystemProjection
Returnstheprojectioncoordinatesystemofadocument.
HRESULT get _Pat h( BSTR *pVal ) ;
HRESULT get _r eadOnl y( VARI ANT_BOOL *pVal ) ;
HRESULT get _Saved( VARI ANT_BOOL *pVal ) ;
63
Parameters
[out]ppVal:AddressoftheIDispCoordSysteminterfacepointerusedtoreturntheprojectioncoordinatesystemofthedocu
ment.
5.10 putref_CoordSystemProjection
Setstheprojectioncoordinatesystemofadocument.
Parameters
[in]pVal:AddressoftheIDispCoordSysteminterfacepointerusedtosettheprojectioncoordinatesystemofthedocument.
5.11 get_CoordSystemDisplay
Returnsthedisplaycoordinatesystemofadocument.
Parameters
[out]ppVal:AddressoftheIDispCoordSysteminterfacepointerusedtoreturnthedisplaycoordinatesystemofthedocument.
5.12 putref_CoordSystemDisplay
Setsthedisplaycoordinatesystemofadocument.
Parameters
[in]pVal:AddressoftheIDispCoordSysteminterfacepointerusedtosetthedisplaycoordinatesystemofthedocument.
5.13 get_CoordSystemInternal
Returnstheinternalcoordinatesystemofadocument.
Parameters
[out]ppVal:AddressoftheIDispCoordSysteminterfacepointerusedtoreturntheinternalcoordinatesystemofthedocu
ment.
Remarks
Whenthedocumentisnotconnectedtoadatabase,theinternalcoordinatesystemisthesameasthedisplaycoordinate
system.Whenthedocumentisconnectedtoadatabase,theinternalcoordinatesystemwontchangewhenthedisplaycoor
dinatesystemischanged.Whenthedocumentisconnectedtoadatabase,theinternalcoordinatesystemisthedisplaycoor
dinatesystemthatwasinusewhenthedocumentwasarchivedinthedatabaseforthefirsttime.
Thecoordinatesofsitesaredefinedwiththeinternalcoordinatesystem.
HRESULT get _Coor dSyst emPr oj ect i on( I Di spCoor dSyst em**ppVal ) ;
HRESULT put r ef _Coor dSyst emPr oj ect i on( I Di spCoor dSyst em*pVal ) ;
HRESULT get _Coor dSyst emDi spl ay( I Di spCoor dSyst em**ppVal ) ;
HRESULT put r ef _Coor dSyst emDi spl ay( I Di spCoor dSyst em*pVal ) ;
HRESULT get _Coor dSyst emI nt er nal ( I Di spCoor dSyst em**ppVal ) ;
64
5.14 get_TransmissionUnit
Returnsthetransmissionpowerunit.
Parameters
[out]pVal:AddressoftheAtoTransmissionUnitenumerationvalueusedtoreturnthetransmissionpowerunit.
5.15 put_TransmissionUnit
Setsthetransmissionpowerunit.
Parameters
[in]aNewVal:TheAtoTransmissionUnitenumerationvalueusedtospecifythetransmissionpowerunit.
5.16 get_ReceptionUnit
Returnsthesignallevelreceptionunit.
Parameters
[out]pVal:AddressoftheAtoReceptionUnitenumerationvalueusedtoreturnthesignallevelreceptionunit.
5.17 put_ReceptionUnit
Setsthesignallevelreceptionunit.
Parameters
[in]aNewVal:TheAtoReceptionUnitenumerationvalueusedtospecifythesignallevelreceptionunit.
5.18 get_DistanceUnit
Returnsthedisplaydistanceunit.
Parameters
[out]pVal:AddressoftheAtoDistanceUnitenumerationvalueusedtoreturnthedisplaydistanceunit.
5.19 put_DistanceUnit
Setsthedisplaydistanceunit.
HRESULT get _Tr ansmi ssi onUni t ( enumAt oTr ansmi ssi onUni t *pVal ) ;
HRESULT put _Tr ansmi ssi onUni t ( enumAt oTr ansmi ssi onUni t aNewVal ) ;
HRESULT get _Recept i onUni t ( enumAt oRecept i onUni t *pVal ) ;
HRESULT put _Recept i onUni t ( enumAt oRecept i onUni t aNewVal ) ;
HRESULT get _Di st anceUni t ( enumAt oDi st anceUni t *pVal ) ;
65
Parameters
[in]aNewVal:TheAtoDistanceUnitenumerationvalueusedtospecifythedisplaydistanceunit.
5.20 Close
Closesadocument.
Parameters
[in]saveChanges:AnAtoSaveChangesenumerationvalue.Thevaluesare:
status:atoSucceededifsavewasforcedtoatoSaveYesoratoSaveNooriftheuserwaspromptedandhehasanswered[out]
pStatus:AddressoftheAtoSaveStatusenumerationvalue.Returnedvaluesare:
5.21 FilePrint
Sendsadocumenttoaprinter.Thecurrentprintsettingsareused.
5.22 Save
Savesadocument.
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.
HRESULT put _Di st anceUni t ( enumAt oDi st anceUni t aNewVal ) ;
HRESULT Cl ose( enumAt oSaveChanges saveChanges, enumAt oSaveSt at us *pSt at us) ;
Constant Value Description
atoSaveNo 0 Documentisclosedwithoutbeingsaved.
atoSaveYes 1 Documentissavedbeforebeingclosed.
atoSavePrompt 2
Theuserispromptedwhetherthedocumentmustbesavedbefore
closed.
atoSaveSucceeded 0 Documenthasbeensuccessfullysaved.
atoSaveCanceled 1 Changesinthedocumenthasbeencancelledbytheuser.
HRESULT Fi l ePr i nt ( ) ;
HRESULT Save( const BSTR pVal ) ;
66
Parameters
[in]aPriority:TheAtoRefreshPriorityenumerationvalueusedtorefreshthedocumentfromthedatabase.
5.24 Archive
Archivesthedocumentinadatabase.Thedocumentmustbeconnectedtoadatabase.
Parameters
[out]pStatus:AddressoftheAtoArchiveStatususedtoreturntheresultoftheoperation.
Remarks
Atoll>=2.7.0:
WhentheDisplayApplicationDialoguespropertyofthedocumentissettotrue,thestandardAtollarchivedialoguewillbe
displayed,otherwisenodialogueisdisplayedandallchangesarearchived.
5.25 Run
Startscalculations.
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.
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.
HRESULT Ref r esh( enumAt oRef r eshPr i or i t y aPr i or i t y) ;
HRESULT Ar chi ve( enumAt oAr chi veSt at us *pSt at us) ;
HRESULT Run( VARI ANT_BOOL aAl l ) ;
HRESULT Set Conf i g( const BSTR bst r Fi l eName) ;
67
5.27 Import
Loadsafilecontaininggeographicdata.
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.
5.28 GetRecords
ReturnsanAtollTabularDataObjectforarequestedcategoryofrecords.
n
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
The list of available table names defined by Atoll can be found in the template (.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
HRESULT I mpor t ( const BSTR f i l eName) ;
Youmustensurethatnoinputsarerequestedfromtheuserwhenimportingthefile(for
instancethefiletype,georeferencementparameters,etc.)whentheapplicationisnot
visible.
HRESULT Get Recor ds(
const BSTR bst r Tabl eName,
VARI ANT_BOOL aAl l ,
I Tabul ar Dat a *ppRecor ds
) ;
68
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
5.29 Redraw
Refreshesallitemsinthedocument.
Remarks
IthasthesameeffectastheiconRefresh(F5)inAtoll.
5.30 CenterMapOn
Centresmaponaparameterpoint.
Parameters
[in]ptx,[in]pty:Thedoublepointersusedtospecifythecoordinatesofthepointtocentresthemapviewon.Thecoordinate
systemusedmustbethethedocumentcoordinatesystem.
5.31 GetRootFolder
ReturnstherootAtollChildFolderObjectusedtoenumerateallChildFolderobjectsbelongingtoonetaboftheAtollexplorer
window.
Di mr ecor ds
Ret ur ns t he cont ent of t he SI TES t abl e
Set r ecor ds = app. Act i veDocument . Get Recor ds( " Si t es" , Tr ue)
Ret ur ns t he cont ent of t he Si t es f ol der , t aki ng t he f ol der f i l t er i nt o ac-
count
Set r ecor ds = app. Act i veDocument . Get Recor ds( " Si t es" , Fal se)
HRESULT Redr aw( ) ;
HRESULT Cent er MapOn( doubl e* pt x, doubl e* pt y) ;
HRESULT Get Root Fol der ( enumAt oRoot Type aType, I Chi l dFol der **ppI t em) ;
69
Parameters
[in]aType:TheAtoRootTypeenumerationvalueusedtospecifytheAtollexplorerwindowtab.ThereisonerootChildFolder
objectforeachtaboftheAtollexplorerwindow.
[out]ppItem:AddressoftheIChildFolderinterfacepointerusedtoreturntherootChildFolderobject.
Example
5.32 RunPathloss
Calculatesthepathlossmatriceswithnoneedforanypredefinedstudies.
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:
5.33 GetService
ReturnsascriptableDocumentServiceObject.
Parameters
[in]bstrName:ABSTRusedtospecifythenameoftheservice.
Di mgeo
const at oGeo = 1
Ret ur ns t he r oot Chi l dFol der obj ect of t he At ol l expl or er " Geo" t ab
Set geo = app. Act i veDocument . Get Root Fol der ( at oGeo)
HRESULT RunPat hl oss( VARI ANT_BOOL al l Tx, VARI ANT_BOOL f or ced) ;
' " Wai t " Loop
Do Whi l e At ol l Doc. HasRunni ngTask
Loop
HRESULT Get Ser vi ce( BSTR bst r Name, I Di spat ch** ppPr ovi der )
70
Theavailablevaluesare:
"SIGNAL":AResultFileProviderobject,implementingtheIResultFileProviderinterface.
OndocumentsbasedontheGSMGPRSEDGEtemplate:
"AFP":AGSMFrequencyPlanAllocationobject,implementingtheIAfpLauncherinterface.
"AFP_IM":AGSMInterferenceMatricesobject,implementingtheIAfpImLauncherinterface.
[out]ppProvider:AddressoftheIDispatchinterfacepointerusedtoreturnthescriptableDocumentServiceObject.
5.34 ExportConfig
Exportsasubsetofthecurrentdocumentconfigurationtoafile.
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:
Atoll 3.1.0 and above:
[in]bstrFile:ABSTRusedtospecifythenameoftheexportfile.
5.35 GetCommandDefaults
Returnscurrentdefaultparametersspecifictoacommand.
HRESULT Expor t Conf i g( const BSTR bst r Cont ent , const BSTR bst r Fi l e) ;
OPTIONname Description
GEO GeographicDataSet
ZONES ComputationandFocusZones
STUDIES PredictionList
OPTIONname Description
FOLDERS FolderConfiguration
MACROS Macros
AFP AFPConfiguration
ANP AutomaticNeighbourAllocationParameters
MW MicrowaveLinkParameters
PNO AutomaticPNOffsetAllocationParameters
SCP AutomaticScramblingCodeAllocationParameters
HRESULT Get CommandDef aul t s(
const BSTR bst r CommandName,
71
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.
Parameters
[in]bstrCommandName:ABSTRusedtospecifythecommand.
[in]pParameters:TheIPropertyContainerinterfacepointerusedtospecifythePropertyContainerobjectholdingtheparam
etersneededtocarryoutthecommand.
IfsettoNULL,defaultparametersforthecommandwillbeused.
ppResults:Resultsofthecommandinvokation.
*ppResultswillbesettoNULLifthecommandhasnoresults.
5.37 get_RadiatedPowerUnit
Returnsthecurrentradiatedpowerunit.
Parameters
[out]pVal:AddressoftheAtoRadiatedPowerUnitenumerationvalueusedtoreturntheradiatedpowerunit.
5.38 put_RadiatedPowerUnit
Setsthecurrentradiatedpowerunit.
Parameters
[in]aNewVal:TheAtoRadiatedPowerUnitenumerationvalueusedtospecifytheradiatedpowerunit.
5.39 get_AntennaGainUnit
Returnsthecurrentantennagainunit.
I Pr oper t yCont ai ner **ppPar amet er s
) ;
HRESULT I nvokeCommand(
const BSTR bst r CommandName,
I Pr oper t yCont ai ner *pPar amet er s,
I Pr oper t yCont ai ner **ppResul t s
) ;
HRESULT get _Radi at edPower Uni t ( enumAt oRadi at edPower Uni t *pVal ) ;
HRESULT put _Radi at edPower Uni t ( enumAt oRadi at edPower Uni t aNewVal ) ;
72
Parameters
[out]pVal:AddressoftheAtoAntennaGainUnitenumerationvalueusedtoreturntheantennagainunit.
5.40 put_AntennaGainUnit
Setsthecurrentantennagainunit.
Parameters
[in]aNewVal:TheAtoAntennaGainUnitenumerationvalueusedtospecifytheantennagainunit.
5.41 get_HeightOffsetUnit
Returnsthecurrentheightoffsetunit.
Parameters
[out]pVal:AddressoftheAtoHei ght Of f set Unitenumerationvalueusedtoreturntheheightoffsetunit.
5.42 put_HeightOffsetUnit
Setsthecurrentheightoffsetunit.
Parameters
[in]aNewVal:TheAtoHei ght Of f set Unitenumerationvalueusedtospecifytheheightoffsetunit.
5.43 get_DatabaseConnectionString
Returnsthedatabaseconnectionstring.
Parameters
[out]pVal:AddressoftheBSTRusedtoreturnthedatabaseconnectionstring.
Remarks
Anerrorisreturnedwhenthedocumentisnotconnectedtoadatabase.
5.44 HasRunningTask
Returnstruewhenthereissomecalculationinprogress.
HRESULT get _Ant ennaGai nUni t ( enumAt oAnt ennaGai nUni t *pVal ) ;
HRESULT put _Ant ennaGai nUni t ( enumAt oAnt ennaGai nUni t aNewVal ) ;
HRESULT get _Hei ght Of f set Uni t ( enumAt oHei ght Of f set Uni t *pVal ) ;
HRESULT put _Hei ght Of f set Uni t ( enumAt oHei ght Of f set Uni t aNewVal ) ;
HRESULT get _Dat abaseConnect i onSt r i ng( BSTR *pVal ) ;
HRESULT HasRunni ngTask( VARI ANT_BOOL *pVal ) ;
73
Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturnwhetherthereissomecalculationinprogressornot.
Remarks
Whensomecalculationisinprogress,itisimpossibletostartnewones.
5.45 RunEx
Startcalculations.
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.
Parameters
[out]pVal:AddressoftheBSTRusedtoreturnthedatabaseschemastring.
Remarks
Anerrorisreturnedwhenthedocumentisnotconnected.
ThedatabaseschemastringisreturnedusingtheexactsamesyntaxdescribedfortheOpenFromDatabasemethod.
5.47 get_DisplayApplicationDialogues
ReturnstruewhensomemethodsonsomeAtollinterfacesmaydisplaysomedialogueboxes.
Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturnwhethersomedialogueboxemaybedisplayeduponinvokationof
somemethodonsomeAtollinterface.
Remarks
SettingtheApplicationObjectvisibilitystatetofalsesetsthisvaluetofalse.
HRESULT RunEx( VARI ANT_BOOL aAl l , VARI ANT_BOOL vbBl ocki ng) ;
HRESULT get _Dat abaseSchemaSt r i ng( BSTR *pVal ) ;
HRESULT get _Di spl ayAppl i cat i onDi al ogues( VARI ANT_BOOL *pVal ) ;
74
5.48 put_DisplayApplicationDialogues
ReturnstruewhensomemethodsonsomeAtollinterfacesmaydisplaysomedialogueboxes.
Parameters
[in]aNewVal:TheVARIANT_BOOLusedtospecifywhethersomedialogueboxemaybedisplayeduponinvokationofsome
methodonsomeAtollinterface.
Remarks
SettingtheApplicationObjectvisibilitystatetofalsesetsthisvaluetofalse.
5.49 PutDatabaseSchemaString
Setsthedatabaseschemastring.
Remarks
Thismethodisnotimplemented.
Pleasedonotusethismethod.
AtollVersion
2.8.1
5.50 PutDatabaseConnectionString
Setsthedatabaseconnectionstring.
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 put _Di spl ayAppl i cat i onDi al ogues( VARI ANT_BOOL aNewVal ) ;
HRESULT Put Dat abaseSchemaSt r i ng( BSTR aVal ) ;
HRESULT Put Dat abaseConnect i onSt r i ng( BSTR aVal ) ;
HRESULT ChangeDat abaseConnect i on( BSTR aCnn, BSTR aReser ved) ;

75
Parameters
[in]aCnn:
TheBSTRusedtospecifythenewdatabaseconnectionstring.
[in]aReserved:
ABSTRreservedforafutureusage.
Remarks
Pleasedonotusethismethod.UsePutDatabaseConnectionStringinstead.
AtollVersion
2.8.1
5.52 get_TemperatureUnit
Returnsthedisplaytemperatureunit.
Parameters
[out]pVal:AddressoftheAtoTemperatureUnitenumerationvalueusedtoreturnthedisplaytemperatureunit.
5.53 put_TemperatureUnit
Setsthedisplaytemperatureunit.
Parameters
[in]aNewVal:TheAtoTemperatureUnitenumerationvalueusedtospecifythedisplaytemperatureunit.
5.54 GetDocumentProperties
Returnsthedocumentproperties.
Parameters
[out]ppProperties:AddressoftheIPropertyContainerinterfacepointerusedtoreturnthedocumentproperties.
Remarks
PleaseseetheSetDocumentPropertiesdocumentationforthelistofavailabledocumentproperties.
5.55 SetDocumentProperties
Setsthedocumentproperties.
HRESULT get _Temper at ur eUni t ( enumAt oTemper at ur eUni t *pVal ) ;

HRESULT put _Temper at ur eUni t ( enumAt oTemper at ur eUni t aNewVal ) ;
HRESULT Get Document Pr oper t i es( I Pr oper t yCont ai ner **ppPr oper t i es) ;
HRESULT Set Document Pr oper t i es( I Pr oper t yCont ai ner *pPr oper t i es) ;
76
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
USER_PROPERTY_NAME0 String
77
78
Chapter6
TabularDataObject
80
AT321_TAG_E2 Chapter6:TabularDataObject
81
6 TabularDataObject
TheTabularDataobjectprovidesaccesstoAtolltableswhetheranAtolldocumentisconnectedtoadatabaseornot.Italso
provides access to other tables which are not database tables, such as PREDICTIONS and ZONES, explained in "Zones and
PredictionsTabularDataObjects"onpage 97.
TheTabularDataobjectprovidesthefollowingpropertiesandmethods:
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
ble to show or solve conflicts between the data in the Atoll document and the current
contentofthedatabase.
Foragivendatabasetable,originaldatavaluesandrowstatusesarenotstoredinthedata
base.TheyarestoredintheAtolldocument.
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
82
Chapter6:TabularDataObject Forsk2014
6.1 HowtoAccessaTabularDataObject
ATabularDataobjectisdefinedbyitsstructure(numberofcolumns,nameofcolumns)anditscontent(rows=records).
Column0androw0arespecial:
Row0holdsthefieldnames,i.e.,thetablestructuredescription.
Column0holdsauniqueidentifierforrecords,calledRECORD_ID.Thisidentifierisnotpersistentandmustnotbe
usedbetweentwosessionsofAtoll,neitherwhenrefreshingnorwhenarchiving.
Thus,inordertogetatabulardatastructure,youwrite:
Thefirstvalue(fori=0)isalways"RECORD_ID".Thesecond(fori=1)is"SITE_NAME"incaseofTRANSMITTERStable,andso
on.Thelastonecorrespondstoi=ColumnCount.
Toreadthecalculationradiiofallthetransmitters,youwrite:
Notethattheloopdoesnotstartwithi=0becauseGetValuewouldreturnthestring"CALC_RADIUS"andnotavalue.
Ifweknowthatcolumn"CALC_RADIUS"isnumber11,wecouldinsteadwrite:
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
Di mi
Di mcol Name
Di mr ecor ds
Set r ecor ds = At ol l . Act i veDocument . Get Recor ds( " Tr ansmi t t er s" , Tr ue)
For i = 0 To r ecor ds. Col umnCount
col Name = r ecor ds. Get Val ue( 0, i )
Next
Di mi
Di mr adi us
Di mr ecor ds
Set r ecor ds = At ol l . Act i veDocument . Get Recor ds( " Tr ansmi t t er s" , Tr ue)
For i = 1 To r ecor ds. RowCount
r adi us = r ecor ds. Get Val ue( i , CALC_RADI US)
Next
83
ButitisbettertoletAtollmanagethecorrespondencebyitself.
ThetablenamesyoucanusetorequestGetRecordsinadocumentareAtolltablesdefinedinthedocumenttemplateinitially
usedtocreateyourdocument,anddependonthetypeofnetwork.
Youcanalsogetsomeadditionaltables:Predictions,Zones.
Predictionstabulardatagivesaccesstopathlossandsignallevelmatrices.
Zonestabulardatagivesaccesstocalculationandfocuszones.
Formoreinformation,see"ZonesandPredictionsTabularDataObjects"onpage 97.
6.2 get_ColumnCount
ReturnsthenumberofcolumnsoftheTabularDataObject.
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
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.
Parameters
[in]iRow:Thelongintegerusedtospecifytherownumbertoputintoeditionmode.
Remarks
Oncearowisputintoeditionmode,itispossibletochangetherowcontentsbyusingSetValue.Updateisusedtocommit
therowchanges.
r adi us = r ecor ds. Get Val ue( i , 11)
HRESULT get _Col umnCount ( l ong *pVal ) ;
HRESULT get _RowCount ( l ong *pVal ) ;
HRESULT Edi t ( l ong i Row) ;
84
6.5 AddNew
AddsanewemptyrowtotheTabularDataObject.Therowaddedisputintoeditionmode.
6.6 Update
Commitsarowchangesandputstherowfromeditionmodetonormalmode.
Parameters
[out] piRow:Thelong integer pointerused to return the numberof the row that was in edition mode. If themethodEdit
startedtheediting,thesameiRowasinEditisreturned.IfitwasAddNewmethod,thenumberistherownumberwherethe
newrecordhasbeenadded.
Remarks
At one pointin time, onlyonerecord canbeputintoedition mode. Thismethod mustbecalled onceaftereachEdit and
AddNew.Editinganotherrecordwithoutupdatingthepreviousonewillthrowanerror.Edit/Updatecannotbemixedupfor
differentrecords,neithercanbeAddNew/Update.
6.7 Delete
Deletesarecord.
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.
DontforgettocallthismethodbeforeacalltoSetValueandtocallUpdatetocommitthe
changesintherow.
HRESULT AddNew( ) ;
DontforgettocallthismethodbeforeacalltoSetValueandtocallUpdatetoactuallyadd
thenewrow.
HRESULT Updat e( l ong *pi Row) ;
HRESULT Del et e( l ong i Row) ;
85
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.
You should never assume that the type of the returned VARIANT is the one you expect. For instance, a VARIANT of type
VT_NULLmaybereturnedwhenthevalueofthecolumnisthe"Null"value.YoushouldexplicitlyconvertthereturnedVARI
ANTtothetypeyouexpectandhandleconversionerrors.
WhenusingaTabularDataObjecttoaccessdatabasetables,pleaserefertotheAtollAdministratorManualfortheavailable
column names, types, units, and to check if the column specification allows for "Null" values. For site coordinates values,
pleaserefertotheAtollTechnicalReferenceGuideforcoordinatesystemsandunits.Sitecoordinatesareexpressedinthe
internalcoordinatesystemoftheAtolldocument.
Example
6.9 SetValue
Setsthevalueofacolumnfortherowbeingeditedoradded.
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.
HRESULT Get Val ue( l ong i Row, const VARI ANT i Col , VARI ANT *pVal ) ;
Set si t es = app. Act i veDocument . Get Recor ds( Si t es)
For i = 1 To si t es. Col umnCount
col Name = si t es. Get Val ue( 0, i )
Next
HRESULT Set Val ue( const VARI ANT i Col , const VARI ANT newVal ) ;
Di mt r ansmi t t er s
Di mdoc
86
Instead,wecouldhaveused:
Updatingthemaincontourofthefocuszone:
Di mi
Di mt xLosses
Set doc = app. Act i veDocument
Set t r ansmi t t er s = doc. Get Recor ds( Tr ansmi t t er s)
For i = 1 To t r ansmi t t er s. RowCount
t xLosses = t r ansmi t t er s. Get Val ue( i , LOSSES)
t r ansmi t t er s. Edi t ( i )
t r ansmi t t er s. Set Val ue( LOSSES, t xLosses + 1)
t r ansmi t t er s. Updat e
Next
For i = 1 To t r ansmi t t er s. RowCount
t xLosses = t r ansmi t t er s. Get Val ue( i , 12)
t r ansmi t t er s. Edi t ( i )
t r ansmi t t er s. Set Val ue( 12, t xLosses + 1)
Next
Publ i c Sub Wr i t eZone( )
Set doc = Act i veDocument
Set zones = doc. Get Recor ds( " Zones" , t r ue)
r ow = zones. Fi nd( 0, "NAME" , at oEQ, " FocusZone")
Di mpt s( 3, 1)
pt s( 0, 0) = 555000
pt s( 0, 1) = 2188000
pt s( 1, 0) = 600000
pt s( 1, 1) = 2188000
pt s( 2, 0) = 600000
pt s( 2, 1) = 2140000
pt s( 3, 0) = 555000
pt s( 3, 1) = 2140000
87
6.10 GetPrimaryKey
Returnsthevalueoftheprimarykeyforagivenrownumber.
Parameters
[in]iRow:Therownumber.
[out]pVal:AddressoftheVARIANTusedtoreturntheprimarykey.
Remarks
AvalidiRownumberisanintegerwhosevalueisgreaterthanzeroorequaltozeroandlowerthanorequaltotherowcount
of the TabularData object. Most of TabularData objects have a primary key. If no primary key is defined, the value of the
columnRECORD_IDfortherowiRowisreturned.WhentheTabularDataobjectprimarykeyismadeofseveralcolumns,the
typeofthevariantreturnedisaonedimensionVARIANTarray,oftypeVT_ARRAY|VT_VARIANT,andVARIANTarrayvalues
arethevaluesofthecolumnsdefiningtheprimarykey.Otherwise,theVARIANTreturnedisthevalueofthecolumnusedto
definetheprimarykey.
When0isusedfortheiRowparameter,thenamesofthecolumnsdefiningtheprimarykeyarereturned.Thevariantreturned
is of type VT_BSTR or VT_ARRAY|VT_VARIANT with variants oftype VT_BSTR, whether the primary key is made of one or
severalcolumns,respectively.
6.11 FindPrimaryKey
Searchestherowwhoseprimarykeyequalstheinputvalueandreturnstherownumberoftherowfound.Ifnorowisfound,
returns1.
Parameters
[in]val:TheVARIANTusedtospecifythekeyvaluetosearchfor.
[out]iRow:Addressofthelongintegerusedtoreturnthenumberoftherowwhoseprimarykeyequalsval.Ifnorowisfound,
1isreturned.
Remarks
Whentheprimarykeyismadeofseveralcolumns,theinputvariantmustbeoftypeVT_ARRAY|VT_VARIANT.
6.12 Find
Searchesacolumnforavalue.
zones. Edi t r ow
zones. Set Val ue " POI NTS", pt s
zones. Updat e
End Sub
HRESULT Get Pr i mar yKey( l ong i Row, VARI ANT* pVal ) ;
HRESULT Fi ndPr i mar yKey( VARI ANT val , l ong* i Row) ;
HRESULT Fi nd(
l ong i RowSt ar t ,
const VARI ANT i Col ,
88
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.
6.13 GetFormattedValue
Returnsacolumnvalueformattedasastring.
enumAt oCompar eOp op,
const VARI ANT val ue,
l ong* pi Row
) ;
Di mt r ansmi t t er s
Di mi Row
Const at oEQ = 0
Set t r ansmi t t er s = Act i veDocument . Get Recor ds( Tr ansmi t t er s, Fal se)
i Row = 0
Whi l e i Row <> - 1
i Row = t r ansmi t t er s. Fi nd( i Row + 1, "LOSSES" , at oEQ, 2)
I f i Row <> - 1 Then
t r ansmi t t er s. Edi t ( i Row)
t r ansmi t t er s. Set Val ue( " LOSSES" , 3)
End I f
Wend
HRESULT Get For mat t edVal ue( l ong i Row, const VARI ANT i Col , BSTR *pVal ) ;
89
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.
6.15 get_ColumnNumber
Returnsacolumnnumber.
Parameters
[in]vColName:TheVARIANTusedtospecifythenameofthecolumn.
[ou]pCol:Addressofthelongintegerusedtoreturncolumnnumber.
Remarks
Itisfastertoreaddatafromtablesusingthecolumnnumberinsteadofthecolumnname.Italsoworksforlinkedfields.
Forinstanceyoucanwrite:
6.16 get_CanEdit
Checksifrowscanbemodified.
HRESULT Cancel Updat e( ) ;
HRESULT get _Col umnNumber ( const VARI ANT vCol Name, l ong *pCol ) ;
Set si t es = doc. Get Recor ds( " SI TES" , Fal se)
col Lat i t ude = si t es. Col umnNumber ( " LATI TUDE" )
For i = 1 To si t es. RowCount
l at i t ude = si t es. Get Val ue i , col Lat i t ude
Next
HRESULT get _CanEdi t ( VARI ANT_BOOL *pVal ) ;
90
Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturnwhetherrowscanbemodifiedornot.
Remarks
IfVARIANT_FALSEisreturned,thentheEditoperationonthistableisundefined.
6.17 get_CanAddNew
Checksifrowscanbeadded.
Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturnwhetherrowscanbeaddedornot.
Remarks
IfVARIANT_FALSEisreturned,thentheAddNewoperationonthistableisundefined.
6.18 get_CanFilterSort
Checksifrowscanbefilteredorsorted.
Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturnwhetherrowscanbefilteredorsorted.
Remarks
IfVARIANT_FALSEisreturned,thentheFilterandSortoperationsonthistableareundefined.
6.19 get_Filter
Returnsthefiltercurrentlysetonthetable.
Parameters
[out]:pvCriteria:AddressoftheVARIANTusedtoreturnthefilterpreviouslysetonthetable.
Remarks
PleaserefertotheAtoRowFilterenumerationdefinitionforthelistofconstantsusedtofilteronlymodified,added,ordeleted
rows.
6.20 put_Filter
Filtersthetabledataaccordingtoafiltercriteria.
HRESULT get _CanAddNew( VARI ANT_BOOL *pVal ) ;
HRESULT get _CanFi l t er Sor t ( VARI ANT_BOOL *pVal ) ;
HRESULT get _Fi l t er ( VARI ANT *pvCr i t er i a) ;
HRESULT put _Fi l t er ( const VARI ANT vCr i t er i a) ;
91
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.
Parameters
[in]vCriteria:TheVARIANT,oftypeVT_BSTR,usedtospecifythesortorder.Itcontainsalistofcommaseparateddatabase
fieldnames.EachfieldisoptionallyfollowedbytheDESCkeywordtoindicatethatthesortorderassociatedwiththefieldis
"Descending".
Remarks
IfthetableisretrievedusingGetRecordswithaAllparametersettoFalse,settingthispropertyisthesameassettingthesort
orderinteractivelyinanAtollsession.
Toremoveanyprevioussortorder,callthismethodwithanemptystring.
Example
HRESULT get _Sor t ( VARI ANT *pvCr i t er i a) ;
Pr i vat e Sub Pr i nt Tr ansmi t t er sTabl e( t r ansmRec, i nf oMsg)
For nRow = 1 To t r ansmRec. RowCount
LogMessage i nf oMsg & " : " & t r ansmRec. Get Val ue( nRow, " TX_I D")
Next
End Sub
Sub Mai n
Set t = Act i veDocument . Get Recor ds( " t r ansmi t t er s" , Fal se)
Sor t ascendi ng accor di ng t o t he " SI TE_NAME" dat abase f i el d
t . Sor t = " SI TE_NAME"
Pr i nt Tr ansmi t t er Tabl es t , " Sor t = SI TE_NAME"
Sor t descendi ng accor di ng t o t he " SI TE_NAME" dat abase f i el d
t . Sor t = " SI TE_NAME DESC"
Pr i nt Tr ansmi t t er sTabl e t , " Sor t = SI TE_NAME DESC"
92
6.22 put_Sort
Sortsthetabledata.
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.
Parameters
[in]iRow:Thelongintegerusedtospecifyarownumber.
[in]iCol:TheVARIANTusedtospecifyacolumnnameoracolumnnumber.
[out]pVal:AddressofVARIANTusedtoreturntheoriginalcolumnvalue.
Remarks
Theoriginalvalue,asopposedtothecurrentvaluereturnbyGetValue,isthevalueretrievedfromthedatabasewhenthe
Atolldocumenthasbeenrefreshedforthelasttime.
Iftherowisunmodified,theoriginalvalueisthesameasthecurrentvalue.
Iftherowisdeletedthecurrentvalueisthenullvalueandtheoriginalvalueisthevaluejustbeforetherowwasdeleted.
6.24 get_RowStatus
Returnsarowstatus.
Parameters
[in]iRow:Thelongintegerusedtospecifyarownumber.
[out]pVal:AddressoftheAtoRowStatusenumerationvalueusedtoreturntherowstatus.
End Sub
HRESULT put _Sor t ( const VARI ANT vCr i t er i a) ;
HRESULT Get Or i gi nal Val ue( l ong i Row, const VARI ANT i Col , VARI ANT *pVal ) ;
HRESULT get _RowSt at us( l ong i Row, enumAt oRowSt at us *pVal ) ;
93
Remarks
WhenanAtolldocumentisopenfromadatabase,rowstatusesaresettoatoRowStatusUnmodifiedandoriginalvaluesare
setforallrowcolumns.
When the document is archived or refreshed from the database,rowstatuses areset to atoRowStatusUnmodified andall
columnsoriginalvaluesaresetforrowsthathavebeenarchivedorrefreshed.
Whenanewrowiscreated,therowstatusissettoatoRowStatusNewandtheoriginalvalueforallcolumnsaresettothenull
value.
Whenarowismodified,therowstatusissettoatoRowStatusModified.Ifyoureverttherowchanges,therowstatusisset
toatoRowStatusUnmodified.
Whenarowisdeleted,therowstatusissettoatoRowStatusDeleted,therowcolumnvaluesaresettothenullvalue,andthe
originalcolumnvaluesarethecolumnvaluesjustbeforetherowwasdeleted.
6.25 get_Columns
Returnstablecolumnsdefinition.
Parameters
[out]ppVal:
AddressoftheITabularDatainterfacepointerusedtoreturnatabulardataobjectholdingthetablecolumnsdefinition:
HRESULT get _Col umns( I Tabul ar Dat a** ppVal ) ;
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.
94
Chapter7
ZonesandPredictions
TabularDataObjects
96
AT321_TAG_E2 Chapter7:ZonesandPredictionsTabularDataObjects
97
7 ZonesandPredictionsTabularDataObjects
7.1 ZonesTabularDataObject
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:
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.
Publ i c Sub ReadZone( )
Set zones = doc. Get Recor ds( "Zones" , Tr ue)
r ow = zones. Fi nd( 1, " NAME" , at oEQ, " FocusZone" )
pt s = zones. Get Val ue( r ow, " POI NTS" )
I f ( I sAr r ay( pt s) ) Then
For i = LBound( pt s, 1) To UBound( pt s, 1)
pt x = pt s( i , 0)
pt y = pt s( i , 1)
MsgBox " Pt s( " + CSt r ( i ) + " ) = " + CSt r ( pt x) + " , " + CSt r ( pt y)
Next
98
Chapter7:ZonesandPredictionsTabularDataObjects Forsk2014
7.2 PredictionsTabularDataObject
The"PREDICTIONS"TabularDataobjectisreadonlyexceptfortheLOCKEDfield,whichcanbeusedtolockorunlockpahloss
matricesofatransmitter.
AtollVersion
2.8.0
ThefieldPATH_NAMEisreadwrite.ItsvaluecanbesettoNull,inwhichcasepathlossmatricesforTX_IDaredeleted.
AtollVersion
2.8.1
Newcolumnsareavailable
ThesevaluesareavailableevenwhenVALIDreturnsFALSEbuttheyarenotuptodatewhentheresolutionofpathlossmatri
ces,thecalculationarea,orthetransmitterlocationhaschanged.
El se
MsgBox "Not an ar r ay"
End I f
End Sub
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.
LOWRES_PATHNAME String
Atollversion 2.7.0
Nullvaluewhenthereisnostoragefortheextendedmatrix.
"(Embeddedindocument)"ifthestorageisnotexternal.
Otherwisecontainstheextendedpathlossmatrixfilepath.
AT321_TAG_E2 Chapter7:ZonesandPredictionsTabularDataObjects
99
AtollVersion
3.1.0
Newcolumnsareavailable:
TX_PATHLOSS,TX_SIGNAL,TX_LOWRES_PATHLOSS,TX_LOWRES_SIGNALforthetransmitterTX_IDdonottakeintoaccount
itsrepeatersorremoteantennas.
On thecontrary, using PATHLOSS, SIGNAL, LOWRES_PATHLOSS, LOWRES_SIGNAL,contributionsfromrepeatersor remote
antennasarecombinedintoonematrix.
Please use TX_PATHLOSS, TX_SIGNAL , TX_LOWRES_PATHLOSS, TX_LOWRES_SIGNAL columns when you need to consider
transmittersignalorpathlossindependentlyfromitsrepeatersorremoteantennas.
AtollVersion
3.2.0
Itisnowpossibletoupdatepathlossmatriceswithexternalresults(.LOSfiles).
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.
TX_PATHLOSS Object TheobjectimplementstheIGridDatainterface.
TX_SIGNAL Object TheobjectimplementstheIGridDatainterface.
TX_LOWRES_PATHLOSS Object TheobjectimplementstheIGridDatainterface.
TX_LOWRES_SIGNAL Object TheobjectimplementstheIGridDatainterface.
100
Chapter7:ZonesandPredictionsTabularDataObjects Forsk2014
YoucaneditthePATH_NAMEorLOWRES_PATHNAMEcolumns,specifyingvalid.LOSabsolutefullpath.
Inthiscase,whentherowinthepredictionstableisupdated,pathlossmatricesareupdatedwiththecontentoffilesprevi
ouslyspecified.
Pleasenotethatfothistowork,youhavetogeoreferenceyourprovided.LOSfiles,withastandardBILheaderfile(.hdr).
Pleasenotethatevenifyour.LOSfilesneedtobegeoreferencedjustliketheywere.BILfiles,.LOSfilesarewrittenbottom
up,nottopdown.
TX_PATHLOSS Object
mainpathlossmatrixdatafortransmitterTX_ID.
Valuesreturneddonotincludecontributionsfromrepeatersorremote
antennasofthetransmitterTX_ID.
TX_SIGNAL Object
mainsignallevelmatrixdatafortransmitterTX_ID.
TX_LOWRES_PATHLOSS Object
extendedpathlossmatrixdatafortransmitterTX_ID.
TX_LOWRES_SIGNAL Object
extendedsignallevelmatrixdatafortransmitterTX_ID.
Chapter8
CoordSystemObject
102
AT321_TAG_E2 Chapter8:CoordSystemObject
103
8 CoordSystemObject
Thisobjectcontainstheentiredefinitionofacoordinatesystem.SeveralcoordinatesystemsareusedinAtolldocuments;one
fordisplay,oneforprojectedgeographicfiles,andoneforsitecoordinates.Thelastonecanberelatedtothesystemusedfor
display.
ThisobjectisnotdefinedinAtolllibrarybut intheFSKGISLiblibrary.Itcanconvertpointsfromonecoordinatesystemto
another.
TheCoordSystemobjectprovidesthefollowingpropertiesandmethods:
Fordetailsoncoordinatesystems,seetheTechnicalReferenceGuide.
8.1 HowtoAccessaCoordSystemObject
Togetthecoordinatesystemusedforsites:
8.2 Code
Returnsorsetsthenumericcodeofthecoordinatessystem.
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.
Di mdoc
Di mcoor dSys
Set doc = At ol l . Act i veDocument
Set coor dSys = doc. Coor dSyst emI nt er nal
HRESULT Code( l ong *pVal ) ;
HRESULT Code( l ong val ) ;
104
Chapter8:CoordSystemObject Forsk2014
Parameters
pVal:AddressoftheLongreadasthecodeofthesystem.
val:Longvaluerepresentingthecodeofthesystemtoset.
8.3 ConvertCoordsTo
Convertsthecoordinatesofapointexpressedinthecurrentsystemtoanotherone.
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
Classical system codes have values less than 32767. System codes greater or equal to
32768correspondtouserdefinedsystems.
HRESULT Conver t Coor dsTo(
I Di spCoor dSyst em*t ar get CS,
VARI ANT i nPoi nt ,
VARI ANT *out Poi nt
) ;
Publ i c Sub Conver t Si t esCoor di nat es
Di msi t es
Di mx
Di my
Di moFr om
Set oFr om= Act i veDocument . Coor dSyst emI nt er nal
Di moTo
Set oTo = Act i veDocument . Coor dSyst emDi spl ay
Di mcoor ds
Set si t es = Act i veDocument . Get Recor ds( " Si t es" , Tr ue)
Di mi
For i = 1 To si t es. RowCount
x = si t es. Get Val ue( i , " LONGI TUDE" )
y = si t es. Get Val ue( i , " LATI TUDE" )
coor ds = oFr om. Conver t Coor dsTo( oTo, Ar r ay( x, y) )
105
8.4 Datum
Returnsorsetsthenumericvalueofthedatum.
Parameters
pVal:Addressreadasthedatumcodeofthesystem.
val:Valuetobesetasthedatumcodeofthesystem.
8.5 DatumName
Nameofthedatum.
Parameters
pVAl:Pointerofthedatumname.
8.6 Description
Descriptionofthedatum.
Parameters
pVal:Pointerofdatumdescription.
8.7 Ellipsoid
Returnsorsetsthenumericvalueoftheellipsoid.
Parameters
pVal:Addressreadastheellipsoidcodeofthesystem.
val:Valuetobesetastheellipsoidcodeofthesystem.
8.8 EllipsoidName
Nameoftheellipsoid.
LogMessage si t es. Get Val ue( i , " NAME" ) &" : " &CSt r ( coor ds( 0) ) &" ; " &CSt r ( coor ds( 1) )
Next
End Sub
HRESULT Dat um( l ong *pVal ) ;
HRESULT Dat um( l ong val ) ;
HRESULT Dat umName( BSTR *pVal ) ;
HRESULT Descr i pt i on( BSTR *pVal ) ;
HRESULT El l i psoi d( l ong* pVal ) ;
HRESULT El l i psoi d( l ong Val ) ;
106
Parameters
pVal:Pointertothenameoftheellipsoid.
8.9 Name
Returnsorsetsthenameofthecoordinatessystem.
Parameters
pVal:Addressreadasthenameofthecoordinatessystem.
val:Valuetobesetasthenameofthecoordinatessystem.
8.10 Pick
Opensthecoordinatessystemdialogue.
Parameters
parentWindow:OLE_HANDLEoftheparentwindowforwhichthedialogueisrequiredtobeopened.
types: Bitsetof CoordSysType (see CoordSysTypes)correspondingtothetypes ofsystems the dialogue must filter before
opening.
ret:PointertoaVARIANT_BOOL,settoVARIANT_TRUEiftheuserquitsthedialoguewithOK,otherwiseVARIANT_FALSE.
CoordSysTypes
8.11 ProjMethod
Projectionmethodusedforthecurrentcoordinatessystem.
Parameters
pVal:PointertothereadProjectionMethod(seeProjectionMethods).
HRESULT El l i psoi dName( BSTR* pVal ) ;
HRESULT Name( BSTR *pVal ) ;
HRESULT Name( BSTR pVal ) ; [ i d( 8) ]
HRESULT Pi ck( OLE_HANDLE par ent Wi ndow, WORD t ypes, VARI ANT_BOOL *r et ) ;
enumCoor dSysType
{ f gUndef i nedCoor dSys = 1,
f gGeogr aphi c2D = 2,
f gPr oj ect ed2D = 4
} Coor dSysType;
HRESULT Pr oj Met hod( Pr oj ect i onMet hod *pVal ) ;
107
8.12 ProjParameter
Readsaparameteroftheprojection.
Parameters
index:Indexoftheparametertoread.
pVal:Addressofthedoublecontainingthevalueoftheparameter.
Remarks
Keepinmindthattherealvalidrangeofindexparametersdependsontheprojectionmethod.
8.13 SetDatum
Changesthedatumofthesystem.
Parameters
ellipsoidCode:Numericcodeoftheellipsoidofthenewdatum.
params:Parametersoftheprojectionprovidedasanarrayofvariants.
8.14 SetProjection
Setstheprojectionparametersofthecoordinatesystem.
Parameters
[in]method:TheProjectionMethodenumerationvalueusedtochangetheprojectionmethodofthecoordinatesystem.
[in]projectionParameters:ASAFEARRAYofVARIANTsoftypeVT_R8usedtospecifytheprojectionparametersofthecoordi
natesystem.Theprojectionparametersmustmatchwiththemethodparameter.Eachparameterisidentifiedbyitsindexin
thearray,startingfrom0.ArrayindexesarethesameasProjParameterIndicesenumerationvalues.Projectionparameters
valuesarethethesameasvaluesreturnedbytheProjParameterproperty.
8.15 Unit
Returnsorsetstheunitofthecoordinatesystem.
Parameters
pVAl:Addressofthecurrentgeographicunit(seeGeographicUnits)ofthesystem.
newVal:Newvalueforthegeographicunit.
HRESULT Pr oj Par amet er ( Pr oj Par amet er I ndi ces i ndex, doubl e *pVal ) ;
HRESULT Set Dat um( l ong el l i psoi dCode, VARI ANT par ams) ;
HRESULT Set Pr oj ect i on( Pr oj ect i onMet hod met hod, VARI ANT pr oj ect i onPar amet er s) ;
HRESULT Uni t ( Geogr aphi cUni t *pVal ) ;
HRESULT Uni t ( Geogr aphi cUni t newVal ) ;
108
Chapter9
ChildFolderObject
110
AT321_TAG_E2 Chapter9:ChildFolderObject
111
9 ChildFolderObject
AChildFolderobjectrepresentsanitemintheapplicationexplorerwindow.Itcanbeacollectionofsubitems.
TheChildFolderobjectprovidesthefollowingpropertiesandmethods:
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 AccesstosomespecificfeaturesontheChildFolderobject.
get_ObjectKind ReturnsatypeidentifieroftheChildFolderobject.
Type:String
Access:Read
GetProperty ReturnsaChildFolderobjectproperty.
SetProperty SetsaChildFolderobjectproperty.
112
Chapter9:ChildFolderObject Forsk2014
9.1 HowtoAccessaChildFolderObject
A ChildFolder is first obtained through a root entry point from the document and is related to a tab of the Atoll Explorer
window.
Most ChildFolderobjectsmay have children,can be selected, setvisible, andrenamed. Only coverage predictionsmaybe
exported.
9.2 get_Application
GetPropertiesInfo
Returnsnamesandtypesforallpropertiesavailableonthe
ChildFolderobject.
PropertyIsPropertyContainer
ReturnstruewhenaChildFolderobjectpropertyisa
PropertyContainerobject.
PropertyIsTabularData
ReturnstruewhenaChildFolderobjectpropertya
TabularDataobject.
LoadProperties
Setspropertiesfromapropertycontainertothe
ChildFolderobject.
SaveProperties
SavesalltheChildFolderobjectpropertiestoanother
propertycontainer.
RemoveItem RemovesoneofthechildrenoftheChildFolderobject.
SetCustomIcon Setsthepathofanicontouseforacustomchildfolder.
Di mf ol der
Di mi t em
Di mdoc
Di mdat aRoot
Const at oDat a = 0
Set doc = At ol l . Act i veDocument
Set dat aRoot = doc. Get Root Fol der ( at oDat a)
For Each f ol der i n dat aRoot
do some wor k wi t h t hi s f ol der , f or i nst ance:
For Each i t emi n f ol der
do some wor k wi t h t hi s i t em
Next
Next
113
Parameters
9.3 get_Parent
ReturnstheparentAtollChildFolderobject.
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.
9.5 put_Name
SetstheChildFolderobjectdisplayname.
HRESULT get _Par ent ( VARI ANT *pVal ) ;
Di mf ol der
Di mdat aTab
Di mf ol der Name
Const at oDat a = 0
Set dat aTab = Act i veDocument . Get Root Fol der ( at oDat a)
For Each f ol der I n dat aTab
f ol der Name = f ol der . Name
I f f ol der Name = Tr ansmi t t er s Then
f ol der . Name = Tr ansmi t t er sTest
End i f
Next
HRESULT put _Name( const BSTR aNewVal ) ;
114
Parameters
[in]aNewVal:TheBSTRusedtospecifythedisplayname.
Example
See"get_Name"onpage 113.
9.6 get_Count
ReturnsthenumberofchildrenoftheChildFolderobject.
Parameters
[out]pVal:Addressofthelongintegerusedtoreturnthenumberofchildren.
9.7 get_Item
ReturnsoneofthechildrenoftheChildFolderobject.
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.
Parameters
[out]ppUnk:AddressoftheIUnknowninterfacepointerusedtoreturntheenumeratorobject.TheIEnumVARIANTinterface
isimplementedbytheenumeratorobject.
Example
9.9 get_Visible
ReturnsthevisibilitystateoftheChildFolderobject.
HRESULT get _Count ( l ong *pVal ) ;
HRESULT get _I t em( const VARI ANT i I dx, I Chi l dFol der **pVal ) ;
HRESULT get __NewEnum( LPUNKNOWN *ppUnk) ;
Const at oModul e = 2
Set modul es = app. Act i veDocument . Get Root Fol der ( at oModul e)
For Each modul e I n modul es
do somet hi ng wi t h modul e
Next
115
Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturnthevisibilitystate.
Thevisibilitystatevaluesare:
VARIANT_TRUE:theChildFolderobjectmaybedisplayedonAtollMapViewwindows.
VARIANT_FALSE:theChildFolderobjectwontbedisplayedonAtollMapViewwindows.
Remarks
ThevisibilitystateonlymakessenseforChildFolderobjectsthatmayappearonAtollMapViewwindows.get_Visibleand
put_Visiblecallsareignoredforobjectsthatdonotsupportit.Noerrorisreturned.
Example
9.10 put_Visible
SetsthevisibilitystateoftheChildFolderobject.
Parameters
[in]aNewVal:TheVARIANT_BOOLusedtospecifythevisibilitystate.
Thevisibilitystatevaluesare:
VARIANT_TRUE:theChildFolderobjectmaybedisplayedonAtollMapViewwindows.
VARIANT_FALSE:theChildFolderobjectwontbedisplayedonAtollMapViewwindows.
Remarks
ThevisibilitystateonlymakessenseforChildFolderobjectsthatmayappearonAtollMapViewwindows.get_Visibleand
put_Visiblecallsareignoredforobjectsthatdontsupportit.Noerrorisreturned.
Example
9.11 get_Selected
ReturnstheselectedstateoftheChildFolderobject.
Parameters
[out]pVal:AddressoftheVARIANT_BOOLusedtoreturntheselectedstateoftheChildFolderobject.
Remarks
get_Selectedandput_Selectedcallsareignoredforobjectsthatdontsupportit.Noerrorisreturned.
HRESULT get _Vi si bl e( VARI ANT_BOOL *pVal ) ;
dat aFol der . I t em( " Pr edi ct i ons" ) . Vi si bl e = Tr ue
HRESULT put _Vi si bl e( VARI ANT_BOOL aNewVal ) ;
dat aFol der . I t em( " Pr edi ct i ons" ) . Vi si bl e = Tr ue
HRESULT get _Sel ect ed( VARI ANT_BOOL *pVal ) ;
116
Example
9.12 put_Selected
SetstheselectedstateoftheChildFolderobject.
Parameters
[in]newVal:TheVARIANT_BOOLusedtospecifytheselectedstate.
Remarks
get_Selectedandput_Selectedcallsareignoredforobjectsthatdontsupportit.Noerrorisreturned.
Example
See"get_Selected"onpage 115.
9.13 Export
ExportsaChildFolderobjecttoafile,inagivenformat.Thismethodcanonlybeusedforstudies.
Parameters
[in]bstrFileName:Astringcontaininganabsolutefilepath.
[in]proj:AnIDispCoordSysteminterfacepointerusedtodefinethecoordinatesystemfortheexport.
[in]bstrFormat:AstringusedtodefinetheformatofthefilespecifiedbybstrFileName.
Publ i c Sub Sel ect Tx
Const at oDat a = 0
Set dat aFol der = doc. Get Root Fol der ( at oDat a)
Sel ect t he " Si t e0_0" t r ansmi t t er
For Each f ol der I n dat aFol der
I f f ol der . Name = " Tr ansmi t t er s" Then
f ol der . I t em( " Si t e0_0" ) . Sel ect ed = Tr ue
End I f
Next
End Sub
HRESULT put _Sel ect ed( VARI ANT_BOOL aNewVal ) ;
HRESULT Expor t (
const BSTR bst r Fi l eName,
I Di spCoor dSyst em* pr oj ,
const BSTR bst r For mat
) ;
117
ThesyntaxforthebstrFormatparameteris:
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:
ReturnValue
S_OK:Exporthascompletedsuccessfully.
S_FALSE:Exportcouldntbeperformedbecauseofoneofthefollowingreasons:
ThefolderspecifiedinbstrFileNamedoesnotexist.
Thestudyvisibilitycheckboxiscleared.
Thestudyhasnocoverage.
WhenS_FALSEisreturned,nooutputfileiscreated.
Example
Pr oper t yName=Val ue; [ Pr oper t yName=Val ue; ] f or mat
PropertyName Value Version Description
Resolution integer 2.8.1
Thisistheexportresolution,expressedinmeter.
Ifnotspecified,theresolutionusedtoperformtheexportis
thestudyresolution.
Itisonlyrelevantwhentheexportformatisavectorformat,
asopposedtoarasterformat.
AreaType 0|1|2 2.8.1
Usedtospecifythezonetoexport.Availablevaluesare:
0:TheEntireCoveredArea
1:TheComputationZone
2:TheGeographicExportZone
Ifnotspecified,theentirecoveredareaisconsideredto
performtheexport.
Itisonlyrelevantforrasterformats,asopposedtovector
formats.
Const SI D_PREDI CTI ONS = " {DA676EF0- E300- 4AFF- BBFA- EC55D3798E4F}"
Publ i c Sub Expor t St udy
Di moSt udy
Di moCS
Set oCS = Act i veDocument . Coor dSyst emDi spl ay
118
9.14 CentreOnMap
CentrestheAtollMapViewwindowaroundtheChildFolderobject.
Remarks
CentreOnMaponlymakessenseforChildFolderobjectsthatmayappearonAtollMapViewwindows.CentreOnMapcallswill
beignoredforobjectsthatdontsupportit.Noerrorwillbereturned.
9.15 Redraw
RedrawstheChildFolderobject.
Remarks
RedrawonlymakessenseforChildFolderobjectsthatmayappearonAtollMapViewwindows.Redrawcallswillbeignored
forobjectsthatdontsupportit.Noerrorwillbereturned.
9.16 AddChild
AddsanewchildtothecurrentAtollchildfolderobject.
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.
For Each oSt udy I n Act i veDocument . Get Root Fol der ( 0) . I t em( SI D_PREDI CTI ONS)
oSt udy. Expor t "c: \ expor t . asc" , oCS, " ARCVI EWGRI DASCI I "
oSt udy. Expor t "c: \ expor t . t xt " , oCS, " TXT"
oSt udy. Expor t "c: \ expor t . bmp" , oCS, " BMP"
Next
End Sub
HRESULT Cent r eOnMap( voi d) ;
HRESULT Redr aw( voi d) ;
HRESULT AddChi l d( const VARI ANT spec, l ong posi t i on, I Chi l dFol der 2** pVal )
119
9.17 Remove
RemovestheChildFolderobjectfromitsparentChildFolderobject.
Remarks
AChildFolderobjectcannotbeusedanymoreafteritisremoved.ChildFolderobjectsmayberemovedbyAtoll,forinstance
whenF5isusedinteractivelytorefreshthescreen.
Atollversion>=2.8.2:
Thismethodisdeprecated.PleaseuseRemoveIteminstead.
9.18 get_position
ReturnstheChildFolderobjectpositionrelativetoitsparentChildFolderobject.
Parameters
[out]pPos:AddressofthelongintegerusedtoreturntheChildFolderobjectposition.ChildFolderobjectsareorderedfrom
position0(top)totoget_Count()1(bottom).
9.19 put_position
SetstheChildFolderobjectpositionrelativetoitsparentChildFolderobject.
Parameters
[in]lPos:AlongintegerusedtospecifytheChildFolderobjectposition.
IflPos 0,theChildFolderobjectismovedtothetop.
IflPos get_Count()1,theChildFolderobjectismovedtothebottom.
9.20 get_Object
AccesstosomespecificfeaturesontheChildFolderobject.
Parameters
[out]ppObject:AddressoftheIUnknowninterfacepointerusedtoaccesssomespecificfeatures.
Remarks
Duetothenatureoftheinterfacereturned,get_Objectcannotbeusedbymacrosandscripts.Macrosorscriptsmustuse
get_dispatchinstead.
9.21 get_dispatch
AccesstosomespecificfeaturesontheChildFolderobject.
HRESULT Remove( voi d) ;
HRESULT get _posi t i on( l ong *pPos) ;
HRESULT put _posi t i on( l ong l Pos) ;
HRESULT get _Obj ect ( I Unknown **ppObj ect ) ;

120
Parameter
[out]ppDispatch:AddressoftheIDispatchinterfacepointerusedtoaccesssomespecificfeatures.
9.22 get_ObjectKind
ReturnsatypeidentifieroftheChildFolderobject.
Parameters
[out]pRetVal:AddressoftheBSTRusedtoreturnthetypeidentifier.
Remarks
TobeabletoidentifytheChildFolderobjecttype,andthereforetosafelyaccessspecificfeaturesoftheChildFolderobject,
hereisthelistoftheavailabletypeidentifiers:
HRESULT get _di spat ch( I Di spat ch **ppDi spat ch) ;
HRESULT get _Obj ect Ki nd( BSTR *pRet Val ) ;
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.
121
9.23 GetProperty
ReturnsaChildFolderobjectproperty.
Parameters
[in]bstrName:Apropertyname.
[out]pValue:AddressoftheVARIANTusedtoreturntheproperty.
Remarks
ThetypeofthereturnedVARIANTcanbeanyofthefollowing:
TheerrorE_INVALIDARGisreturnedwhenthereisnopropertynamedbstrNamefortheChildFolderobject.Theproperties
availablefortheChildFolderobjectdependonthetypeoftheChildFolderobject,asreturnedbyget_ObjectKind.
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.
HRESULT Get Pr oper t y( const BSTR bst r Name, VARI ANT *pVal ue) ;
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
122
9.24 SetProperty
SetsaChildFolderobjectproperty.
Parameters
[in]varValue:TheVARIANTusedtospecifythepropertyvalue.
Remarks
TheerrorE_INVALIDARGisreturnedwhenthereisnopropertynamedbstrNamefortheChildFolderobject.Theproperties
availablefortheChildFolderobjectdependonthetypeoftheChildFolderobject,asreturnedbyget_ObjectKind.
9.25 GetPropertiesInfo
ReturnsnamesandtypesforallpropertiesavailableontheChildFolderobject.
Parameters
[out]pValue:AddressoftheVARIANTusedtoreturnthenamesandtypesforallpropertiesinthepropertycontainer.
9.26 PropertyIsPropertyContainer
ReturnstruewhenaChildFolderobjectpropertyisaPropertyContainerobject.
Parameters
[in]bstrName:Thepropertyname.
[out]pValue:AddressoftheVARIANT_BOOLusedtoreturnwhetherthepropertyisaPropertyContainerobjectornot.
9.27 PropertyIsTabularData
ReturnstruewhenaChildFolderobjectpropertyisaTabularDataobject.
Parameters
[out]pValue:AddressoftheVARIANT_BOOLusedtoreturnwhethertheChildFolderpropertytypeisTabularDataobject.
9.28 LoadProperties
SetspropertiesfromapropertycontainertotheChildFolderobject.
HRESULT Set Pr oper t y( const BSTR bst r Name, const VARI ANT var Val ue) ;
HRESULT Get Pr oper t i esI nf o( VARI ANT *pVal ue) ;
HRESULT
Pr oper t yI sPr oper t yCont ai ner ( const BSTR bst r Name, VARI ANT_BOOL *pVal ue) ;
HRESULT Pr oper t yI sTabul ar Dat a( const BSTR bst r Name, VARI ANT_BOOL *pVal ue) ;
HRESULT LoadPr oper t i es( const VARI ANT var Sour ce) ;
123
Parameters
[in]varSource:VARIANToftypeVT_DISPATCH,usedtospecifyapropertycontainerforthepropertiestoset.
9.29 SaveProperties
SavesalltheChildFolderobjectpropertiestoanotherpropertycontainer.
Parameters
[in]varDestination:VARIANToftypeVT_DISPATCH,usedtospecifyapropertycontainerwhereallpropertieswillbeset.
9.30 RemoveItem
RemovesoneofthechildrenoftheChildFolderobject.
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.
Parameters
[in]bstrPath:Thefullpathtotheiconfile(*.ico)toload.
9.32 OpenPropertySheet
Displaysthechildfolderpropertysheetdialogue.
Parameters:
HRESULT SaveProperties( const VARIANT varDestination) ;
HRESULT RemoveItem( const VARIANT idx) ;
HRESULT SetCustomIcon(const BSTR bstrPath);
HRESULT OpenPropertySheet();
124
Chapter10
PropertyContainer
Object
126
AT321_TAG_E2 Chapter10:PropertyContainerObject
127
10 PropertyContainerObject
ThePropertyContainerobjectisagenericcontainercontainingasetofnamedpropertiesofarbitrarytypes.
ThePropertyContainerobjectprovidesthefollowingpropertiesandmethods:
10.1 Get
Returnsanamedproperty.
Parameters
[out]pValue:AddressoftheVARIANTusedtoreturntheproperty.
Remarks
ThetypeofthereturnedVARIANTcanbeanyofthefollowing:
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.
HRESULT Get ( const BSTR bst r Name, VARI ANT *pVal ue) ;
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
128
Chapter10:PropertyContainerObject 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.
Parameters
[in]varValue:TheVARIANTusedtospecifythepropertyvalue.
Remarks
IfthepropertynamedbstrNamehasbeenpreviouslyset,itscontentisreplacedbyvarValue,otherwiseanewpropertynamed
bstrNameisaddedtothepropertycontainer.
10.3 GetInfo
Returnsnamesandtypesforallpropertiessettothepropertycontainer.
Parameters
[out]pValue:AddressoftheVARIANTusedtoreturnthenamesandtypesforallpropertiesinthepropertycontainer.
10.4 IsPropertyContainer
ReturnstruewhenanamedpropertyisaPropertyContainerobject.
Parameters
[out]pValue:AddressoftheVARIANT_BOOLusedtoreturnwhetherthepropertyisaPropertyContainerObject.
10.5 IsTabularData
ReturnstruewhenanamedpropertyisaTabularDataobject.
Parameters
[out]pValue:AddressoftheVARIANT_BOOLusedtoreturnwhetherthepropertyisaTabularDataObject.
10.6 Load
Addspropertiesfromanotherpropertycontainertothepropertycontainer.
HRESULT Set ( const BSTR bst r Name, const VARI ANT var Val ue) ;
HRESULT Get I nf o( VARI ANT *pVal ue) ;
HRESULT I sPr oper t yCont ai ner ( const BSTR bst r Name, VARI ANT_BOOL *pVal ue) ;
HRESULT I sTabul ar Dat a( const BSTR bst r Name, VARI ANT_BOOL *pVal ue) ;
AT321_TAG_E2 Chapter10:PropertyContainerObject
129
Parameters
[in]varSource:VARIANToftypeVT_DISPATCH,usedtospecifyapropertycontainerforthepropertiestoadd.
10.7 Save
Savesallthepropertiestoanotherpropertycontainer.
Parameters
[in]varDestination:VARIANToftypeVT_DISPATCH,usedtospecifyapropertycontainerwhereallpropertieswillbeset.
10.8 RemoveAll
Removesallpropertiesfromthepropertycontainer.
10.9 Remove
Removesanamedpropertyfromthepropertycontainer.
Parameters
[out]pValue:AddressoftheVARIANTusedtoreturntheoriginalpropertyvalue,beforeitisremoved.
HRESULT Load( const VARI ANT var Sour ce) ;
HRESULT Save( const VARI ANT var Dest i nat i on) ;
HRESULT RemoveAl l ( voi d) ;
HRESULT Remove( const BSTR bst r Name, VARI ANT *pVal ue) ;
130
Chapter10:PropertyContainerObject Forsk2014
Chapter11
ChildFolderObject
Properties
132
AT321_TAG_E2 Chapter11:ChildFolderObjectProperties
133
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.
WritingaChildFolderObjectProperty
item:AChildFolderobject.
propertyname:Thepropertyname.
propertyvalue:Thepropertyvalue.
I f t he pr oper t y t ype i s an Obj ect ( At ol l Tabul ar Dat a Obj ect , At ol l Pr oper t y
Cont ai ner Obj ect , . . . ) , t hen r epl ace t he next l i ne wi t h
" Set pr oper t yval ue = i t em. Get Pr oper t y( pr oper t yname) "
pr oper t yval ue = i t em. Get Pr oper t y( pr oper t yname)
I f Er r Then
MsgBox i t em. Name & ". " & pr oper t yname & " does not exi st . "
El se
MsgBox i t em. Name & ". " & pr oper t yname & " = " & CSt r ( pr oper t yval ue)
End I f
134
Chapter11:ChildFolderObjectProperties Forsk2014
11.2 CommonChildFolderObjectProperties
SomeChildFolderobjectpropertiesarecommontoallkindsofChildFolderobjects.Thesepropertiesincludethefollowing.
11.3 PredictionsFolderProperties
Typereturnedbyget_ObjectKind:{DA676EF0E3004AFFBBFAEC55D3798E4F}
ThefollowingpropertiesareaccessiblethroughthePredictionsfolder.
i t em. Set Pr oper t y pr oper t yname, pr oper t yval ue
I f Er r Then
MsgBox Er r . Descr i pt i on
End I f
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
135
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 138:Coverageconditionsforpredictionsthatcannotbebased
onsimulations,
"SimulationbasedCoverageConditions"onpage 139:Coverageconditionsforpredictionsthatcanbebasedonsim
ulations,
"ShadowingandIndoorCoverageConditions"onpage 140,
"DisplayProperties"onpage 140.
GSMGPRSEDGECoveragePredictions
UMTSHSPACoveragePredictions
PRIVATESTORAGE
Pathtothepathlossmatricesprivatestoragefolder,asitappears
inthePredictionsfolderproperties.
Version :2.6.1
Type:String
Access:Read/Write
Name ObjectKind Attributes

CoveragebyTransmitter {9E42C87F56D043CAA31378A7CA9A811B}
CoveragebySignalLevel {1FF202779A4C486AB0A490E7E8EC72E4}
OverlappingZones {1F0C294B11A045C99B32640FED79BCA6}
CoveragebyC/ILevel {8A94CAE7B4FF4DC6854ABC90FE8F0073}
InterferedZones {EB45E33DFB3344F1A63BB4661ACE78B2}
CoveragebyGPRS/EDGECoding
Scheme
{6B062215EEC140E99A02F909AFF6B5DB}
RLC/MACThroughput/Timeslot {02BE397A1F4B423EAEC4B8138974ADD8}
ApplicationThroughput/Timeslot {3F8F8CB3A5DC49F98F3D0E7243AA0E6C}
CircuitQualityIndicatorAnalysis {67EC97E99F064B0F90C0E42A67FE560C}
CoveragebyC/ILevel(UL) {549A79FFD1914486B6D8A1544633BC26} Version :3.2.1
CoveragebyTransmitter {A6FB7132FB5E42CCA1C10BEA4AF09921}
CoveragebySignalLevel {E82C3B13240E4DD3A553583ADDF57713}
OverlappingZones {53B30925B781499D90E43F9B8570871B}
CoveragebyTotalNoiseLevel(DL) {1C9384EB57CA433FBDB307E1BE317890}
PilotQualityAnalysis(Ec/Io) {66287FC581FA40B684E32C2C4E13D121}
ServiceAreaAnalysis(Eb/Nt)(DL) {5C6427F7D63A4046B8BD1A5E9D165890}
ServiceAreaAnalysis(Eb/Nt)(UL) {D75ADE37FB8A4693A78847109A913C29}
136
WiMAXCoveragePredictions
LTECoveragePredictions
EffectiveServiceAreaAnalysis(Eb/
Nt)(DL+UL)
{5F74AEFA295842CC8244C12DC19B26C3}
HandoffZones {39A63BBA02EC43E7852307E29B519181}
PilotPollutionAnalysis {2199E577F3F54FFDBCAB0D748CA7CCD3}
HSDPAQualityandThroughput
Analysis
{BFDDFC83D8EE4225840FEF842DE19B74}
HSUPAQualityandThroughput
Analysis
{E9ED15F1EC144451ADFA1953A6FB2526}
ScramblingCodeCollisionZones {AC612067A173439EBF7A76B17933A30E}
CoveragebyTransmitter {BE607087CB08453CB2A0B356CD38C3F5} Version :2.7.1
CoveragebySignalLevel {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
CoveragebyTransmitter {BE607087CB08453CB2A0B356CD38C3F5} Version :2.8.0
CoveragebySignalLevel {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
CoveragebyC/(I+N)Level(DL) {DCB4B7564D0242DBB83814A62F603922} Version :2.8.0
CoveragebyC/(I+N)Level(UL) {4163305DE2034A7899F6E59EA537AB7E} Version :2.8.0
CoveragebyBearer(DL) {C5A270AA15A1443DBBCB77B1B99D447F} Version :2.8.0
CoveragebyBearer(UL) {A07FB55064C74D2AB63479FC6A981828} Version :2.8.0
CoveragebyThroughput(DL) {645C7166CE004EFBB9AFA7F25A3BBBA6} Version :2.8.0
137
11.4.1 GeneralProperties
Thesepropertiesareavailableforallkindsofcoveragepredictions.
11.4.2 Group,Filter,andSortProperties
ThesepropertiesarecalledRECORDSETCONDITIONS,whichareavailableforallkindsofcoveragepredictions.
ThefollowingRECORDSETCONDITIONSareavailable:
CoveragebyThroughput(UL) {1A8B4ACB8D5149AAAA673ADAB48F09B6} Version :2.8.0
CoveragebyQualityIndicator(DL) {B682A005CCC24C7CA9FAD2FEBA633E15} Version :2.8.0
CoveragebyQualityIndicator(UL) {E648833C48E149C0A56F6B94DBA9C358} Version :2.8.0

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
Name Attributes
RECORDSETCONDITIONS
Version :2.7.0
PropertyContainerobject
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
138
11.4.3 NonSimulationbasedCoverageConditions
ThesepropertiesarecalledCOVERAGECONDITIONS.
Thesepropertiesareavailableforthefollowingcoveragepredictions:
GSMGPRSEDGE:
CoveragebyTransmitter
CoveragebySignalLevel
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:
Name Attributes
COVERAGECONDITIONS
Version :2.7.0
PropertyContainerobject
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
139
11.4.4 SimulationbasedCoverageConditions
ThesepropertiesarecalledSIMULATIONCONDITIONS.
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:
CoveragebyC/(I+N)Level(DL)
CoveragebyC/(I+N)Level(UL)
CoveragebyBearer(DL)
CoveragebyBearer(UL)
CoveragebyThroughput(DL)
CoveragebyThroughput(UL)
LTE(Version :2.8.0):
CoveragebyC/(I+N)Level(DL)
CoveragebyC/(I+N)Level(UL)
CoveragebyBearer(DL)
CoveragebyBearer(UL)
CoveragebyThroughput(DL)
CoveragebyThroughput(UL)
CoveragebyQualityIndicator(DL)
CoveragebyQualityIndicator(UL)
ThefollowingSIMULATIONCONDITIONSareavailable:
USESUBCELLRECEPTIONTHRESHOLD
Whethertousethelowerreceptionthresholddefinedfor
thetransmittersubcellornot.WhensettoTrue,the
FIELDMINIMUMpropertyisignored.
Version :2.7.0
Type:Boolean
Access:Read/Write
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
Name Attributes
SIMULATIONCONDITIONS
Version :2.7.0
Type:PropertyContainerobject
TERMINAL Thenameoftheterminaltypeusedfortheprediction.
Version :2.7.0
Type:String
Access:Read/Write
MOBILITY Thenameofthemobilitytypeusedfortheprediction.
Version :2.7.0
Type:String
Access:Read/Write
140
11.4.5 ShadowingandIndoorCoverageConditions
ThesepropertiesarecalledCLUTTERCONDITIONS.
Thesepropertiesareavailableforallkindsofcoveragepredictions:
11.4.6 DisplayProperties
Display properties for coverage predictions are accessed through a property named "DISPLAYPROPERTIES." The "DISPLAY
PROPERTIES"propertyisacontainerobjectusedtocontainindividualdisplayproperties.
SERVICE Thenameoftheserviceusedfortheprediction.
Version :2.7.0
Type:String
Access:Read/Write
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
Name Attributes
CLUTTERCONDITIONS
Version :2.7.0
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
141
Thepropertiesavailableinthe"DISPLAYPROPERTIES"propertycontainerare,forallkindsofcoveragepredictions:
REPRESENTATIONtabulardataobject
The"REPRESENTATION"tabulardataobjectcontainsattributesofintervalsorvaluesusedtodisplaythepredictiononthe
map.Thistabulardataobjectcanbeeditedtochange,remove,oradddisplayintervalsordisplayvalues.
The"REPRESENTATION"tabulardataobjectisavailableasa"DISPLAYPROPERTIES"propertynamed"REPRESENTATION"
Theschemaofthe"REPRESENTATION"tabulardataobjectis:
Name Attributes
DISPLAYPROPERTIES
Version :2.7.0
Name Attributes
REPRESENTATION
Version :2.7.0
Type:TabularDataobject
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 142.
Version :2.7.0
Type:Integer
Access:Read/Write
SECONDARYCOLOR
Thesecondarycolorassignedtothedisplayintervalorthe
displayvalue.ThecolorformatisRGB.
page 142.
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
142
ConvertingIntegerstoRGBandViceversa
ToconvertIntegertoRGBcolorcomponents:
ToconvertRGBcolourcomponentstoInteger:
OtherDISPLAYPROPERTIESproperties
11.5 GSMSimulationGroupProperties
ThefollowingpropertiesareaccessibleforaGSMMonteCarlosimulationgroup.
Di mRed
Di mGr een
Di mBl ue
Let Red = ( col or And &HFF)
Let Gr een = ( ( col or \ 256) And &HFF)
Let Bl ue = ( ( col or \ 65536) And &HFF)
Di mcol or
Let col or = ( Red + Gr een * 256 + Bl ue * 65536)
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

TRAFFICMAPS
Thenamesofthetrafficmapsusedbyasimulation
group.
Version :3.2.1
Type:ArrayofStrings
Access:Read/Write
NUMBEROFSIMULATIONS Thenumberofsimulationsinasimulationgroup.
Version :3.2.1
Type:Integer
Access:Read/Write
EXECUTELATER
Whensettotrue,thegroupofsimulationswillberunas
partofthepredictionscalculation.
Version :3.2.1
Type:Boolean
Access:Read
GLOBALSCALINGFACTOR Globaltrafficdensitiesweighting.
Version :3.2.1
Type:Single
Access:Read/Write
143
11.6 UMTSSimulationGroupProperties
Typereturnedbyget_ObjectKind:{AF5E2B981D5448FA89C58BFA2936ABF2}
ThefollowingpropertiesareaccessibleforaUMTSMonteCarlosimulationgroup.
GENERATORINITIALISATION
Theseedofthepseudorandomnumbergenerator,used
toobtaintwoidenticaluserdistributions.
Version :3.2.1
Type:Integer
Access:Read/Write
MAXNUMBEROFITERATIONS
Themaximumnumberofiterationsiftheconvergence
criteriacannotbereached.
Version :3.2.1
Type:Integer
Access:Read/Write
ULCONVERGENCETHRESHOLD
(forSingleRATdocuments)
GSMULCONVERGENCETHRESHOLD
(for3GPPMultiRATdocuments)
TheULrelativeinterferencedifferencetoreachbetween
twoiterativesteps.
Version :3.2.1
Type:Single
Access:Read/Write
DLCONVERGENCETHRESHOLD
(forSingleRATdocuments)
GSMDLCONVERGENCETHRESHOLD
(for3GPPMultiRATdocuments)
TheDLrelativeinterferencedifferencetoreachbetween
twoiterativesteps.
Version :3.2.1
Type:Single
Access:Read/Write
ULCONVERGENCEINTERFERENCES
TheULnoiseriserelativeinterferencetoreachbetween
twoiterativesteps.
Version :3.2.1
Type:Single
Access:Read/Write
DLCONVERGENCEPWRCTRLGAIN
ThepowercontrolgaindifferencetoreachDLbetween
twoiterativesteps.
Version :3.2.1
Type:Single
Access:Read/Write

TRAFFICMAPS Thenamesofthetrafficmapsusedbyasimulationgroup.
Type:ArrayofStrings
Access:Read/Write
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
Version :2.7.1
Type:Single
Access:Read/Write
Theseedofthepseudorandomnumbergenerator,usedto
obtaintwoidenticaluserdistributions.
Version :2.7.1
Type:Integer
Access:Read/Write
144
11.7 WiMAXandLTESimulationGroupProperties
Typereturnedbyget_ObjectKind:{AF5E2B981D5448FA89C58BFA2936ABF2}
ThefollowingpropertiesareaccessibleforaWiMAXorLTEMonteCarlosimulationgroup.
Version :2.7.1
Type:Integer
Access:Read/Write
twoiterativesteps.
Version :2.7.1
Type:Single
Access:Read/Write
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

TRAFFICMAPS Thenamesofthetrafficmapsusedbyasimulationgroup.
Version :2.8.1
Type:ArrayofStrings
Access:Read/Write
SUBSCRIBERLISTS
Thenamesofthesubscriberlistsusedbyasimulations
group.
Version :2.8.1
Type:ArrayofStrings
Access:Read/Write
145
11.8 3GPPMultiRATSimulationGroupProperties
Thefollowingpropertiesareaccessiblefora3GPPMultiRATsimulationgroup.
Ina3GPPMultiRATdocument,youcanaccessallthepropertieswehaveforallthetechnologiesavailableinyourdocument,
exceptULCONVERGENCETHRESHOLDandDLCONVERGENCETHRESHOLDwhichareprefixedwiththetechnologyname.
Version :2.8.1
Type:Integer
Access:Read/Write
EXECUTELATER
Version :2.8.1
Type:Boolean
Access:Read
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 BackhaulCapacity
Version :3.2.1
Type:Boolean
Access:Read/Write
NOISERISECONTROL NoiseRiseControl
Version :3.2.1
Type:Boolean
Access:Read/Write
146
11.9 PropagationModelProperties
TheTypereturnedbyget_ObjectKindforthePropagationModelsfolder:{4A2D160B7D114D0792DFA3CF6B68D402}
get_ObjectKindisaccessibleforthePropagationModelsfolderforversion 2.7.0.
TheTypereturnedbyget_ObjectKindfortheStandardPropagationModel:Atoll.StdPropagModel.1
get_ObjectKindisaccessiblefortheStandardPropagationModelforversion 2.7.0.
TheStandardPropagationModelpropertiesarecalledMODELPROPERTIES.
ThefollowingMODELPROPERTIESareavailablefortheStandardPropagationModel:
GSMULCONVERGENCETHRESHOLD
ForGSMtechnology:
twoiterativesteps.
Version :3.2.1
Type:Single
Access:Read/Write
GSMDLCONVERGENCETHRESHOLD
ForGSMtechnology:
twoiterativesteps.
Version :3.2.1
Type:Single
Access:Read/Write
UMTSULCONVERGENCETHRESHOLD
ForUMTStechnology:
twoiterativesteps.
Version :3.2.1
Type:Single
Access:Read/Write
UMTSDLCONVERGENCETHRESHOLD
ForUMTStechnology:
twoiterativesteps.
Version :3.2.1
Type:Single
Access:Read/Write
LTEULCONVERGENCETHRESHOLD
ForLTEtechnology:
twoiterativesteps.
Version :3.2.1
Type:Single
Access:Read/Write
LTEDLCONVERGENCETHRESHOLD
ForLTEtechnology:
twoiterativesteps.
Version :3.2.1
Type:Single
Access:Read/Write
Name Attributes
MODELPROPERTIES
Thepropertycontainerholdingthepropagationmodelparameters
Version :2.7.0
EFFECTIVEANTENNAHEIGHTMETHO
D
Version :2.7.0
Type:Integer
Access:Read/Write
EFFECTIVEANTENNAHEIGHTDISTANC
EMIN
Version :2.7.0
Type:Double
Access:Read/Write
147
EFFECTIVEANTENNAHEIGHTDISTANC
EMAX
Version :2.7.0
Type:Single
Access:Read/Write
DIFFRACTIONMETHOD
Version :2.7.0
Type:Integer
Access:Read/Write
CLUTTERLOSSES
LossforeachclutterclassdefinedintheAtolldocument.
Whentherearenoclutterclasses,theNullvalueis
returned,otherwisethesizeofthereturnedarrayisthe
numberofclutterclassesdefinedintheAtolldocument.
Version :2.7.0
Type:ArrayofSingle
Access:Read/Write
CLUTTERCLEARANCES
ClearanceforeachclutterclassdefinedintheAtoll
document.Whentherearenoclutterclasses,theNullvalue
isreturned,otherwisethesizeofthereturnedarrayisthe
numberofclutterclassesdefinedintheAtolldocument.
Version :2.7.0
Type:ArrayofSingle
Access:Read/Write
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
148
11.10 CWMeasurementProperties
TheTypereturnedbyget_ObjectKindfortheCWMeasurementsfolder:SID_CW_MEASUREMENTS
ThefollowingpropertiesareaccessiblefortheCWMeasurementsfolder:
TheTypereturnedbyget_ObjectKindforaCWMeasurementssubfolder:MeasureTx
ThefollowingpropertiesareaccessibleforaCWMeasurementssubfolder:
TheTypereturnedbyget_ObjectKindforaCWMeasurementsitem:MeasureItem
ThefollowingpropertiesareaccessibleforaCWMeasurementsitem:
CONSIDERCLUTTERHEIGHTSINDIFFR
ACTION
Version :2.7.0
Type:Integer
Access:Read/Write
HILLYTERRAINCORRECTION
Version :2.7.0
Type:Integer
Access:Read/Write
CLUTTERRECEIVERHEIGHTS
Heightofthereceiverforeachclutterclassdefinedinthe
Atolldocument.Whentherearenoclutterclasses,theNull
valueisreturned,otherwisethesizeofthereturnedarrayis
thenumberofclutterclassesdefinedintheAtolldocument.
Version :2.7.0
Type:ArrayofSingle
Access:Read/Write
LIMITATIONTOFREESPACELOSS
Version :2.7.0
Type:Integer
Access:Read/Write
RECEIVERONTOPOFCLUTTER
Version :2.7.0
Type:Integer
Access:Read/Write

VECTORDATAFILTER
Advancedvectortablefilter,asitappearsinCW
Measurementsfoldersproperties.
Type:String
Access:Read/Write
VECTORDATAFILTER
Measurementssubfolderproperties.
Type:String
Access:Read/Write
VECTORDATAFILTER
Measurementsitemproperties.
Type:String
Access:Read/Write
PREDICTIONMODEL Nameofapropagationmodel.
Type:String
Access:Read/Write
HEADER
Type:String
Access:Read/Write
TRANSMITTERNAME Nameofatransmitter.
Type:String
Access:Read/Write
TRANSMITTERFREQUENCY
Type:Single
Access:Read/Write
RECEIVERHEIGHT
Type:Single
Access:Read/Write
149
11.11 DriveTestDataProperties
TheTypereturnedbyget_ObjectKindforaDriveTestDataitem:NumMeasureItem
ThefollowingpropertiesareaccessibleforaDriveTestDataitem:
11.12 CustomChildFolderObjectProperties
TheTypereturnedbyget_ObjectKindforacustomChildFolderobjectistheversiondependentPROGIDofthecustomChild
Folderobject.
get_ObjectKindisaccessibleforthecustomChildFolderobjectsforversion 2.7.0.
ThefollowingpropertiesareaccessibleforacustomChildFolderobject.
RECEIVERGAIN
Type:Single
Access:Read/Write
RECEIVERLOSSES
Type:Single
Access:Read/Write
VECTORDATA Tablecontentofthemeasurementpath. Type:TabularDataobject
TECHNOLOGYNAME Technologyname:"UMTS","LTE",or"GSM"
Version :3.1.1
Type:String
Access:Read/Write

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. Type:TabularDataobject
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
150
11.13 MasterLinkProperties
MasterLinkChildFolderobjectsarelocatedastoplevelitemsineithertheDatatabortheGeotabofthedocumentexplorer
window. They are used to specify links from one ChildFolder object to another ChildFolder object (the target ChildFolder
object),locatedinanotherDocumentobject(thetargetDocumentobject).
TheTypereturnedbyget_ObjectKindforMasterLinkChildFolderobjectsis:
{16A53FB3- A961- 4EEA- 8C30- 2387DBF1CC24}
ThefollowingpropertiesareaccessibleforMasterLinkChildFolderobjects.
11.14 LinkProperties
LinkChildFolderobjectsarechildrenofMasterLinkChildFolderobjects.
TheTypereturnedbyget_ObjectKindforLinkChildFolderobjectsis:
{232BDB73- A68F- 41A6- A954- 75112D907BBF}
ThefollowingpropertiesareaccessibleforLinkChildFolderobjects.
11.15 VectorLayerProperties
ThefollowingpropertiesareaccessibleforVectorLayerChildFolderobjects.
11.15.1 DisplayProperties
Displaypropertiesforvectorlayersareaccessedthroughapropertynamed"DISPLAYPROPERTIES."The"DISPLAYPROPERTIES
"propertyisacontainerobjectusedtocontainindividualdisplayproperties.
COMMENT
ThecommentstringassociatedwiththecustomChildFolder
object.
Version :3.2.1
Type:String
Access:Read/Write

TARGET
ThetargetChildFolderobject.
TheNullvalueisreturnedwhenthetargetDocumentobject
isnotopenedinthecurrentsession.
Type:Object,orNull
value.
Access:Read
TARGETDOCUMENTFULLNAME
Thefullpathtothetargetdocument.ATLfile.
Anerrorisreturnedwhenthetargetfilecannotbelocated.
Type:String
Access:Read
TARGET
ThetargetChildFolderobject.
TheNullvalueisreturnedwhenthetargetDocumentobject
isnotopenedinthecurrentsession.
Type:Object,orNull
value.
Access:Read
VECTORDATA Thevectortableofthevectorlayer.
Version :3.2.1
Type:TabularData
object
DISPLAYPROPERTIES Thevectorlayerdisplayproperties.
Version :2.7.0
Type:
PropertyContainer
object
151
Thepropertiesavailableinthe"DISPLAYPROPERTIES"propertycontainerare,forallkindsofvectorlayers:
REPRESENTATIONtabulardataobject
The"REPRESENTATION"tabulardataobjectcontainsattributesofintervalsorvaluesusedtodisplaythevectorlayeronthe
map.Thistabulardataobjectcanbeeditedtochange,remove,oradddisplayintervalsordisplayvalues.
The"REPRESENTATION"tabulardataobjectisavailableasa"DISPLAYPROPERTIES"propertynamed"REPRESENTATION"
Theschemaofthe"REPRESENTATION"tabulardataobjectis:
ConvertingIntegerstoRGBandViceversa
ToconvertIntegertoRGBcolorcomponents:
DISPLAYPROPERTIES
PropertyName
Attributes
REPRESENTATION
Version :3.2.1
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 142.
Version :3.2.1
Type:Integer
Access:Read/Write
SECONDARYCOLOR
Thesecondarycolorassignedtothedisplayintervalorthe
displayvalue.ThecolorformatisRGB.
page 142.
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
152
ToconvertRGBcolourcomponentstoInteger:
OtherDISPLAYPROPERTIESproperties
11.16 UserDensityTrafficMapProperties
AuserdensitytrafficmapisaparticulartypeoftrafficmapavailableinAtoll.Userdensitytrafficmapsareavailableinthe
trafficmapsfolderofthedocument.
TheTypereturnedbyget_ObjectKindfortheTrafficMapsfolderis:{B3B25A07A9944E8dBBD151556D6C4245}
TheTypereturnedbyget_ObjectKindforaUserDensityTrafficMapis:{2984F32FF7374250A6C07439E249D039}
ThefollowingpropertiesareavailableforUserDensityTrafficMaps:
Di mRed
Di mGr een
Di mBl ue
Let Red = ( col or And &HFF)
Let Gr een = ( ( col or \ 256) And &HFF)
Let Bl ue = ( ( col or \ 65536) And &HFF)
Di mcol or
Let col or = ( Red + Gr een * 256 + Bl ue * 65536)
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

DISTRIBUTIONPERSERVICE
ATabularDataObjectusedtoaccessthetrafficdistribution
perservice,inpercentage.
Version :3.2.1
Type:TabularData
Object
Access:Readonly
DISTRIBUTIONPERTERMINAL
ATabularDataObjectusedtoaccessthetrafficdistribution
perterminal,inpercentage.
Version :3.2.1
Type:TabularData
Object
Access:Readonly
DISTRIBUTIONPERMOBILITY
ATabularDataObjectusedtoaccessthedistributionper
mobility,inpercentage.
Version :3.2.1
Type:TabularData
Object
Access:Readonly
153
DISTRIBUTIONPERCLUTTERCLASS
ATabularDataObjectusedtoaccesstheindoortraffic
distributionperclutterclass,inpercentage.
Version :3.2.1
Type:TabularData
Object
Access:Readonly
ACTIVITYSTATUS
Anintegerusedtoaccesstheuserdensitytrafficmap
activitystatus.Availablevaluesare:
0:Uplink
1:Downlink
2:Uplink/Downlink
3:Inactive
4:Allactivitystatuses
Version :3.2.1
Type:Integer
Access:Read/Write
154
Chapter12
ChildFolderFeature
Objects
156
AT321_TAG_E2 Chapter12:ChildFolderFeatureObjects
157
12 ChildFolderFeatureObjects
FeatureobjectsofferfeaturescloselytiedtosomeAtolldocumentfolders.ThefollowingChildFolderFeatureobjectsareavail
ablethroughtheDispatchpropertyofChildFolderobjectsofAtolldocumentfolders:
"ClutterFeatureObject"onpage 157,
"TrafficFeatureObject"onpage 160,
"UMTSTrafficScenarioProviderObject"onpage 163,
"EnvironmentBasedTrafficMapFeatureObject"onpage 165,
"SimulationFeatureObject"onpage 167,
"SimulationGroupFeatureObject"onpage 170.
12.1 ClutterFeatureObject
TheClutterFeatureobjectgivesaccesstoclutterclassesproperties.ItisavailableforallAtolldocuments.Itisassociatedwith
theClutterClassesfolderofanAtolldocument.
TheClutterFeatureobjectprovidesthefollowingpropertiesandmethods:
12.1.1 HowtoAccesstheClutterFeatureObject
TheObjectKindpropertyfortheClutterClassesfolderis:
{7CB51DE8- A961- 11D2- 8688- 0060086457D1}
SamplecodetoaccesstheClutterFeatureobject:
12.1.2 get_Source
ReturnstheClutterClassesChildFolderobject.
Parameters
[out]ppSource:AddressoftheIDispatchinterfacepointerusedtoreturntheClutterClassesChildFolderobject.
get_Source ReturnstheClutterClassesChildFolderobject.
get_ClassAttributes ReturnsaTabularDataobjectholdingtheclutterclassattributes.
get_DefaultAttributes
ReturnsaTabularDataobjectholdingtheclutterclassdefault
values.
Ret ur ns t he cl ut t er f eat ur e obj ect of t he doc At ol l document obj ect
Publ i c Funct i on Cl ut t er Feat ur eObj ect ( doc)
Const OBJ ECTKI ND_CLUTTER = "{7CB51DE8- A961- 11D2- 8688- 0060086457d1}"
Const at oGeo = 1
Di moCl ut t er Cl asses
Set oCl ut t er Cl asses = doc. Get Root Fol der ( at oGeo) . I t em( OBJ ECTKI ND_CLUTTER)
Set Cl ut t er Feat ur eObj ect = oCl ut t er Cl asses. Di spat ch
End Funct i on
HRESULT get _Sour ce( I Di spat ch **ppSour ce) ;
158
Chapter12:ChildFolderFeatureObjects Forsk2014
12.1.3 get_ClassAttributes
ReturnsaTabularDataobjectholdingtheclutterclassattributes.
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.
Parameters
[out]ppTable:AddressoftheITabularDatainterfacepointerusedtoreturntheclutterclassdefaultvalues.Thecontentofthe
TabularDataobjectreturnedisthesameasthecontentofthe"DefaultValues"propertypagefortheClutterClassesfolderof
anAtolldocument,itisdependentonthetypeoftheprojecttemplateusedbytheAtolldocument.
12.1.5 AccessingClutterClassAttributes
SamplemacrotooutputthevariousclutterclassattributestotheAtolleventviewer:
HRESULT get _Cl assAt t r i but es( I Tabul ar Dat a **ppTabl e) ;
HRESULT get _Def aul t At t r i but es( I Tabul ar Dat a **ppTabl e) ;

Pr i vat e Funct i on Cl ut t er Feat ur eObj ect ( doc)
Const OBJ ECTKI ND_CLUTTER = " {7CB51DE8- A961- 11D2- 8688- 0060086457d1}"
Const at oGeo = 1
Di moCl ut t er Cl asses
Set oCl ut t er Cl asses = doc. Get Root Fol der ( at oGeo) . I t em( OBJ ECTKI ND_CLUTTER)
Set Cl ut t er Feat ur eObj ect = oCl ut t er Cl asses. Di spat ch
End Funct i on
Pr i vat e Sub DumpTabl e( t )
159
Di mc
Di mr
Di mval ues( )
For r = 0 To t . RowCount
Redi mval ues( t . Col umnCount )
For c = 0 To t . Col umnCount
val ues( c) = t . Get Val ue( r , c)
I f I sNul l ( val ues( c) ) Then
val ues( c) = " ( Nul l ) "
End I f
I f I sEmpt y( val ues( c) ) Then
val ues( c) = " ( Empt y) "
End I f
I f I sAr r ay( val ues( c) ) Then
val ues( c) = " ( Ar r ay) "
End I f
Next
LogMessage J oi n( val ues, "; " )
Next
End Sub
Publ i c Sub DumpCl ut t er At t r i but es
Di mf
Set f = Cl ut t er Feat ur eObj ect ( Act i veDocument )
Di mcl assat t r s
Di mdef aul t at t r s
Set cl assat t r s = f . Cl assAt t r i but es
LogMessage "Cl ut t er Cl ass At t r i but es. . . "
DumpTabl e( cl assat t r s)
LogMessage "End Cl ass At t r i but es. "
Set def aul t at t r s = f . Def aul t At t r i but es
LogMessage "Cl ut t er Cl ass Def aul t At t r i but es. . . "
DumpTabl e( def aul t at t r s)
LogMessage "End Cl ut t er Cl ass Def aul t At t r i but es. "
160
12.2 TrafficFeatureObject
TheTrafficFeatureobjectgivesaccesstofeaturesassociatedwiththetrafficfolder,suchastheexportofthecumulatedtraf
fic.ItisavailableforallAtolldocumentsexceptMicrowaveLinksdocuments.ItisassociatedwiththeTrafficfolderofanAtoll
document.
TheTrafficFeatureobjectprovidesthefollowingpropertiesandmethods:
12.2.1 HowtoAccesstheTrafficFeatureObject
TheObjectKindpropertyfortheTrafficfolderis:
{B3B25A07- A994- 4E8D- BBD1- 51556D6C4245}
SamplecodetoaccesstheTrafficFeatureObject:
12.2.2 get_Source
ReturnstheTrafficChildFolderobject.
Parameters
[out]ppSource:AddressoftheIDispatchinterfacepointerusedtoreturntheTrafficChildFolderobject.
12.2.3 get_ScenarioProvider
CreatesanewTrafficScenarioProviderobjectinstance.See"UMTSTrafficScenarioProviderObject"onpage 163formore
informationontheUMTSTrafficScenarioProviderobject.
End Sub
get_Source ReturnstheTrafficChildFolderobject.
get_ScenarioProvider CreatesanewTrafficScenarioProviderobjectinstance.
ExportCumulatedTraffic Exportsthecumulatedtraffic.
HasTrafficForService
Determinesifatrafficmapcontainstrafficinformationforagiven
service.
' Ret ur ns t he t r af f i c f eat ur e obj ect of t he doc At ol l document obj ect
Publ i c Funct i on Tr af f i cFeat ur eObj ect ( doc)
Const OBJ ECTKI ND_TRAFFI C = " {B3B25A07- A994- 4E8D- BBD1- 51556D6C4245}"
Const at oGeo = 1
Di moTr af f i c
Set oTr af f i c = doc. Get Root Fol der ( at oGeo) . I t em( OBJ ECTKI ND_TRAFFI C)
Set Tr af f i cFeat ur eObj ect = oTr af f i c. Di spat ch
End Funct i on
HRESULT get _Scenar i oPr ovi der ( I Tr af f i cScenar i oPr ovi der **ppPr ovi der ) ;
161
Parameters
[out] ppProvider: Address of the ITrafficScenarioProvider interface pointer used to return a new Traffic Scenario Provider
objectinstance.
Remarks
AnerrorisreturnedwhenthismethodiscalledforanAtolldocumentnotbasedontheUMTSHSPAtemplate.
12.2.4 ExportCumulatedTraffic
Exportsthecumulatedtraffic.
Parameters
[in]bstrFileName:
ABSTRusedtospecifytheabsolutefilepathusedtoexportthecumulatedtraffic.TheBILfileformatisusedtoexportthe
cumulatedtraffic.
[in]atoRegion:
t ypedef enum_At oRegi on
{
at oEnt i r ePr oj ect Ar ea = 0,
at oComput at i onZone = 1
} _At oRegi on;
t ypedef _At oRegi on At oRegi on;
t ypedef enum_At oDi r ect i on
{
at oUpl i nkDownl i nk = 0,
at oUpl i nk = 1,
at oDownl i nk = 2,
} _At oDi r ect i on;
t ypedef _At oDi r ect i on At oDi r ect i on;
HRESULT Expor t Cumul at edTr af f i c(
BSTR bst r Fi l eName,
enum_At oRegi on at oRegi on,
BSTR bst r Ter mi nal ,
BSTR bst r Mobi l i t y,
BSTR bst r Ser vi ce,
VARI ANT vTr af f i cMaps,
l ong l Resol ut i on,
enum_At oDi r ect i on at oDi r ect i on
) ;
162
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 HasTrafficForService
Determinesifatrafficmapcontainstrafficinformationforagivenservice.
Parameters
[in]bstrServiceName:
ABSTRusedtospecifytheaservicename.
[in]at oDi r ect i on:
AnAtoDirectionenumerationvalueusedtospecifythekindoftraffictolookfor:
atoUplinkDownlink(=0):Uplinkanddownlinktraffic
atoUplink(=1):Uplinktraffic
atoDownlink(=2):Downlinktraffic
[in]pTr af f i cMap:
AIChildFolderinterfacepointerusedtospecifythetrafficmapChildFolderobject.Thetrafficmapissearchedfortrafficinfor
mationrelatedtothebstrServiceNameservice.
ThisparametermaybeNULL.Inthiscase,alltrafficmapsinthetrafficmapfolderaresearched.
HRESULT HasTr af f i cFor Ser vi ce(
BSTR bst r Ser vi ceName,
enum_At oDi r ect i on at oDi r ect i on,
I Chi l dFol der * pTr af f i cMap,
VARI ANT_BOOL* pHasTr af f i c
) ;
163
[out]pHasTr af f i c:
ApointertoaVARIANT_BOOLvalueusedtoreturnwhetherthetrafficmapspecifiedbypTrafficMap has some t r af -
f i c i nf or mat i on f or t he ser vi ce speci f i ed 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:
12.3.1 GetMeanSize
Returnstheaveragecountofmobiles.
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.
GetMeanSize Returnstheaveragecountofmobiles.
Create Createsrawmobiledata.
HRESULT Get MeanSi ze(
const VARI ANT aSel ect edMapsNames,
doubl e dScal e,
const VARI ANT aReser ved,
ULONG *pMobi l esCount
) ;
164
Parameters
[in]aSelectedMapsNames:
A VARIANT valueused tospecifythenamesof the traffic maps. The type of the VARIANT must be VT_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:
HRESULT Cr eat e(
const VARI ANT aSel ect edMapsNames,
doubl e dScal e,
enumAt oTr af f i cScenar i oLaw aLaw,
const VARI ANT aRr eser ved,
I Tabul ar Dat a **ppMobi l es
) ;
ColumnName Value Type Description
X Xcoordinate Long Expressedinthedocumentprojectioncoordinatesystem
Y 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"
165
12.4 EnvironmentBasedTrafficMapFeatureObject
Userprofileenvironmentbasedtrafficmapfeatureobjectsgiveaccesstouserprofileenvironmentbasedtrafficmapsattrib
utes. They are available forall Atolldocumentsexcept Microwave Linksdocuments. They are associatedwithuser profile
environmentbasetrafficmapscontainedintheTrafficfolderofanAtolldocument.
TheUserProfileEnvironmentBasedTrafficMapFeatureobjectprovidesthefollowingpropertiesandmethods:
12.4.1 HowtoAccessEnvironmentBasedTrafficMapFeature
Objects
TheObjectKindpropertyforUserProfileEnvironmentBasedTrafficMapsis:
{E8784A75- AE03- 4F4F- B923- 6E8BF20725C5}
TheUserProfileEnvironmentBasedTrafficMapFeatureobjectforauserprofileenvironmentbasedtrafficmapisreturned
bytheDispatchpropertyoftheuserprofileenvironmentbasedtrafficmapChildFolderobject.
12.4.2 get_Source
ReturntheUserProfileEnvironmentBaseTrafficMapChildFolderobjectassociatedwiththeUserProfileEnvironmentBased
TrafficMapFeatureObject.
Parameters
[out] ppSource: Address of the IDispatch interface pointer used to return the User Profile Environment Based Traffic Map
ChildFolderObject.
12.4.3 get_ClassAttributes
ReturnsaTabularDataobjectholdingtheuserprofileenvironmentbasedtrafficmapattributes.
Parameters
[out]ppTable:AddressoftheITabularDatainterfacepointerusedtoreturntheuserprofileenvironmentbasedtrafficmap
attributes.ThecontentoftheTabularDataobjectisthesameastheoneshownonthe"Description"propertypageofuser
profileenvironmentbasedtrafficmapspropertysheet.
12.4.4 get_DefaultAttributes
Remarks
Thismethodisnotimplemented.Pleasedontusethismethod.
get_Source
ReturntheTrafficMapChildFolderobjectassociatedwiththe
TrafficMapperEnvironmentFeatureobject.
get_ClassAttributes
ReturnsaTabularDataobjectholdingthetrafficmapenvironment
attributes.
get_DefaultAttributes Notimplemented
HRESULT get _Cl assAt t r i but es( I Tabul ar Dat a **ppTabl e) ;
HRESULT get _Def aul t At t r i but es( I Tabul ar Dat a **ppTabl e) ;
166
12.4.5 AccessingEnvironmentBasedTrafficMapsAttributes
Pr i vat e Funct i on Tr af f i cMapPer Envi r onment Feat ur eObj ect s( doc)
Const SI D_TRAFFI CFOLDER = " {B3B25A07- A994- 4E8D- BBD1- 51556D6C4245}"
Const OKI ND_MAP_PER_ENVI RONMENT =" {E8784A75- AE03- 4F4F- B923- 6E8BF20725C5}"
Const at oGeo = 1
Di mmaps( )
Di moTr af f i cFol der
Set oTr af f i cFol der = doc. Get Root Fol der ( at oGeo) . I t em( SI D_TRAFFI CFOLDER)
I f Er r Then
On Er r or Got o 0
El se
On Er r or Got o 0
Di mi
Di mn
n = 0
For i = 0 To oTr af f i cFol der . Count - 1
Di mmap
Set map = oTr af f i cFol der . I t em( i )
I f map. Obj ect Ki nd = OKI ND_MAP_PER_ENVI RONMENT Then
Redi mPr eser ve maps( n)
Set maps( n) = map. Di spat ch
n = n + 1
End I f
Next
End I f
Tr af f i cMapPer Envi r onment Feat ur eObj ect s = maps
End Funct i on
Di mc
Di mr
Di mval ues( )
167
12.5 SimulationFeatureObject
SimulationFeatureobjectsgiveaccesstosimulationresults.TheyareassociatedwithSimulationChildFolderobjects.
End I f
End I f
End I f
Next
Next
End Sub
Publ i c Sub DumpTr af f i cMapPer Envi r onment At t r i but es
Di mmaps
maps = Tr af f i cMapPer Envi r onment Feat ur eObj ect s( Act i veDocument )
Di moFeat ur e
For Each oFeat ur e I n maps
LogMessage " Tr af f i c Map Per Envi r onment [ " & oFeat ur e. Sour ce. Name &
" ] . . . "
Di mat t r s
Set at t r s = oFeat ur e. Cl assAt t r i but es
DumpTabl e( at t r s)
LogMessage " End Tr af f i c Map Per Envi r onment . "
Next
End Sub
168
SimulationFeatureobjectsareavailableinAtolldocumentsbasedonthetemplates:
UMTSHSPA
LTE
CDMA20001xRTT1xEVDO
WiMAX802.16e
TDSCDMA
TheSimulationFeatureobjectprovidesthefollowingpropertiesandmethods:
12.5.1 HowtoAccessSimulationFeatureObjects
TheObjectKindpropertyfortheSimulationChildFolderobjectsis:
{095C5D90- 96F1- 4BA8- 85BB- B2F990AC2DD9}
SimulationChildFolderobjectsarechildofSimulationGroupsChildFolderobjects.
SimulationFeatureobjectsareavailablethroughtheDispatchpropertyofSimulationChildFolderobjects:
12.5.2 get_Source
ReturnstheassociatedSimulationChildFolderobject.
Parameters
[out]ppSource:AddressoftheIDispatchinterfacepointerusedtoreturntheassociatedSimulationChildFolderobject.
Remarks
ForaSimulationFeatureobjectreturnedbyaSimulationGroupFeatureobjectmethod,thereisnoassociatedChildFolder
object,andthebehaviourofthismethodisundefined.
12.5.3 get_Statistics
Returnsa TabularData objectholding the results as presented in the "Statistics"property page ofthe simulation property
sheet.
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.
Di moSi mul at i on
Di moSi mul at i onChi l dFol der
Set oSi mul at i on = oSi mul at i onChi l dFol der . Di spat ch
169
Remarks
12.5.4 get_Cells
ReturnsaTabularDataobjectholdingtheresultsaspresentedinthe"Cells"propertypageofthesimulationpropertysheet.
Parameters
[out]ppResults:AddressoftheITabularDatainterfacepointerusedtoreturnthe"Cells"simulationresults.
12.5.5 get_Sites
ReturnsaTabularDataobjectholdingtheresultsaspresentedinthe"Sites"propertypageofthesimulationpropertysheet.
Parameters
[out]ppResults:AddressoftheITabularDatainterfacepointerusedtoreturnthe"Sites"simulationresults.
12.5.6 get_Mobiles
Returns a TabularData object holding the results as presented in the "Mobiles" property page of the simulation property
sheet.
Parameters
[out]ppResults:AddressoftheITabularDatainterfacepointerusedtoreturnthe"Mobiles"simulationresults.
Remarks
ThecontentoftheTabularDataobjectreturneddependsonthe"Informationtoretain"settingofthesimulation.Inparticular,
whentheinformationtoretainis"NoInformationAboutMobiles",thenumberofmobilesreturnedintheTabularDataobject
is0.
Allmobilesarereturned,thefocuszoneisnottakenintoaccount.
12.5.7 get_Results
ReturnsaTabularDataobjectholdingtherequiredresults.
Parameters
[in]aType:AnAtoSimulationResultsTypeenumerationvalue,usedtospecifythesimulationresultstoreturn.
Enumerationvaluesare:
HRESULT get _St at i st i cs( I Tabul ar Dat a **ppTabl e) ;
HRESULT get _Cel l s( I Tabul ar Dat a **ppResul t s) ;
HRESULT get _Si t es( I Tabul ar Dat a **ppResul t s) ;
HRESULT get _Mobi l es( I Tabul ar Dat a **ppResul t s) ;
HRESULTget_Results(enumAt oSi mul at i onResul t sType aType, I Tabul ar Dat a **ppResul t s) ;
170
[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:
12.6.1 HowtoAccessSimulationGroupFeatureObjects
TheObjectKindpropertyforGroupofSimulationsfolderis:
{AF5E2B98- 1D54- 48FA- 89C5- 8BFA2936ABF2}
SamplecodetoaccessSimulationGroupFeatureobjects:
atoSimulationResultsStatistics 0 Returns a TabularData object holding the results as presented in the
"Statistics"propertypageofthesimulationpropertysheet.
atoSimulationResultsCells 1 Returns a TabularData object holding the results as presented in the
"Cells"propertypageofthesimulationpropertysheet.
atoSimulationResultsSites 2 Returns a TabularData object holding the results as presented in the
"Sites"propertypageofthesimulationpropertysheet.
atoSimulationResultsMobiles 3 Returns a TabularData object holding the results as presented in the
"Mobiles"propertypageofthesimulationpropertysheet.
atoSimulationResultsGsmSubCells 100 Returns a TabularData object holding the results as presented in the
"SubCells"propertypageofthesimulationpropertysheet.
atoSimulationResultsGsmTRXs 101 Returns a TabularData object holding the results as presented in the
"TRXs"propertypageoftheGSMsimulationpropertysheet.
get_Source
ReturnstheassociatedSimulationGroupChildFolder
object.
get_Statistics
ReturnsaTabularDataobjectholdingthestatisticsofthe
simulationgroup.
get_MeanSimulation
ReturnsaSimulationFeatureobjectgivingaccesstothe
averagesimulationproperties.
get_StdDevSimulation
ReturnsaSimulationFeatureobjectusedtoaccessthe
standarddeviationsimulationproperties.
Ret ur ns Tr ue i f t her e i s at l east one gr oup of si mul at i ons i n doc ,
Fal se ot her wi se
Par ams:
[ i n] doc : At ol l document obj ect
[ out ] ar r ay: Ar r ay of si mul at i on gr oup f eat ur e obj ect s
171
Pr i vat e Funct i on Si mul at i onGr oupFeat ur eObj ect s( doc, ByRef ar r ay)
Const OBJ ECTKI ND_SI MULATI ONS = " {CDDF1E1D- 1963- 4D80- A057- D23A19570984}"
Const OBJ ECTKI ND_SI MULATI ONGROUP = " {AF5E2B98- 1D54- 48FA- 89C5-
8BFA2936ABF2}"
Const at oDat a = 0
Di moSi mul at i ons
oSi mul at i ons i s t he " Si mul at i ons" Chi l dFol der obj ect
Set oSi mul at i ons =doc. Get Root Fol der ( at oDat a) . I t em( OBJ ECTKI ND_SI MULATI ONS)
I f Er r Then
Ther e i s no " Si mul at i ons" f ol der
On Er r or Got o 0
Si mul at i onGr oupFeat ur eObj ect s = Fal se
Exi t Funct i on
End I f
On Er r or Got o 0
I f oSi mul at i ons. Count = 0 Then
Exi t Funct i on
End I f
Redi mar r ay( oSi mul at i ons. Count - 1)
Di moSi mul at i onGr oup
Di mn
n = 0
" Si mul at i on Gr oup" Chi l dFol der obj ect s ar e l ocat ed
i n t he " Si mul at i ons" f ol der
For Each oSi mul at i onGr oup I n oSi mul at i ons
I f oSi mul at i onGr oup. Obj ect Ki nd = OBJ ECTKI ND_SI MULATI ONGROUP Then
Set ar r ay( n) = oSi mul at i onGr oup. Di spat ch
n = n + 1
End I f
Next
Si mul at i onGr oupFeat ur eObj ect s = Tr ue
End Funct i on
172
12.6.2 get_Source
ReturnstheassociatedSimulationGroupChildFolderobject.
Parameters
[out]ppSource:AddressoftheIDispatchinterfacepointerusedtoreturntheassociatedSimulationGroupChildFolderobject.
ReturnsaTabularDataobjectholdingthestatisticsofthesimulationgroup.
Remarks
12.6.4 get_MeanSimulation
ReturnsaSimulationFeatureobjectgivingaccesstotheaveragesimulationproperties.
Parameters
[out]ppMeanValues:AddressoftheISimulationinterfacepointerusedtoreturntheSimulationFeatureobjectcorresponding
totheaveragesimulation.
Remarks
ThereturnedSimulationFeatureobjectisnotassociatedwithaparticularChildFolderobjectintheAtolldocument.
Anerrorisreturnedwhennosimulationinthesimulationgrouphasconverged.Theaveragesimulationisnotavailablewhen
nosimulationinthesimulationgrouphasconverged.
Anerrorisreturnedwhenthesimulationgrouphasnotbeencalculatedyet,forinstancewhenthesimulationgrouphasbeen
createdwiththecheckbox"ExecuteLater"set.
12.6.5 get_StdDevSimulation
ReturnsaSimulationFeatureobjectusedtoaccessthestandarddeviationsimulationproperties.
[out]ppStdDevValues:AddressoftheISimulationinterfacepointerusedtoreturntheSimulationFeatureobjectcorrespond
ingtothestandarddeviationsimulation.
Remarks
Anerrorisreturnedwhennosimulationinthesimulationgrouphasconverged.Thestandarddeviationsimulationisnotavail
ablewhennosimulationinthesimulationgrouphasconverged.
AnerrorisreturnedwhentheAtolldocumentisbasedontheLTE,WiMAX802.16etemplates.Thestandarddeviationsimu
lationisnotavailableforLTEandWiMAX.
HRESULT get _St at i st i cs( I Tabul ar Dat a **ppTabl e) ;
HRESULT get _MeanSi mul at i on( I Si mul at i on **ppMeanVal ues) ;
HRESULT get _St dDevSi mul at i on( I Si mul at i on **ppSt dDevVal ues) ;
173
12.6.6 AccessingMobiles,Cells,Sites,forSimulationsandSimula
tionGroups
HereisasamplemacrousedtodisplaythevariousavailableresultsforsimulationgroupsandsimulationsintheAtollevent
viewer,fortheactivedocument:
Ret ur ns Tr ue i f t her e i s at l east one gr oup of si mul at i on i n doc ,
Fal se ot her wi se
' Par ams:
' [ i n] doc : At ol l document obj ect
' [ out ] ar r ay: Ar r ay of si mul at i on gr oup f eat ur e obj ect s
Pr i vat e Funct i on Si mul at i onGr oupFeat ur eObj ect s( doc, ByRef ar r ay)
Const OBJ ECTKI ND_SI MULATI ONS = " {CDDF1E1D- 1963- 4D80- A057- D23A19570984}"
Const OBJ ECTKI ND_SI MULATI ONGROUP = " {AF5E2B98- 1D54- 48FA- 89C5-
8BFA2936ABF2}"
Const at oDat a = 0
Di moSi mul at i ons
' oSi mul at i ons i s t he " Si mul at i ons" Chi l dFol der obj ect
Set oSi mul at i ons =doc. Get Root Fol der ( at oDat a) . I t em( OBJ ECTKI ND_SI MULATI ONS)
I f Er r Then
' Ther e i s no " Si mul at i ons" f ol der
On Er r or Got o 0
Exi t Funct i on
End I f
On Er r or Got o 0
I f oSi mul at i ons. Count = 0 Then
Exi t Funct i on
End I f
Redi mar r ay( oSi mul at i ons. Count - 1)
Di mn
n = 0
" Si mul at i on Gr oup" Chi l dFol der obj ect s ar e l ocat ed
174
i n t he "Si mul at i ons" f ol der
For Each oSi mul at i onGr oup I n oSi mul at i ons
I f oSi mul at i onGr oup. Obj ect Ki nd = OBJ ECTKI ND_SI MULATI ONGROUP Then
Set ar r ay( n) = oSi mul at i onGr oup. Di spat ch
n = n + 1
End I f
Next
Si mul at i onGr oupFeat ur eObj ect s = Tr ue
End Funct i on
Ret ur ns ' Tr ue' i f t her e i s at l east one si mul at i on i n ' oSi mul at i onGr oup' ,
Fal se ot her wi se
Par ams:
[ i n] oSi mul at i onGr oup : Gr oup of si mul at i ons Chi l dFol der obj ect
[ out ] ar r ay: Ar r ay of si mul at i on f eat ur e obj ect s
Pr i vat e Funct i on Si mul at i onFeat ur eObj ect s( oSi mul at i onGr oup, ByRef ar r ay)
I f oSi mul at i onGr oup. Count = 0 Then
Si mul at i onFeat ur eObj ect s = Fal se
Exi t Funct i on
End I f
Redi mar r ay( oSi mul at i onGr oup. Count - 1)
Di moSi mul at i on
Di mn
n = 0
For Each oSi mul at i on I n oSi mul at i onGr oup
Const OBJ ECTKI ND_SI MULATI ON = " {095C5D90- 96F1- 4BA8- 85BB- B2F990AC2DD9}"
I f oSi mul at i on. Obj ect Ki nd = OBJ ECTKI ND_SI MULATI ON Then
Set ar r ay( n) = oSi mul at i on. Di spat ch
n = n + 1
End I f
Next
Si mul at i onFeat ur eObj ect s = Tr ue
End Funct i on
175
Di mc
Di mr
Di mval ues( )
End I f
End I f
End I f
Next
Next
End Sub
Pr i vat e Sub DumpSi mul at i on( oSi mul at i on, name)
LogMessage name
LogMessage "Cel l s. . . "
DumpTabl e( oSi mul at i on. Cel l s)
LogMessage "End Cel l s. "
LogMessage "Si t es. . . "
DumpTabl e( oSi mul at i on. Si t es)
LogMessage "End Si t es. "
LogMessage "Mobi l es. . . "
DumpTabl e( oSi mul at i on. Mobi l es)
LogMessage "End Mobi l es. "
LogMessage "End " & name & ". "
End Sub
176
Publ i c Sub DumpSi mul at i onGr oupAt t r i but es
Di mf ( )
Di mar r aySi mul at i ons( )
I f ( Si mul at i onGr oupFeat ur eObj ect s( Act i veDocument , f ) = Fal se) Then
LogMessage " No Gr oup of Si mul at i ons f ound i n t he document . "
Exi t Sub
End I f
Di moFeat ur e
For Each oFeat ur e I n f
LogMessage " Gr oup of Si mul at i ons [ " & oFeat ur e. Sour ce. Name & " ] . . . "
Di maver age
Di mst ddev
Set aver age = oFeat ur e. MeanSi mul at i on
I f Er r Then
The aver age si mul at i on i s not avai l abl e when
no si mul at i on has conver ged i n t he gr oup.
LogMessage "The aver age si mul at i on i s not avai l abl e. "
On Er r or Got o 0
El se
On Er r or Got o 0
DumpSi mul at i on aver age, " Aver age Si mul at i on"
Set st ddev = oFeat ur e. St dDevSi mul at i on
I f Er r Then
' The st andar d devi at i on si mul at i on i s not avai l abl e
f or LTE and Wi MAX pr oj ect s.
On Er r or Got o 0
El se
On Er r or Got o 0
DumpSi mul at i on st ddev, " St ddev Si mul at i on"
End I f
End I f
177
12.7 3GPPMultiRATSimulationGroupFeatureObject
MultiRATSimulationGroupFeatureobjectsareavailableinAtolldocumentsbasedonthetemplates:
3GPPMultiRAT
3GPP MultiRAT Simulation Group Feature objects are similar to Simulation Group Feature objects available in singleRAT
documents,exceptsomemethodsin3GPPMultiRATSimulationGroupFeatureobjectsrequirethenameofthetechnology
tobespecified.MultiRATSimulationGroupFeatureobjectsprovidethefollowingpropertiesandmethods:
12.7.1 get_Source
Returnstheassociated3GPPMultiRATSimulationGroupChildFolderobject.
Parameters
[out]ppSource:AddressoftheIDispatchinterfacepointerusedtoreturntheassociated3GGPMultiRATSimulationGroup
ChildFolderobject.
' Dump al l si mul at i on i n t he gr oup of si mul at i ons
Set oSi mul at i onGr oup = oFeat ur e. Sour ce
I f ( Si mul at i onFeat ur eObj ect s( oSi mul at i onGr oup, ar r aySi mul at i ons) =
Fal se) Then
LogMessage " Ther e ar e no si mul at i ons i n t hi s gr oup of si mul at i ons. "
El se
Di moSi mul at i on
For Each oSi mul at i on I n ar r aySi mul at i ons
DumpSi mul at i on oSi mul at i on, oSi mul at i on. Sour ce. Name
Next
End I f
LogMessage " End Gr oup of Si mul at i ons. "
Next
End Sub
get_Source
Returnstheassociated3GPPSimulationGroupChildFolder
object.
get_Statistics
ReturnsaTabularDataobjectholdingthestatisticsofthe
simulationgroupforthespecifiedtechnology.
get_MeanSimulation
ReturnsaSimulationFeatureobjectgivingaccesstothe
averagesimulationpropertiesforthespecifiedtechnology.
get_StdDevSimulation
ReturnsaSimulationFeatureobjectusedtoaccessthe
standarddeviationsimulationpropertiesforthespecified
technology.
178
ReturnsaTabularDataobjectholdingthestatisticsofthesimulationgroupforthespecifiedtechnology.
Remarks
12.7.3 get_MeanSimulation
ReturnsaSimulationFeatureobjectgivingaccesstotheaveragesimulationpropertiesforthespecifiedtechnology.
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.
[in]bstrTechno:Astringusedtospecifytherequestedtechnology.Availablevaluesare"GSM,UMTS,orLTE.
[out]ppStdDevValues:AddressoftheISimulationinterfacepointerusedtoreturntheSimulationFeatureobjectcorrespond
ingtothestandarddeviationsimulation.
Remarks
Anerrorisreturnedwhennosimulationinthesimulationgrouphasconverged.Thestandarddeviationsimulationisnotavail
ablewhennosimulationinthesimulationgrouphasconverged.
AnerrorisreturnedwhentheAtolldocumentisbasedontheLTE,WiMAX802.16etemplates.Thestandarddeviationsimu
lationisnotavailableforLTEandWiMAX.
HRESULT get _St at i st i cs( const BSTR bst r Techno, I Tabul ar Dat a **ppTabl e) ;
HRESULT get _MeanSi mul at i on(
const BSTR bst r Techno,
I Si mul at i on **ppMeanVal ues
) ;
HRESULT get _St dDevSi mul at i on(
const BSTR bst r Techno,
I Si mul at i on **ppSt dDevVal ues
) ;
179
12.8 GSMInterferenceMatrixFeatureObject
GSMInterferenceMatrixFeatureobjectsgiveaccesstoGSMinterferencematrices.Adocumentcancontainzero,one,or
moreinterferencematrices.Theyarelocatedinthe"Interferencematrices"folderofthedocument.
GSMInterferenceMatrixFeatureobjectsareavailableindocumentsbasedontheGSMGPRSEDGEtemplate.
GSMInterferenceMatrixFeatureobjectsprovidethefollowingpropertiesandmethods:
12.8.1 HowtoAccessGSMInterferenceMatrixFeatureObjects
TheObjectKindpropertyforanInterferenceMatrixChildFolderobjectsis:
{5144E1F9- E539- 4F8C- BC0C- 49A11C6389E8}
InterferenceMatrixChildFolderobjectsarechildrenofthefoldernamed"InterferenceMatrices".
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
180
GSM Interference Matrix Feature objects are available through the Dispatch property of Interference Matrix ChildFolder
objects:
12.8.2 get_Source
Returnsthe"InterferenceMatrices"ChildFolderobject.
Parameters
[out]ppSource:AddressoftheIDispatchinterfacepointerusedtoreturnthe"InterferenceMatrices"ChildFolderobject.
12.8.3 Load
Loadsaninterferencematrix.
Remarks
Thismethodmustbecalledbeforeanyaccesstoaninterferencematrix.
12.8.4 CompleteScopeInfo
Completesscopeinformation.
Remarks
Thismethodmustbecalledaftertransmittersareaddedtothescope.
12.8.5 get_Scope
Returnsthescopeoftheinterferencematrix.
Parameters
[out]ppTable:TheaddressoftheITabularDatainterfacepointerusedtoreturnthescopeoftheinterferencematrix.
Remarks
ThescopeofaninterferencematrixisaTabularDataobjectcontainingamappingfromtherowidentifierforatransmitter
tothefollowinginformation:
Thecoveragepercentageasvictim,andasinterferer.Thedefaultvaluesare100.
TheBSICandBCCHwhentheinterferencematrixinformationwascollected.Thedefaultvaluesare1.
Di moI nt er f er enceMat r i x
Di moI nt er f er enceMat r i cesChi l dFol der
Set oI nt er f er enceMat r i cesChi l dFol der
= oDocument . Get Root Fol der ( at oDat a) . I t em( " I nt er f er ence Mat r i ces" )
Set oI nt er f er enceMat r i x = oI nt er f er enceMat r i cesChi l dFol der . Di spat ch
HRESULT Load();
HRESULT Compl et eScopeI nf o( ) ;
HRESULT get_Scope(ITabularData **ppTable);
181
12.8.6 put_Active
Setstheactivestate.
Parameters
[in]isActiveVal:TheVARIANT_BOOLvalueusedtospecifytheactivestateoftheinterferencematrix.
Remarks
Anactiveinterferencematrixisusedbytheautomaticfrequencyplanningprocesswhentheinterferencematrixscopeinter
sectstheautomaticfrequencyplanningscope.
12.8.7 get_Active
Returnstheactivestate.
Parameters
[out]pIsActiveVal:AddressoftheVARIANT_BOOLusedtoreturntheactivestateoftheinterferencematrix.
Remarks
Anactiveinterferencematrixisusedbytheautomaticfrequencyplanningprocesswhentheinterferencematrixscopeinter
sectstheautomaticfrequencyplanningscope.
12.8.8 get_Type
Returrnstheinterferencematrixtype.
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
be correctly assigned. This type of interference matrix is highly correlated with the neighbour relations. It can be used to
removeexcessiveneighbourconstraints.However,itcannotbeusedtocompleteanymissingneighbourinformation.Another
reasonforlowreliabilityisthatinterferenceinformationiscollectedfromhandoverregionsonly,insteadoffromtheservice
area.
4:OMC_NEI_EXT_HO_IM
InterferencematricesbasedonRXLEVstatisticsfromtheOMC(neighbours,aswellastemporaryneighbours).
Theycanbeaverygoodsourceofinterferenceinformationiftheyarestatisticallystablebecausetheyarenotsensitiveto
dataerrors.Ontheotherhand,theyhavemanydisadvantages,suchas:
HRESULT put _Act i ve( VARI ANT_BOOL i sAct i veVal ) ;
HRESULT get_Active(VARIANT_BOOL *pIsActiveVal);
HRESULT get_Type(IM_TYPE *pImTypeVal);
182
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.
Parameters
[in]imTypeVal:Theenumerationvalueusedtospecifytheinterferencematrixtype.
12.8.10 get_BasedOnTraffic
Returnsbasedontraffic.
Parameters
[out]pbBasedOntraf:TheaddressoftheVARIANT_BOOLvalueusedtoreturnbasedontraffic.
HRESULT put_Type(IM_TYPE imTypeVal);
HRESULT get_BasedOnTraffic(VARIANT_BOOL *pbBasedOntraf) ;
183
Remark
ThismethodonlymakessenseforinterferencematricesoftypePROPAG_IM.Inthatcase,thereturnvalueindicateswhether
theinterferencematrixtakesintoaccountnonuniformtrafficdistributionswithineachcell.
12.8.11 put_BasedOnTraffic
Setsbasedontraffic.
Parameters
[in]bBasedOntraf:TheVARIANT_BOOLvalueusedtospecifybasedontraffic.
12.8.12 get_Resolution
Returnstheresolutionoftheinterferencematrixcalculation.
Parameters
[out]piResolutionParamVal:Theaddressofthelongintegerusedtoreturntheresolutionoftheinterferencematrixcalcula
tion.
Remarks
ForinterferencematricesoftypePROPAG_IM,thereturnvalueistheresolutionoftheinterferencematrixcalculation.
For interference matrices of type TEST_MOBILE_DATA_IM, CW_IM, or SCAN_DATA_IM, the return value is the number of
measurementspercalculationpointintheinterferencematrix.
12.8.13 put_Resolution
Setstheresolutionoftheinterferencematrixcalculation.
Parameters
[in]:iResolutionParamVal:Thelongintegerusedtospecifytheresolutionoftheinterferencematrixcalculation.
12.8.14 get_StdDev
Returnstheinterferencematrixstandarddeviation.
Parameters
[out]pfStdDevParamVal:Addressofthesingleprecisionfloatingpointvalueusedtoreturntheinterferencematrixstandard
deviation.
Remarks
ForinterferencematricesoftypePROPAG_IM,thereturnvalueisthestandarddeviationofthepropagationmodelusedin
theinterferencematrixcalculation.
ForinterferencematricesoftypeTEST_MOBILE_DATA_IM,CW_IM,orSCAN_DATA_IM,thereturnvalueisthestandarddevi
ationofthemeasurementequipment.
HRESULT put_BasedOnTraffic(VARIANT_BOOL bBasedOntraf) ;
HRESULT get_Resolution(long *piResolutionParamVal);
HRESULT put_Resolution(long iResolutionParamVal) ;
HRESULT get_StdDev(float *pfStdDevParamVal);
184
12.8.15 put_StdDev
Setstheinterferencematrixstandarddeviation.
Parameters
[in]fStdDevParamVal:Thesingleprecisionfloatingpointvalueusedtospecifytheinterferencematrixstandarddeviation.
12.8.16 get_InfoQuantityIndicator
Returnstheinformationquantityindicator.
Parameters
[out]pilInfoQuantIndic:Addressofthelongintegerusedtoreturntheinformationquantityindicator.
Remarks
ForinterferencematricesoftypePROPAG_IM,thereturnvalueisaninformationabouttheinterferencematrixcalculation
parameters.
For interference matrices of type TEST_MOBILE_DATA_IM, CW_IM, or SCAN_DATA_IM, the return value is the number of
calculationpointspervictim.
ForinterferencematricesoftypeOMC_RESELCTION_IM,OMC_SIMPLE_HO_IM,orOMC_NEI_EXT_HO_IM,thereturnvalue
isthenumberofdayssincetheOMCstatisticswerecollected.
12.8.17 put_InfoQuantityIndicator
Setstheinformationquantityindicator.
Parameters
[in]ilInfoQuantIndic:Thelongintegerusedtospecifytheinformationquantityindicator.
12.8.18 get_CdfTab
ReturnstheinterferencematrixCDFtabulardata.
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.
HRESULT put_StdDev(float fStdDevParamVal);
HRESULT get_InfoQuantityIndicator(long *piInfoQuantIndic);
HRESULT put_InfoQuantityIndicator(long iInfoQuantIndic) ;
HRESULT get_CdfTab(ITabularData **ppTable) ;
185
Column5:
AsafearrayoftypeVT_ARRAY|VT_R4,orVT_ARRAY|VT_R8,orVT_VARIANThaving1dimensionandcontainingtheproba
bilityvaluesoftheCDF.
Performanceconsiderations:
Whendeletingelements,trytoalwaysdeletethelastelementfirst.
Wheneditinganexistingelement,donotchangecolumns1,2,or3.
186
Chapter13
DocumentCommands
188
AT321_TAG_E2 Chapter13:DocumentCommands
189
13 DocumentCommands
TheAtollAPIenablesexecutingcommandsonAtolldocuments.
Commandsareinvokedbytheirnames,whichmustbeknowninadvance.
ThefollowingcommandsareavailableforallAtolldocuments:
Thefollowingcommandsareavailableforradionetworktechnologydocuments:
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
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
190
Chapter13:DocumentCommands Forsk2014
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:
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
DefaultParameters
None.GetCommandDefaultsonIDocument4interfaceforthecommandIMPORTXMLreturnsanemptyPropertyContainer
object.
MWRun Thiscommandrunsanalysisforagivensetoflinks. Version: 2.6.1
EXPORTMAPWINDOW Exportsaregionofthemapwindowasanimage. Version: 3.1.0
IMPORTPLANETDATAFILE Importsaplanetdatafile. Version: 3.1.0
ARCHIVETODATABASE Archivesadocumenttothedatabase. Version: 3.2.1
EXPORTMWLINKANALYSISP
ROFILEPICTURE
ExportsamicrowavelinkanalysisprofilepicturetoaWindows
bitmapfile.
Version: 3.1.0
Publ i c Funct i on Execut eCommand( oDocument , st r Command, oPar amet er s)

Set Execut eCommand = oDocument . I nvokeCommand( st r Command, oPar amet er s)
End Funct i on
PATH
ThePATHinputparameterisusedtospecifythesourcefolder
containingXMLfilestoimport.
Version: 2.7.1
Type:String
191
Results
None.ThedataintheAtolldocumentareupdatedwiththecontentofXMLfiles.
13.3 EXPORTXML
ThiscommandperformsthesametaskastheAtoll"File >DataExchange >XMLFileExport..."mainmenucommand.
Version
2.7.1
InputParameters
DefaultParameters
None.GetCommandDefaultsforthecommandEXPORTXMLreturnsanemptyPropertyContainerobject.
Results
None.ThedataintheAtolldocumentareexportedtoasetofXMLfiles.
13.4 APPENDTABLECOLUMN
This command adds a new column to a database table. This command is only available for Atoll documents that are not
connectedtodatabases.
Version
2.8.0
InputParameters
PATH
ThePATHinputparameterisusedtospecifythedestinationfolder
whereXMLfileswillbeexported.
Version: 2.7.1
Type:String

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
192
DefaultParameters
TheTABLE,NAME,LEGEND,andTYPEinputparametershavenodefaultvalues,theymustbespecified.Defaultvaluesfor
otherinputparametersarereturnedbyGetCommandDefaultsforthecommandAPPENDTABLECOLUMN:
Results
None.Uponsuccessfulcompletionthenewcolumnisaddedtothetable.
13.5 CALCULATEPOINTS
ThiscommandreturnssignallevelsindBmforagivensetofpointsandasetoftransmitters.
Pathlossmatrices,whethertheyarevalidornot,arenotused.ThereforetheCalculatePointscommandisnotdependenton
thepathlossmatricesresolution.Signallevelsarecalculatedusingthepropagationmodelofeachtransmitter.
Version
2.6.0
InputParameters
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
CHOICELIST
TheCHOICELISTinputparameterisusedtospecifythelistofpossible
valuesforanewcolumnoftype0(Text).TheCHOICELISTinput
parameterisspecifictotextcolumns.Pleasenotethattheactual
columnvalueisnotrestrictedtothevaluesdefinedinthechoicelist.
TheCHOICELISTparametermaybeusedbyAtolltodisplaypreferred
valuestotheuser,forinstanceinacomboboxcontrol.
Version: 2.8.0
Type:ArrayofStrings
InputParameterName DefaultValue
LEGEND Empty.
SIZE 10bytes.
DEFAULT Null
GROUP Empty.
CHOICELIST Empty.

POINTS ThePOINTSinputparameterisusedtodefineasetofpoints.
Version: 2.6.1
Type:ArrayofIntegers
TRANSMITTERS
TheTRANSMITTERSinputparameterisusedtodefineasetof
transmitters.
Version: 2.6.1
Type:ArrayofStrings
193
ThePOINTSarraymusthave2dimensions,0and1.Thesizeofdimension0isthenumberofpoints.Thesizeofdimension1
is2,index0and1fordimension1aretheXandYcoordinates,respectively.Thecoordinatesofpointsareexpressedinthe
projectioncoordinatesystemoftheAtolldocument.
TheTRANSMITTERSarraymusthave1dimension.Thesizeofthearrayisthenumberoftransmitters.Arrayvaluesaretrans
mittersIDs,astheyappearintheTX_IDfieldoftheTransmitterstable
DefaultParameters
None.GetCommandDefaultsforthecommandCALCULATEPOINTSreturnsanemptyPropertyContainerobject.
Results
TheSIGNALSTabularDataobjecthasonerecordforeachtransmitterbelongingtotheTRANSMITTERSinputparameter.The
rownumberngivesthesignalreceivedonthepointnumbern.TheSIGNALSTabularDataobjecthasthefollowingstructure:
13.6 IMPORTTESTMOBILEDATA
ThiscommandimportsasetofdrivetestdatafilesintoanAtolldocument.
Version
2.6.1
InputParameters
TECHNOLOGY
TheTECHNOLOGYinputparameterisusedtospecifythetechnology
oftransmittersspecifiedbytheTRANSMITTERSinputparameter.
Availablevaluesare:
"GSM"
"UMTS"
"LTE"
"CDMA2000"
ThisparameterisignoredforsingleRATdocuments.
Version: 3.2.0
Type:String
SIGNALS TheSIGNALSresultisusedtoreturnsignalslevels.
Version: 2.6.1
Type:TabularData
object
ColumnName Description Attributes
TX_ID Astringholdingatransmitteridentifier. Type:String
Pn
Thesignallevelreceivedonpointnumbernfromthetransmitter
identifiedbythefieldTX_ID.
Whenthesignallevelislessthan200dBm,thetypeofthevariant
returnedforthefieldPnisVT_NULL.
Type:SingleorNull

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
194
DefaultParameters
None.GetCommandDefaultsforthecommandIMPORTTESTMOBILEDATAreturnsanemptyPropertyContainerobject.
Results
None.
13.7 RUNNEIGHBOURALLOCATION
PerformsneighbourallocationonaGSMnetwork.
Version
2.6.1
InputParameters
DefaultParameters
None. GetCommandDefaults for the command RUNNEIGHBOURALLOCATION returns an empty PropertyContainer object.
TheneighbourallocationparametersusedtocomputeneighboursaretheonessetintotheAtolldocument.Theneigbour
allocationparameterscanbesetbyimportingauserconfigurationfilecontainingneighbourallocationparameters.Usethe
AtollDocumentobjectSetConfigmethodtoimporttheneighbourallocationparameters.
Results
The NEIGHBOURS TabularData object has one record for each neighbour relation between two transmitters belonging to
TRANSMITTERFOLDER.
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
CONFIGURATIONFILE
TheCONFIGURATIONFILEinputparameterisusedtospecifythefull
pathtotheinitializationfile(.ini)containingthe
CONFIGURATIONNAME.Thisparameterisoptional.Whenitisnot
specifiedtheconfigurationfileusedistheoneusedintheproject.
Version: 3.2.0
Type:String

TRANSMITTERFOLDER
Asubfolderofthetransmittersfolder,orthetransmittersfolder
itself.
Version: 2.6.1
Type:ChildFolder
object
NEIGHBOURS TheNEIGHBOURSresultisusedtoreturnneighbourrelations.
Version: 2.6.1
Type:TabularData
object
195
13.8 RUNINTERTECHNOLOGYNEIGHBOURALLOCATION
Performsintertechnologyneighbourallocation.
Version
2.6.1
InputParameters
DefaultParameters
None.GetCommandDefaultsforthecommandRUNINTERTECHNOLOGYNEIGHBOURALLOCATIONreturnsanemptyProperty
Containerobject.TheneighbourallocationparametersusedtocalculateneighboursaretheonessetintheAtolldocument.
Theneigbourallocationparameterscanbesetbyimportingauserconfigurationfilecontainingneighbourallocationparam
eters.UsetheAtollDocumentobjectSetConfigmethodtoimporttheneighbourallocationparameters.
Results
TRANSMITTERFOLDER.
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
TRANSMITTERFOLDER
Asubfolderofatransmittersfolder,oratransmittersfolder
itself.
Version: 2.6.1
NeighbourTechnologyName
Astringusedtospecifythetechnologyofallocated
neighbours.
Availablevaluesare:
"GSM",
"UMTS",
"LTE"
Version: 3.1.0
Type:String
Version: 2.6.1
Type:TabularData
object
Number Type:Integer
196
13.9 RUNINTRACARRIERNEIGHBOURALLOCATION
PerformsintracarrierneighbourallocationonaUMTSnetwork.
Version
2.6.1
InputParameters
DefaultParameters
None.GetCommandDefaultsforthecommandRUNINTRACARRIERNEIGHBOURALLOCATIONreturnsanemptyPropertyCon
tainerobject.TheneighbourallocationparametersusedtocalculateneighboursaretheonessetintheAtolldocument.The
neigbourallocationparameterscanbesetbyimportingauserconfigurationfilecontainingneighbourallocationparameters.
UsetheAtollDocumentobjectSetConfigmethodtoimporttheneighbourallocationparameters.
Results
TRANSMITTERFOLDER.
13.10 RUNINTERCARRIERNEIGHBOURALLOCATION
PerformsintercarrierneighbourallocationonaUMTSnetwork.
Cause Type:String
Distance(m) Type:Single
TRANSMITTERFOLDER
itself.
Version: 2.6.1
Type:ChildFolder
object
Version: 2.6.1
Type:TabularData
object
Cell Type:String
Number Type:Integer
Cause Type:String
197
Version
2.6.1
InputParameters
DefaultParameters
None.GetCommandDefaultsforthecommandRUNINTERCARRIERNEIGHBOURALLOCATIONreturnsanemptyPropertyCon
tainerobject.TheneighbourallocationparametersusedtocomputeneighboursaretheonessetintotheAtolldocument.
Theneigbourallocationparameterscanbesetbyimportingauserconfigurationfilecontainingneighbourallocationparam
eters.UsetheAtollDocumentobjectSetConfigmethodtoimporttheneighbourallocationparameters.
Results
TRANSMITTERFOLDER.
13.11 CLONESTUDY
Thiscommandclonesacoverageprediction.
Version
2.7.0
InputParameters
TRANSMITTERFOLDER
itself.
Version: 2.6.1
Type:ChildFolder
object
Version: 2.6.1
Type:TabularData
object
Cell
Cell Type:String
Number Type:Integer
Cause Type:String

STUDY
TheSTUDYinputparameterholdsthestudytoclone.Thestudyto
cloneisastudyobjectcontainedinthePredictionsfolderoftheAtoll
document.
Version: 2.7.0
Type:ChildFolder
object
198
DefaultParameters
None.GetCommandDefaultsforthecommandCLONESTUDYreturnsanemptyPropertyContainerobject.
Results
13.12 DUPLICATESTUDY
Thiscommandduplicatesacoverageprediction.
Version
2.7.0
InputParameters
DefaultParameters
None.GetCommandDefaultsforthecommandDUPLICATESTUDYreturnsanemptyPropertyContainerobject.
Results
13.13 COMPARESTUDY
Thiscommandcomparestwocoveragepredictions.
Version
2.7.0
NEWSTUDYNAME
TheNEWSTUDYNAMEinputparameterisusedtodefinethenameof
thenewclonedstudy.
Version: 2.7.0
Type:String
NEWSTUDY
TheNEWSTUDYresultisusedtoreturnthenewcloned
studyobject.
Version: 2.7.0

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
NEWSTUDY
TheNEWSTUDYresultisusedtoreturnthenewduplicatedstudy
object.
Version: 2.7.0
Type:ChildFolder
object
199
InputParameters
DefaultParameters
None. GetCommandDefaults on IDocument4 interface for the command COMPARESTUDY returns an empty PropertyCon
tainerobject.
Results
13.14 CALCULATEEQUIPMENTLOSSES
Thiscommandcalculatesequipmentlossesandnoisefigureforalltransmittersinadocumenttransmittersfolder.
Version
2.7.0
InputParameters
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
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
NEWSTUDY TheNEWSTUDYresultisusedtoreturnthecomparisonstudyobject.
Version: 2.7.0
Type:ChildFolder
object

TRANSMITTERFOLDER Asubfolderofatransmittersfolder,oratransmittersfolderitself.
Version: 3.1.0
Type:ChildFolder
object
200
InputParameters
DefaultParameters
GetCommandDefaultsforthecommandCALCULATEREPEATERSreturnsaPropertyContainerobjectwiththeproperties:
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
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
Version: 3.1.0
Type:ChildFolder
object
PROPAGATIONLOSSES Boolean True
AZIMUTHSANDTILTS Boolean True
GAINS Boolean True

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
201
DefaultParameters
GetCommandDefaultsforthecommandCALCULATEREMOTEANTENNASreturnsaPropertyContainerobjectwiththeproper
ties:
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).
Thegeneralparametersinclude:
Version: 3.1.0
Type:ChildFolder
object
PropertyName Type Value
PROPAGATIONLOSSES Boolean True
AZIMUTHSANDTILTS Boolean True
GAINS Boolean True

TheSIMULATIONCONDITIONSPropertyContainerobjectusedhere
hasasubsetoftheSIMULATIONCONDITIONSpropertyofa"Pilot
QualityAnalysis(Ec/Io)"PredictionChildFolderObject.Thereforethe
SIMULATIONCONDITIONSpropertyofa"PilotQualityAnalysis(Ec/
Io)"PredictionChildFolderObjectcanbeuseddirectly,additional
contentinthisPropertyContainerobjectwillbeignored.
Version: 2.7.1
Type:
PropertyContainer
object
CLUTTERCONDITIONS
Version: 2.7.1
Type:
PropertyContainer
object
RECORDSETCONDITIONS
TheRECORDSETCONDITIONSPropertyContainerobjectusedhere
hasasubsetoftheRECORDSETCONDITIONSpropertyofaPrediction
ChildFolderObject.ThereforetheRECORDSETCONDITIONSproperty
ofaPredictionChildFolderObjectcanbeuseddirectly,additional
contentinthisPropertyContainerobjectwillbeignored.
Version: 2.7.1
Type:
PropertyContainer
object
202
SIMULATIONCONDITIONSinclude:
CLUTTERCONDITIONSinclude:
RECORDSETCONDITIONSinclude:
DefaultParameters
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
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
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
FILTER
"Filter"partoftherecordsetconditions,appliedtothetransmitters
table.
Version: 2.7.1
Type:String
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.
203
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
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:
TEXTSEPARATOR
59,ietheASCIIcodeofthe;character.Fieldsintheexported
fileswillbeseparatedbythe;character.
t ype; UMTS
t i mest amp; 16: 15: 01 18- J ul y- 2008
r esol ut i on; 50
xmi n; 23200
PropertyName DefaultValue
204
13.18 CALCULATEPOINTSECI0
ThiscommandreturnsEc/I0valuesindBforagivensetofpointsandasetoftransmitters.
Version
2.7.1
InputParameters
ThePOINTSarraymusthave2dimensions,0and1.Thesizeofdimension0isthenumberofpoints.Thesizeofdimension1
is 2,index0 and 1 for dimension 1 are the X and Y coordinates,respectively. The points coordinates are expressedin the
projectioncoordinatesystemoftheAtolldocument.
TheTRANSMITTERSarraymusthave1dimension.Thesizeofthearrayisthenumberoftransmitters.Arrayvaluesaretrans
mittersIDs,astheyappearintheTX_IDfieldoftheTransmitterstable.
DefaultParameters
None.GetCommandDefaultsontheIDocument4interfaceforthecommandCALCULATEPOINTSECI0returnsanemptyProp
ertyContainerobject.
Results
xmax; 23700
ymi n; - 14250
ymax; - 13650
x_num_pi xel s; 10
y_num_pi xel s; 12
[ . . . ]
23200; - 14200;
23250; - 14200; 0; Si t e3_1; - 10. 06; - 64. 88; Si t e3_3; - 12. 62; - 64. 88; Si t e3_2; - 13. 56; -
64. 88
23300; - 14200;
23350; - 14200;
[ . . . ]
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
VALUES TheVALUESresultisusedtoreturnEc/I0values.
Version: 2.7.1
Type:TabularData
object
205
TheVALUEStabulardataobjecthasonerecordforeachtransmitterbelongingtotheTRANSMITTERSinputparameter.The
rownumberngivestheEc/I0valueonthepointnumbern.
13.19 RUNALLCARRIERSALLOCATION
PerformsallcarriersallocationonaTDSCDMAnetwork.
Version
2.8.1
InputParameters
DefaultParameters
None.GetCommandDefaultsforthecommandRUNALLCARRIERSALLOCATIONreturnsanemptyPropertyContainerobject.
Results
TheCARRIERSTabularDataobjecthasonerecordforeachtransmitterscarrierallocation.
13.20 RUNMASTERCARRIERALLOCATION
PerformsmastercarrierallocationonaTDSCDMAnetwork.
Version
2.8.1
TX_ID Astringholdingatransmitteridentifier. Type:String
Pn
TheEc/I0valueonpointnumbernfromthetransmitteridentifiedby
thefieldTX_ID.
Type:SingleorNull
TRANSMITTERFOLDER
itself.
Version: 2.8.1
Type:ChildFolder
object
CONFREQUENCYALLOCATI
ON
AbooleanvalueusedtospecifywhethertoperformCoNfrequency
allocation(True)orDiffNfrequencyallocation(False).
Version: 2.8.1
Type:Boolean
COMMITRESULTS
Abooleanvalueusedtospecifywhethertheallocationresultswillbe
commitedinthedocument(True),ornot(False).
Version: 2.8.1
Type:Boolean
CARRIERS TheCARRIERSresultisusedtoreturncarrierallocationinformation.
Version: 2.8.1
Type:TabularData
object
Carriers Type:Integer
MasterCarrier Type:Integer
206
InputParameters
DefaultParameters
None. GetCommandDefaults for the command RUNMASTERCARRIERALLOCATION returns an empty PropertyContainer
object.
Results
TheCARRIERSTabularDataobjecthasonerecordforeachtransmitterscarrierallocation.
13.21 MWRun
Thiscommandrunsanalysisforagivensetoflinks.Theanalysiscantakeintoaccountinterferers.
Theresultsareprovidedinatabulardataformat.Thefieldsareallthecolumnsdisplayedwhenrunninglinkbudgetsorinter
ferencecalculationonawholelinksfolder.
Version
2.6.1
InputParameters
AlltheparametersthattheusercanprovideasinputthroughtheGUIcanbeprovidedtothiscommand.
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
CARRIERS
TheCARRIERSresultisusedtoreturncarrier
allocationinformation.
Version: 2.8.1
MasterCarrier Type:Integer

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
207
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
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
208
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
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
209
DefaultParameters
ThedefaultvalueslistedbelowarethedefaultvaluessetinAtoll.Ifthesehavebeenmodified,thenewdefaultvalueswillbe
usedinstead.
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
Name DefaultValue
Links Arrayoflinksname
Interference False
QualityModel 1
QualityObjective0 0
QualityObjective1 1
QualityObjective2 2
QualityObjective3 3
AvailabilityObjective0 0
RainMod 1
RBER 1e12
ALFA1 10
ALFA2 1
RefDelayM 6.3
RefDelayNM 6.3
EquipPercent 33
RainPercent 33
kMoy 1.33
kMin NULL
UseAtpc False
Rec530Simple True
IgnoreXPD True
210
AnalysisResultsWithoutInterferenceCalculation
IgnorePR False
OneBER 0
BER1 1e3
BER2 1e6
Rec838 0
CALC_LINK_PORTS "selected"
CALC_WITH_NOI True
InterferenceDistanceMax 50000
InterferenceDropMin 0.3
InterferenceCalcGo True
InterferenceCalcReturn True
InterferenceCalcUplink True
InterferenceCalcDownlink True
InterferenceRainSurfCorrelation 100
InterferenceAutoWeight 50
InterferenceUseAtpc False
InterferenceWidth 250
InterferenceOverShoot 0
INTERF_DETAIL "Both"
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
Name DefaultValue
211
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
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
212
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
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
213
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
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
214
AnalysisResultsWithInterferenceCalculation
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
RX_PORT Receptionport.
Version: 3.1.0
Type:String
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
C
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
I
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
215
13.22 EXPORTMAPWINDOW
Exportsaregionofthemapwindowasanimage.
Version
3.1.0
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
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
216
InputParameters
DefaultParameters
None.GetCommandDefaultsforthecommandEXPORTMAPWINDOWreturnsanemptyPropertyContainerobject.
Results
None.ThemapwindowimageisexportedtothefilespecifiedbythePATHinputparameter.
13.23 IMPORTPLANETDATAFILE
Importsaplanetdatafile.
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
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
217
Version
3.1.0
InputParameters
DefaultParameters
None.GetCommandDefaultsforthecommandIMPORTPLANETDATAFILEreturnsanemptyPropertyContainerobject.
Results
None.Theplanetdataisimported.
13.24 EXPORTMWLINKANALYSISPROFILEPICTURE
ExportsamicrowavelinkanalysisprofilepicturetoaWindowsbitmapfile.
Version
3.1.0
InputParameters
PATH Theabsolutepathoftheplanetdatafiletoimport.
Version: 3.1.0
Type:String
EMBED Whethertoembeddata,ornot.
Version: 3.1.0
Type:Boolean
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

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
218
DefaultParameters
None.GetCommandDefaults for the command EXPORTMWLINKANALYSISPROFILEPICTURE returns an empty PropertyCon
tainerobject.
Results
None.ThepictureofthelinkprofileisexportedtothefilespecifiedbyFILEPATHinputparameter.
13.25 GETPOWERMODE
Retreivesthedocumentcurrentpowermode.
ThiscommandisonlyavailableforUMTSorLTEtechnologies.
Version
3.1.0
InputParameters
DefaultParameters
None.GetCommandDefaultsforthecommandGETPOWERMODEreturnsanemptyPropertyContainerobject.
Results
13.26 SETPOWERMODE
Setsthedocumentpowermode.
ThiscommandisonlyavailableforUMTSorLTEtechnologies.
Version
3.1.0
InputParameters
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

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
219
DefaultParameters
None.GetCommandDefaultsforthecommandSETPOWERMODEreturnsanemptyPropertyContainerobject.
Results
None.Thedocumentpowermodeischanged.
13.27 APPENDVECTORDATACOLUMN
Thiscommandaddsanewcolumntoavectordatatable.
Version
3.1.1
InputParameters
DefaultParameters
None.
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
220
Results
None.Uponsuccessfulcompletionthenewcolumnisaddedtothetable.
13.28 LOADSAVEPRINTSETUP
Thiscommandloadsorsavestheprintsetupconfiguration.
Version
3.1.1
InputParameters
DefaultParameters
None.
Results
13.29 CALCULATEPATHLOSS
Performspathlossmatrixcalculationonatransmitterfolder.
Version
3.2.0
InputParameters
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
PRINTERNAME
ThePRINTERNAMEoutput
parameterisusedtoreturnthedefaultprinterused
inttheprintsetupconfigurationfile.
.
Version: 3.1.1
Type:String

TRANSMITTERFOLDER
itself.
Version: 2.6.1
Type:ChildFolder
object
221
DefaultParameters
None.GetCommandDefaultsforthecommandCALCULATEPATHLOSSreturnsanemptyPropertyContainerobject.
13.30 MWLinksCustomExport
Performsmicrowavelinkscustomexport.
Version
3.2.0
InputParameters
DefaultParameters
None.GetCommandDefaultsforthecommandMWLinksCustomExportreturnsanemptyPropertyContainerobject.
13.31 ARCHIVETODATABASE
Archivesaprojecttothedatabase.
Version
3.2.1
InputParameters
DefaultParameters
None.GetCommandDefaultsforthecommandARCHIVETODATABASEreturnsanemptyPropertyContainerobject.
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

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

IGNOREALLCONFLICTS
Abooleanusedtospecifywhethertoignoreallconflictswhen
archiving.
Version: 3.2.1
Type:Boolean
222
Results
ARCHIVESTATUS
Thearchiveoperationstatus.
Availablevaluesare:
0:Thearchiveoperationhassucceeded.
1:Thearchiveoperationhasbeeninterrupted
becauseofconflicts.
Version: 3.2.1
Type:Integer
Chapter14
Enumerations,
Structures,and
Interfaces
224
AT321_TAG_E2 Chapter14:Enumerations,Structures,andInterfaces
225
14 Enumerations,Structures,andInterfaces
14.1 Enumerations
Enumerationsareusedtospecifyconstants.Twocategoriesofenumerationsaredefinedhereafter.
ThefirstcategoryreferstoallenumerationsdefinedintheAtolltypelibrary.AllofthemareprefixedwithAto.
ThesecondcategoryreferstoallenumerationsdefinedinFSKGISLiblibrary.Allofthemareprefixedwithfg.
14.1.1 AtollTypeLibraryEnumerations
14.1.1.1 AtoSaveStatus
14.1.1.2 AtoSaveChanges
14.1.1.3 AtoRefreshPriority
14.1.1.4 AtoArchiveStatus
14.1.1.5 AtoWindowStatus
atoSaveSucceeded 0 Documenthasbeensuccessfullysaved.
atoSaveCanceled 1 Changesinthedocumenthasbeencancelledbytheuser.
atoSaveNo 0 Documentisclosedwithoutbeingsaved.
atoSaveYes 1 Documentissavedbeforebeingclosed.
atoSavePrompt 2
Theuserispromptedwhetherthedocumentmustbesavedbefore
closed.
atoCancelChanges 0
Allchangesarecancelledbeforethedocumentisrefreshedfromthe
database.
atoSkipChanges 1 Onlyrefreshesdatathathavenotbeenmodified.
atoArchiveSaveSucceeded 0 Archivinghassucceededwithoutconflicts.
atoArchiveCanceled 1
Archivinghasbeencancelled,eitherbytheuserorbecauseconflicts
occurred.
atoMaximized 0 Maximized(enlargedtomaximumsize).
atoNormal 1 Normal(Default).
atoMinimized 2 Minimized(minimizedtoaniconinthetaskbar).
226
Chapter14:Enumerations,Structures,andInterfaces Forsk2014
14.1.1.6 AtoLogType
14.1.1.7 AtoCompareOp
14.1.1.8 AtoTransmissionUnit
14.1.1.9 AtoReceptionUnit
14.1.1.10 AtoDistanceUnit
atoInfo 0 Information.
atoError 1 Error.
atoWarning 2 Warning.
atoEQ 0 (Equal)ThefirstvalueequaltosearchValissearchedfor.
atoLT 1
(StrictlyLowerThan)ThefirstvaluelessthansearchValissearched
for.
atoLE 2
(LowerorEqual)ThefirstvaluelessthanorequaltosearchValis
searchedfor.
atoGE 3
(GreaterorEqual)ThefirstvaluegreaterthanorequaltosearchVal
issearchedfor.
atoGT 4
(StrictlyGreaterThan)ThefirstvaluegreaterthansearchValis
searchedfor.
atoNE 5 (NotEqual)ThefirstvaluenotequaltosearchValissearchedfor.
atoDbm 0 TransmissionunitisdBm.
atoWatt 1 TransmissionunitisWatt.
atoKWatt 2 TransmissionunitiskWatt.
atoDbmRx 0 ReceptionunitisdBm.
atoDbMicroVolt 1 ReceptionunitisdBV.
atoDbMicroVoltMeter 2 ReceptionunitisdBV/meter.
atoM 0 Distanceunitismeter.
atoKm 1 Distanceunitiskilometer.
atoMiles 2 Distanceunitismiles.
227
14.1.1.11 AtoRadiatedPowerUnit
14.1.1.12 AtoAntennaGainUnit
14.1.1.13 AtoHeightOffsetUnit
14.1.1.14 AtoRootType
14.1.1.15 AtoRowFilter
Constantstofilteronlymodified,added,ordeletedrows.
14.1.1.16 AtoRowStatus
Allpossiblerowstatuses.
atoRadiatedPowerEIRP 0 RadiatedpowerisEIRP.
atoRadiatedPowerERP 1 RadiatedpowerisERP.
atoAntennaGainDbi 0 AntennagainunitisdBi.
atoAntennaGainDbd 1 AntennagainunitisdBd.
atoHeightOffsetM 0 Heightoffsetunitismeter.
atoHeightOffsetFeet 1 Heightoffsetunitisfeet.
atoData 0 Atollexplorerwindowdatatab.
atoGeo 1 Atollexplorerwindowgeotab.
atoModule 2 Atollexplorerwindowmodulestab.
atoParameters 2 Atollexplorerwindowparameterstab.
atoRowFilterNone 0 Nofilter.
atoRowFilterModifiedOrNew 1 Filtertoretainonlymodifiedornewrows.
atoRowFilterDeleted 2 Filtertoretainonlydeletedrows.
atoRowStatusNew 1 Rowhasbeenadded.
atoRowStatusModified 2 Rowhasbeenmodified.
atoRowStatusDeleted 4 Rowhasbeendeleted.
atoRowStatusUnmodified 8 Rowisunmodified.
228
14.1.1.17 AtoTemperatureUnit
14.1.2 FSKGISLibTypeLibraryEnumerations
14.1.2.1 GeographicUnit
14.1.2.2 ProjectionMethod
atoTempCelcius 0 TemperatureunitisdegreeCelsius(C).
atoTempFarenheit 1 TemperatureunitisdegreeFarenheit(F).
fgUnspecifiedUnit 1 Valuewhennothinghasbeendefined.
fgMeter 0 Lengthunitismeter.
fgKilometer 1 Lengthunitiskilometre.
fgFoot 2 Lengthunitisfoot.
fgLink 3
fgChain 4
fgYard 5 Lengthunitisyard.
fgNauticalMile 6 Lengthunitisnauticalmile.
fgMile 7 Lengthunitismile.
fgRadian 100 Longitude/Latitudeunitsareradian.
fgDegree 101 Longitude/Latitudeunitsaredegree.
fgGrad 102 Longitude/Latitudeunitsaregrads.
fgArcMinute 103 Longitude/Latitudeunitsareminutes.
fgArcSecond 104 Longitude/Latitudeunitsareseconds.
fgUndefinedProjection 0 Valuewhennothinghasbeendefined.
fgNoProjection 1 Thissystemhasnoprojectionmethod.
fgLambertConfConic1SP 2 LambertConfConic1SP.
fgLambertConfConic2SP 3 LambertConfConic2SP.
fgMercator 4 Mercator.
fgCassiniSoldner 5 CassiniSoldner.
fgTransverseMercator 6 TransverseMercator.
fgTransvMercatorSouthOriented 7 TransverseMercatorSouthOriented.
fgObliqueStereographic 8 ObliqueStereographic.
fgNewZealandMapGrid 9 NewZealandMapGrid.
fgHotineObliqueMercator 10 HotineObliqueMercator.
fgLabordeObliqueMercator 11 LabordeObliqueMercator.
229
14.1.2.3 ProjParameterIndices
fgSwissObliqueCylindrical 12 SwissObliqueCylindrical.
fgObliqueMercator 13 ObliqueMercator.
fgUTMProjection 14 UTMProjection.
fgUTMZoneNumber 0 NumberofUTMzone.
fgLongitudeOfOrigin 0 Longitudeoftheoriginofthezone.
fgLatitudeOfOrigin 1 Latitudeoftheoriginofthezone.
fgFalseEasting 2 False"easting".
fgFalseNorthing 3 False"northing".
fgScaleFactorAtOrigin 4 Scalingfactorattheorigin.
fgLatitudeOf1stParallel 4 Latitudeofthefirstparallel.
fgAzimuthOfCentralLine 5 Azimuthofthecentralline.
fgLatitudeOf2ndParallel 5 Latitudeofthesecondparallel.
fgAngleFromRecttifiedToSkewed
Grid
6
EXTRACT_DEFAULT 0 Allthegeographicdatapresentinthedocumentwillbeused.
PIXEL_POINT 0
Thevalueispointwiseandisassociatedwiththecentreofagrid
mesh(cornersofa4pointgrid).
PIXEL_AREA 1 Thevalueissurfaceareawiseandassociatedwithameshgrid.
POLAR_NONE 0 Nopolarizationorunknownpolarization.
POLAR_HORIZ 1 Horizontalpolarization.
POLAR_VERT 2 Verticalpolarization.
230
AT321_TAG_E2 Atoll3.2.1TaskAutomationGuide
231
AT321_TAG_E2 www.forsk.com June2014
HeadOffice
7ruedesBriquetiers
31700Blagnac,France
Tel:+33562747210
Fax:+33562747211
USOffice
200SouthWackerDriveSuite3100
Chicago,IL60606,USA
Tel:+13126744800
Fax:+13126744847
ChinaOffice
Suite302,3/F,WestTower,JiaduCommercialBuilding,
No.66JianzhongRoad,TianheHiTechIndustrialZone,
Guangzhou,510665,P.R.ofChina
Tel:+862085538938 Fax:+862085538285

Atoll 3.2.1 Task Automation Guide PDF

Încărcat de

Informații document

Descriere originală:

Titlu original

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

Atoll 3.2.1 Task Automation Guide PDF

Încărcat de

Drepturi de autor:

Formate disponibile

Version3.2.

HRESULT Set Addi nI nf oEx(

HRESULT Cl oseAl l ( At oSaveChanges saveChanges, At oSaveSt at us *st at us) ;

HRESULT Put Dat abaseConnect i onSt r i ng( BSTR aVal ) ;

HRESULT ChangeDat abaseConnect i on( BSTR aCnn, BSTR aReser ved) ;

HRESULT get _Temper at ur eUni t ( enumAt oTemper at ur eUni t *pVal ) ;

HRESULT get _Obj ect ( I Unknown **ppObj ect ) ;

Name ObjectKind Attributes

Name Description Attributes

Name Description Attributes

Name Description Attributes

Name Description Attributes

Name Description Attributes

Name Description Attributes

Name Description Attributes

Name Description Attributes

HRESULT get _Def aul t At t r i but es( I Tabul ar Dat a **ppTabl e) ;

Publ i c Funct i on Execut eCommand( oDocument , st r Command, oPar amet er s)

Name Description Attributes

Name Description Attributes

Name Description Attributes

Name Description Attributes

Name Description Attributes

Name Description Attributes

Name Description Attributes

Name Description Attributes

Name Description Attributes

Name Description Attributes

Name Description Attributes

Name Description Attributes

Name Description Attributes

Name Description Attributes

Name Description Attributes

S-ar putea să vă placă și