Download Atoll 3.3.2 Task Automation Guide PDF

TitleAtoll 3.3.2 Task Automation Guide
TagsContractual Term 3 Gpp License Technology Computing
File Size2.1 MB
Total Pages236
Table of Contents
                            Table of Contents
Atoll 3.3.2 Task Automation Guide
1 Getting Started
	1.1 Supported Extensions
	1.2 Script Tutorial
		1.2.1 Writing a VBScript File
		1.2.2 Testing the Script
		1.2.3 Scheduling the Script
		1.2.4 Debugging the Script
		1.2.5 Error Management
	1.3 Macro Tutorial
		1.3.1 Adding Macros to Atoll
		1.3.2 Running a Macro
		1.3.3 Saving a List of Macros
	1.4 Windows Script Host, 32-bit vs 64-bit
2 Object Model
	2.1 Interfaces Implemented by Objects
	2.2 Properties and Methods Provided by Objects
		2.2.1 Parameters
		2.2.2 Error Information
3 Application Object
	3.1 How to Access the Application Object
	3.2 get_Application
	3.3 get_Parent
	3.4 get_Active
	3.5 put_Active
	3.6 get_Documents
	3.7 get_Name
	3.8 get_FullName
	3.9 get_Path
	3.10 get_ActiveDocument
	3.11 get_WindowStatus
	3.12 put_WindowStatus
	3.13 put_StatusBar
	3.14 get_Visible
	3.15 put_Visible
	3.16 get_Version
	3.17 Quit
	3.18 LogMessage
	3.19 CreatePropertyContainer
	3.20 get_IniFileFullPath
	3.21 put_IniFileFullPath
	3.22 GetOption
	3.23 SetOption
	3.24 Sleep
	3.25 SetAddinInfoEx
	3.26 put_OLENotRespondingDialog
	3.27 put_OLEBusyDialog
	3.28 put_OLEMessagePendingDelay
	3.29 get_PID
	3.30 Application Events
		3.30.1 WillQuitApp
		3.30.2 DocumentOpenComplete
		3.30.3 WillCloseDocument
		3.30.4 WillSaveDocument
		3.30.5 DocumentSaveComplete
		3.30.6 DocumentNewComplete
		3.30.7 WillRefreshDocument
		3.30.8 RefreshDocumentComplete
		3.30.9 WillArchiveDocument
		3.30.10 ArchiveDocumentComplete
		3.30.11 WillRun
		3.30.12 RunComplete
		3.30.13 LicenceAcquireComplete
		3.30.14 LicenceReleaseComplete
		3.30.15 WillNewDocumentFromDatabase
		3.30.16 WillRunMicrowave
4 Documents Object
	4.1 How to Access a Documents Object
	4.2 get_Count
	4.3 get_Item
	4.4 get_Application
	4.5 get_Parent
	4.6 Open
	4.7 Add
	4.8 OpenFromDatabase
	4.9 CloseAll
	4.10 SaveAll
5 Document Object
	5.1 How to Access a Document Object
	5.2 get_Application
	5.3 get_Parent
	5.4 get_FullName
	5.5 get_Name
	5.6 get_Path
	5.7 get_ReadOnly
	5.8 get_Saved
	5.9 get_CoordSystemProjection
	5.10 putref_CoordSystemProjection
	5.11 get_CoordSystemDisplay
	5.12 putref_CoordSystemDisplay
	5.13 get_CoordSystemInternal
	5.14 get_TransmissionUnit
	5.15 put_TransmissionUnit
	5.16 get_ReceptionUnit
	5.17 put_ReceptionUnit
	5.18 get_DistanceUnit
	5.19 put_DistanceUnit
	5.20 Close
	5.21 FilePrint
	5.22 Save
	5.23 Refresh
	5.24 Archive
	5.25 Run
	5.26 SetConfig
	5.27 Import
	5.28 GetRecords
	5.29 Redraw
	5.30 CenterMapOn
	5.31 GetRootFolder
	5.32 RunPathloss
	5.33 GetService
	5.34 ExportConfig
	5.35 GetCommandDefaults
	5.36 InvokeCommand
	5.37 get_RadiatedPowerUnit
	5.38 put_RadiatedPowerUnit
	5.39 get_AntennaGainUnit
	5.40 put_AntennaGainUnit
	5.41 get_HeightOffsetUnit
	5.42 put_HeightOffsetUnit
	5.43 get_DatabaseConnectionString
	5.44 HasRunningTask
	5.45 RunEx
	5.46 get_DatabaseSchemaString
	5.47 get_DisplayApplicationDialogues
	5.48 put_DisplayApplicationDialogues
	5.49 PutDatabaseSchemaString
	5.50 PutDatabaseConnectionString
	5.51 ChangeDatabaseConnection
	5.52 get_TemperatureUnit
	5.53 put_TemperatureUnit
	5.54 GetDocumentProperties
	5.55 SetDocumentProperties
	5.56 get_RadioTableNames
	5.57 LogMessage
6 TabularData Object
	6.1 How to Access a TabularData Object
	6.2 get_ColumnCount
	6.3 get_RowCount
	6.4 Edit
	6.5 AddNew
	6.6 Update
	6.7 Delete
	6.8 GetValue
	6.9 SetValue
	6.10 GetPrimaryKey
	6.11 FindPrimaryKey
	6.12 Find
	6.13 GetFormattedValue
	6.14 CancelUpdate
	6.15 get_ColumnNumber
	6.16 get_CanEdit
	6.17 get_CanAddNew
	6.18 get_CanFilterSort
	6.19 get_Filter
	6.20 put_Filter
	6.21 get_Sort
	6.22 put_Sort
	6.23 GetOriginalValue
	6.24 get_RowStatus
	6.25 get_Columns
	6.26 GetValues
	6.27 GetFormattedValues
	6.28 SetValues
	6.29 Hidden Columns In Radio Tabular Data Objects
		6.29.1 Table MWLINKS
		6.29.2 Table MWOTLINKS
		6.29.3 Transmitters Tables, All Technologies
7 Zones and Predictions Tabular Data Objects
	7.1 Zones Tabular Data Object
	7.2 Predictions Tabular Data Object
8 CoordSystem Object
	8.1 How to Access a CoordSystem Object
	8.2 Code
	8.3 ConvertCoordsTo
	8.4 Datum
	8.5 DatumName
	8.6 Description
	8.7 Ellipsoid
	8.8 EllipsoidName
	8.9 Name
	8.10 Pick
	8.11 ProjMethod
	8.12 ProjParameter
	8.13 SetDatum
	8.14 SetProjection
	8.15 Unit
9 ChildFolder Object
	9.1 How to Access a ChildFolder Object
	9.2 get_Application
	9.3 get_Parent
	9.4 get_Name
	9.5 put_Name
	9.6 get_Count
	9.7 get_Item
	9.8 get__NewEnum
	9.9 get_Visible
	9.10 put_Visible
	9.11 get_Selected
	9.12 put_Selected
	9.13 Export
	9.14 CentreOnMap
	9.15 Redraw
	9.16 AddChild
	9.17 Remove
	9.18 get_position
	9.19 put_position
	9.20 get_Object
	9.21 get_dispatch
	9.22 get_ObjectKind
	9.23 GetProperty
	9.24 SetProperty
	9.25 GetPropertiesInfo
	9.26 PropertyIsPropertyContainer
	9.27 PropertyIsTabularData
	9.28 LoadProperties
	9.29 SaveProperties
	9.30 RemoveItem
	9.31 SetCustomIcon
	9.32 OpenPropertySheet
10 PropertyContainer Object
	10.1 Get
	10.2 Set
	10.3 GetInfo
	10.4 IsPropertyContainer
	10.5 IsTabularData
	10.6 Load
	10.7 Save
	10.8 RemoveAll
	10.9 Remove
11 ChildFolder Object Properties
	11.1 How to Access ChildFolder Object Properties
	11.2 Common ChildFolder Object Properties
	11.3 Predictions Folder Properties
	11.4 Coverage Prediction Properties
		11.4.1 General Properties
		11.4.2 Group, Filter, and Sort Properties
		11.4.3 Non-Simulation-based Coverage Conditions
		11.4.4 Simulation-based Coverage Conditions
		11.4.5 Shadowing and Indoor Coverage Conditions
		11.4.6 Display Properties
	11.5 GSM Simulation Group Properties
	11.6 UMTS Simulation Group Properties
	11.7 WiMAX and LTE Simulation Group Properties
	11.8 3GPP Multi-RAT Simulation Group Properties
	11.9 Standard Propagation Model Properties
	11.10 CW Measurement Properties
	11.11 Drive Test Data Properties
	11.12 Custom ChildFolder Object Properties
	11.13 Master Link Properties
	11.14 Link Properties
	11.15 Vector Layer Properties
		11.15.1 Display Properties
	11.16 Aster Propagation Model Properties
	11.17 KPI Item Properties
12 ChildFolder Feature Objects
	12.1 Clutter Feature Object
		12.1.1 How to Access the Clutter Feature Object
		12.1.2 get_Source
		12.1.3 get_ClassAttributes
		12.1.4 get_DefaultAttributes
		12.1.5 Accessing Clutter Class Attributes
	12.2 Traffic Feature Object
		12.2.1 How to Access the Traffic Feature Object
		12.2.2 get_Source
		12.2.3 get_ScenarioProvider
		12.2.4 ExportCumulatedTraffic
		12.2.5 HasTrafficForService
	12.3 UMTS Traffic Scenario Provider Object
		12.3.1 GetMeanSize
		12.3.2 Create
	12.4 Environment Based Traffic Map Feature Object
		12.4.1 How to Access Environment Based Traffic Map Feature Objects
		12.4.2 get_Source
		12.4.3 get_ClassAttributes
		12.4.4 get_DefaultAttributes
		12.4.5 Accessing Environment Based Traffic Maps Attributes
	12.5 Simulation Feature Object
		12.5.1 How to Access Simulation Feature Objects
		12.5.2 get_Source
		12.5.3 get_Statistics
		12.5.4 get_Cells
		12.5.5 get_Sites
		12.5.6 get_Mobiles
		12.5.7 get_Results
	12.6 Simulation Group Feature Object
		12.6.1 How to Access Simulation Group Feature Objects
		12.6.2 get_Source
		12.6.3 get_Statistics
		12.6.4 get_MeanSimulation
		12.6.5 get_StdDevSimulation
		12.6.6 Accessing Mobiles, Cells, Sites, for Simulations and Simulation Groups
	12.7 3GPP Multi-RAT Simulation Group Feature Object
		12.7.1 get_Source
		12.7.2 get_Statistics
		12.7.3 get_MeanSimulation
		12.7.4 get_StdDevSimulation
	12.8 GSM Interference Matrix Feature Object
		12.8.1 How to Access GSM Interference Matrix Feature Objects
		12.8.2 get_Source
		12.8.3 Load
		12.8.4 CompleteScopeInfo
		12.8.5 get_Scope
		12.8.6 put_Active
		12.8.7 get_Active
		12.8.8 get_Type
		12.8.9 put_Type
		12.8.10 get_BasedOnTraffic
		12.8.11 put_BasedOnTraffic
		12.8.12 get_Resolution
		12.8.13 put_Resolution
		12.8.14 get_StdDev
		12.8.15 put_StdDev
		12.8.16 get_InfoQuantityIndicator
		12.8.17 put_InfoQuantityIndicator
		12.8.18 get_CdfTab
13 Document Commands
	13.1 How to Invoke a Document Command
	13.2 IMPORTXML
	13.3 EXPORTXML
	13.4 APPENDTABLECOLUMN
	13.5 CALCULATEPOINTS
	13.6 IMPORTTESTMOBILEDATA
	13.7 RUNNEIGHBOURALLOCATION
	13.8 RUNINTERTECHNOLOGYNEIGHBOURALLOCATION
	13.9 RUNINTRACARRIERNEIGHBOURALLOCATION
	13.10 RUNINTERCARRIERNEIGHBOURALLOCATION
	13.11 CLONESTUDY
	13.12 DUPLICATESTUDY
	13.13 COMPARESTUDY
	13.14 CALCULATEEQUIPMENTLOSSES
	13.15 CALCULATEREPEATERS
	13.16 CALCULATEREMOTEANTENNAS
	13.17 EXPORTACTIVESETANALYSIS
	13.18 CALCULATEPOINTSECI0
	13.19 RUNALLCARRIERSALLOCATION
	13.20 RUNMASTERCARRIERALLOCATION
	13.21 MWRun
	13.22 EXPORTMAPWINDOW
	13.23 IMPORTPLANETDATAFILE
	13.24 EXPORTMWLINKANALYSISPROFILEPICTURE
	13.25 GETPOWERMODE
	13.26 SETPOWERMODE
	13.27 APPENDVECTORDATACOLUMN
	13.28 LOADSAVEPRINTSETUP
	13.29 CALCULATEPATHLOSS
	13.30 MWLinksCustomExport
	13.31 ARCHIVETODATABASE
	13.32 MWCalculateProfiles
	13.33 PURGEPATHLOSSFOLDERS
14 Enumerations
	14.1 Enumerations
		14.1.1 Atoll Type Library Enumerations
			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
			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
			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
			14.1.1.16 AtoRowStatus
			14.1.1.17 AtoTemperatureUnit
		14.1.2 FSKGISLib Type Library Enumerations
			14.1.2.1 GeographicUnit
			14.1.2.2 ProjectionMethod
			14.1.2.3 ProjParameterIndices
                        
Document Text Contents
Page 1

Version 3.3.2

Task Automation Guide


AT332_TAG_E0

Page 2

AT332_TAG_E0

Atoll 3.3.2 Task Automation Guide
Release: AT332_TAG_E0 (November 2016)
© Copyright 1997-2016 Forsk. All Rights Reserved.
Published by:

Forsk
7 rue des Briquetiers
31700 Blagnac, France
Tel: +33 562 747 210
Fax: +33 562 747 211

The software described in this document is provided under a licence agreement. The software may only be used or copied under the terms and conditions of the licence agreement.
No part of the contents of this document may be reproduced or transmitted in any form or by any means without written permission from the publisher.
The product or brand names mentioned in this document are trademarks or registered trademarks of their respective registering parties.
Third party services that are not part of Atoll are governed by the terms and conditions of their respective providers, which are subject to change without notice.
The publisher has taken care in the preparation of this document, but makes no expressed or implied warranty of any kind and assumes no responsibility for errors or omissions.
No liability is assumed for incidental or consequential damages in connection with or arising out of the use of the information contained herein.

Page 118

Atoll 3.3.2 Task Automation Guide
Chapter 9: ChildFolder Object © 2016 Forsk. All Rights Reserved.
Example

9.12 put_Selected
Sets the selected state of the ChildFolder object.

Parameters

[in] newVal: The VARIANT_BOOL used to specify the selected state.

Remarks

get_Selected and put_Selected calls are ignored for objects that don’t support it. No error is returned.

Example

See "get_Selected" on page 117.

9.13 Export
Exports a ChildFolder object to a file, in a given format. This method can only be used for studies.

Parameters

[in] bstrFileName: A string containing an absolute file path.

[in] proj: An IDispCoordSystem interface pointer used to define the coordinate system for the export.

[in] bstrFormat: A string used to define the format of the file specified by bstrFileName.

Public Sub SelectTx

Set doc = ActiveDocument

Const atoData = 0

Set dataFolder = doc.GetRootFolder(atoData)

’ Select the "Site0_0" transmitter

For Each folder In dataFolder

If folder.Name = "Transmitters" Then

folder.Item("Site0_0").Selected = True

End If

Next

End Sub

HRESULT put_Selected(VARIANT_BOOL aNewVal);

HRESULT Export(

const BSTR bstrFileName,

IDispCoordSystem* proj,

const BSTR bstrFormat

);
118

Page 119

Atoll 3.3.2 Task Automation Guide
AT332_TAG_E0 Chapter 9: ChildFolder Object
The syntax for the bstrFormat parameter is:

format:

• Available values are:
• SHP
• AGD
• MIF
• TAB
• BMP
• TIF
• TXT
• ARCVIEWGRIDASCII
• PNG
• JP2
• VMAPPER (for Vertical Mapper GRC or GRD file formats)

Please read the application documentation to learn more about these file formats.

The data exported is the geographic coverage prediction of a study when using SHP, AGD, MIF, TAB, BMP, ARCVIEW-
GRIDASCII, PNG, JP2, or TIF formats. However, if you specify TXT format, this method will export the study report in
tabulated ASCII text format. This prediction study report is the same as the one available by right-clicking the study in
the application and selecting Generate Report.

Available properties are:

Atoll version >= 3.3.1

PropertyName=Value;[PropertyName=Value;]format

Property Name Value Version Description

Resolution integer 2.8.1

This is the export resolution, expressed in meter.
If not specified, the resolution used to perform the export is

the study resolution.
It is only relevant when the export format is a vector format,

as opposed to a raster format.

AreaType 0|1|2 2.8.1

Used to specify the zone to export. Available values are:
0 : The Entire Covered Area
1 : The Computation Zone

2 : The Geographic Export Zone
If not specified, the entire covered area is considered to

perform the export.
It is only relevant for raster formats, as opposed to vector

formats.

Property Name Value Description

FilteringPercentage
integer, between

0 and 100

This is the filtering percentage value.
It is only relevant when the export format is a vector format,

as opposed to a raster format.

SmoothingPercentage
integer, between

0 and 100

This is the smoothing percentage value.
It is only relevant when the export format is a vector format,

as opposed to a raster format.

SmoothingMaximumNumberOfPoints integer

This is the maximum number of points for exported vector
geometries. This option is mutually exclusive with the

smoothing percentage option.
It is only relevant when the export format is a vector format,

as opposed to a raster format.

DataType integer, 0 or 1

0 = coverage thresholds are exported, this is the defaut
setting if not specified.

1 = numerical coverage results are exported.

This option is only relevant when BIL or GRD formats are
specified.





119

Page 235

Atoll 3.3.2 Task Automation Guide
AT332_TAG_E0 Chapter 14: Enumerations
14.1.2.3 ProjParameterIndices

fgSwissObliqueCylindrical 12 Swiss Oblique Cylindrical.

fgObliqueMercator 13 Oblique Mercator.

fgUTMProjection 14 UTM Projection.

Constant Value Description

Constant Value Description

fgUTMZoneNumber 0 Number of UTM zone.

fgLongitudeOfOrigin 0 Longitude of the origin of the zone.

fgLatitudeOfOrigin 1 Latitude of the origin of the zone.

fgFalseEasting 2 False Easting.

fgFalseNorthing 3 False Northing.

fgScaleFactorAtOrigin 4 Scaling factor at the origin.

fgLatitudeOf1stParallel 4 Latitude of the first parallel.

fgAzimuthOfCentralLine 5 Azimuth of the central line.

fgLatitudeOf2ndParallel 5 Latitude of the second parallel.

fgAngleFromRectfifiedToSkewed
Grid

6

235

Page 236

AT332_TAG_E0 www.forsk.com November 2016

• Head Office
7 rue des Briquetiers
31700 Blagnac, France
Tel: +33 562 747 210
Fax: +33 562 747 211

• US Office
200 South Wacker Drive – Suite 3100
Chicago, IL 60606, USA
Tel: +1 312 674 4800
Fax: +1 312 674 4847

• China Office
Suite 302, 3/F, West Tower, Jiadu Commercial Building,
No. 66 Jianzhong Road, Tianhe Hi-Tech Industrial Zone,
Guangzhou, 510665, P. R. of China
Tel: +86 20 8553 8938 Fax: +86 20 8553 8285

http://www.forsk.com

Similer Documents