SimGis Avenue Development Environment Extension

(SiGADE)
For Arcview GIS V.3.0a or later
Internal Product ID – a6f

SimGis Corporation
Copyright 2000. All Rights Reserved.
SimGis Corporate Private 11/6/09:10:23 AM Michael Corsello

Introduction
The SimGis Avenue Development Environment Extension for Arcview provides the most
complete and robust set of development and deployment tools for the Avenue language currently
existing. This document is an exhaustive list of functions included in version 1.0 of this extension.

The SimGis Avenue Development Environment Extension for Arcview is comprised of 6 files:

sgde01sg.avx $AVHOME/ext The Installable Portion of the tool with

Gui controls.

sgde11sg.afx $AVHOME/apps/simgis/ Functional Scripts for the demo

releases.

sgde12sg.afx $AVHOME/apps/simgis/ Functional Scripts for the standard and

gold releases.

sgde13sg.afx $AVHOME/apps/simgis/ Functional Scripts for the platinum

release.

gnfn11sg.afx $AVHOME/apps/simgis/ The Functional Scripts for the demo

releases (SiGGeF).

gnfn12sg.afx $AVHOME/apps/simgis/ The Functional Scripts for the SimGis

commercial releases (SiGGeF).

These 6 files are installed from Arcview via the supplied project file (sg_XXXXX.apr, where XXXX
is the acronym for the SimGis product being installed), which contains the functional content of
the extensions internally.

Installation of the product results in the creation of a supporting directory structure in the
$AVHOME path which consists of the following directory hierarchy:

$AVHOME Arcview Application home directory

/apps SiGADE functional extension storage location
/simgis SimGis corporate reserved product space
/lib SimGis library and security file locale
/usr SimGis license and default user profiles locale

Additionally, unless otherwise configured, each user will have a directory created in the $HOME
path which is a hidden preferences / configuration file directory.

$HOME Users home directory

/avstor SiGADE configuration storage location (Windows)
/.avstor SiGADE configuration storage location (UNIX)

This directory can contain several files depending on the extensions installed.

* Most extensions created using the SimGis SiGADE product will add or use some files in these
locations.

Functional Overview of SiGADE

SiGADE contains several generic functions that pertain to the SimGis product line, as well as
several functions that implement the base functionality enabling SiGADE developed products.

SimGis Page 1 of 12 Last saved by Michael Corsello

SimGis Corporate Private 11/6/09:10:23 AM Michael Corsello

These functions are all part of the SiGADE product which is packaged with additional base
functions that are part of SiGGeF.

The functions included in Version 1.0 will expand with the release of future expanded versions of
SiGADE. Version numbering of SiGADE will not correspond to the versions of other components,
including SiGGeF.

The *.afx file for the Demo and SiGADE developed versions will include all functions related to
configuration, license handling general SiGADE implementation required functions.

Demo / SiGADE developed release functions:

Compile all Scripts

Open system script
Export Current
Load with name
Insert run statement
Button Copy
Execute comment
Replace Script
Auto Embed
Auto For
Auto While
Auto If Then End
Auto If Then Else End
Auto If Then Else

Limited Functions in demo release:

List Dependant Scripts

List Parent Scripts
List Orphan Scripts
Insert Header
Script Name Prefix
Project Documenter

SimGis Standard release functions:

Open Parents
Code Counter
Extract Scripts (From File)
Extract Scripts (From Extensions)
Extension Builder
Button Add
Menu Report
Button Delete
Get Script Documentation
Execute Block
Auto Encrypt
Comment Builder
Comment Remover

SimGis Gold release functions:

SimGis Page 2 of 12 Last saved by Michael Corsello

SimGis Corporate Private 11/6/09:10:23 AM Michael Corsello

Key Code
Auto Expiration Date
Multi-File extension builder
Replace Script (disable control)
AV Based install

SimGis Platinum release functions:

Auto Script Name (Random)

Auto Diagram

These functions will be extended in future versions by the inclusion of new functions and the
enhancement of current functions.

Functional Definitions of SiGADE Scripts

(See SiGGeF documentation for details on SiGGeF related scripts)

1. Compile all Scripts

a. Definition:
i. Compiles all scripts in selected DocGui. If selected from Project menu,
compilation of scripts from Script or SiGADE or both is permitted.
b. Sg_ae_CompileAll_SEd
c. Requires no parameters
d. Not Callable from script
e. Called from 3 Gui elements
i. Project Menu (SiGADE)
ii. Script Menu (SiGADE)
iii. SiGADE Menu (Tools)
f. No children
g. No parents
h. Returns no values
2. Open system script
a. Definition:
i. Loads system script into a new Sed with name preserved.
b. Sg_ae_OpenSystemScript_SEd
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Script Menu (SiGADE)
ii. SiGADE Menu (Tools)
f. No children
g. No parents
h. Returns
i. Sed object
3. Export Current
a. Definition:
i. Exports current script to file, preserving script name.
b. Sg_ae_ExportCurrent_SEd
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Script Menu (SiGADE)
ii. SiGADE Menu (Tools)
f. No children
g. No parents

SimGis Page 3 of 12 Last saved by Michael Corsello

SimGis Corporate Private 11/6/09:10:23 AM Michael Corsello

h. Returns no values
4. Load with name
a. Definition:
i. Loads script from file into a new Sed with name preserved
b. Sg_ae_LoadWithName_SEd
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Script Menu (SiGADE)
ii. SiGADE Menu (Tools)
f. No children
g. No parents
h. Returns
i. Sed object
5. Insert run statement
a. Definition:
i. Inserts an “av.run()” statement at current cursor location. If text is
selected, it is inserted between the parentheses. Otherwise, the user is
prompted for script name and list contents
b. Sg_ae_InsRunStmt_SEd
c. Requires no parameters
d. Not Callable from script
e. Called from 2 Gui elements
i. Script Menu (SiGADE)
ii. SiGADE Menu (Tools)
f. No children
g. No parents
h. Returns no values
6. Button Copy
a. Definition:
i. Copies Control object to specified location, uses current Sed as input to
locate Button(s).
b. Sg_ae_ButtonCopy_SEd
c. Requires no parameters
d. Not callable from script
e. Called from 2 Gui elements
i. Script Menu (SiGADE)
ii. SiGADE Menu (Tools)
f. No children
g. No parents
h. Returns no values
7. Execute comment
a. Definition:
i. Executes comment block in which cursor is currently positioned.
b. Sg_ae_ExecuteComment_SEd
c. Requires no parameters
d. Not callable from script
e. Called from 2 Gui elements
i. Script Menu (SiGADE)
ii. SiGADE Menu (Tools)
f. No children
g. No parents
h. Returns no values
8. Replace Script
a. Definition:

SimGis Page 4 of 12 Last saved by Michael Corsello

SimGis Corporate Private 11/6/09:10:23 AM Michael Corsello

i. Replaces current Sed content with content from selected Sed, preserving
the name of the current Sed.
b. Sg_ae_ReplaceScript_SEd
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Script Menu (SiGADE)
ii. SiGADE Menu (Tools)
f. No children
g. No parents
h. Returns no values
9. Auto Embed
a. Definition:
i. Embeds selected scripts in project, or all scripts if none selected. If run
from script type DocGUI, only scripts in current DocGUI are embedded.
b. Sg_ae_EmbedScripts
c. Requires no parameters
d. Callable from script
e. Called from 3 Gui elements
i. Project Menu (SiGADE)
ii. Script Menu (SiGADE)
iii. SiGADE Menu (Tools)
f. No children
g. No parents
h. Returns no values
10. Auto For
a. Definition:
i. Inserts “For each „x‟ in „y‟ …” construct at current cursor position. If
selected text exists, it is inserted inside the for construct already
indented.
b. Sg_ae_AutoForEach_SEd
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Script Menu (SiGADE)
ii. SiGADE Menu (Tools)
f. No children
g. No parents
h. Returns no values
11. Auto While
a. Definition:
i. Inserts “While ( )” construct at current cursor position. If selected text
exists, it is inserted inside the while construct already indented.
b. Sg_ae_AutoWhile_SEd
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Script Menu (SiGADE)
ii. SiGADE Menu (Tools)
f. No children
g. No parents
h. Returns no values
12. Auto If Then End
a. Definition:
i. Inserts “If ( ) then … end” construct at current cursor position.
b. Sg_ae_AutoIfThenEnd_SEd

SimGis Page 5 of 12 Last saved by Michael Corsello

SimGis Corporate Private 11/6/09:10:23 AM Michael Corsello

c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Script Menu (SiGADE)
ii. SiGADE Menu (Tools)
f. No children
g. No parents
h. Returns no values
13. Auto If Then Else End
a. Definition:
i. Inserts “If ( ) then … else … end” construct at current cursor position.
b. Sg_ae_AutoIfThenElseEnd_SEd
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Script Menu (SiGADE)
ii. SiGADE Menu (Tools)
f. No children
g. No parents
h. Returns no values
14. Auto If Then Else
a. Definition:
i. Inserts “If ( ) then … else” construct at current cursor position
b. Sg_ae_AutoIfThenElse_SEd
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Script Menu (SiGADE)
ii. SiGADE Menu (Tools)
f. No children
g. No parents
h. Returns no values
15. List Dependant Scripts
a. Definition:
i. Lists Dependent scripts to current Sed.
b. Sg_ae_ListDependents_SEd
c. Requires no parameters
d. Not callable from script
e. Called from 2 Gui elements
i. Script Menu (SiGADE)
ii. SiGADE Menu (Tools)
f. No children
g. No parents
h. Returns no values
16. List Parent Scripts
a. Definition:
i. Lists Parent Scripts to current Sed.
b. Sg_ae_ListParents_SEd
c. Requires no parameters
d. Not callable from script
e. Called from 2 Gui elements
i. Script Menu (SiGADE)
ii. SiGADE Menu (Tools)
f. No children
g. No parents
h. Returns no values

SimGis Page 6 of 12 Last saved by Michael Corsello

SimGis Corporate Private 11/6/09:10:23 AM Michael Corsello

17. List Orphan Scripts

a. Definition:
i. Lists orphan scripts in current project (or DocGUI if selection site).
b. Sg_ae_CheckEnvVars
c. Requires no parameters
d. Not callable from script
e. Called from 4 Gui elements
i. Project Menu (SiGADE)
ii. Application Menu (SiGADE)
iii. Script Menu (SiGADE)
iv. SiGADE Menu (Tools)
f. No children
g. No parents
h. Returns no values
18. Insert Header
a. Definition:
i. Inserts Script header into current Sed, if header already exists, updates
history.
b. Sg_ae_InsertHeader_SEd
c. Requires no parameters
d. Not Callable from script
e. Called from 2 Gui elements
i. Script Menu (SiGADE)
ii. SiGADE Menu (Tools)
f. No children
g. No parents
h. Returns no values
19. Script Name Prefix
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)
f. No children
g. No parents
h. Returns no values
20. Project Documenter
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)
f. No children
g. No parents
h. Returns no values
21. Open Parents
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)

SimGis Page 7 of 12 Last saved by Michael Corsello

SimGis Corporate Private 11/6/09:10:23 AM Michael Corsello

ii. Application Menu (Config)

f. No children
g. No parents
h. Returns no values
22. Code Counter
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)
f. No children
g. No parents
h. Returns no values
23. Extract Scripts (From File)
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)
f. No children
g. No parents
h. Returns no values
24. Extract Scripts (From Extensions)
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)
f. No children
g. No parents
h. Returns no values
25. Extension Builder
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)
f. No children
g. No parents
h. Returns no values
26. Button Add
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)

SimGis Page 8 of 12 Last saved by Michael Corsello

SimGis Corporate Private 11/6/09:10:23 AM Michael Corsello

f. No children
g. No parents
h. Returns no values
27. Menu Report
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)
f. No children
g. No parents
h. Returns no values
28. Button Delete
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)
f. No children
g. No parents
h. Returns no values
29. Get Script Documentation
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)
f. No children
g. No parents
h. Returns no values
30. Execute Block
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)
f. No children
g. No parents
h. Returns no values
31. Auto Encrypt
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)
f. No children

SimGis Page 9 of 12 Last saved by Michael Corsello

SimGis Corporate Private 11/6/09:10:23 AM Michael Corsello

g. No parents
h. Returns no values
32. Comment Builder
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)
f. No children
g. No parents
h. Returns no values
33. Comment Remover
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)
f. No children
g. No parents
h. Returns no values
34. Key Code
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)
f. No children
g. No parents
h. Returns no values
35. Auto Expiration Date
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)
f. No children
g. No parents
h. Returns no values
36. Multi-File extension builder
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)
f. No children
g. No parents

SimGis Page 10 of 12 Last saved by Michael Corsello

SimGis Corporate Private 11/6/09:10:23 AM Michael Corsello

h. Returns no values
37. Replace Script (disable control)
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)
f. No children
g. No parents
h. Returns no values
38. AV Based install
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)
f. No children
g. No parents
h. Returns no values
39. Auto Script Name (Random)
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)
f. No children
g. No parents
h. Returns no values
40. Auto Diagram
a. Definition:
b. Sg_gf_CheckEnvVars
c. Requires no parameters
d. Callable from script
e. Called from 2 Gui elements
i. Project Menu (Config)
ii. Application Menu (Config)
f. No children
g. No parents
h. Returns no values

SimGis Page 11 of 12 Last saved by Michael Corsello