Project tools
It’s possible to define set of project specific tools using the tool.xml definition. These tools are available in LIDS Edit and LIDS Explorer clients. The tools define their own icons and are organized into tool palettes or ribbon pages.
Common properties of individual tools and tool palettes definitions include:
-
name – Title of the tool displayed as the first line in the tooltip
-
description – Optional description displayed as the second line in the tooltip
-
icon – References an icon representing the tool in GUI. The icons are defined in resource.xml metadata file and stored on AS in the appropriate subdirectories of the
${project folder}lids-as/resources/icon/bmp16x16directory.
Tools
Project tools can be used to call up all the system functions available in the application menus. The following chapters describe only those tools which allow for launch of functions with predefined parameters. Commands for calling up individual functions without further parameters are specified directly by the description of individual application menus in user’s documentation.
Data Management
Send Features to Data Selection
Command: graphicElm graphicsSendTo
This function allows you to send features selected in Graphics to a data selection which is displayed in Form, in Browse or in Graphics (with / without theme assignment, or with centering).
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| visualizeType | Method of displaying features of data selection. Options:
| yes |
| methodId | ID of a method with the aid of which features for processing are selected in Graphics. Values in LIDS Edit:
| yes |
| viewId | ID of view to which the new data selection sent to Graphics is switched on. | no |
Example:
<ber:tool id="sys_sendToForm" name="Send features to form">
<ber:description>Features selected in graphics</ber:description>
<ber:icon xlink:href="resource.xml#ic_zoomRef1"/>
<ber:script>
<ber:module id="graphicElm"/>
<ber:function id="graphicsSendTo"/>
<ber:parameterArray>
<ber:parameter name="visualizeType" value="Form"/>
<ber:parameter name="methodId" value="1"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Simple Template – Browse
Command: lidsMain newSimpleTemplateBrowse
A data selection is created on the basis of the defined feature type condition and displayed in Browse.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureTypes | List of feature types separated by commas. | yes |
Example:
<ber:tool id="sys_newSimpleTemplateBrowse" name="Simple template - Browse">
<ber:description>Opens browse for Main pipeline segments</ber: description>
<ber:icon xlink:href="resource.xml#ic_newSimpleTemplateBrowse"/>
<ber:script>
<ber:module id="lidsMain"/>
<ber:function id="newSimpleTemplateBrowse"/>
<ber:parameterArray>
<ber:parameter name="featureTypes" value="ft_5012100"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Simple Template – Form
Command: lidsMain newSimpleTemplateForm
A data selection is created on the basis of the defined feature type condition and displayed in Form.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureTypes | List of feature types separated by commas. | yes |
Example:
<ber:tool id="sys_newSimpleTemplateForm" name="Simple template - Form">
<ber:description>Opens form for Pumping stations and Hydrants</ber: description>
<ber:icon xlink:href="resource.xml#ic_newSimpleTemplateForm"/>
<ber:script>
<ber:module id="lidsMain"/>
<ber:function id="newSimpleTemplateForm"/>
<ber:parameterArray>
<ber:parameter name="featureTypes" value="ft_5010100,ft_5011200"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Open Simplified Form
Command: freeForm singleComponent
Tool allows to open simplified form for feature selected in graphics. The simplified form includes just the specified component type.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| componentType | Possible types of components:
| yes |
| singleForm | Defines, if subsequent execution of the function opens new window form or replaces the existing form Values: true / false Default value: false | no |
Example:
<ber:tool id="ti_form_systemInfo_m" name="Display info about feature">
<ber:description>Individual windows for subsequent selections</ber:description>
<ber:icon xlink:href="resource.xml#ic_form_systemInfo_m"/>
<ber:script>
<ber:module id="freeForm"/>
<ber:function id="singleComponent"/>
<ber:parameterArray>
<ber:parameter name="componentType" value="systemInformation"/>
<ber:parameter name="singleForm" value="false"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Location Form
Command: lidsMain openLocateForm
The defined location form opens. The attribute condition can optionally be predefined (including attribute condition with parameters).
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| locateFormId | Form ID. | yes |
| predefinedValues | Definitions of attribute conditions separated by a semicolon. The method of writing individual attribute conditions is: attribute,operator,value The method of writing an attribute condition with parameters is: attribute,operator At most one attribute condition with parameters can be defined. | no |
Example:
<ber:tool id="sys_locForm_predef1" name="Locating form - Main pipeline segment">
<ber:description>Predefined operators and values</ber:description>
<ber:icon xlink:href="resource.xml#ic_locForm_main"/>
<ber:script>
<ber:module id="lidsMain"/>
<ber:function id="openLocateForm"/>
<ber:parameterArray>
<ber:parameter name="locateFormId" value="fml_50121"/>
<ber:parameter name="predefinedValues" value="at_5010007,like,MPL
%;at_5012112,equiv,6887866707151025347729701;at_5012003,equiv"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Management of Display of Data Selections, Thematization and Toolbars
Command: lidsMain layerMagic
The function allows you to:
switch on / switch off display of data selections determined by parameters in the graphic window,
assign specified themes to defined data selections,
assign the default theme to defined data selections,
switch on / switch off display of defined project toolbars.
The function does not allow you to switch on display of data selections which are not included in the right-hand part of Data Management.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| layerTurnOn | List of identifiers of data selections, display of which will be switched on in the graphic window. Identifiers are separated by a comma in the list. | no |
| layerTurnOff | List of identifiers of data selections, display of which will be switched off in the graphic window. Identifiers are separated by a comma in the list. | no |
| setThema | List of ordered pairs identifier of data selection;identifier of theme. The respective theme is always set for the given data selection. Individual pairs are separated by a comma in the list. | no |
| resetThema | List of identifiers of data selections, for which the default theme will be set. Identifiers are separated by a comma in the list. | no |
| toolbarTurnOn | List of identifiers of toolbars, display of which will be switched on. Identifiers are separated by a comma in the list. | no |
| toolbarTurnOff | List of identifiers of toolbars, display of which will be switched off. Identifiers are separated by a comma in the list. | no |
Example:
<ber:tool id="layerMagic1" name="Activate work mode 1">
<ber:description>Open/close templates, set themas and open/close toolbars</ber:description>
<ber:icon xlink:href="resource.xml#ic_layerMagic1"/>
<ber:script>
<ber:module id="lidsMain"/>
<ber:function id="layerMagic"/>
<ber:parameterArray>
<ber:parameter name="layerTurnOn" value="id_01,id_02"/>
<ber:parameter name="layerTurnOff" value="id_03,id_04"/>
<ber:parameter name="setThema" value="id_01;th_01,id_02;th_02"/>
<ber:parameter name="resetThema" value="id_05,id_06"/>
<ber:parameter name="toolbarTurnOn" value="tb_01,tb_02"/>
<ber:parameter name="toolbarTurnOff" value="tb_03,tb_04"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Displaying and Fitting Defined Template in Graphics
Command: lidsMain fitTemplateInGraphics
The function allows you to:
-
Add defined template into the list of used layers in Data Management
- If the template includes attribute condition with parameters, the user has to enter the values
-
Display the template content in the graphics
- If more graphical views are opened, user has to specify the view by clicking inside it
-
Load all features of the template and fit the view extent to the loaded features
-
This works only if the template includes spatial condition
-
If the template doesn’t include spatial condition, the whole content is not loaded and it’s not possible to fit the view to the content
-
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| templateId | Identifier of the template. | yes |
Example:
<ber:tool id="layerMagic1" name="Activate template">
<ber:description>Loads template content into graphics & fits</ber:description>
<ber:icon xlink:href="resource.xml#ic_layerMagic1"/>
<ber:script>
<ber:module id="lidsMain"/>
<ber:function id="fitTemplateInGraphics"/>
<ber:parameterArray>
<ber:parameter name="templateId" value="1234567890"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Send Content of Details to Data Selection
Command: graphicElm displayDetails
This function allows you to send the content of details for features selected in Graphics to a data selection which is displayed in Form, in Browse or in Graphics (with assignment / without assignment of a theme, or with centering).
After the function is launched, the features selected in Graphics are processed. If no features are selected in Graphics, selection of one feature in Graphics is activated. Only feature types defined by a parameter can be selected.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| visualizeType | Method of displaying features of data selection. Options:
| no |
| methodId | ID of a method with the aid of which features for processing are selected in Graphics. Values in LIDS Edit:
| no |
| viewId | ID of view to which the new data selection sent to Graphics is switched on. | no |
| featureTypes | List of IDs of feature types which detail content can be displayed for. Feature types are separated by a comma in the list. If this parameter is not entered, all feature types are allowed. | no |
| detailAssociations | List of IDs of allowed detail associations. Detail associations are separated by a comma in the list. If this parameter is not entered, all detail associations are allowed. | no |
Example:
<ber:tool id="id" name="Name">
<ber:description>Description</ber:description>
<ber:icon xlink:href="resource.xml#icon"/>
<ber:script>
<ber:module id="graphicElm"/>
<ber:function id="displayDetails"/>
<ber:parameterArray>
<ber:parameter name="featureTypes" value="ft_1,ft_2" />
<ber:parameter name="detailAssociations" value="det_assoc_1, det_assoc_2" />
<ber:parameter name="visualizeType" value="GraphicsFit" />
<ber:parameter name="methodId" value="1" />
<ber:parameter name="viewId" value="5" />
</ber:parameterArray>
</ber:script>
</ber:tool>
Relation Tools
A set of tools allowing you to optimize work procedures relating to specific relationship types.
Create Related Feature
Command: relationTools createRelated
A new feature related by the defined relationship type is created for the feature selected in Graphics.
After clicking on the icon, the user selects a feature in Graphics. A dialog box opens for creation of a new feature without graphics. The created feature is automatically related to the feature selected in Graphics.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| relationType | List of relationship types separated by a comma. | yes |
| featureType | Type of related feature. | yes |
Example:
<ber:tool id="rel_createRelated_inspection" name="Create related inspection">
<ber:description>Select: Main pipeline segment</ber:description>
<ber:icon xlink:href="resource.xml#ic_rel_createHaltung"/>
<ber:script>
<ber:module id="relationTools"/>
<ber:function id="createRelated"/>
<ber:parameterArray>
<ber:parameter name="relationTypes" value="r_pipe_inspection"/>
<ber:parameter name="featureType" value="ft_pig_inspection"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Create Related Feature in Graphics
Command: relationTools.createRelatedInGraphics
A new feature related by the defined relationship type is constructed in Graphicsfor the feature selected in Graphics.
After clicking on the icon, the user selects a feature in Graphics. The selection is limited only to features with types which are specified in the parameter inputFeatureTypes. A dialog box opens for construction of a feature, in which the target feature type specified in the superiorFeatureType parameter is set, and construction of the feature in Graphics is activated. After construction has been completed, the created feature is related to the feature selected in Graphics in the first step.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| inputFeatureTypes | List of input feature types separated by a comma. | yes |
| superiorFeatureType | Target feature type. | yes |
| relationTypes | Relationship type. | yes |
Example:
<ber:tool id="Create_related_in_graphic_1" name="Create related feature">
<ber:description>Create related feature in graphics</ber:description>
<ber:icon xlink:href="resource.xml#ic_createRelatedInGraphics" />
<ber:script>
<ber:module id="relationTools" />
<ber:function id="createRelatedInGraphics" />
<ber:parameterArray>
<ber:parameter name="inputFeatureTypes" value="ft_1,ft_2,ft_3" />
<ber:parameter name="superiorFeatureType" value="ft_new" />
<ber:parameter name="relationTypes" value="r_123" />
</ber:parameterArray>
</ber:script>
</ber:tool>
Create Relationship between Features
Command: relationTools createRelation
This function creates a relationship between two features selected in graphic view.
After clicking on the icon, the user is prompted to select the first feature in graphic view. If the roleType parameter is entered, selection is limited to a feature from this role. Otherwise, this can be a feature from any role of the entered relationship, the type of which is listed in the relationType parameter. This is followed by selection of the second feature, which must be from an opposite role than the first feature. A relationship of the defined type is created between both selected features.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| relationType | Relationship type. | yes |
| roleType | Role type. | no |
Example:
<ber:tool id="rel_createRelation" name="Create relation">
<ber:description>Select features in graphics </ber:description>
<ber:icon xlink:href="resource.xml#ic_relCreateRelation"/>
<ber:script>
<ber:module id="relationTools"/>
<ber:function id="createRelation"/>
<ber:parameterArray>
<ber:parameter name="relationType" value="r_1_2"/>
<ber:parameter name="roleType" value="rt_1"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Generate Related Graphical and Nongraphical Features
Command: relationTools advancedConstruction
This tool allows user to capture one feature standard way. Then system opens window with further to-be-generated feature types. User can select, which features will be generated automatically.
If selected feature type has geometry, it will be generated with the same geometry as the constructed feature
The generated features are automatically connected with each other by using the configured relationship types.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureType | Type of feature manually captured. | yes |
| featureTypes | Comma separated list of feature types to be generated automatically | no |
| relationTypes | Comma separated list of relationship types | no |
Example:
<ber:tool id="advConstruction_1" name="Point with related features">
<ber:description>Generate related graphical and nongraphical</ber:description>
<ber:icon xlink:href="resource.xml#ic_advConstruction_1"/>
<ber:script>
<ber:module id="relationTools"/>
<ber:function id="advancedConstruction"/>
<ber:parameterArray>
<ber:parameter name="featureType" value="ft_point1"/>
<ber:parameter name="featureTypes" value="ft_point2,ft_point3,ft_s1,ft_s2"/>
<ber:parameter name="relationTypes" value="r_1,r_2,r_3,r_4"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Show Related Features
Command: relationTools showRelated
Features related by the defined relationship type are displayed for the feature selected in Graphics.
After clicking on the icon, the user selects a feature in Graphics. Alternatively, if some features are already selected using a selection set when clicking on the icon, the selection set is processed as an input. Features related via the defined relationship types are searched for to go with the selected feature or features related to features being searched for in this manner via other relationship types. The resulting features can be displayed according to the settings of the action parameter in Form, in Browse, or highlighted or located in Graphics.
The tool is displayed in two places in application:
- In project toolbar together with the other tools
- In the form / browse of the feature defined as the source feature
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| relationTypes | List of relationship types separated by a comma. | yes |
| action | Parameter determining the method of displaying related features:
| no |
| hiliteSelected | The feature selected by the user is also highlighted in Graphics. Values: true / false Default value: false | no |
| subsequentRelationTypes | List of relationship types separated by a comma. These relationship types are used to search for features related to features related with the aid of relationTypes to the feature selected by the user. If more levels of relationships are needed, it’s possible to define additional levels separated by semicolon, more relationship types inside every level still separated by comma | no |
| subsequentRelationTypesOnly | If the parameter is set to true, the result of the function then includes only features found in the last step Values: true / false Default value: true | no |
| recursive | If the parameter is set to true, the same relationship type is evaluated more times until next features are found. Values: true / false Default value: false | no |
| selectMode | Highlighting of graphic elements during selecting in graphics:
| no |
Example 1:
<ber:tool id="rel_showRelated_inspections" name="Show related inspections in browse">
<ber:description>Select: Main pipeline segment</ber:description>
<ber:icon xlink:href="resource.xml#ic_rel_showRelated1"/>
<ber:script>
<ber:module id="relationTools"/>
<ber:function id="showRelated"/>
<ber:parameterArray>
<ber:parameter name="relationTypes" value="r_pipe_inspection"/>
<ber:parameter name="action" value="browse"/>
<ber:parameter name="hiliteSelected" value="true"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Example 2:
<ber:tool id="rel_showRelated_cables_browse" name="Display all related cables in ducts (and also ducts) in browse">
<ber:description>Select route</ber:description>
<ber:icon xlink:href="resource.xml#ic_rel_showRelated3"/>
<ber:script>
<ber:module id="relationTools"/>
<ber:function id="showRelated"/>
<ber:parameterArray>
<ber:parameter name="selectMode" value="GraphicTagComponents"/>
<ber:parameter name="relationTypes" value="r_route_duct"/>
<ber:parameter name="subsequentRelationTypes" value="r_duct_cable, r_duct_t_cable"/>
<ber:parameter name="subsequentRelationTypesOnly" value="false"/>
<ber:parameter name="action" value="browse"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Example 3: More levels of subsequent relation types
<ber:tool id=" rel_showRelated3" name="Load features related by more levels">
<ber:description>Only features from the lowest level included</ber:description>
<ber:icon xlink:href="resource.xml#ic_rel_showRelated3"/>
<ber:script>
<ber:module id="relationTools"/>
<ber:function id="showRelated"/>
<ber:parameterArray>
<ber:parameter name="selectMode" value="GraphicTagComponents"/>
<ber:parameter name="relationTypes" value="r_route_duct"/>
<ber:parameter name="subsequentRelationTypes" value=" level1_r1,level1_r2;level2_r1,level2_r2;level3;level4"/>
<ber:parameter name="subsequentRelationTypesOnly" value="true"/>
<ber:parameter name="action" value="browse"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Show Related Feature by ID
Command: relationTools showRelatedById
This tool enables the display of a feature based on identifiers stored in the attributes of the selected feature. The standard relation association between the features doesn’t have to exist at all. The feature identifiers must be stored in the feature attribute using some project logic.
The tool is displayed in two places in application:
- In project toolbar together with the other tools
- In the form / browse of the feature defined as the source feature
The resulting feature can be displayed according to the settings of the action parameter in Form, in Browse, or highlighted or located in Graphics.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureTypes | List of source feature types separated by a comma. | yes |
| attributeFTID | Attribute of the selected feature which includes feature type id of the resulting feature. | yes |
| attributeFID or attributeSID | Attribute of the selected feature which includes FID or SID of the resulting feature. | yes |
| action | Parameter determining the method of displaying related feature:
| no |
| hiliteSelected | The feature selected by the user is also highlighted in Graphics. Values: true / false Default value: false | no |
Example:
<ber:tool id="rel_showRelated_inspections" name="Show related feature by ID">
<ber:description>Select feature in graphics or in form</ber:description>
<ber:icon xlink:href="resource.xml#ic_1"/>
<ber:script>
<ber:module id="relationTools"/>
<ber:function id="showRelatedByID"/>
<ber:parameterArray>
<ber:parameter name="featureTypes" value="ft_1"/>
<ber:parameter name="attributeFTID" value="at_01"/>
<ber:parameter name="attributeFID" value="at_02"/>
<ber:parameter name="action" value="form"/>
<ber:parameter name="hiliteSelected" value="true"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Delete Related Features
Command: relationTools deleteRelated
Features related by the defined relationship type are deleted for the feature selected in Graphics.
After clicking on the icon, the user selects a feature in Graphics. Features related by the defined relationship type are deleted.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| relationTypes | Relationship type. | yes |
| selectMode | Highlighting of graphic elements during selecting in graphics:
| no |
Example:
<ber:tool id="rel_deleteFeatureInspection" name="Delete related inspections">
<ber:description>Select Main pipeline segment - all related Pig inspections and Damages are deleted</ber:description>
<ber:icon xlink:href="resource.xml#ic_rel_deleteFeature2"/>
<ber:script>
<ber:module id="relationTools"/>
<ber:function id="deleteRelated"/>
<ber:parameterArray>
<ber:parameter name="relationTypes" value="r_pipe_inspection"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Create Superior Feature
Command: relationTools createSuperior
This function allows you to create a superior non-graphic feature for geometrically related point and line features making up the traced route.
After clicking on the icon, the user selects the start point feature of the path. The start line segment of the path and the end point feature of the path must also be selected. A non-graphic feature is created which is also connected:
to all line features of the path graphically found between the start line segment and the end point feature,
to both point features.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| startingShaftRelType | Types of relationships to the point feature determining the start of the path. | yes |
| endingShaftRelType | Types of relationships to the point feature determining the end of the path. | yes |
| lineSegmentRelType | Relationship type of superior feature for line features of the path. | yes |
| superiorFeatureType | Superior feature type. | yes |
| tolerance | Lines are regarded as geometrically related if their end vertexes are at a distance less than the value of tolerance (decimal number). | yes |
Example:
<ber:tool id="rel_create_superior" name="Create superior feature">
<ber:description>Creates superior nongraphic feature</ber:description>
<ber:icon xlink:href="resource.xml#ic_rel_create_superior"/>
<ber:script>
<ber:module id="relationTools"/>
<ber:function id="createSuperior"/>
<ber:parameterArray>
<ber:parameter name="startingShaftRelType" value="r_mains_valve_start,r_mains_hydrant_start"/>
<ber:parameter name="endingShaftRelType" value="r_mains_valve_end, r_mains_hydrant_end"/>
<ber:parameter name="lineSegmentRelType" value="r_5040000_5012100"/>
<ber:parameter name="superiorFeatureType" value="ft_5040000"/>
<ber:parameter name="tolerance" value="0,005"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Delete Relationships
Command: relationTools deleteRelationships
This function deletes relationships between found related features. Originally related features are preserved.
After clicking on the icon, the user selects a feature in graphics. Features related by the defined relationship types are searched for the selected feature. Defined relationship types are deleted for features searched for in this manner. The features themselves are not deleted.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| searchingRelationTypes | Relationship types for searching for features related to the feature selected in graphics. | yes |
| deletingRelationTypes | Types of deleted relationships for found features. | yes |
| selectMode | Highlighting of graphic elements during selecting in graphics:
| no |
Example:
<ber:tool id="rel_deleteRelations" name="Delete relations">
<ber:description>Select Main pipeline segment - for found Water mains all relationships to Segments and start / end Valves and Hydrants are deleted</ber:description>
<ber:icon xlink:href="resource.xml#ic_rel_deleteRelations"/>
<ber:script>
<ber:module id="relationTools"/>
<ber:function id="deleteRelationships"/>
<ber:parameterArray>
<ber:parameter name="searchingRelationTypes"
value="r_5040000_5012100"/>
<ber:parameter name="deletingRelationTypes" value="r_5040000_5012100,r_mains_valve_start,r_mains_valve_end, r_mains_hydrant_start,r_mains_hydrant_end"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Construction
Feature construction
This function is used for construction of a new feature of a specific type with predefined parameters and set values of certain attributes.
Click on the icon to display a construction dialog box allowing you to set parameters for creation of graphic data for the feature and fill in its attribute data.
The type of the constructed feature is determined using the element ber:featureType.
Example:
<ber:featureType xlink:href="model.xml#ft_1"/>
The root element ber:stdConstrTool contains the optional element ber:initialize for initial setting of switches and a nested element corresponding to the respective geometry type ( ber:pointConstruction, ber:surfaceConstruction, ber: curveConstruction, ber:textConstruction). Construction parameters are contained in these elements as nested elements or attributes.
Parameters for initial setting of switches (element ber:initialize):
| Parameter | Meaning | Mandatory |
|---|---|---|
| takeover | This element determines whether a feature should be selected in graphics before starting construction or whether a selection set will be used. Possible subordinate elements:
| no |
| group | This element determines whether construction is started in Multigeometry or Shared Semantics mode. Possible values:
| no |
| autoDAConstruction | This parameter controls whether the command for placement of the displayable attributes of the feature will be automatically activated after completion of its construction. Possible values:
| no |
| autoDAPlace | This parameter controls whether automatic placement of the displayable attributes of the feature will be performed after completion of its construction. The definition of the types of displayable attributes and parameters for their automatic placement is saved in metadata for the given feature type. Possible values:
| no |
| attachment | If defined, then window for creating new attachment is opened automatically after finishing the new feature construction. If attachmentType is defined, it is prefilled. If source="file" is defined, the window for selecting file on filesystem is opened automatically If source="camera" is defined, window for controlling integrated camera is opened automatically | no |
Parameters (subordinate XML elements) for construction of point features (element ber:pointConstruction):
| Parameter | Meaning | Mandatory |
|---|---|---|
| angleFromElement | If the parameter is set, the angle of the point feature being constructed is determined in the first step by being taken over from the feature selected in Graphics. | no |
| symbolOnLine | If the parameter is entered (empty), then construction of the point feature begins with selection of a line segment and position on it. | no |
| splitLine | If the parameter is entered (empty and if the symbolOnLine parameter is also entered), the selected line is divided into two graphic elements. | no |
| copyRelations | If the parameter attribute splitLine is entered and has the value true, then the new part of the split line gains all of the permitted related features which the original part of the line had. | no |
| copyAttacments | If the parameter attribute splitLine is entered and has the value true, then the new part of the split line gains all of the attachments which the original part of the line had. | no |
| splitLine | If the parameter is entered (empty and if the symbolOnLine parameter is also entered), the selected line is divided into two graphic features. | no |
| insertInnerVertex | If the parameter is entered (empty and if the symbolOnLine parameter is also entered), an inner vertex is inserted in the line of the graphic feature which was selected. | no |
| lineDistance | If the parameter is entered (and if the symbolOnLine parameter is also entered), then the symbol is placed at the entered distance from the line of the graphic feature which was selected. The parameter determines the distance in metres. | no |
| angleLock | If the parameter is entered (empty and if the symbolOnLine and angleFromElement parameter is also entered), the angle deducted from the selected line segment is set when the cursor is moved along the line. | no |
| storeAngle | If the parameter is entered (empty), the currently used value of the angle is set as the default angle for placement of the subsequent point feature (within the framework of the given construction command). | no |
| activeAngle | If the parameter is entered, its value is used as the default angle. | no |
Parameters for construction of area features (element ber:surfaceConstruction): The name of the element after surfaceConstruction determines the construction mode:
- shape = shape,
- shapePolar = shape – polar construction,
- orthogonal = rectangular shape,
- block = rectangle,
- blockRotated = rotated rectangle,
- arcPolygonStartCenter = shape with arcs - center,
- arcPolygonStartEndMid = shape with arcs - 3 points,
- circle = circle,
- circleRadius = circle - radius, value of element determines radius in m
- circlePoints = circle – 3 points,
- nGon = circle - n-angle, value of element determines radius in m
- ellipse = ellipse, fillHole = fill hole, floodFill = fill area,
- parallelSurface = by area, value of element determines distance in m
| Attribute/Parameter | Meaning | Mandatory |
|---|---|---|
| sides | If the construction mode is nGon, then the value of this attribute determines the number of sides. | Yes, only for nGon mode |
| adjustAngle | If the construction mode is nGon, then the value of this attribute (true/false) determines whether the user will be able to also enter its rotation after placement of the center of the n-angle. The default value is false. | No, only for nGon mode |
| displayMeasure | If the parameter is entered, then the dimensions of the constructed area will be displayed according to its value. Possible values:
| no |
Parameters (subordinate XML elements) for construction of line features (element ber:curveConstruction):
| Parameter | Meaning | Mandatory |
|---|---|---|
| constructionMode | Construction mode. Values:
| no |
| startOnLine | If the parameter is entered (empty), then construction of the line begins with selection of a segment of another line and position on it for the start of the constructed line. | no |
| splitLine | If the parameter is entered (empty and the startOnLine parameter is entered), then the line of the graphic feature which was selected for the start of the constructed line is divided into 2 graphic features. | no |
| insertInnerVertex | If the parameter is entered (empty and the startOnLine parameter is entered), then an inner vertex is inserted into the line of the graphic feature which was selected for the start of the constructed line. | no |
| displayMeasure | If the parameter is entered, then the dimensions of the constructed line will be displayed according to its value. Possible values:
| no |
| vertexMode | If constructionMode=line, then this parameter governs how the inner vertex will be created. Values:
| no |
Parameters (subordinate XML elements) for construction of text features (elementber: textConstruction):
| Parameter | Meaning | Mandatory |
|---|---|---|
| angleFromElement | If the parameter is set (and has no value or the value true), the angle of the text feature being constructed is determined in the first step by being taken over from the feature selected in Graphics. Values: true / false Default value: true | no |
| activeAngle | If the parameter is entered, its value is used as the default angle. | no |
| anglePlus | If the parameter is entered, 90° is added to the value of the angle | no |
| 90 | (and the legibility of the text is maintained during placement). | |
| storeAngle | If the parameter is entered (empty), the currently used value of the angle is set as the default angle for placement of the subsequent text feature (within the framework of the given construction command). | no |
Example 1: Simple feature construction tool
<ber:stdConstrTool id="ti_1" name="FT 1">
<ber:description>No additional parameters</ber:description>
<ber:icon xlink:href="resource.xml#ic_1"/>
<ber:featureType xlink:href="model.xml#ft_1"/>
</ber:stdConstrTool>
Example 2: Feature construction tools with graphics construction parameters
<ber:stdConstrTool id="ti_2" name="FT 2">
<ber:description>Point on line</ber:description>
<ber:icon xlink:href="resource.xml#ic_2"/>
<ber:initialize autoDAPlace="true" />
<ber:featureType xlink:href="model.xml#ft_2"/>
<ber:pointConstruction>
<ber:angleFromElement/>
<ber:symbolOnLine>
<ber:splitLine copyRelations="true" copyAttachments="true"/>
</ber:symbolOnLine>
</ber:pointConstruction>
</ber:stdConstrTool>
<ber:stdConstrTool id="ti_3a" name="FT 3">
<ber:description>Take over semantics</ber:description>
<ber:icon xlink:href="resource.xml#ic_3" />
<ber:initialize autoDAConstruction="true">
<ber:takeover>
<ber:semantics />
</ber:takeover>
</ber:initialize>
<ber:featureType xlink:href="model.xml#ft_3" />
</ber:stdConstrTool>
<ber:stdConstrTool id="ti_3b" name="FT 3">
<ber:description>Take over semantics - ignore specified atttributes</ber:description>
<ber:icon xlink:href="resource.xml#ic_3" />
<ber:initialize autoDAConstruction="true">
<ber:takeover>
<ber:semantics>
<ber:ignoredAttributes>at_1, at_2, at_3, at_4</ber:ignoredAttributes>
</ber:semantics>
</ber:takeover>
</ber:initialize>
<ber:featureType xlink:href="model.xml#ft_3" />
</ber:stdConstrTool>
<ber:stdConstrTool id="ti_4" name="FT 4">
<ber:description>Take over graphics - single selection + default value</ber:description>
<ber:icon xlink:href="resource.xml#ic_4" />
<ber:initialize autoDAConstruction="true">
<ber:takeover>
<ber:geometry bulk="false" />
</ber:takeover>
</ber:initialize>
<ber:featureType xlink:href="model.xml#ft_4" />
<ber:defaultAttValueArray>
<ber:defaultAttValue>
<ber:attribute xlink:href="model.xml#at_xyz" />
<ber:value>50</ber:value>
</ber:defaultAttValue>
</ber:defaultAttValueArray>
</ber:stdConstrTool>
<ber:stdConstrTool id="ti_5" name="FT 5">
<ber:description>Create shared semantics</ber:description>
<ber:icon xlink:href="resource.xml#ic_5" />
<ber:initialize>
<ber:group addToExisting="false">sharedSemantics</ber:group>
</ber:initialize>
<ber:featureType xlink:href="model.xml#ft_5" />
</ber:stdConstrTool>
<ber:stdConstrTool id="ti_6" name="FT 6">
<ber:description>Create multigeometry</ber:description>
<ber:icon xlink:href="resource.xml#ic_6" />
<ber:initialize>
<ber:group addToExisting="false">multigeometry</ber:group>
</ber:initialize>
<ber:featureType xlink:href="model.xml#ft_6" />
</ber:stdConstrTool>
Example 3: Feature construction tool with automatic attachments creation opening
<ber:stdConstrTool id="ti_1" name="FT 1">
<ber:description>No additional parameters</ber:description>
<ber:icon xlink:href="resource.xml#ic_1"/>
<ber:initialize>
<ber:attachment source="file">
<ber:attachmentType xlink:href="model.xml#att_1"/>
</ber:attachment>
</ber:initialize>
<ber:featureType xlink:href="model.xml#ft_1"/>
</ber:stdConstrTool>
Construction of displayable attributes
Construction tools for placement of displayable attributes are defined similarly to construction tools for features (in particular text features). Default alignment and rotation are set using the ber: defaultTextProperties element and its sub-elements ber:anchorPoint(with values left-top, left-center, left-bottom, center-top, center-center, center-bottom, right-top, right-center, right-bottom) and ber: rotation (with the value in degrees).
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| activeAngle | If the parameter is entered, its value is used as the default angle. | no |
| anglePlus | If the parameter is entered, the entered angle is added to the value of the angle (and the legibility of the text is maintained during placement). | no |
| anglePlus90 | If the parameter is entered, 90° is added to the value of the angle (and the legibility of the text is maintained during placement). | no |
| anglePlus180 | If the parameter is entered, 180° is added to the value of the angle (and the legibility of the text is maintained during placement). | no |
| anglePlus270 | If the parameter is entered, 270° is added to the value of the angle (and the legibility of the text is maintained during placement). | no |
| angleLock | If the parameter is entered (empty), the angle deducted from the selected line segment remains set when the cursor is moved along the line (main feature graphics). | no |
| justificationlock | If the parameter is set (and has no value or has the value true), alignment is preserved. | no |
| dynamicAnchorPoint | If the parameter is set (and has no value or has the value true), alignment changes according to the position of the cursor in relation to the main feature graphics. | no |
| distanceLock | If the parameter is entered, its value is used as the distance lock from main graphics. | no |
| labelLine | If the parameter is set (and has no value or has the value true), a label line is first placed during construction of a displayable attribute. | no |
Example:
<!-- Displayable attribute construction tool with graphics construction parameter -->
<ber:daConstrTool id="ti_3" name="Displayable attribute 1">
<ber:description>Distance 1m from master graphics</ber:description>
<ber:icon xlink:href="resource.xml#ic_3"/>
<ber:displayableAttribute xlink:href="option.xml#da_1"/>
<ber:daConstruction>
<ber:distanceLock>1</ber:distanceLock>
</ber:daConstruction>
</ber:daConstrTool>
Place Zoom Feature
Command: ConstructionSupport DenseArea
This function allows you to place a zoom feature. Settings of parameters in the Place Zoom Feature dialog box can be predefined.
Click on the icon to open the PlaceZoomFeature dialog box with predefined parameters.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureType | Zoom feature type. | no |
| scaleFactor | Value of the Zoom coefficient parameter. Default value: 1 | no |
| specification | Method of specification. Possible values:
| no |
| radius | Radius of the circle if the method of specification is Circle – radius. Default value: 5 | no |
Example:
<ber:tool id="zoomF_2" name="Zoom feature Water - parameters">
<ber:description>Scale 3, circle by radius 50</ber:description>
<ber:icon xlink:href="resource.xml#ic_zoom2"/>
<ber:script>
<ber:module id="ConstructionSupport"/>
<ber:function id="DenseArea"/>
<ber:parameterArray>
<ber:parameter name="featureType" value="ft_5200001"/>
<ber:parameter name="scaleFactor" value="3"/>
<ber:parameter name="specification" value="circleByRadius"/>
<ber:parameter name="radius" value="50"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Place Reference to Zoomed Area
Command: ConstructionSupport DenseAreaRef
This function allows you to place a reference to a zoomed area. Settings of parameters in the
Place Reference to Zoomed Area dialog box can be predefined.
After clicking on the icon, the Place Reference to Zoomed Area dialog box opens with predefined parameters. Further procedure is the same as the description of the Place Reference to Zoomend Area function.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureType | Zoomed area feature type. | no |
| specification | Method of specification. Possible values:
| no |
| labelLine | Enable option Label line. Values: true / false Default value: true | no |
| symbol | Enable option Symbol. Values: true / false Default value: true | no |
| x | Width in the case of method of specification Rotated rectangle – fixed size and Rectangle – fixed size. | yes, if the specification parameter is set to rectangleFixed or rectangleRotatedFixed |
| y | Height in the case of method of specification Rotated rectangle – fixed size and Rectangle – fixed size. | yes, if the specification parameter is set to rectangleFixed or rectangleRotatedFixed |
Example:
<ber:tool id="zoomFRef_3" name="Zoom feature reference - fixed size 1">
<ber:description>Rectangle, symbol ON, label line OFF</ber: description>
<ber:icon xlink:href="resource.xml#ic_zoomRef2"/>
<ber:script>
<ber:module id="ConstructionSupport"/>
<ber:function id="DenseAreaRef"/>
<ber:parameterArray>
<ber:parameter name="featureType" value="ft_5200100"/>
<ber:parameter name="specification" value="rectangleFixed"/>
<ber:parameter name="x" value="10.5"/>
<ber:parameter name="y" value="7"/>
<ber:parameter name="labelLine" value="false"/>
<ber:parameter name="symbol" value="true"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Place Reference to Detail
Command: ConstructionSupport DetailRef
This function allows you to place a reference to a detail. Settings of parameters in the Place Reference to Detail dialog box can be predefined.
After clicking on the icon, the Place Reference to Detail dialog box opens with predefined parameters.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| labelLine | Enable option Label line. Values: true / false Default value: false | no |
| symbol | Enable option Symbol (for the detail component in map layout). Values: true / false Default value: false | no |
| scale | Scale (for detail in the map frame). Sole use with the Zoom option. Switches the Rectangle selection button to the "free" item. | no |
| enlargement | Zoom (for detail in the map frame). Sole use with the Scale option. Switches the Rectangle selection button to the "by detail" item. | no |
Example:
<ber:tool id="detr_2" name="Detail Reference - parameters">
<ber:description>Symbol ON, label line OFF</ber:description>
<ber:icon xlink:href="resource.xml#ic_detRef2"/>
<ber:script>
<ber:module id="ConstructionSupport"/>
<ber:function id="DetailRef"/>
<ber:parameterArray>
<ber:parameter name="labelLine" value="false"/>
<ber:parameter name="symbol" value="true"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Place Parallel Lines
Command: ConstructionSupport ParallelLines
This function allows you to place parallel lines with predefined distance.
After clicking on the icon, the Place Parallel Lines dialog box opens with predefined distance. Further procedure is the same as the description of the Place Parallel Lines function.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| gap | Distance between lines. | no |
| setting | Id of setting including list / order and gaps of to be generated lines. If setting is defined, the gaps are taken from the setting even if gap parameter is defined in the tool. So, defining both parameters in one tool doesn’t make any sense | no |
Example: Pre-set distance between lines
<ber:tool id="ti_parallel_lines" name="Place parallel lines - gap 1,25">
<ber:description>System function - gap pre-set to 1,25m</ber: description>
<ber:icon xlink:href="resource.xml#ic_parallel"/>
<ber:script>
<ber:module id="ConstructionSupport"/>
<ber:function id="ParallelLines"/>
<ber:parameterArray>
<ber:parameter name="gap" value="1.25"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Example: Preconfigured configuration from saved setting
<ber:tool id="ti_parallel_lines" name="Place parallel lines - setting">
<ber:description>Setting includes list, order, gaps</ber: description>
<ber:icon xlink:href="resource.xml#ic_parallel"/>
<ber:script>
<ber:module id="ConstructionSupport"/>
<ber:function id="ParallelLines"/>
<ber:parameterArray>
<ber:parameter name="setting" value="id_140359257843873880"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Place Displayable Attributes for Selected Parallel Lines
Command: ConstructionSupport ParallelDA
This function allows you to place displayable attributes for lines selected in Graphics on the basis of definition of displayable attributes in the parallelda.xml file. This definition determines:
-
a list of line feature types which the displayable attribute is placed for,
-
assignment of one type of displayable attribute for each of these feature types,
-
the option whether the angle for placing displayable attributes will be taken from the feature selected in Graphics,
-
the option whether each displayable attribute will be placed with its own label line, or whether one common label line will be used for all displayable attributes.
After clicking on the icon, the user constructs an auxiliary line in Graphics. Displayable attributes are displayed in the cursor for lines intersected by the auxiliary line; the user places these displayable attributes in Graphics.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| parallelDAPlacementId | Reference to definition of parallel displayable attributes in the parallelda.xml file. | yes |
| angleFromElement | If the parameter is set to the value true, the angle of the placed displayable attribute is determined in the first step by being taken over from the feature selected in Graphics. Values: true / false Default value: false | no |
Example:
<ber:tool id="ti_parallelDA1a" name="Parallel DAs 1 - angle">
<ber:description>Parallel displayable attributes for water pipelines - more space, angle from element</ber:description>
<ber:icon xlink:href="resource.xml#ic_pda1"/>
<ber:script>
<ber:module id="ConstructionSupport"/>
<ber:function id="ParallelDA"/>
<ber:parameterArray>
<ber:parameter name="parallelDAPlacementId" value="parallelDA1"/>
<ber:parameter name="angleFromElement" value="true"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Place Centroid
Command: advancedGeomcentroid
This function allows you to construct a centroid for a selected area. The values of certain attributes of the centroid can optionally be predefined.
After clicking on the icon, the user selects an area. A point feature of the defined type is created, which is a centroid of the selected area.
Parameters:
The ber:featureType element is used to determine the type of constructed point feature.
The values of the individual attributes of this feature can be defined in the ber: defaultAttValue section.
Example:
<ber:extConstrTool id="ti_centroid" name="Symbol in centroid">
<ber:description>Sketch point placed as centroid of selected area</ ber:description>
<ber:icon xlink:href="resource.xml#ic_centroid"/>
<ber:featureType xlink:href="model.xml#ft_5081000"/>
<ber:defaultAttValueArray>
<ber:defaultAttValue>
<ber:attribute xlink:href="model.xml#at_5080003"/>
<ber:value>Placed as centroid</ber:value>
</ber:defaultAttValue>
</ber:defaultAttValueArray>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="centroid"/>
</ber:script>
</ber:extConstrTool>
Place Reduction
Command: reduction construct
This function allows you to place a reduction.
See description of the standard function Place Reduction.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureType | Feature type of constructed reduction. | yes |
Example:
<ber:tool id="reduction_main" name="Main pipeline segment - reduction">
<ber:description>Reduction between Main pipeline segments</ber: description>
<ber:icon xlink:href="resource.xml#ic_reduction_main"/>
<ber:script>
<ber:module id="reduction"/>
<ber:function id="construct"/>
<ber:parameterArray>
<ber:parameter name="featureType" value="ft_main_reduction"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Generate Measure Descriptions
Command: mileageDA place
This function is used for mass generation of measure descriptions for point features positioned on lines. Features must be selected first using the method defined with the aid of the methodKind parameter. After selection of features, you must press the icon and click on graphic view. Descriptions will then be generated.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| pointFT | Type of point feature which the displayable attribute is generated for. | yes |
| pointDA | Type of generated displayable attribute. | yes |
| orientation | Orientation of position of displayable attribute relative to the line direction. Values: left / right Default value: right | no |
| labelLineLength | Length of label line of displayable attribute. Default value: 8 | no |
| labelLineOverlap | Length of label line of displayable attribute in opposite direction. Default value: 0 | no |
| textOrientation | Orientation of text element of displayable attribute. Values: normal / opposite Default value: normal | no |
| pointDAOffset | Distance of text element of displayable attribute from end of label line. Default value: 1 | no |
| lineFT | Type of line feature for determination of normal vector. | yes |
| startDA | Displayable attribute for previous line segment. | no |
| startDAOffset | Distance of displayable attribute for previous line segment from label line. Default value: 1 | no |
| endDA | Displayable attribute for following line segment. | no |
| endDAOffset | Distance of displayable attribute for following line segment from label line. Default value: 1 | no |
| methodKind | A type of method with the aid of which features for processing are selected in graphics. Values:
| No |
| tolerance | Tolerance for selection of features for processing. Default value corresponds to project value. | no |
Example 1:
<ber:tool id="id" name="Name">
<ber:description>Description</ber:description>
<ber:icon xlink:href="resource.xml#icon"/>
<ber:script>
<ber:module id="mileageDA"/>
<ber:function id="place"/>
<ber:parameterArray>
<ber:parameter name="pointFT" value="ft1"/>
<ber:parameter name="pointDA" value="gt1"/>
<ber:parameter name="lineFT" value="ft2"/>
<ber:parameter name="labelLineLength" value="45"/>
<ber:parameter name="orientation" value="left"/>
<ber:parameter name="textOrientation" value="opposite"/>
<ber:parameter name="pointDAOffset" value="2"/>
<ber:parameter name="startDA" value="gt2"/>
<ber:parameter name="startDAOffset" value="2"/>
<ber:parameter name="endDA" value="gt3"/>
<ber:parameter name="endDAOffset" value="2"/>
<ber:parameter name="methodKind" value="SelectionSet"/>
<ber:parameter name="tolerance" value="0.3"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Example 2:
<ber:tool id="id" name="Name">
<ber:description>Description</ber:description>
<ber:icon xlink:href="resource.xml#icon"/>
<ber:script>
<ber:module id="mileageDA"/>
<ber:function id="place"/>
<ber:parameterArray>
<ber:parameter name="pointFT" value="ft1"/>
<ber:parameter name="pointDA" value="gt1"/>
<ber:parameter name="lineFT" value="ft2"/>
<ber:parameter name="labelLineLength" value="10"/>
<ber:parameter name="pointDAOffset" value="2"/>
<ber:parameter name="labelLineOverlap" value="5"/>
<ber:parameter name="methodKind" value="SelectionSet"/>
<ber:parameter name="tolerance" value="0.5"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Generate Details
Command: generateDetailrun
This function allows you to place a standardized detail in graphics according to a specific template defined in metadata. After launching this command, placement of the detail in graphics starts directly. The GenerateDetails dialog box is not displayed.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| detailType | Identifier of a detail template defined in metadata. | yes |
| contactNumber | Number of outlets which will have a detail generated. | yes |
Example:
<ber:tool id="gen_detail1" name="Generate detail">
<ber:description>Generate detail with 5 contacts</ber:description>
<ber:icon xlink:href="resource.xml#ic_genDetail" />
<ber:script>
<ber:module id="generateDetail" />
<ber:function id="run" />
<ber:parameterArray>
<ber:parameter name="detailType" value="DET_NEW1" />
<ber:parameter name="contactNumber" value="5" />
</ber:parameterArray>
</ber:script>
</ber:tool>
Construction with the Aid of a MicroStation Command
Command: MSCONS CADCOMMAND
This function allows you to activate a defined construction command of the MicroStation graphic system while constructing a new feature.
The function is only available in LIDS Edit with the Bentley graphic system.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| CADCmd | MicroStation construction command. | yes |
Example:
<ber:extConstrTool id="ti_5060001" name="Service organization unit - orthoghonal">
<ber:description>Construct area using CAD command PLACE SHAPE ORTHOGONAL</ber:description>
<ber:icon xlink:href="resource.xml#ic_5060001"/>
<ber:featureType xlink:href="model.xml#ft_5060000"/>
<ber:script>
<ber:module id="MSCONS"/>
<ber:function id="CADCOMMAND"/>
<ber:parameterArray>
<ber:parameter name="CADCmd" value="PLACE SHAPE ORTHOGONAL"/>
</ber:parameterArray>
</ber:script>
</ber:extConstrTool>
New Feature without Graphics
Command: lidsMain newFeature
This function allows you to create a new feature of the given type without graphics. The values of certain attributes can optionally be predefined.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureType | New feature type. | yes |
| Attribute ID | Attribute of the given feature type filled with a predefined value. Values may be defined for several attributes. | no |
Example:
<ber:tool id="sys_newFeature2" name="New feature without graphics2">
<ber:description>Calls system function</ber:description>
<ber:icon xlink:href="resource.xml#ic_newFeature"/>
<ber:script>
<ber:module id="lidsMain"/>
<ber:function id="newFeature"/>
<ber:parameterArray>
<ber:parameter name="featureType" value="ft_5010100"/>
<ber:parameter name="at_5010006" value="poznamka1"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
New Feature with Collection Type Graphics
Command: graphicElm multiConstruction
This function allows you to construct features with collection type graphics.
After clicking on the icon, a construction form opens for construction of a feature with collection type graphics. The user gradually selects and constructs individual graphics component types.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featuretype | Constructed feature type. | yes |
Example:
<ber:tool id="ti_508_collection" name="Sketch collection">
<ber:description>Construction of individual components of collection</ ber:description>
<ber:icon xlink:href="resource.xml#ic_sketch_collection"/>
<ber:script>
<ber:module id="graphicElm"/>
<ber:function id="multiConstruction"/>
<ber:parameterArray>
<ber:parameter name="featuretype" value="ft_508_collection"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Place Symbol at Distance
Command: advancedGeom placeAtDistance
This function allows you to place a symbol at the entered distance.
After clicking on the icon, a dialog opens with the distance parameter and the user launches placement of the symbol at the entered distance by selecting that part of the line which should be the start for finding the path.
The function can also be used to place a symbol on a cable and at the same time on the route which the cable passes through. The parameters used for this use of the function are placeRouteFT and routePathFT.
If the placeRouteFT and routePathFT parameters are used, then the function will only work correctly if the geometry of the cable and the respective routes are placed in parallel and with the same orientation – i.e. the following conditions must be met:
- the distance between the start point of the selected cable and the start point of the respective routes is less than the distance to the other end of the routes,
- the angle of the selected cable segment is similar to the angle of the respective routes.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| placeFT | Type of point feature for placement. | yes |
| placeRouteFT | Type of point feature for placement on a route. | no |
| linePathFT | Types of line features for finding a path or their attributes | yes |
| routePathFT | Types of route features which will be processed if the function is used to place point features on the cable and the route. | no |
| symbolPathFT | Types of point features which extend the path and may be placed at vertexes of lines which create the path. An attribute, the value of which determines extension, must be stated for each type. | no |
| targetFT | Type of point feature which closes a path. If this type of feature is found on the path before the defined distance is reached and the path no longer continues, the feature of this type is regarded as the found target. | no |
| processJunction | The parameter determines whether any junctions which may be found before reaching the end of the path will also be processed (false means that placing of a symbol is not performed if a junction is found). If point features are placed on a cable and on a route and the value of the parameter is true, point features are placed on all found branches. | no |
| selPosOnStart | The parameter determines whether the position of the start of measuring should be determined along the start line. If not, the end point of the line nearer to the place of selection of the line is regarded as the start of measuring. | no |
| selectCable | The parameter determines whether a cable should be selected for distance (one of the cables on the selected route). In this case, searching for the path is performed on lines of routes containing the given cable. | no |
| cableReactance | Attribute (+column of codelist) determining the value of the attenuation coefficient of the cable in [m/µs]. Relates to the cable in the route. The parameter only makes sense in combination with the parameter selectCable. | no |
| tolerance | Tolerated distance of point features from vertexes of lines and distance of end points of connected lines. If not stated, project tolerance is used. | no |
| labelDistance | Optional description for distance which is displayed in the dialog box. If not entered, "Distance" or "Time" is used. | no |
| labelUnit | Optional description for unit which is displayed in the dialog box. If not entered, "m" or "ms" is used. | no |
Example 1:
<ber:tool id="t_1" name="Place symbol at distance 1">
<ber:description>Simple example 1</ber:description>
<ber:icon xlink:href="resource.xml#ic_1" />
<ber:script>
<ber:module id="advancedGeom" />
<ber:function id="placeAtDistance" />
<ber:parameterArray>
<ber:parameter name="placeFT" value="ft_damage" />
<ber:parameter name="linePathFT" value="ft_line_1,ft_line_2" />
<ber:parameter name="tolerance" value="0.1" />
</ber:parameterArray>
</ber:script>
</ber:tool>
<ber:tool id="t_2" name="Place symbol at distance 2">
<ber:description>Using DB length and reactance</ber:description>
<ber:icon xlink:href="resource.xml#ic_2" />
<ber:script>
<ber:module id="advancedGeom" />
<ber:function id="placeAtDistance" />
<ber:parameterArray>
<ber:parameter name="placeFT" value="ft_damage" />
<ber:parameter name="linePathFT" value="ft_line_1;at_length_1; at_reactance,ft_line_2;at_length_2,ft_line_3" />
<ber:parameter name="symbolPathFT" value="ft_spare; at_spare_length" />
<ber:parameter name="targetFT" value="ft_box" />
<ber:parameter name="tolerance" value="0.5" />
<ber:parameter name="selPosOnStart" value="true" />
<ber:parameter name="processJunction" value="true" />
</ber:parameterArray>
</ber:script>
</ber:tool>
<ber:tool id="t_3" name=" Place symbol at distance 3">
<ber:description>First select route, then select cable</ber: description>
<ber:icon xlink:href="resource.xml#ic_3" />
<ber:script>
<ber:module id="advancedGeom" />
<ber:function id="placeAtDistance" />
<ber:parameterArray>
<ber:parameter name="placeFT" value="ft_damage" />
<ber:parameter name="linePathFT" value="ft_route;at_length" />
<ber:parameter name="tolerance" value="0.5" />
<ber:parameter name="selPosOnStart" value="true" />
<ber:parameter name="selectCable" value="true" />
<ber:parameter name="cableReactance" value="at_reactance/ca_value"
/>
<ber:parameter name="labelDistance" value="Resistance" />
<ber:parameter name="labelUnit" value="mΩ" />
</ber:parameterArray>
</ber:script>
</ber:tool>
Example 2 - use of the place Route FT and route PathFT parameters:
<ber:tool id="t4" name="Find damage on Routes and Cables">
<ber:description>Select Cable - with junction</ber:description>
<ber:icon xlink:href="resource.xml#ic_4"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="placeAtDistance"/>
<ber:parameterArray>
<ber:parameter name="placeFT" value="ft_cable_damage"/>
<ber:parameter name="placeRouteFT" value="ft_route_damage"/>
<ber:parameter name="linePathFT" value="ft_cable_1, ft_cable_2, ft_cable_3"/>
<ber:parameter name="routePathFT" value="ft_route"/>
<ber:parameter name="tolerance" value="0.5"/>
<ber:parameter name="selPosOnStart" value="true"/>
<ber:parameter name="processJunction" value="true"/>
<ber:parameter name="cableReactance" value="at_reactance/ ca_value"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Cohere Construction
Command: cohereConstruction endPointsOnLine
This function allows you to construct a line feature, for which a start and end point feature of the defined type is automatically created.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| lineFT | Type of line feature captured. | yes |
| startPointFT | Type of point feature captured automatically at the start of the line. | no |
| startPointOffset | Distance of the start point feature from the start of the line. If the value is negative, the point feature is generated in front of the start of the line (i.e. it does not lie on the line). Default value: 0 | no |
| startOffsetPointVertex | Determines whether an inner vertex of the line should be created on placement of the start point feature on the line. Values: true / false Default value: false | no |
| startPointRotation | Angle of rotation of the point feature captured at the start of the line. If the value of the parameter starts with the + or - sign, the angle is then defined as relative with a view to the angle of the start segment of the constructed line feature. If no sign is specified, the angle is defined as absolute. Default value: relative 0° | no |
| endPointFT | Type of point feature captured automatically at the end of the line. | no |
| endPointOffset | Distance of the end point feature from the end of the line. If the value is negative, the point feature is generated after the end of the line (i.e. it does not lie on the line). Default value: 0 | no |
| endOffsetPointVertex | Determines whether an inner vertex of the line should be created on placement of the end point feature on the line. Values: true / false Default value: false | no |
| endPointRotation | Angle of rotation of the point feature captured at the end of the line. If the value of the parameter starts with the + or - sign, the angle is then defined as relative with a view to the angle of the end segment of the constructed line feature. If no sign is specified, the angle is defined as absolute. Default value: relative 0° | no |
| businessFT | If defined, polygon feature is generated around the line and point features as their MBR, expanded by boundaryOffset. The SAMO assignments are generated between the features as well. | no |
Example 1:
<ber:tool id="ti_servicePipeExtractionPoint" name="Cohere Construction 1
- simple">
<ber:description>Service pipe - valve as start point, extraction point as end point</ber:description>
<ber:icon xlink:href="resource.xml#ic_servicePipeExtractionPoint"/>
<ber:script>
<ber:module id="cohereConstruction"/>
<ber:function id="endPointsOnLine"/>
<ber:parameterArray>
<ber:parameter name="lineFT" value="ft_5012200"/>
<ber:parameter name="startPointFT" value="ft_5011100"/>
<ber:parameter name="endPointFT" value="ft_5010200"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Example 2:
<ber:tool id="ti_servicePipeExtractionPointOffset" name="Cohere Construction 2 - offset, rotation">
<ber:description>Service pipe - valve as start point, extraction point as end point</ber:description>
<ber:icon xlink:href="resource.xml#ic_servicePipeExtractionPoint"/>
<ber:script>
<ber:module id="cohereConstruction"/>
<ber:function id="endPointsOnLine"/>
<ber:parameterArray>
<ber:parameter name="lineFT" value="ft_5012200"/>
<ber:parameter name="startPointFT" value="ft_5011100"/>
<ber:parameter name="startPointOffset" value="0.5"/>
<ber:parameter name="startOffsetPointVertex" value="true"/>
<ber:parameter name="startPointRotation" value="0"/>
<ber:parameter name="endPointFT" value="ft_5010200"/>
<ber:parameter name="endPointOffset" value="-1"/>
<ber:parameter name="endOffsetPointVertex" value="true"/>
<ber:parameter name="endPointRotation" value="+180"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Example 3: Business feature generated as surface around the line and points, assignments created
<ber:tool id="ti_3" name="Cohere Construction + business object">
<ber:description> </ber:description>
<ber:icon xlink:href="resource.xml#ic_3"/>
<ber:script>
<ber:module id="cohereConstruction"/>
<ber:function id="endPointsOnLine"/>
<ber:parameterArray>
<ber:parameter name="lineFT" value="ft_line"/>
<ber:parameter name="startPointFT" value="ft_point1"/>
<ber:parameter name="endPointFT" value="ft_point2"/>
<ber:parameter name="boundaryOffset" value="1.0"/>
<ber:parameter name="businessFT" value="ft_boWorkOrderArea"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Sequence of Construction Commands
The project toolbar may contain icons which are defined in the project for launch of a whole sequence of construction commands. After having been launched, a construction dialog box opens for the first construction command in the given sequence. Once it has ended, the following command is automatically activated. After the last command in the given sequence has ended, the whole construction is activated again from the start.
Apart from construction commands for new features, commands for placing displayable attributes can also be used in the sequence.
Example:
<ber:chainConstrTool id="ti_seq1" name="Chain construction tool">
<ber:description>Valve - Service pipe with DA - Extraction point</ber:
description>
<ber:icon xlink:href="resource.xml#ic_seq1"/>
<ber:toolArray>
<ber:tool refId="ti_5011100"/>
<ber:tool refId="ti_5012200"/>
<ber:tool refId="ti_5012202"/>
<ber:tool refId="ti_5010200"/>
</ber:toolArray>
</ber:chainConstrTool>
Generate Descriptions of Vertical Transitions
Command: verticalDA place
The function is used to generate descriptions of vertical transitions to point elements placed on lines in groups. The features must first be selected using the method defined with the methodKind parameter. After selecting the features, click on the icon and click on the graphical view. The descriptions are then generated.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| pointFT | Type of point feature, for which the displayable attribute will be generated. | yes |
| pointDA | Type of the displayable attribute which will be generated. | yes |
| lineFT | Type of line feature to define the normal. | yes |
| startDA | Displayable attribute for the previous line segment | yes |
| endDA | Displayable attribute for the next line segment | yes |
| labelLineLength | Length of the label line for displayable attribute Default value: 10 | no |
| pointDAOffset | Offset of the displayable attribute from the end of the label line Default value: 1 | no |
| verticalDAOffset | Offset of the displayable attribute from the vertical Default value: 1 | yes |
| verticalLineLength | Length of the labeling line of the vertical. Default value: 10 | no |
| tiltCoef | Exaggeration coefficient Default value: 10 | no |
| tiltStart | Attribute id, which defines the angle of the incoming labeling line | yes |
| tiltEnd | Attribute id, which defines the angle of the outgoing labeling line | yes |
| invertStart | Defines, if value of tiltStart should be inverted Default value: true | no |
| invertEnd | Defines, if value of tiltEnd should be inverted Default value: false | no |
| orientation | Position of the displayable attribute relative to the line direction Values: right / left Default value: right | no |
| textOrientation | Orientation of the displayable attribute Values: normal / opposite Default value: normal | no |
| methodKind | A type of method with the aid of which features for processing are selected in Graphics. Values: • Fence – by fence • SelectionSet – by selection set | no |
Example 1:
<ber:tool id="id" name="Name">
<ber:description>Description</ber:description>
<ber:icon xlink:href="resource.xml#icon"/>
<ber:script>
<ber:module id="verticalDA"/>
<ber:function id="place"/>
<ber:parameterArray>
<ber:parameter name="pointFT" value="ft_1"/>
<ber:parameter name="pointDA" value="gtt_1_1"/>
<ber:parameter name="lineFT" value="ft_2"/>
<ber:parameter name="startDA" value="gtt_1_2"/>
<ber:parameter name="endDA" value="gtt_1_3"/>
<ber:parameter name="tiltStart" value="at_1_start"/>
<ber:parameter name="tiltEnd" value="at_1_end"/>
<ber:parameter name="methodKind" value="SelectionSet"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Example 2:
<ber:tool id="id" name="Name">
<ber:description>Description</ber:description>
<ber:icon xlink:href="resource.xml#icon"/>
<ber:script>
<ber:module id="verticalDA"/>
<ber:function id="place"/>
<ber:parameterArray>
<ber:parameter name="pointFT" value="ft_1"/>
<ber:parameter name="pointDA" value="gtt_1_1"/>
<ber:parameter name="lineFT" value="ft_2"/>
<ber:parameter name="startDA" value="gtt_1_2"/>
<ber:parameter name="endDA" value="gtt_1_3"/>
<ber:parameter name="labelLineLength" value="8"/>
<ber:parameter name="pointDAOffset" value="3"/>
<ber:parameter name="verticalDAOffset" value="2"/>
<ber:parameter name="verticalLineLength" value="6"/>
<ber:parameter name="tiltCoef" value="500"/>
<ber:parameter name="tiltStart" value="at_1_start"/>
<ber:parameter name="tiltEnd" value="at_1_end"/>
<ber:parameter name="orientation" value="left"/>
<ber:parameter name="methodKind" value="SelectionSet"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Editing Functions
Find Duplicate Vertexes
Command: advancedGeom findDuplicateVertexes
For line elements or area borders (including borders of holes in areas) selected in Graphics, this function searches for neighboring vertexes, the distance of which from each other is less than the determined tolerance. Auxiliary symbols are displayed in Graphics at positions corresponding to duplicate vertexes.
If a line has only two vertexes, it is not processed by the function. Elements must be selected in advance using the method defined with the aid of the methodId parameter.
The function also processes line elements and area borders of attached external files.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| methodId | ID of a method with the aid of which features for processing are selected in Graphics. Values in LIDS Edit: 1 – by fence 2 – by selection set Values in LIDS Explorer: 1 – by selection set | yes |
| tolerance | Neighboring vertexes of lines or area borders at a distance less than the set tolerance will be regarded as duplicate. | yes |
Example:
<ber:tool id="find_duplicateVertexes" name="Find duplicate vertexes">
<ber:icon xlink:href="resource.xml#ic_findDuplicateVertexes"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="findDuplicateVertexes"/>
<ber:parameterArray>
<ber:parameter name="methodId" value="1"/>
<ber:parameter name="tolerance" value="0,01"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Remove Duplicate Vertexes
Command: advancedGeom removeDuplicateVertexes
For line elements or area borders (including borders of holes in areas) selected in Graphics, this function performs merging of neighboring vertexes, the distance of which from each other is less than the set tolerance. If a line has only two vertexes, it is not processed by the function. Elements can be selected individually (unless the methodId parameter has been entered) or in bulk.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| methodId | ID of a method with the aid of which features for processing are selected in Graphics. Values in LIDS Edit: 1 – by fence 2 – by selection set Values in LIDS Explorer: 1 – by selection set | no |
| tolerance | Neighboring vertexes of lines or area borders at a distance less than the set tolerance will be merged into one vertex. | yes |
Example:
<ber:tool id="linear_duplicateVertexes" name="Remove duplicate vertexes">
<ber:description>Removes duplicate vertexes from linear elements</ber: description>
<ber:icon xlink:href="resource.xml#ic_removeDuplicateVertexes"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="removeDuplicateVertexes"/>
<ber:parameterArray>
<ber:parameter name="methodId" value="1"/>
<ber:parameter name="tolerance" value="0,01"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Delete Inner Vertexes of Lines in Bulk
Command: advancedGeom deleteInnerVertices
This function allows you to delete the inner vertexes of all selected lines. Features for processing can be selected individually (if the methodKind parameter is not set) or in bulk.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| methodKind | A type of method with the aid of which features for processing are selected in Graphics. Values: Fence – by fence SelectionSet – by selection set | no |
Example:
<ber:tool id="delete_innerVertices2" name="Delete inner vertices - selection set">
<ber:description>Select features before calling function</ber: description>
<ber:icon xlink:href="resource.xml#ic_delVert2"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="deleteInnerVertices"/>
<ber:parameterArray>
<ber:parameter name="methodKind" value="SelectionSet"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Move Feature
Command: advancedGeom moveSelected
This function is used to move a selected feature. Optionally, it’s possible to move also the features included in the details of the selected feature.
After clicking on the icon, the user selects a feature in Graphics. Click on the left mouse button to determine the grabbing point. The user selects the new target placement by dragging on the grabbing point.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureTypes | List of feature types which can be selected for movement. Feature types in the list are separated by a comma. | no |
| moveWithDetails | Determines whether features included in details are also moved. Values: true / false Default value: false | no |
| detailTypes | List of detail types which should be moved. Types are separated by a comma in the list. Makes sense only in combination with moveWithDetails = true. If moveWithDetails = true and detailTypes are not defined, all details are processed | no |
Example – all details of selected feature are processed:
<ber:tool id="ti_1" name="Move with detail 1">
<ber:description>Select feature and details are moved too</ber:description>
<ber:icon xlink:href="resource.xml#ic_moveWithDetail1"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="moveSelected"/>
<ber:parameterArray>
<ber:parameter name="moveWithDetails" value="true"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Example – details of defined types of defined feature types are processed:
<ber:tool id="ti_2" name="Move with detail 2">
<ber:description>Select feature and details are moved too</ber:description>
<ber:icon xlink:href="resource.xml#ic_moveWithDetail2"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="moveSelected"/>
<ber:parameterArray>
<ber:parameter name="featureTypes" value="ft_1,ft_2,ft_3"/>
<ber:parameter name="moveWithDetails" value="true"/>
<ber:parameter name="detailTypes" value="det_1,det_2"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Move with Context
Command: advancedGeom moveElems
This function allows you to move a selected point feature or vertex of a line or area to a new location. The associated graphics or features bordering the feature can also be automatically moved together with the feature.
Use of the function is the same as the description of the standard function Move with Context.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureTypes | List of feature types which can be selected for movement. Feature types in the list are separated by a comma. | no |
| sameFeatureType | Determines whether point features or vertexes of line features of the same type as the selected feature should be moved. Values: true / false Default value: false | no |
| displayMeasure | Determines whether the length of the segments will be displayed during editing of line and area features and in the case of areas, also the surface area of the features. Values for area features: • None – do not display anything • Length – only display the length • Area – display the surface area • All – display the length and the surface area Values for line features: • None – do not display anything • Length – display the length If the parameter is not set, use is made of the global settings specified in the Settings / Construction of Features dialog box. | no |
| measureUnits | Units in which the displayed surface area or length of segments is given. Values for area features: m2, cm2, a, ha, km2 Default value: m2 The corresponding unit is also used to display lengths: • m2/a/ha -> m • cm2 -> cm • km2 -> km Values for line features: m, cm, km, mm Default value: m | no |
| tolerance | Distance in meters which specifies how far from the processed vertex/point the vertices/points of other features can be in order for them to be processed simultaneously. Vertices/points like this are moved to a common position. Default value: project tolerance | no |
Example:
<ber:tool id="ti_moveElems1" name="Move parcel and parcel borders">
<ber:description>Select Parcel/Parcel boundary </ber:description>
<ber:icon xlink:href="resource.xml#ic_moveWithContextRelationships2"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="moveElems"/>
<ber:parameterArray>
<ber:parameter name="featureTypes" value=" ft_parcel_boundary, ft_parcel_face "/>
<ber:parameter name="displayMeasure" value="All"/>
<ber:parameter name="tolerance" value="0.5"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Move with Context on the Basis of Relationships
Command: advancedGeom moveElemWithRelated
This function is used to move a selected feature together with features which are related with the aid of determined relationship types.
After clicking on the icon, the user selects a feature in Graphics. Click on the left mouse button to determine the grabbing point. The user selects the new target placement by dragging on the grabbing point.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureTypes | List of feature types which can be selected for the move. Types are separated by a comma in the list. | yes |
| relationsTypes | List of relationship types separated by a comma. Features related by these relationship types are moved together with the moved feature. | yes |
| cascade | Determines whether features related in cascade are also moved. Values: true / false Default value: false | no |
Example:
<ber:tool id="ti_moveWithContextRelationships2" name="Move with context according relatioships 2">
<ber:description>Select TELCO cassette in graphics and all related cassettes and contacts are moved too</ber:description>
<ber:icon xlink:href="resource.xml#ic_moveWithContextRelationships2"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="moveElemWithRelated"/>
<ber:parameterArray>
<ber:parameter name="cascade" value="true"/>
<ber:parameter name="featureTypes" value="ft_telco_rack_dev, ft_telco_router,ft_telco_dwdm,ft_telco_cassette,ft_telco_rs_cassette, ft_telco_spl_cassette,ft_telco_router_cassette,ft_telco_dwdm_cassette"/>
<ber:parameter name="relationsTypes" value="r_device_cassette, r_router_routcassette,r_dwdm_dwdmcassette,r_cassette_contact, r_cassette_sppoint,r_splcassette_splpoint,r_routcassette_routcont, r_dwdmcassette_dwdmcont"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Copy Features
Command: graphicElm.copyFeatures
This function allows you to copy a feature with settings determined by parameter values.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| takeOverAttributes | If the value is true, the semantics of the created feature will be populated with the values of the source feature. In the case of a copy with change of the feature type, the values of the common attributes are taken over. Values: true / false Default value: false | no |
| takeOverCoordinates | If the value is true, the graphics of the new feature is created in the coordinates of the source feature as a copy of its geometry. Parameters for geometric transformation are not applied. Values: true / false Default value: false | no |
| takeOverAttachments | If the value is true, the same attachments as attached to the source feature are copied to the new feature. Values: true / false Default value: true | no |
| takeOverRelations | If the value is true, the new feature will automatically be related to the same superior features (in relationship M:1 or M:N) to which the source feature is related. Values: true / false Default value: true | no |
| featureCopyMetaId | Identification of feature type conversion table defined in project metadata. Default value: empty string (i.e. conversion table not specified). | no |
Example:
<ber:tool id="ti_copy_feature" name="Copy feature">
<ber:description>Feature copy with defined parameters</ber: description>
<ber:icon xlink:href="resource.xml#ic_copy_feature"/>
<ber:script>
<ber:module id="graphicElm"/>
<ber:function id="copyFeatures"/>
<ber:parameterArray>
<ber:parameter name="takeOverAttributes" value="true"/>
<ber:parameter name="takeOverCoordinates" value="false"/>
<ber:parameter name="takeOverAttachments" value="true"/>
<ber:parameter name="takeOverRelations" value="false"/>
<ber:parameter name="featureCopyMetaId" value="tb_5"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Split Parallel Lines
Command: advancedGeom splitLineMulti
This function allows for simultaneous splitting of several lines.
After clicking on the icon, the user constructs an auxiliary line in Graphics. Line features intersected by the auxiliary line will be split at the intersection points.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| splitMode | The line is split at the intersection with the auxiliary line: the part from the start point to the split point is preserved, the other part will be processed in one of the following ways according to parameter settings: • newFeature – a new feature is created from the other part of the line, • sharedSemantics – a new feature will be created as a part of shared semantics, • multiGeometry – feature graphics will be split into several geometric elements (multigeometry). Default value: newFeature | no |
| copyRelations | If a new feature is created when the line is split, setting this parameter can be used to ensure that the relationships are copied from the original feature to the new feature. Values: true / false Default value: true | no |
Example 1:
<ber:tool id="ti_cutParallel3" name="Cut parallel lines 3">
<ber:description>Result as shared semantics</ber:description>
<ber:icon xlink:href="resource.xml#ic_pCut" />
<ber:script>
<ber:module id="advancedGeom" />
<ber:function id="splitLineMulti" />
<ber:parameterArray>
<ber:parameter name="splitMode" value="sharedSemantics" />
</ber:parameterArray>
</ber:script>
</ber:tool>
Example 2:
<ber:tool id="ti_cutParallel4" name="Cut parallel lines 4">
<ber:description>Result as new features + don't copy relationships</ ber:description>
<ber:icon xlink:href="resource.xml#ic_pCut"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="splitLineMulti"/>
<ber:parameterArray>
<ber:parameter name="copyRelations" value="false"/>
<ber:parameter name="splitMode" value="newFeature"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Split Line with Interpolation of Height
Command: advancedGeom splitLine
The function allows you to split a line with a defined height at the start and at the end. The height at the split point is calculated by interpolation and is saved for the start and end of the resulting lines to the respective attributes.
Use of the function is the same as the description of the standard Split Line function.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureTypes | List of feature types which can be selected for splitting. Types in the list are separated by a comma. | no |
| startHeightAttributes | List of attributes containing the height value for the start of the line. Attributes in the list are separated by a comma. | yes |
| endHeightAttributes | List of attributes containing the height value for the end of the line. Attributes in the list are separated by a comma. | yes |
Example:
<ber:tool id="id" name="Name">
<ber:description>Description</ber:description>
<ber:icon xlink:href="resource.xml#icon"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="splitLine"/>
<ber:parameterArray>
<ber:parameter name="featureTypes" value="ft1,ft2"/>
<ber:parameter name="startHeightAttributes" value="at1,at2"/>
<ber:parameter name="endHeightAttributes" value="at3,at4"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Move Line with Context
Command: advancedGeom moveLineWithContext
This function allows you to move a selected point feature or vertex of a line to a new position. The feature’s associated graphics, line features bordering it and also point features and the first segments of lines which touch the bordering lines are automatically moved together with the feature.
After clicking on the icon, the user selects a point feature or vertex of a line for the move with context in Graphics and places it in its new position.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| relationsTypes | List of relationship types separated by a comma. Features related by these types of relationships are moved with the moved feature. | no |
| tolerance | This parameter determines the distance from the vertex of the bordering line at which features are regarded as touching. | no |
Example:
<ber:tool id="ti_moveLineWithContext2" name="Move line with context 2">
<ber:description>Move end point of a line, tolerance = 2m</ber: description>
<ber:icon xlink:href="resource.xml#ic_moveLineWithContext"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="moveLineWithContext"/>
<ber:parameterArray>
<ber:parameter name="tolerance" value="2"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Add Feature to Shared Semantics
Command: advancedGeom addSharedSemanticMember
This function allows you to construct a feature sharing semantics with an existing feature.
After clicking on the icon, the user selects a feature in Graphics, for which creation of shared semantics is permitted. A construction dialog box opens, allowing for construction of a new feature as a part of shared semantics of the feature selected in Graphics.
Example:
<ber:tool id="sys_new_ss_add" name="Capture feature - add to shared semantics">
<ber:description>Select feature first + construct additional shared semantics graphics</ber:description>
<ber:icon xlink:href="resource.xml#ic_5112200_1"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="addSharedSemanticMember"/>
</ber:script>
</ber:tool>
Join Features
Command: graphicElm joinElements
The function is used to create shared semantics or multigeometry from existing features. It can also add features to already existing shared semantics / multigeometry.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| sharedSemantics | If the parameter is set at the value true, the mode is set to Shared Semantics. Values: true / false Default value: false | no |
Example:
<ber:tool id="sys_join_features_shared_semantics" name="Join Features - shared semantics">
<ber:description>Open the window Join Features and set the mode to Shared Semantics</ber:description>
<ber:icon xlink:href="resource.xml#ic_123"/>
<ber:script>
<ber:module id="graphicElm"/>
<ber:function id="joinElements"/>
<ber:parameterArray>
<ber:parameter name="sharedSemantics" value="true"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Join Areas
Command: advancedGeom unionArea
This function allows you to join two area features with a not-empty intersection. The resulting feature can be automatically displayed in the defined form.
After clicking on the icon, the user gradually selects area features to join in Graphics. After confirmation, the features are joined and where applicable, a form opens for viewing the resulting feature.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| sameFeatureTypes | If the parameter is set at the value true, the joined areas must have the same feature type. Values: true / false Default value: false | no |
| featureTypes | List of area feature types which can be selected to join. Feature types are separated in the list by a comma. | no |
| resultingFeatureForm | ID of form for displaying the resulting feature. | no |
Example:
<ber:tool id="joinAreaSOU" name="Join permitted areas">
<ber:description>Only the same feature type possible + display resulting form</ber:description>
<ber:icon xlink:href="resource.xml#ic_placeDA"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="unionArea"/>
<ber:parameterArray>
<ber:parameter name="sameFeatureTypes" value="true"/>
<ber:parameter name="featureTypes" value="ft_parcel_face, ft_5083000"/>
<ber:parameter name="resultingFeatureForm" value="fml_50600"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Add Area to Area
Command: advancedGeom addArea
This function allows you to add the area of a second selected feature to the area of the first selected feature (geometry with a not-empty intersection is joined). The resulting feature can be displayed automatically in the defined form.
After clicking on the icon, the user in turn selects two area features in Graphics. After confirmation, the area of the second feature is added to the area of the first area (the second feature remains unchanged) and where applicable, a form opens displaying the resulting feature.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| sameFeatureTypes | If the parameter is set to the value true, both joined areas must have the same feature type. Values: true / false Default value: false | no |
| featureTypes | List of area feature types which can be selected for addition. Feature types in the list are separated by a comma. | no |
| resultingFeatureForm | ID of form for displaying resulting feature. | no |
Example:
<ber:tool id="addAreaSOU" name="Add permitted areas">
<ber:description>Only the same feature type possible + display resulting form</ber:description>
<ber:icon xlink:href="resource.xml#ic_placeDA"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="addArea"/>
<ber:parameterArray>
<ber:parameter name="sameFeatureTypes" value="true"/>
<ber:parameter name="featureTypes" value="ft_parcel_face, ft_5083000"/>
<ber:parameter name="resultingFeatureForm" value="fml_50600"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Subtract Areas
Command: advancedGeom diffArea
This function allows you to subtract the areas of two area features with a not-empty intersection.
After clicking on the icon, the user in turn selects two area features in Graphics(the area of the second feature is subtracted from the area of the first feature). After confirmation, the features are subtracted, and an inner vertex may be inserted on the borders of neighboring area features in the location of newly created vertexes of the first area.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureTypes | List of area feature types which can be selected for subtraction. Feature types in the list are separated by a comma. | no |
| insertVertices | Determines whether inner vertexes are inserted on the borders of neighboring areas. Values: true / false Default value: false | no |
| verticesSameFT | Determines whether only those neighboring areas with the same feature type as the first feature selected should be selected for insertion of vertexes. Values: true / false Default value: false | no |
| adjacentFeatureTypes | List of types of neighboring area features on the border of which it is permitted to insert an inner vertex. Feature types in the list are separated by a comma. | no |
| tolerance | Value of the maximum distance of a neighboring area from the newly created vertex and also the minimum distance between two vertexes of the neighboring area. Default value: 0.0005 | no |
Example:
<ber:tool id="diffAreaSOU" name="Difference permitted areas">
<ber:description>Only the same feature type possible</ber:description>
<ber:icon xlink:href="resource.xml#ic_placeDA"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="diffArea"/>
<ber:parameterArray>
<ber:parameter name="featureTypes" value="ft_parcel_face, ft_5083000"/>
<ber:parameter name="insertVertices" value="true"/>
<ber:parameter name="verticesSameFT" value="true"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Split Area
Command: advancedGeom splitArea
This function allows you to split an area feature and create a new feature from part of it (see description of the standard function t). After confirming the split, an inner vertex may be inserted on the borders of neighboring area features in the location of newly created vertexes depending on settings of the parameters.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureTypes | List of area feature types which can be selected for splitting. Feature types in the list are separated by a comma. | no |
| noGroupsOption | Determines whether the dropdown icon with the options One Graphics/Multigeometry/Shared Semantics will be hidden. Values: true / false Default value: false | no |
| insertVertices | Determines whether inner vertexes are inserted on the borders of neighboring areas. Values: true / false Default value: false | no |
| verticesSameFT | Determines whether only those neighboring areas with the same feature type as the 1st feature selected should be selected for insertion of an inner vertex. Only applied if the insertVertices parameter is set to the value true. Values: true / false Default value: false | no |
| adjacentFeatureTypes | List of types of area features for which insertion of inner vertexes is permitted if they figure as neighboring areas. Feature types in the list are separated by a comma. Only applied if the insertVertices parameter is set to the value true. | no |
| tolerance | Value of the maximum distance of a neighboring area from the newly created vertex and also the minimum distance between two vertexes of the neighboring area. Default value: 0.0005 | no |
| displayMeasure | Determines whether the length of the segments will be displayed during editing of line and area features and in the case of areas, also the surface area of the features. Values for area features: • None – do not display anything • Length – only display the length • Area – display the surface area • All – display the length and the surface area Values for line features: • None – do not display anything • Length – display the length If the parameter is not set, use is made of the global settings specified in the Settings / Construction of Features dialog box. | no |
| measureUnits | Units in which the displayed surface area or length of segments is given. Values for area features: m2, cm2, a, ha, km2 Default value: m2 The corresponding unit is also used to display lengths: • m2/a/ha -> m • cm2 -> cm • km2 -> km Values for line features: m, cm, km, mm Default value: m | no |
Example:
<ber:tool id="splitAreaSOU" name="Split permitted areas">
<ber:description>Only the same feature type is possible to insert vertices</ber:description>
<ber:icon xlink:href="resource.xml#ic_placeDA"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="splitArea"/>
<ber:parameterArray>
<ber:parameter name="featureTypes" value="ft_parcel_face, ft_5083000"/>
<ber:parameter name="insertVertices" value="true"/>
<ber:parameter name="verticesSameFT" value="true"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Insert Vertex on Common Border
Command: advancedGeom addVertexMulti
This function allows you to simultaneously insert a new vertex on overlapping line segments and borders of area features and to select placement of the newly inserted vertex.
Use of the function is the same as the description of the standard function Insert Vertex on Common Border.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureTypes | List of feature types which can be selected for insertion of the new vertex. Types in the list are separated by a comma. | no |
| sameFeatureType | Determines whether only features of the same type as the selected feature will be edited. Values: true / false Default value: false | no |
| tolerance | Determines the distance from the vertex of the bordering line at which features are regarded as touching. Default value: 0.0005 | no |
| displayMeasure | Determines whether the length of the segments will be displayed during editing of line and area features and in the case of areas, also the surface area of the features. Values for area features: • None – do not display anything • Length – only display the length • Area – display the surface area • All – display the length and the surface area Values for line features: • None – do not display anything • Length – display the length If the parameter is not set, use is made of the global settings specified in the Settings / Construction of Features dialog box. | no |
| measureUnits | Units in which the displayed surface area or length of segments is given. Values for area features: m2, cm2, a, ha, km2 Default value: m2 The corresponding unit is also used to display lengths: • m2/a/ha -> m • cm2 -> cm • km2 -> km Values for line features: m, cm, km, mm Default value: m | no |
Example:
<ber:tool id="ti_addVertexMulti1" name="Insert vertex into parcel and parcel borders">
<ber:description>Select Parcel/Parcel boundary </ber:description>
<ber:icon xlink:href="resource.xml#ic_moveWithContextRelationships2"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="addVertexMulti"/>
<ber:parameterArray>
<ber:parameter name="featureTypes" value=" ft_parcel_boundary, ft_parcel_face "/>
<ber:parameter name="displayMeasure" value="All"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Delete Vertex from Common Border
Command: advancedGeom remVertexMulti
This function allows you to delete a vertex common to several areas, or lines creating area borders.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureTypes | List of feature types which can be selected for deletion of the common vertex. Types in the list are separated by a comma. | no |
| sameFeatureType | Determines whether only features of the same type as the selected feature will be edited. Values: true / false Default value: false | no |
| tolerance | Determines the distance at which common vertexes for deletion may be located from the selected vertex. Default value: 0.0005 | no |
| innerVertices | If the value is true and there is a line between the features for deletion of the vertex, deletion is only performed if the inner vertex of the line is deleted. Values: true / false Default value: false | no |
| nodeMaxLevel | Maximum degree of deleted vertex, whereas identical edges are counted only once independently of direction. Values: 1–2147483647 Default value: 2147483647 | no |
Example 1:
<ber:tool id="ti_remVertexMulti1" name="Remove a vertex from common lines/polygons">
<ber:description>When removing a vertex from the line/border of an object, vertex is removed automatically from the adjoining objects too</ ber:description>
<ber:icon xlink:href="resource.xml#ic_addVertexMulti" />
<ber:script>
<ber:module id="advancedGeom" />
<ber:function id="remVertexMulti" />
<ber:parameterArray>
<ber:parameter name="tolerance" value="0.15" />
</ber:parameterArray>
</ber:script>
</ber:tool>
Example 2:
<ber:tool id="ti_remVertexMulti2" name="Remove a vertex from adjoining Parcels">
<ber:description>When removing a vertex from the line/border of an object, vertex is removed automatically from the adjoining objects too. Limited to Parcel face and Parcel boundary.
</ber:description>
<ber:icon xlink:href="resource.xml#ic_addVertexMulti" />
<ber:script>
<ber:module id="advancedGeom" />
<ber:function id="remVertexMulti" />
<ber:parameterArray>
<ber:parameter name="tolerance" value="0.15" />
<ber:parameter name="featureTypes" value="ft_parcel_face, ft_parcel_boundary" />
<ber:parameter name="innerVertices" value="true" />
<ber:parameter name="nodeMaxLevel" value="2" />
</ber:parameterArray>
</ber:script>
</ber:tool>
Set Attribute Values
Command: lidsMain editAttribute
This function allows you to change values of the attributes for a selected feature to defined values without the need to display form.
After clicking on the icon, the user selects a feature in Graphics. The values of the attributes change appropriately for the selected feature.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| Attribute ID | Attribute of the given feature type filled with a predefined value. Values can be defined for several attributes. | A new value must be defined for at least one attribute. |
| suppressMessage | If true, message “Update successful” is not displayed after finishing the update. Values: true / false Default value: false | no |
Example:
<ber:tool id="att_attributes" name="Set attribute values directly">
<ber:description>AT1=100 AT2=2 AT3=7</ber:description>
<ber:icon xlink:href="resource.xml#ic_editAttributes"/>
<ber:script>
<ber:module id="lidsMain"/>
<ber:function id="editAttribute"/>
<ber:parameterArray>
<ber:parameter name="at_1" value="100"/>
<ber:parameter name="at_2" value="2"/>
<ber:parameter name="at_3" value="7"/>
<ber:parameter name="suppressMessage" value="true"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Rotate Symbol / Text
Command: advancedGeom rotateFeature
This function allows you to rotate selected point or text feature by specified angle.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureTypes | Comma separated list of feature types which can be selected | no |
| rotateByAngle | Defines change of angle in °. When value is defined, it’s not possible to change the angle by moving the cursor | no |
Example 1: Rotate a text or point feature by 45°
<ber:tool id="ti_rotate1" name="Rotate a text or point feature by 45°">
<ber:description>Rotate any text or point feature by 45°</ber:description>
<ber:icon xlink:href="resource.xml#ic_rotate1"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="rotateFeature"/>
<ber:parameterArray>
<ber:parameter name="rotateByAngle" value="45"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Example 2: Rotate text or point of specified types by 90°
<ber:tool id="ti_rotate2" name="Rotate specified features by 90°">
<ber:description>Select feature 1, 2 or 3</ber:description>
<ber:icon xlink:href="resource.xml#ic_rotate2"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="rotateFeature"/>
<ber:parameterArray>
<ber:parameter name="rotateByAngle" value="90"/>
<ber:parameter name="featureTypes" value="ft_1,ft_2,ft_3"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Change Coordinates - Table
Command: advancedGeom editCoordinates
This function allows you to manually edit individual coordinates of a feature using a table. It's possible to call this function from a feature form. In case of shared semantics it's possible to merge more features of the same type into multigeometry.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureTypes | Comma-separated list of feature types from whose forms the tool can be invoked. In case of shared semantics, semantic parent should be defined to allow editing of all graphical children. | no |
| virtualEdgeLength | Defines a gap between individual multigeometry components displayed in the 3D preview. | no |
| mergeSharedSemantics | If the function is called for shared semantics using the form and the feature has more graphical features of the same type, this parameter activates an option to merge such features into one feature with multigeometry Values: true / false Default value: false | no |
Example:
<ber:tool id="ti_editCoordinatesTable" name="Edit coordinates in table">
<ber:description>Opens window Edit Coordinates - Table for current feature in form</ber:description>
<ber:icon xlink:href="resource.xml#ic_editCoordinatesTable"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="editCoordinates"/>
<ber:parameterArray>
<ber:parameter name="featureTypes" value="ft_parent_1,ft_parent_2"/>
<ber:parameter name="virtualEdgeLength" value="0.5"/>
<ber:parameter name="mergeSharedSemantics" value="true"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Transform to Line String
Command: advancedGeom simplifyComplexLine
The function transforms the type of geometry from multigeometry or lineArcString to lineString for the selected line feature if the individual segments are connected to each other correctly.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| strokeTolerance | Predefines the value of Arcs approximating tolerance | no |
Example:
<ber:tool id="ti_simplifyComplexLine" name="Simplify complex line to line string">
<ber:description>Arcs approximating tolerance: 0,2 m</ber:description>
<ber:icon xlink:href="resource.xml#ic_simplifyComplexLine"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="simplifyComplexLine"/>
<ber:parameterArray>
<ber:parameter name="strokeTolerance" value="0.2"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Connect Line Borders
Command: LineBorder BatchJoinLineFeat
The function allows you to connect line borders of specified feature types which are defined in metadata as line axes with generated line borders. Connected line borders must not be associated graphics. Only borders of the same type are connected and the function works correctly if the borders have the same distance from the axis.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| axisFeatureType | ID of feature type constituting axis. | yes |
| lineBorder | ID of type of generated line border which is the only one to be processed. If this parameter is not entered, all types of borders are processed. | no |
| minAxisLength | Minimum length of axis feature needed for the feature to be processed. If this parameter is not entered, all axes are processed. | no |
| maxBisectorAngleDiff | Maximum angular deviation (in degrees) of two axis features from the line when three axes are connected. If this parameter is not entered, borders are connected in a different way and more than three axes can be connected. | no |
| changeAttVal4Bords | List of triplets separated by a comma or semicolon. The triplet (separator : or /) consists of the line border ID, the axis feature attribute ID and the value of this attribute to be set after connection. | no |
Example 1:
<ber:tool id="ti_join_line_border_1" name="Join line borders 1">
<ber:description>Join all line borders of selected axis</ber: description>
<ber:icon xlink:href="resource.xml#ic_join_line_border_1"/>
<ber:script>
<ber:module id="LineBorder"/>
<ber:function id="BatchJoinLineFeat"/>
<ber:parameterArray>
<ber:parameter name="axisFeatureType" value="ft_axis"/>
<ber:parameter name="changeAttVal4Bords" value="border_1: at_axis_1:2,border_2:at_axis_2:0,border_3:at_axis_3:8"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Example 2 – limited types of borders for processing:
<ber:tool id="ti_join_line_border_2" name="Join line borders 2">
<ber:description>Just predefined types, limited length & angle</ber: description>
<ber:icon xlink:href="resource.xml#ic_join_line_border_2"/>
<ber:script>
<ber:module id="LineBorder"/>
<ber:function id="BatchJoinLineFeat"/>
<ber:parameterArray>
<ber:parameter name="axisFeatureType" value="ft_axis"/>
<ber:parameter name="lineBorder" value="border_1"/>
<ber:parameter name="minAxisLength" value="0.35"/>
<ber:parameter name="maxBisectorAngleDiff" value="0.5"/>
<ber:parameter name="changeAttVal4Bords" value="border_1: at_axis_1:2"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Connect Buffer Zones of Lines
Command: LineBorder BatchJoinAreaFeat
This function allows you to connect buffer zones of lines of specified feature types for which the option to generate buffer zones is defined in metadata. Connected buffer zones must not be associated graphics. Only buffer zones of the same type are connected, and the function works correctly if the buffer zones have the same diameter.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| axisFeatureType | ID of feature type constituting axis. | yes |
| areaBorder | ID of type of generated buffer zone which is the only one to be processed. If this parameter is not entered, all types of buffer zones are processed. | no |
| minAxisLength | Minimum length of axis feature needed for the feature to be processed. If this parameter is not entered, all axes are processed. | no |
| changeAttVal4Bords | List of triplets separated by a comma or semicolon. The triplet (separator : or /) consists of the line border ID, the axis feature attribute ID and the value of this attribute to be set after connection. | no |
Example:
<ber:tool id="ti_join_area_border" name="Join area borders">
<ber:description>Join buffer zones of selected axis</ber:description>
<ber:icon xlink:href="resource.xml#ic_join_area_border"/>
<ber:script>
<ber:module id="LineBorder"/>
<ber:function id="BatchJoinAreaFeat"/>
<ber:parameterArray>
<ber:parameter name="axisFeatureType" value="ft_axis"/>
<ber:parameter name="minAxisLength" value="0.7"/>
<ber:parameter name="changeAttVal4Bords" value="border_1/ at_axis_r/2"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Delete Feature
Command: graphicElm deleteObject
This function allows you to delete a feature of a defined type. When the feature is deleted, all of the graphic and attribute data of the feature are also deleted.
After clicking on the icon, the user selects a feature in Graphics. The selected feature is then deleted.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureTypes | List of feature types which can be selected for deletion. Types in the list are separated by a comma. | no |
Example:
<ber:tool id="id" name="Name">
<ber:description>Description</ber:description>
<ber:icon xlink:href="resource.xml#icon" />
<ber:script>
<ber:module id="graphicElm" />
<ber:function id="deleteObject" />
<ber:parameterArray>
<ber:parameter name="featureTypes" value="ft_1,ft_2" />
</ber:parameterArray>
</ber:script>
</ber:tool>
Delete Features
Command: graphicElm deleteObjects
This function deletes features which were selected in advance in Graphics. Only features of the defined types and CAD elements in the active layer are deleted. When the feature is deleted, all of the graphic and attribute data of the feature are also deleted.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| methodId | ID of a method with the aid of which features for processing are selected in Graphics. Values in LIDS Edit: – 1 – by fence – 2 – by selection set Values in LIDS Explorer: • 1 – by selection set | no |
| methodKind | A type of method with the aid of which features for processing are selected in Graphics. Values: • Fence – by fence • SelectionSet – by selection set | no |
| featureTypes | List of feature types which can be deleted. Feature types are separated by a comma in the list. | no |
Example:
<ber:tool id="id" name="Name">
<ber:description>Description</ber:description>
<ber:icon xlink:href="resource.xml#icon" />
<ber:script>
<ber:module id="graphicElm" />
<ber:function id="deleteObjects" />
<ber:parameterArray>
<ber:parameter name="methodKind" value="SelectionSet" />
<ber:parameter name="featureTypes" value="ft_1,ft_2" />
</ber:parameterArray>
</ber:script>
</ber:tool>
Vertex Property / Quality
This set of functions makes it possible to store for individual line / surface border vertexes additional property value. It is typically used to store an accuracy of the vertex.
To visualize the stored values for individual vertexes, system uses point components of graphicType with VertexProperty class. roleId of a component corresponds to the stored value.
Example: graphicType used to visualize stored vertex property
<ber:graphicType id="vertex_quality" name="Vertex quality">
<ber:class refId="VertexProperty"/>
<ber:collectionGraphicType>
<ber:graphicTypeComponentArray>
<ber:graphicTypeComponent id="vq_1" name="GPS measured" roleId="1">
<ber:pointGraphicType>
<ber:symbology>
<ber:pointSymbolizer>
<se:Graphic>
<se:ExternalGraphic>
<se:OnlineResource xlink:href="resource.xml#sf/1/center-center"/>
<se:Format/>
</se:ExternalGraphic>
</se:Graphic>
<ber:rgbColor>#009000</ber:rgbColor>
</ber:pointSymbolizer>
</ber:symbology>
</ber:pointGraphicType>
</ber:graphicTypeComponent>
<ber:graphicTypeComponent id="vq_2" name="Surveyed" roleId="2">
<ber:pointGraphicType>
<ber:symbology>
<ber:pointSymbolizer>
<se:Graphic>
<se:ExternalGraphic>
<se:OnlineResource xlink:href="resource.xml#sf/2/center-center"/>
<se:Format/>
</se:ExternalGraphic>
</se:Graphic>
<ber:rgbColor>#FFFF00</ber:rgbColor>
</ber:pointSymbolizer>
</ber:symbology>
</ber:pointGraphicType>
</ber:graphicTypeComponent>
<ber:graphicTypeComponent id="vq_3" name="From orthophoto" roleId="3">
<ber:pointGraphicType>
<ber:symbology>
<ber:pointSymbolizer>
<se:Graphic>
<se:ExternalGraphic>
<se:OnlineResource xlink:href="resource.xml#sf/3/center-center"/>
<se:Format/>
</se:ExternalGraphic>
</se:Graphic>
<ber:rgbColor>#FF9000</ber:rgbColor>
</ber:pointSymbolizer>
</ber:symbology>
</ber:pointGraphicType>
</ber:graphicTypeComponent>
<ber:graphicTypeComponent id="vq_4" name="From scanned map" roleId="4">
<ber:pointGraphicType>
<ber:symbology>
<ber:pointSymbolizer>
<se:Graphic>
<se:ExternalGraphic>
<se:OnlineResource xlink:href="resource.xml#sf/4/center-center"/>
<se:Format/>
</se:ExternalGraphic>
</se:Graphic>
<ber:rgbColor>#FF0000</ber:rgbColor>
</ber:pointSymbolizer>
</ber:symbology>
</ber:pointGraphicType>
</ber:graphicTypeComponent>
</ber:graphicTypeComponentArray>
</ber:collectionGraphicType>
</ber:graphicType>
Set Quality of Point during Construction
Command: advancedGeom pointQuality
This function allows you to switch (set) the current quality of a point for creation of new features. The value of the quality is determined with the aid of a parameter.
The quality of the point can be changed continuously, even during construction which is underway (e.g. it is possible to determine quality differently for each vertex during construction of a line). Keyboard shortcuts can be used to set the quality of a point.
If graphic representation (point representation is anticipated) is also set in metadata, this representation is also displayed next to the cursor during construction to let the user to know which quality is saved for the point.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| qualityValue | Value of the quality of the point corresponding to rule_id of a component in metadata. | yes |
Example:
<ber:tool id="id" name="Name">
<ber:description>Description</ber:description>
<ber:icon xlink:href="resource.xml#icon"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="pointQuality"/>
<ber:parameterArray>
<ber:parameter name="qualityValue" value="1"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Cancel Quality of Point during Construction
Command: advancedGeom resetPointQuality
This function allows you to reset the current quality of the point for creation of new features. No graphic representation is displayed next to the cursor during construction.
Example:
<ber:tool id="id" name="Name">
<ber:description>Description</ber:description>
<ber:icon xlink:href="resource.xml#icon"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="resetPointQuality"/>
</ber:script>
</ber:tool>
Edit Quality of Point for Existing Geometries
Command: advancedGeom setPointQuality
This function allows you to change the quality of a point for a selected vertex of a selected feature. The value of the quality is determined with the aid of a parameter.
After the function is launched, selection of a vertex (or placement point for texts and areas) is activated in graphics. Quality is set for the selected vertex. After the operation has ended, selection of another vertex is activated.
If graphic representation (point representation is anticipated) is also set in metadata, this representation is also displayed next to the cursor during editing to let the user to know which quality is saved for the point.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| qualityValue | Value of the quality of the point corresponding to rule_id of a component in metadata. | yes |
Example:
<ber:tool id="id" name="Name">
<ber:description>Description</ber:description>
<ber:icon xlink:href="resource.xml#icon"/>
<ber:script>
<ber:module id="advancedGeom"/>
<ber:function id="setPointQuality"/>
<ber:parameterArray>
<ber:parameter name="qualityValue" value="1"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Line Direction Symbols
Place Line Direction Symbols
Command: directionSymbol construct
This function allows you to place a line direction symbol. Settings of parameters in the Place Line Direction Symbol dialog box can be predefined.
Click on the icon to open the Place Line Direction Symbol dialog box with predefined parameters. Further procedure is the same as the description of the Place Line Direction Symbol function.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| distanceLock | Determination of the distance for the distance lock. | no |
| labelLine | Enable Label line option. Values: true / false Default value: false | no |
Example:
<ber:tool id="dirsymb_2" name="Direction symbol - parameters">
<ber:description>Distance lock + label line</ber:description>
<ber:icon xlink:href="resource.xml#dirsymb_2"/>
<ber:script>
<ber:module id="directionSymbol"/>
<ber:function id="construct"/>
<ber:parameterArray>
<ber:parameter name="distanceLock" value="1.5"/>
<ber:parameter name="labelLine" value="true"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Place Line Direction Symbols in Bulk
Command: directionSymbol constructBulk
This function allows you to place line direction symbols in bulk.
After clicking on the icon, placing of line direction symbols is performed for line features selected in Graphics according to the defined parameters.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureType | Type of line feature which will be processed. | yes |
| directionSymbolId | Line direction symbol graphic tag ID. | yes |
| position | • relative – distance data will be determined as a percentage with a view to the length of the line • absolute – distance data will be determined in absolute units of length Default value: relative | no |
| distance | Distance of the start of the label line from the start of the line. The value must be positive. Default value: 50 | no |
| dX | Length of the segment of the label line parallel to the line. Default value: 0 | no |
| dY | Distance of the direction symbol from the line. Default value: 0 | no |
| minLength | The function processes only lines which are longer than the determined value. Default value: 0 | no |
| methodId | ID of a method with the aid of which features for processing are selected in Graphics. Values in LIDS Edit: • 1 – by fence • 2 – by selection set Values in LIDS Explorer: • 1 – by selection set | yes |
Example:
<ber:tool id="ti_dirSymbAuto3" name="Place direction symbol in bulk 3">
<ber:description>Main pipeline segment, other side of line, position 25% from start, min length 3m, fence</ber:description>
<ber:icon xlink:href="resource.xml#ic_dirSymbAuto"/>
<ber:script>
<ber:module id="directionSymbol"/>
<ber:function id="constructBulk"/>
<ber:parameterArray>
<ber:parameter name="featureType" value="ft_5012100"/>
<ber:parameter name="directionSymbolId" value="ft_5012100_dirsymb_01"/>
<ber:parameter name="position" value="relative"/>
<ber:parameter name="distance" value="25"/>
<ber:parameter name="dX" value="1.5"/>
<ber:parameter name="dY" value="-1.2"/>
<ber:parameter name="minLength" value="3"/>
<ber:parameter name="methodId" value="1"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Update Line Direction Symbol
Command: directionSymbol update
This function allows you to update a line direction symbol.
After clicking on the icon, the user selects a line feature with placed line direction symbol in Graphics. The angle of placement is updated for symbols.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| angleTolerance | Permitted angle tolerance in degrees. Default value: 1 | no |
Example:
<ber:tool id="dirsymb_refr1" name="Direction symbol - refresh 1">
<ber:description>Select individual features</ber:description>
<ber:icon xlink:href="resource.xml#dirsymb_refr1"/>
<ber:script>
<ber:module id="directionSymbol"/>
<ber:function id="update"/>
</ber:script>
</ber:tool>
Update Line Direction Symbols in Bulk
Command: directionSymbol updateBulk
This function allows you to update line direction symbols in bulk.
After clicking on the icon, updating of line direction symbols is performed for line features selected in Graphics.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| methodId | ID of a method with the aid of which features for processing are selected in Graphics. Values in LIDS Edit: • 1 – by fence • 2 – by selection set Values in LIDS Explorer: • 1 – by selection set | yes, unless the methodKind parameter has been entered |
| methodKind | A type of method with the aid of which features for processing are selected in Graphics. Values: • Fence – by fence • SelectionSet – by selection set | yes, unless the methodId parameter has been entered |
| angleTolerance | Permitted angle tolerance in degrees. Default value: 1 | no |
Example:
<ber:tool id="dirsymb_refr3" name="Direction symbol - refresh 3">
<ber:description>Select features by selection set; tolerance 10 degrees</ber:description>
<ber:icon xlink:href="resource.xml#dirsymb_refr3"/>
<ber:script>
<ber:module id="directionSymbol"/>
<ber:function id="updateBulk"/>
<ber:parameterArray>
<ber:parameter name="methodId" value="2"/>
<ber:parameter name="angleTolerance" value="10"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Cross Sections
Correct Routes without Cross Sections
Command: crossSection repairRoutes
This function assigns either a selected or empty cross section to routes with no cross section assigned.
The user first selects the input routes (according to the settings of the selectedSetInDM parameter in the function definition, it is possible to select either a data selection in Data Management, or to select features in Graphics using the defined method). Click on the project icon to launch the respective function. If an identifier of the cross-section template being assigned is defined in the function definition with the aid of the templateId parameter, this template is assigned to input routes. If not, a dialog box opens in which the user selects a cross-section template for assignment. If the user does not select any template here, the option of assigning an empty cross section to the routes is offered.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| selectedSetInDM | If the value is true, the function is launched for the data selection selected in Data Management. Values: true / false | no, if the methodId parameter is set |
| templateId | Template identifier of the assigned cross section. | no |
| methodId | ID of a method with the aid of which features for processing are selected in Graphics. Values in LIDS Edit: • 1 – by fence • 2 – by selection set Values in LIDS Explorer: • 1 – by selection set | no, if the selectedSetInDM parameter is entered with the value true |
Example 1:
<ber:tool id="route_CS_addition_1" name="Select in data management, CS template">
<ber:description>Select input in Data Management, CS from predefined template</ber:description>
<ber:icon xlink:href="resource.xml#ic_e_pcs2"/>
<ber:script>
<ber:module id="crossSection"/>
<ber:function id="repairRoutes"/>
<ber:parameterArray>
<ber:parameter name="selectedSetInDM" value="true"/>
<ber:parameter name="templateId" value="id_201105021204"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
This function assigns a cross section with a template defined with the aid of the templateId parameter to features of data selection selected in Data Management.
Example 2:
<ber:tool id="route_CS_addition_6" name="Select by selection set">
<ber:description>Select input by selection set</ber:description>
<ber:icon xlink:href="resource.xml#ic_e_pcs2"/>
<ber:script>
<ber:module id="crossSection"/>
<ber:function id="repairRoutes"/>
<ber:parameterArray>
<ber:parameter name="selectedSetInDM" value="false"/>
<ber:parameter name="methodId" value="2"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
When this function is used, the user selects the input routes in Graphics. The user selects the cross-section template for assignment manually.
Place Cross Sections
Command: crossSection placeCrossSection
This function allows you to place a cross section for an existing route.
After clicking on the icon, the Place Cross Section dialog box opens with predefined parameters. Further procedure is the same as the description of the standard function Place Cross Section.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| scale | Set value of the zoom coefficient. Default value: 1.0 | no |
| mirroring | Enable Mirroring option. Values: true / false Default value: false | no |
| labelLine | Enable Label line option. Values: true / false Default value: false | no |
| directionSymbol | Enable Direction symbol option. Values: true / false Default value: false | no |
| plusRotation | Setting the value of the Change angle by item. Default value: 0.0 | no |
| useLabelLineString | Values: • true – the label line will be a Line string • false – the label line will be a Simple line Default value: false | no |
| angleByLabelLine | Enable Angle according to label line option. Can be used if useLabelLineString=true. Values: true / false Default value: false | no |
Example:
<ber:tool id="ti_e_pcs2" name="Place CS - parameters">
<ber:description>Scale 0.5, mirroring ON, label line + direction symbol OFF</ber:description>
<ber:icon xlink:href="resource.xml#ic_e_pcs2"/>
<ber:script>
<ber:module id="crossSection"/>
<ber:function id="placeCrossSection"/>
<ber:parameterArray>
<ber:parameter name="scale" value="0.5"/>
<ber:parameter name="mirroring" value="true"/>
<ber:parameter name="labelLine" value="false"/>
<ber:parameter name="directionSymbol" value="false"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Construct Route
Command: crossSection placeRoute
This function allows you to construct a route. Settings of parameters in the Construct New Feature dialog box can be predefined.
After clicking on the icon, a route construction form opens with predefined parameters. Further procedure is the same as the description of standard route construction.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| routeType | Route type. | no |
| mode | Method of selecting cross section: • template – from cross section template • route – take over from existing route Default value: template | no |
| ducts | Method of creating ducts for the constructed route if the cross section is taken over from a route: • new – both new ducts and cables are created. • cables – new ducts are created. Cables related to ducts, or to the cross section, are the same as those related to the cross section of the selected route. • continue – ducts related to the cross section are the same which are related to the cross section of the selected route, including cables related to them. Default value: new | no |
Example:
<ber:extConstrTool id="ti_e_route2" name="Route 2">
<ber:description>Cross-section from existing route</ber:description>
<ber:icon xlink:href="resource.xml#ic_e_route2"/>
<ber:featureType xlink:href="model.xml#ft_e_route"/>
<ber:script>
<ber:module id="crossSection"/>
<ber:function id="placeRoute"/>
<ber:parameterArray>
<ber:parameter name="mode" value="route"/>
<ber:parameter name="ducts" value="new"/>
</ber:parameterArray>
</ber:script>
</ber:extConstrTool>
Place Reference to Cross Section
Command: ConstructionSupport CrossSectionRef
This function allows you to place a reference to a cross section. Settings of parameters in the
Place Reference to Cross Section dialog box can be predefined.
After clicking on the icon, the user selects a route in Graphics. The Place Reference to Cross Section dialog box opens with predefined parameters. Further procedure is the same as the description of the Place Reference to Cross Section function.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| labelLine | Enable option Label line. Values: true / false Default value: true | no |
| symbol | Enable option Symbol. Values: true / false Default value: true | no |
| diameterLine | Enable option Diameter line. Values: true / false Default value: true | no |
| leftDirection | Enable option Direction symbol of view from left. Values: true / false Default value: true | no |
| rightDirection | Enable option Direction symbol of view from right. Values: true / false Default value: true | no |
| labelLineLength | Preconfigured length of label line. Label line is placed with specified length, perpendicular to the route, to the left according to the route direction | No |
| referencePointDistance | Reference point is placed in specified distance from the end of label line, in the direction of label line | no |
Example:
<ber:tool id="csr_2" name="Place CS reference - parameters">
<ber:description>Label line + symbol + diameter line + direction symbols ON</ber:description>
<ber:icon xlink:href="resource.xml#ic_e_csref2"/>
<ber:script>
<ber:module id="ConstructionSupport"/>
<ber:function id="CrossSectionRef"/>
<ber:parameterArray>
<ber:parameter name="labelLine" value="true"/>
<ber:parameter name="symbol" value="false"/>
<ber:parameter name="diameterLine" value="true"/>
<ber:parameter name="leftDirection" value="true"/>
<ber:parameter name="rightDirection" value="true"/>
<ber:parameter name="labelLineLength" value="1.35" />
<ber:parameter name="referencePointDistance" value="1.0" />
</ber:parameterArray>
</ber:script>
</ber:tool>
Generate Cable Graphics
Command: crossSection cableEmptyGeomGenerate
This function allows you to generate graphics for selected cables without graphics according to the graphics of related routes.
After having been launched, a window opens with a browse of all cables without graphics. The user can choose cables from this browse and generate graphics for them according to the graphics of the respective routes.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| tolerance | Tolerated distance of end vertexes of related routes. If the end vertexes of related routes are closer than this value, and if it is possible to calculate lines from related routes, cable graphics are generated. Otherwise, an error is reported. Default value: 5 m | no |
| sharedSemChildsGroupIDs | Identification of the group defined in the model.xml file for descendants of shared semantics. If the parameter is used, cables with shared semantics belonging to this metadata group are also listed in the browse. | no |
Example:
<ber:tool id="ti_cableEmptyGeomGenerate" name="Generate geometry for cables">
<ber:description>Geometry is taken from related routes</ber: description>
<ber:icon xlink:href="resource.xml#ic_cableEmptyGeomGenerate"/>
<ber:script>
<ber:module id="crossSection"/>
<ber:function id="cableEmptyGeomGenerate"/>
<ber:parameterArray>
<ber:parameter name="tolerance" value="2.5"/>
<ber:parameter name="sharedSemChildsGroupIDs" value="generateCableGeometry"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Telco
Save Definition for Replacement of Cassette/Port
Command: telco createReplacementTemplate
This function saves a definition of the selected cassette or port to Store.
After clicking on the icon, the user selects cassette or port graphics in graphic view. The Save to Store dialog box opens, allowing you to save the content of the selected cassette/port as a template for later use.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureTypes | List of feature type; attribute pairs. The separator between the feature type and the attribute is a semicolon. Pairs are separated by a comma in the list. The function can only be used for feature types included in this list. An attribute is determined for each feature type, the values of which will be used to filter definitions in the function for replacing a cassette/port according to the saved definition. | yes |
| settingFolder | Store folder for saving the setting. | no |
Example:
<ber:tool id="telco_creRepTempl" name="Definition of adapter templates">
<ber:description>Create replacement template for port or cassette</ ber:description>
<ber:icon xlink:href="resource.xml#ic_createReplacementTemplate"/>
<ber:script>
<ber:module id="telco"/>
<ber:function id="createReplacementTemplate"/>
<ber:parameterArray>
<ber:parameter name="featureTypes" value="ft_port; at_port_form_factor,ft_cassette;at_form_factor"/>
<ber:parameter name="settingFolder" value="1234567890"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Replace Cassette/Port According to Saved Definition
Command: telco applyReplacementTemplate
This function allows you to replace the selected cassette or port according to a definition saved in
Store.
After clicking on the icon, the user selects cassette or port graphics in graphic view. The Load from Store dialog box opens, in which only definitions which correspond to the selected source feature by feature type and value of the defined attribute are displayed. The user selects one of the definitions and confirms the selection by pressing the OK button. The content of the cassette/port is replaced according to the selected definition.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureTypes | List of feature type; attribute pairs. The separator between the feature type and the attribute is a semicolon. Pairs are separated by a comma in the list. The function can only be used for feature types included in this list. An attribute is determined for each feature type, the values of which allow you to filter features of this type. It is only possible to load definitions from Store which correspond to the selected source feature by feature type and value of the defined attribute. | yes |
| settingFolder | Store folder for loading the setting. | no |
| mode | Mode for replacing feature graphics. Values: • auto – the graphics of the source feature are replaced automatically • manual – the graphics of the source feature must be replaced manually by placing new graphics Default value: auto | no |
Example 1:
<ber:tool id="telco_useRepTempl" name="Replacement of adapters">
<ber:description>Replace adapter - placed automatically, predefined folder</ber:description>
<ber:icon xlink:href="resource.xml#ic_applyReplacementTemplate1"/>
<ber:script>
<ber:module id="telco"/>
<ber:function id="applyReplacementTemplate"/>
<ber:parameterArray>
<ber:parameter name="featureTypes" value="ft_port; at_port_form_factor,ft_cassette;at_form_factor"/>
<ber:parameter name="settingFolder" value="1234567890"/>
<ber:parameter name="mode" value="auto"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Example 2:
<ber:tool id="telco_useRepTemp2" name="Replacement of adapters">
<ber:description>Replace adapter - place manually</ber:description>
<ber:icon xlink:href="resource.xml#ic_applyReplacementTemplate2"/>
<ber:script>
<ber:module id="telco"/>
<ber:function id="applyReplacementTemplate"/>
<ber:parameterArray>
<ber:parameter name="featureTypes" value="ft_port; at_port_form_factor,ft_cassette;at_form_factor"/>
<ber:parameter name="mode" value="manual"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Application Dimensions
Dimension Construction
Command: ExtDimension create
This function allows for construction of an application dimension according to predefined parameters.
The Construct Dimension dialog box opens after clicking on the icon. The dimension type and feature type can be predefined with the aid of parameters.
Further procedure is the same as the description of standard dimension construction.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| dimDefinition | Reference to application dimension definition in the extdimension.xml file. | no |
| featureType | Constructed dimension feature type. | no |
Example 1:
<ber:tool id="ti_dim11" name="Dimension - orthogonal">
<ber:description>Creates orthogonal dimension (ft_5031001)</ber: description>
<ber:icon xlink:href="resource.xml#ic_dim11"/>
<ber:script>
<ber:module id="ExtDimension"/>
<ber:function id="create"/>
<ber:parameterArray>
<ber:parameter name="dimDefinition" value="ed_1"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Example 2:
<ber:tool id="ti_dim21" name="Create Dimension">
<ber:description>Creates Dimension (ft_5031001)</ber:description>
<ber:icon xlink:href="resource.xml#ic_dim21"/>
<ber:script>
<ber:module id="ExtDimension"/>
<ber:function id="create"/>
<ber:parameterArray>
<ber:parameter name="featureType" value="ft_5031001"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Add Compponent of Orthogonal Dimension
Command: ExtDimension addOrthogonal
This function allows you to add a component of orthogonal dimension.
After clicking on the icon, the user selects an orthogonal dimension in Graphics. The Orthogonal Dimension Parameters dialog box opens.
Further procedure is the same as the description of the Add Components of Orthogonal Dimension function.
Example:
<ber:tool id="ti_dim02" name="Add component">
<ber:description>Adds a new orthogonal component</ber:description>
<ber:icon xlink:href="resource.xml#ic_dim02"/>
<ber:script>
<ber:module id="ExtDimension"/>
<ber:function id="addOrthogonal"/>
</ber:script>
</ber:tool>
MicroStation Dimensions
Change MicroStation Dimension Feature Type Individually
Command: graphicElm changeDimFeatureType
This function allows you to change the feature type of a selected MicroStation dimension.
After clicking on the icon, the user selects one MS dimension in Graphics. The Feature Type Selection dialog box opens with a menu of all other types of MS dimensions which it is possible to change the type of the selected MS dimension to. After selecting the target feature type and confirming the dialog, the MS dimension type changes. The function remains active for further use for which the target MS dimension type used is set. If the user needs to set a different target MS dimension type, the icon for this function must be clicked on again.
The target MS dimension type may be predefined with the aid of a parameter. In such a case, the user can only select an MS dimension in Graphics of a different type than the entered target type
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| targetFeatureType | Target MS dimension feature type. | no |
Example:
<ber:tool id="changeDimFT" name="Change Dimension FT">
<ber:description>Change FT of MS dimension</ber:description>
<ber:icon xlink:href="resource.xml#ic_changeDimFT"/>
<ber:script>
<ber:module id="graphicElm"/>
<ber:function id="changeDimFeatureType"/>
<ber:parameterArray>
<ber:parameter name="targetFeatureType" value="ft_dim2"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Change MicroStation Dimension Feature Type in Bulk
Command: graphicElm massChangeDimFeatureType
This function is used for bulk change of the feature type of MicroStation dimensions selected in Graphics to the selected target type
The user first selects MS dimensions in Graphics, the type of which should be changed. They then click on the function icon. The Feature Type Selection dialog box opens with a menu of all other types of MS dimensions which it is possible to change all selected MS dimensions to. After selecting the target feature type and confirming the dialog, the type of all selected MS dimensions changes.
If the user selects MS dimensions in Graphics of all types existing in the given project, it is not then possible to perform the type change. The user is warned of this by means of an error message.
The target MS dimension type may be predefined with the aid of a parameter. In such a case, change of the feature type is performed even if the user selects MS dimensions of all types existing in the given project in Graphics.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| methodId | ID of a method with the aid of which features for processing are selected in Graphics. Values in LIDS Edit: • 1 – by fence • 2 – by selection set Values in LIDS Explorer: • 1 – by selection set | yes |
| targetFeatureType | Target MS dimension feature type. | no |
Example:
<ber:tool id="changeDimFT_3" name="Change Dimension FT in bulk">
<ber:description>Change FT of MS dimension to "Dimension - white"</ ber:description>
<ber:icon xlink:href="resource.xml#ic_changeDimFTinBulk"/>
<ber:script>
<ber:module id="graphicElm"/>
<ber:function id="massChangeDimFeatureType"/>
<ber:parameterArray>
<ber:parameter name="methodId" value="1"/>
<ber:parameter name="targetFeatureType" value="ft_dim2"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Calling Applications and Services
Start External Application
Command: program runForFeature
This function allows you to launch an external application by calling a URL, which is handed over to the client station operating system for processing. The URL may contain parameters, the values of which are determined by the values of the attributes of the selected feature.
After clicking on the icon, the user selects a feature in Graphics. The values of the defined attributes of this feature are sent to an external application (e.g. a website) for processing. This function can also be launched for several selected features. In this case, a list of values of the determined attributes for all selected features is sent for processing.
This function can also be used to start an external application without parameters. In this case, the external application is started immediately after clicking on the icon.
Apart from the respective project toolbars, the function is also automatically available in the Form header and in Browse after marking all feature types which are specified in the featureTypes parameter.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| programPath | Determination of the URL and attributes, the values of which will be used as the parameter. Individual attributes are defined using identifiers from metadata introduced with %%. If a different column than the default one from the codelist should be used in the case of a codelist attribute, this can be stated after a forward slash. | yes |
| featureTypes | List of feature types separated by a comma which can be selected in Graphics. | no |
| methodKind | A type of method with the aid of which features for processing are selected in Graphics. Values: • Fence – by fence • SelectionSet – by selection set | no |
| methodId | ID of a method with the aid of which features for processing are selected in Graphics. Values in LIDS Edit: • 1 – by fence • 2 – by selection set Values in LIDS Explorer: • 1 – by selection set | no |
| attributeDelimiter | Separator between individual values in the list of values of the given attribute in the case of selection of multiple features. Default value: comma | no |
Example 1 – calling a URL with addition of parameters according to the values of attributes:
<ber:tool id="t_01" name="Call web page">
<ber:description>Calls web browser and puts attribute values to URL</ ber:description>
<ber:icon xlink:href="resource.xml#i_01" />
<ber:script>
<ber:module id="program" />
<ber:function id="runForFeature" />
<ber:parameterArray>
<ber:parameter name="programPath" value="https://portal.com/page? p_1=%%at_01%%&p_2=%%at_02/ca_03%%p_fid=%%id%%" />
<ber:parameter name="featureTypes" value="ft_1,ft_2,ft_3" />
<ber:parameter name="attributeDelimiter" value=" OR "/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Example 2 – calling a specific application:
<ber:tool id="t_02" name="Open notepad">
<ber:description>Calls defined program</ber:description>
<ber:icon xlink:href="resource.xml#i_02"/>
<ber:script>
<ber:module id="program"/>
<ber:function id="runForFeature"/>
<ber:parameterArray>
<ber:parameter name="programPath" value="notepad.exe"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Example 3 - calling a specific application with parameters according to attributes:
<ber:tool id="t_03" name="Call local application">
<ber:description>Calls defined program with parameters</ber: description>
<ber:icon xlink:href="resource.xml#i_03" />
<ber:script>
<ber:module id="program" />
<ber:function id="runForFeature" />
<ber:parameterArray>
<ber:parameter name="programPath" value="C:\Utils\App.exe PARAMETER=%%at_01%%" />
<ber:parameter name="featureTypes" value="ft_1" />
</ber:parameterArray>
</ber:script>
</ber:tool>
Call LIDS Application Server Service
Command: restGetService callForFeature
This function is used to call a GET RESTful request on the currently connected LIDS application server with current authentication data. After the call, a dialog box corresponding to the http status code is displayed. The address may contain parameters, the values of which are determined by the values of the attributes of the selected feature.
After clicking on the icon, the user selects a feature in Graphics. Values of the defined attributes of this feature are sent for processing to the current LIDS application server. This function can also be launched for several selected features. In this case, a list of values of the determined attributes for all selected features is sent for processing.
The function can also be used to call a service with no parameters. In this case, the call will be made as soon as the icon is pressed.
Apart from the respective project toolbars, the function is also automatically available in the Form header and in Browse after marking all feature types which are specified in the featureTypes parameter.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| url | Address of the GET RESTful request containing any attributes, the values of which will be used as a parameter. Individual attributes are defined using identifiers from metadata introduced with %%. If a different column than the default one from the codelist should be used in the case of a codelist attribute, this can be stated after a forward slash. | yes |
| featureTypes | List of feature types separated by a comma which are allowed to be selected in Graphics. | no |
| methodKind | A type of method with the aid of which features for processing are selected in Graphics. Values: • Fence – by fence • SelectionSet – by selection set | no |
| methodId | ID of a method with the aid of which features for processing are selected in Graphics. Values in LIDS Edit: • 1 – by fence • 2 – by selection set Values in LIDS Explorer: • 1 – by selection set | no |
| attributeDelimiter | Separator between individual values in the list of values of the given attribute in the case of selection of multiple features. Default value: comma | no |
| notNullAttributes | List of mandatory attributes the values of which must be filled in. Otherwise, the given feature will not be used. | no |
Example 1 – calling a service with addition of parameters according to attribute values and the list of mandatory attributes:
<ber:tool id="t_01" name="Call REST service">
<ber:icon xlink:href="resource.xml#i_01" />
<ber:script>
<ber:module id="restGetService" />
<ber:function id="callForFeature" />
<ber:parameterArray>
<ber:parameter name="url" value="https://srvaddress.com:8080/rest/ service?p_1=%%at_01%%&p_2=%%at_02/ca_03%%p_fid=%%id%%" />
<ber:parameter name="featureTypes" value="ft_1,ft_2,ft_3" />
<ber:parameter name="notNullAttributes" value="at_01,at_02" />
<ber:parameter name="attributeDelimiter" value=" OR "/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Example 2 - calling a service with automatic filling in of the address of the current LIDS application server:
<ber:tool id="t_03" name="Call REST service">
<ber:icon xlink:href="resource.xml#i_03" />
<ber:script>
<ber:module id="restGetService" />
<ber:function id="callForFeature" />
<ber:parameterArray>
<ber:parameter name="url" value="%projectUrl%%/rest/api/assoc/%% ftid%%/%%id%%"/" />
<ber:parameter name="featureTypes" value="ft_1" />
</ber:parameterArray>
</ber:script>
</ber:tool>
Locate Position in Web Application
Command: sendCoord point
This function allows you to locate a selected position in a web application.
The user clicks in Graphics after clicking on the icon. The coordinates of the position are transferred and located in the defined web application.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| program | Web application definition. | yes |
| targetSrs | Identification of the target coordinate system into which the position entered by the user will be converted. | no |
Example:
<ber:tool id="sys_sendCoordGoogle" name="Google Maps">
<ber:description>Opens web browser and locates to given position</ber: description>
<ber:icon xlink:href="resource.xml#ic_googlemaps"/>
<ber:script>
<ber:module id="sendCoord"/>
<ber:function id="point"/>
<ber:parameterArray>
<ber:parameter name="program" value=" q={1},+{0}&iwloc=A&hl=en"/>
<ber:parameter name="targetSrs" value="EPSG:4326"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Other Project Tools
Run Trace Task
Command: topoTools runTraceTask
This function allows you to run a predefined trace task.
After clicking on the icon, the user selects the start feature for tracing in Graphics. After selecting the feature, the predefined trace task is automatically launched. A temporary data selection is created which contains features which match the found nodes and edges, and this is also displayed using the defined method (in Browse, in Form, in Graphicswith / without theme assignment). At least one method of display must be defined.
The user can determine a set of several start features for tracing if they select features in Graphics using a selection set or by selecting individual features before clicking on the icon.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| traceTaskId | Reference to definition of the trace task in the options.xml file or in Store. | yes |
| resultActionBrowse | Determines whether the result of tracing is displayed in Browse. Values: true / false | no |
| resultActionForm | Determines whether the result of tracing is displayed in Form. Values: true / false | no |
| resultActionGraphics | Determines whether the result of tracing is displayed in Graphics. Values: true / false | no |
| themeId | ID of theme definition for displaying the trace result in Graphics. | no |
| browseTabFTs | List of feature types which will be displayed in the automatically created tab page in Browse if the resultActionBrowse parameter is set to the value true. Feature types in the list are separated by a comma. | no |
| browseTabForm | Determines the form which will be selected in Browse if the resultActionBrowse parameter is set to the value true. | no |
| clipboardAttribute | Determines the attribute, the values of which are saved to clipboard when displaying the result of tracing in Browse. | no |
| clipboardDelimiter | Determines the separator which is used to separate attribute values copied to clipboard. Default value: line break (CRLF) | no |
| resultNameAttribute | Pairs of feature type id + attribute id. The attribute value is used to name the resulting selection set in Data management. Additional optional parameters resultNamePrefix / resultNamePostfix can define constant text to be added before / after the attribute value. | no |
| resultNameConstant | Constant used to name the resulting selection set in Data management, when the values of name attributes are different for the start features. |
Example:
<ber:tool id="topoTrace1" name="Tracing task 1 - Closed valves">
<ber:description>Closed valves, max length=500m, defined in metadata, result to graphics with theme + form + browse</ber:description>
<ber:icon xlink:href="resource.xml#ic_traceTask_1"/>
<ber:script>
<ber:module id="topoTools"/>
<ber:function id="runTraceTask"/>
<ber:parameterArray>
<!--mandatory - can be defined either in metadata or in settings-->
<ber:parameter name="traceTaskId" value="tr_2"/>
<!--optional - default = false-->
<ber:parameter name="resultActionBrowse" value="true"/>
<!--optional - default = false-->
<ber:parameter name="resultActionForm" value="true"/>
<!--optional - default = false-->
<ber:parameter name="resultActionGraphics" value="true"/>
<ber:parameter name="themeId" value="id_72630443611933178"/>
<ber:parameter name="resultNameAttribute" value="ft_1;at_a,ft_2;at_a,ft_3;at_b"/>
<ber:parameter name="resultNamePrefix" value="Start of tracing 1: '"/>
<ber:parameter name="resultNamePostfix" value="'"/>
<ber:parameter name="resultNameConstant" value="TOPO Task"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Run Tracing and Color Found Paths
Command: topoTools traceEleCircuit
This function allows you to run a predefined trace task and apply different symbology to individual found paths.
After calling the function:
-
User selects starting node in graphics (e.g. some station or cabin)
-
System loads all features related by defined relationship (e.g. some outlets)
-
System starts tracing task from every feature found by the relationship
-
The order of processing the features is defined by specified feature attribute
-
If the tracing of an outlet doesn't return any features (apart from the outlet itself), the outlet is considered to be diconnected
-
The related linear feature (e.g. a cable or pipe) will be found
-
The tracing will be started again from this linear feature
-
Result of every single tracing operation is new selection set in Data management
-
It’s selection from features, not selection from template
-
The theme for whole selection set is set
-
Tool defines themes in the order corresponding to the order of processing
-
If the number of starting features is larger than the number of defined themes, the system just starts with the first theme again
-
Specific theme is assigned to the selection set representing tracing result from disconnected outlet
-
Also selected starting node is placed into separate selection set
-
This selection set doesn’t get any extra theme
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureTypeTrace | Pairs of starting feature type: tracing task | yes |
| outlets | Groups of starting feature type:outlet feature type: relation: order attribute: relationship from disconnected outlet to line | yes |
| outletThemes | List of themas to be assigned to the tracing results in defined order | yes |
| disconnectedThema | Thema to be assigned to the tracing result from disconnected outlet | yes |
Example:
<ber:tool id="topoTraceCirc" name="Run Tracing Circuits">
<ber:description/>
<ber:icon xlink:href="resource.xml#ic_ topoTraceCirc "/>
<ber:script>
<ber:module id="topoTools"/>
<ber:function id="traceEleCircuit"/>
<ber:parameterArray>
<ber:parameter name="featureTypeTrace" value="ft_1:tr_1; ft_2:tr_2"/>
<ber:parameter name="outlets" value="ft_1:ft_o1#r_ft1_o1#at_1#r_o1_l1; ft_2:ft_o2#r_ft2_fto2#at_2#r_o2_l2"/>
<ber:parameter name="outletThemas" value="ft_1:id_1,id_2,id_3,id_4; ft_2:id_5,id_6,id_7,id_8"/>
<ber:parameter name="disconnectedThema" value="id_123456"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Bulk Download of Attachments
Command: lidsMain exportAttachments
Bulk download is performed of all attachments of the selected type from all project features to the selected ZIP archive.
After clicking on the project icon, the ExportAttachments dialog box is displayed. The parameters Attachment type and Output file must be filled in the dialog box. After pressing the Apply or OK button, attachments will be downloaded.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| attachmentType | List of attachment types separated by a comma. | no |
| fileName | Predefined path and name of output ZIP archive. | no |
Example:
<ber:tool id="att_download_2" name="Download attachments in bulk 2">
<ber:description>Attachment type Pumping station exterior, file name predifned</ber:description>
<ber:icon xlink:href="resource.xml#ulozenisouboru"/>
<ber:script>
<ber:module id="lidsMain"/>
<ber:function id="exportAttachments"/>
<ber:parameterArray>
<ber:parameter name="attachmentType" value="att_pumpingstation_e"/>
<ber:parameter name="fileName" value="C:
\TEMP\att_pumpstation_exterior.zip"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Display attachment by selecting a feature
Command: graphicElm showAttachmentByAttribute
This function makes the opening of a defined attachment as simple as possible.
After clicking on the project icon, the user can select a feature in graphics. The system opens defined attachment in the associated application directly. The identifier of the attachment is stored in the attribute defined in tool parameter.
The attachment identifier must be stored in the feature attribute using some project logic.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| attributes | List of attribute ids (for different feature types) separated by a comma. | yes |
Example:
<ber:tool id="ti_showAttachment" name="Show attachment by ID">
<ber:description>ID stored in attribute.</ber:description>
<ber:icon xlink:href="resource.xml#ic_1"/>
<ber:script>
<ber:module id="graphicElm"/>
<ber:function id="showAttachmentByAttribute"/>
<ber:parameterArray>
<ber:parameter name="attributes" value="at_1,at_2"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Import
Command: lidsMain dataActualization
Opens standard Import window.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| sharedStorage | If set to true, option Configuration file: shared storage is selected. Default: false | no |
Example:
<ber:tool id="ti_import" name="Import">
<ber:description>Shared storage is set</ber:description>
<ber:icon xlink:href="resource.xml#ic_import"/>
<ber:script>
<ber:module id="lidsMain"/>
<ber:function id="dataActualization"/>
<ber:parameterArray>
<ber:parameter name="sharedStorage" value="true"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Import Data from XTR File
Command: xtrImportrun
The function allows you to import a file in XTR format.
After launching the icon, a dialog box is displayed for selection of the configuration file in XML format. The input XTR file must also be selected. The XTR file is imported immediately after selection.
Example:
<ber:tool id="id" name="Name">
<ber:description>Description</ber:description>
<ber:icon xlink:href="resource.xml#icon"/>
<ber:script>
<ber:module id="xtrImport"/>
<ber:function id="run"/>
</ber:script>
</ber:tool>
Clear Codelist Cache
Command: lidsMainclearCodelistCache
Deletes the content of codelists from the local client cache.
Example:
<ber:tool id="sys_clearCodelistCache" name="Clear codelist cache">
<ber:description>Codelists content is unloaded from memory</ber: description>
<ber:icon xlink:href="resource.xml#ic_clearCodelistCache"/>
<ber:script>
<ber:module id="lidsMain"/>
<ber:function id="clearCodelistCache"/>
</ber:script>
</ber:tool>
Clear Data Cache
Command: lidsMainclearFeatureSets
This function can be used in specific situations, when it’s necessary to refresh all feature data already loaded and cached on the client. In standard situation this shouldn’t be necessary at all, or the refresh functions available in system GUI should be enough.
This function does following:
-
All selection sets including the hidden ones are processed. Their displaying is switched off (in graphics, form, browse)
-
All features from all selection sets are removed
-
All features from the global cache are removed
-
Displaying of selection sets in restored (in graphics, form, browse)
After applying this function all selections from features become empty.
Example:
<ber:tool id="sys_clearFeatureSets" name="Clear feature cache">
<ber:description>Features are unloaded from memory</ber:description>
<ber:icon xlink:href="resource.xml#ic_ clearFeatureSets"/>
<ber:script>
<ber:module id="lidsMain"/>
<ber:function id="clearFeatureSets"/>
</ber:script>
</ber:tool>
Set View Rotation
Command: lidsMain setViewRotation
This function allows you to activate rotation of a view, whereas the value of the angle for rotation is predefined with the aid of a parameter.
After activation of the function, the view is rotated by the predefined angle. In the case of work with several views, the user marks the required view by clicking on it. This function is permanent and allows you to click on further views in turn.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| angle | Predefined angle in degrees. | yes |
Example:
<ber:tool id="id" name="Name">
<ber:description>Description</ber:description>
<ber:icon xlink:href="resource.xml#icon"/>
<ber:script>
<ber:module id="lidsMain"/>
<ber:function id="setViewRotation"/>
<ber:parameterArray>
<ber:parameter name="angle" value="30.5"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Generate Areas with Predefined Parameters
Command: BatchTopo runArealTopo
This function allows you to start generation of areas with the aid of a project icon with predefined parameters.
After activating the tool, a check is made to see whether any graphic view is open. If only one view is open, the spatial limitation is taken over from it. If this is not the case, the user will be prompted to click on a view in order to determine where the spatial limitation should be taken over from.
After determination of the spatial limitation, the Generate Areasdialog box opens in which the spatial limitation and values set with the aid of parameters are pre-filled. Generation of areas is launched directly without any further confirmation.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| topologyType | ID of topological type. | yes |
| areaIlLayer | ID of layer. | yes |
| maxScaleDenominator | Maximum scale denominator. A warning is displayed when the function is launched for smaller scales in graphic view. | no |
| ignoreErrors | Activates option Automatically continue in the event of an error in Generate Areas window. Default value: false | no |
Example:
<ber:tool id="id" name="Name">
<ber:description>Description</ber:description>
<ber:icon xlink:href="resource.xml#icon"/>
<ber:script>
<ber:module id="BatchTopo"/>
<ber:function id="runArealTopo"/>
<ber:parameterArray>
<ber:parameter name="topologyType" value="as_11"/>
<ber:parameter name="arealLayer" value="lay_1"/>
<ber:parameter name="maxScaleDenominator" value="800"/>
<ber:parameter name="ignoreErrors" value="true"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Open Generate Areas Window with Predefined Parameters
Command: BatchTopo runArealTopo
This function allows you to open Generate Areas dialog box with predefined parameters. Unlike the runArealTopo, the generating doesn’t start immediately.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| topologyType | ID of topological type. | yes |
| areaIlLayer | ID of layer. | yes |
| ignoreErrors | Activates option Automatically continue in the event of an error in Generate Areas window. Default value: false | no |
Example:
<ber:tool id="id" name="Name">
<ber:description>Description</ber:description>
<ber:icon xlink:href="resource.xml#icon"/>
<ber:script>
<ber:module id="BatchTopo"/>
<ber:function id="runArealTopo"/>
<ber:parameterArray>
<ber:parameter name="topologyType" value="as_11"/>
<ber:parameter name="arealLayer" value="lay_1"/>
<ber:parameter name="ignoreErrors" value="true"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Run Print Report
Command: graphicElmprintReport
This function allows you to run a print report, the content of which is determined with the aid of parameters.
After launching the function, a print report is run for features of defined types which are selected in Graphics. The function only allows you to process homogeneous feature selections. If no features are selected in Graphics, selection of one feature in Graphicsis activated (it is only possible to select defined feature types) and a report is then run for the feature selected in this manner.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| methodId | ID of a method with the aid of which features for processing are selected in Graphics. Values in LIDS Edit: • 1 – by fence • 2 – by selection set Values in LIDS Explorer: • 1 – by selection set | no |
| featureTypes | List of IDs of feature types which a print report can be run for. Feature types are separated by a comma in the list. If this parameter is not entered, all feature types are allowed. | no |
| reportId | Identifier of print template. | yes |
| outputFormat | Output format of print report (e.g. pdf, html, xml). Allowed formats depend on definition of the print template. | yes |
| showDialog | If the value is true, the query form dialog Print Reports opens for entry of parameters before calling the print report. | no |
| parameters of selected print template | Parameters contained in definition of the print template determined by the parameter reportId. Some of these parameters may be mandatory. |
Example:
<ber:tool id="id" name="Name">
<ber:description>Description</ber:description>
<ber:icon xlink:href="resource.xml#icon"/>
<ber:script>
<ber:module id="graphicElm" />
<ber:function id="printReport" />
<ber:parameterArray>
<ber:parameter name="reportId" value="rp_1" />
<ber:parameter name="featureTypes" value="ft_1,ft_2" />
<ber:parameter name="outputFormat" value="html" />
<ber:parameter name="TITLE" value="Output 1" />
<ber:parameter name="MODEL_NAME" value="DEMO" />
<ber:parameter name="methodId" value="1" />
<ber:parameter name="showDialog" value="true"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Call Search Function
Command: elasticSearchopen
This function opens Search window for finding features by typing in simple search condition. This window uses the search extension in the background.
The tool allows to preconfigure, which feature types or categories are selected by default in the tree part of the Search window.
Parameters:
| Parameter | Meaning | Mandatory |
|---|---|---|
| featureTypes | Comma separated list of feature types. If defined, Feature Types Tree panel is expanded in Search window and specified feature types are selected | no |
| categories | Comma separated list of categories. If defined, Categories panel is expanded in Search window and specified categories are selected | no |
Example: Feature types are preconfigured
<ber:tool id="ti_search1" name="Search 1">
<ber:description>Feature types 1, 2 and 3 are selected</ber:description>
<ber:icon xlink:href="resource.xml#ic_search1"/>
<ber:script>
<ber:module id="elasticSearch"/>
<ber:function id="open"/>
<ber:parameterArray>
<ber:parameter name="featureTypes" value="ft_1,ft_2,ft_3"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Example: Categories are preconfigured
<ber:tool id="ti_search1" name="Search 2">
<ber:description>Categories 1, 2 and 3 are selected</ber:description>
<ber:icon xlink:href="resource.xml#ic_search1"/>
<ber:script>
<ber:module id="elasticSearch"/>
<ber:function id="open"/>
<ber:parameterArray>
<ber:parameter name="categories" value="c_1,c_2,c_3"/>
</ber:parameterArray>
</ber:script>
</ber:tool>
Tool Palettes
Tool palettes are groups of tools created to enable tools logical arrangement. The palettes can be nested into each other, i.e. subpalettes can be created. One tool can be included in several palettes. A definition of a tool palette can include:
references to the tools it contains
separators
reference to a superior palette (optional)
link to an icon representing the palette in LIDS GUI.
The definitions of tool palettes are grouped together in the toolBoxArray collection.
Example: Definition of tool palettes.
<ber:toolBoxArray>
<!-- Root level tool palette definition -->
<ber:toolBox id="tb_01" name="Main toolbox">
<ber:description>Toolbox with 6 tools and 2 sub-toolboxes</ber:description>
<ber:icon xlink:href="resource.xml#ic_01"/>
<ber:subToolArray>
<ber:tool refId="ti_1"/>
<ber:tool refId="ti_2"/>
<ber:tool refId="ti_3"/>
<ber:separator/>
<ber:tool refId="ti_4"/>
<ber:tool refId="ti_5"/>
<ber:separator/>
<ber:tool refId="ti_6"/>
</ber:subToolArray>
</ber:toolBox>
<!-- Tool subpalette definition -->
<ber:toolBox id="tb_011" name="Sub-toolbox 1">
<ber:description>4 tools</ber:description>
<ber:icon xlink:href="resource.xml#ic_011"/>
<ber:superToolBox refId="tb_01"/>
<ber:subToolArray>
<ber:tool refId="ti_10"/>
<ber:tool refId="ti_11"/>
<ber:tool refId="ti_12"/>
<ber:tool refId="ti_13"/>
</ber:subToolArray>
</ber:toolBox>
<!-- Another tool subpalette definition -->
<ber:toolBox id="tb_012" name=" Sub-toolbox 2">
<ber:description>3 tools</ber:description>
<ber:icon xlink:href="resource.xml#ic_012"/>
<ber:superToolBox refId="tb_01"/>
<ber:subToolArray>
<ber:tool refId="ti_20"/>
<ber:tool refId="ti_21"/>
<ber:tool refId="ti_22"/>
</ber:subToolArray>
</ber:toolBox>
</ber:toolBoxArray>
-
toolBox – Defines a tool palette.
-
superToolBox – Optionally references a superior palette.
-
subToolArray – References tools (tool) that the palette contains.
Ribbon Pages
LIDS Explorer enables selection of the menu style as ribbon. In this case the project tools definition in toolBoxArray is ignored. It’s necessary to define section ribbonPageArray which will be used instead of tool palettes. The definition of individual tools is common for both modes.
The definition of ribbon consists of:
-
ribbonPage – defines the main section in the ribbon
-
ribbonPageGroup – section inside a ribbonPage with individual tools and separators
-
collapsed– optional attribute. If set to true, the ribbonPageGroup appears as collapsed list of tools.
-
icon – image on button representing the collapsed ribbonPageGroup
-
description – tooltip over the button representing the collapsed ribbonPageGroup
-
maxRows – if the collapsed ribbonPageGroup includes more tools than the value of this parameter, the tools are displayed in more columns
Tool definition inside ribbon page group consists of:
-
refId – reference to tool definition in toolArray
-
style – optional definition
-
Large – default; large icon with label below it
-
SmallWithText – small icon with label next to it
-
SmallWithoutText – small icon without labelt
-
label - optional definition; tool name is used if omitted
Example: Definition of ribbon pages.
<ber:ribbonPageArray>
<ber:ribbonPage id="rp_p1" name="Page 1">
<ber:ribbonPageGroup id="rpg_g1" name="Group 1">
<ber:tool refId="ti_1" style="Large" label="Tool 1"/>
<ber:tool refId="ti_2" style="SmallWithText" label="Tool 2"/>
<ber:separator/>
<ber:tool refId="ti_3"/>
</ber:ribbonPageGroup>
<ber:ribbonPageGroup id="rpg_g2" name="Group 2">
<ber:tool refId="ti_4"/>
</ber:ribbonPageGroup>
</ber:ribbonPage>
<ber:ribbonPage id="rp_p2" name="Page 2">
<ber:ribbonPageGroup id="rpg_g3">
<ber:tool refId="ti_5" style="SmallWithText"/>
<ber:tool refId="ti_6" style="SmallWithoutText"/>
</ber:ribbonPageGroup>
</ber:ribbonPage>
</ber:ribbonPageArray>