QGIS TUFLOW Increment Layer

Introduction

This tool takes the active layer (as selected in the layer control) and saves a copy of this with a new filename. By default the currently open file will be closed and the new version opened, however there is the option to keep both versions open in the workspace. The new layer will adopt the same styling as the old layer.

Running the Tool

In QGIS, the tool can be found in the TUFLOW Plugin toolbar, or via the top dropdown menu options Plugins >> TUFLOW >> Editing >> Increment Selected Layer.

Example 'Increment Selected Layer' dialog:

The parameters are described below:

1. Source Layer: Drop box for selecting the layer to be incremented. This defaults to the layer currently selected in the QGIS Layers panel.
2. Keep source formatting: Depcrecated - this option is no longer available. The source formatting is now always retained (it also no longer creates a .QML file).
3. Output Folder: The location for the folder to be saved into. This defaults to the folder location where the current file is saved and is updated if the 'Source Layer' dropbox is changed.
4. Output Filename: The output file, the tool will attempt to guess a filename by incrementing the current filename by 1. For example the source layer with name 2d_code_M01_001_R will guess 2d_code_M01_002_R. This will be updated if the 'Source Layer' dropbox is changed.
5. Move Source Layer to Superseded Folder: This option will move the source layer to a new folder call 'SS' (superseded) once the new incremented layer has been created. This is intended to help users keep their GIS files tidy, with only current layers being present.
6. Remove/Keep Source Layer in Workspace: This option will determine whether the original source layer is removed from the workspace or not. It is possible to use the option to 'Keep Source Layer in Workspace' and 'Move Source Layer to Superseded Folder' together.

The tool also checks if an existing file with the name and location specified already exists, if so, a warning will appear alerting the user. If the existing layer is open in QGIS (or another GIS program) the tool will produce an error.

Working with GPKG

Available since v3.3

If the source layer is a GPKG, the user will be given additional options:

Note: Save layer out into superseded folder is available since v3.7.0.25

A summary of the options is described below and more details are given further on:

• Increment Layer Only - this only saves the individual layer from the GPKG database into a new or existing GPKG database. Other layers in the GPKG will not be copied.
• Increment Layer and Preserve Database - this option allows the user to increment or copy multiple layers from the same GPKG into a new or existing GPKG.
• Save Layer Out Into Superseded Folder - this saves the currently selected layer into a new location but does not open it in QGIS. This option allows users to use centralised databases without having to increment the entire database each time. The user saves the superseded layer into a new location for posterity and continues to work with the layer in the centralised database.
  

Increment Layer Only

This option saves the layer selected in the dropbox into a new or existing GPKG. Other layers in the GPKG will not be copied or incremented in the process. The tool automatically provided an incremented name (that the user can edit) for the output database and layer name when the layer is selected in the dropdown box. The ability to move the old layer to the superseded folder and/or keep the old layer open is available for this increment option.

Increment Layer and Preserve Database

This options gives the user the ability to copy or increment multiple layers from the same GPKG. All layers in the GPKG will be listed for the user to decide what to do with: the options are to copy, increment, or discard. A given layer will be copied if it is checked on, it will be incremented if is checked on and new name is provided in the right column, and a given layer will discarded (i.e. not copied) if the layer is checked off. The tool will automatically give an incremented name of the layer selected in the dropdown box and will automatically update the datasource of any open layers in QGIS if required. To increment multiple layers within the same GPKG, it is possible to manually edit the filename of any layer in the incremented the GPKG within the 'Incremented Layer' column.
The option to move superseded files to a new separate folder and/or keep the old layers open is available for this increment option.

Save Layer Out Into Superseded Folder

The option saves the layer selected in the dropdown box into a new location (called a superseded folder by the tool) and keeps the current layer open in QGIS. This option allows users to use a centralised database without having to increment the entire database each time. The user saves the superseded layer in a new location for posterity and continues to work the layer in the centralised database. The user is given the option to let the tool automatically supersede the layer or customise the supersede location. The automatic option will save the layer into a folder called 'ss' in the same location as the GPKG (each layer will be given a new GPKG with the same name as the layer).

If the user has the File Management plugin installed, an option to increment the active layer is also available. This simply renames the layer inside the GPKG (no copying is done in this step) and allows the usual workflow of incrementing names to be used with this approach. The File Management plugin is required as this plugin has solved the problem of renaming a layer that is actively open in QGIS.

Examples

Example 1 - Shapefile


Example 2 - GPKG

Up
Back to TUFLOW QGIS Plugin Main Page