You can extend the capabilities of Source by adding new component models or data processing tools. Some of these "plugin" tools extend Source’s user interface, or add additional steps to the Geographic Wizard. Other plugins, especially those written by third parties, may look and operate differently from the normal user interface.
When installing plugins in Source, you must have administrator access on your computer. Plugins that are installed as part of Source are located in the following plugins folder:
...
Plugins
...
They are files which have a .DLL or .EXE extension, and work with specific versions of Sourceof Source. Plugins that are external to Sourceto Source, and must be downloaded from the Internet, must be handled differently. Refer below, to Externally created plugins, for more information..
| Info | ||
|---|---|---|
| ||
| Note: Many of the existing eWater CRC Toolkit tools (or components of these tools) can be used as Source plugins; however, you must ensure that the plugin version is compatible with the Source version. In other words, the plugin .dll files have been compiled against the Source version that the plugin is to be used with. Also note that plugins are compatible with different version of Source, provided that the first three digits of the Source version number are the same. For example, a plugin that is compatible with different versions of Source 3.7.0 will not be compatible with 3.5.0. |
It is also good practice to copy external or third party plugins to the corresponding plugins folder prior to loading the plugin into Source.
The following plugins have been discussed in more detail in sub-pages:
Working with plugins
Ensure that there are no projects open prior to loading pluginsThere are several plugins included with Source that have been verified by the Source development team. This documentation is only developed and maintained for these included plugins. Table 1 provides plugin file and location details of plugins that are discussed in more detail.
Table 1. Plugins
| Plugin | Plugin file | Location in Source |
|---|---|---|
| Contributor | C:\Program Files\eWater\<Source version>\Plugins\RiverSystem.Plugins.Contributor.dll | Tools » Plugins Contributor Contributor |
| GWLag Plugin | C:\Program Files\eWater\<Source version>\Plugins\RiverSystem.Plugins.PerfectGWLag.dll | Tools » Plugins <various related folders> |
| River Analysis Package | C:\Program Files\eWater\<Source version>\Plugins\RiverSystem.Plugins.RAP.dll | |
| Spatial data pre-processor | C:\Program Files\eWater\<Source version>\Plugins\RiverSystem.Plugins.SpatialDataPreProcessor.dll | Tools » Plugins RiverSystem.Plugins.SpatialDataPreProcessor |
Loading plugins
When installing plugins in Source, you must have administrator access on your computer. Plugins that are installed as part of Source are located in the following plugins folder:
C:\Program Files\eWater\<Source version>\Pluginswhere:
<Source version> refers to the version of Source currently in use.
It is also good practice to copy external or third party plugins to the corresponding plugins folder prior to loading the plugin into Source.
| Info | ||
|---|---|---|
| ||
| Note: Plugins will only load when no projects are open. |
To load a new plugin:
- Choose to open the Plugin manager (Figure 1);
- Click Add and in the plugins folder (usually C:\Program Files\eWater\Source version\Plugins); and
- Select the plugin and click Open.
...
Figure 1. Plugin manager
| Info | ||
|---|---|---|
| ||
Note: If a required plugin is required to run the project, butnot loaded, an error appears asking if you want to keep loading the project without loading the plugin first. If the plugin is important to the project,Source might have problemsa problem running. The error tells you the name of the plugin that was used. An example of this is shownIn this instance, an error dialog appears (example in Figure 2 , indicating that the HargreavesET plugin is missing), showing the name of the missing plugin. Figure 2. Error without installed plugin |
There are several plugins included with Source that have been verified by the Source development team. This documentation is only developed and maintained for these included plugins.
Writing your own plugins
...
Writing your own plugins
To write your own plugins using .NET and C#, refer to Source plugins.
When you install Source, instructions for writing your own plugins are included along with in the following location (depending on your operating system). It also contains a series of templates to help you get started.
| Operating system | Standard plugin location |
|---|---|
| Windows XP | C:\Program Files\Source n.n.n.n<Source version>\Plugins\ExamplePlugins.zip |
| Windows 7 | C:\Program Files\eWater\Source n.n.n.n<Source version>\Plugins\ExamplePlugins.zip |
where n.n.n.n is the version number of Source. | |
If you boot Windows from a different hard disk drive or have otherwise customised your installation, you should make the necessary adjustments.
Please consult your system administrator if local security policies prevent you from accessing this package.
| Anchor | ||||
|---|---|---|---|---|
|
For plugins that have been developed externally to Source (such as DERMTools), you must manually unblock them in Windows after downloading. By default, Windows blocks the execution of programs downloaded from the internet (including the .dlls used as Source plugins) in order to reduce the risk of the computer being infected by a virus or some other form of malicious software.
...
- Right click on the dll file in Explorer and choose Properties (Figure 3); and
- In the resulting dialog (shown in Figure 3), click Unblock at the bottom of the screen, then OK.
...