Edit Control Codes

Description

Create or edit control codes to create line objects or assign symbols.

Access

Manage / Configuration / Edit control codes .

Controls

Control	Description
Name	Type a name for the group of control codes.
Description	Explain the purpose for the group of control codes.
	Add a new control code.
	Delete the selected control code.
	Insert the default values for the selected control codes.

List Controls

Control	Description
Action	Select an action from the list.
Value	Do one of the following: Click to insert the default value. Type the control code's definition using the syntax below.

The definition defines:

The name of the control code.
If a code is exported to the code list as a control code or free code.
How parameters are input.
The order parameters are input.
Attribute names when the parameters are inserted using attributes.
Acceptable attribute values that are exported to the code list.

Syntax

When control codes require parameters, use a combination of the following syntax to define the format and method in which control codes and their parameters are to be entered.

Syntax	Description
{0=Code}	Identifies the code that will instigate the control code action. Note: '0=' identifies the item is the actionable code (not a required parameter) and is only required if the code is not the first item in the definition. Code names must be unique and not empty.
{p} [..n]	Indicates the position of the required parameter in the code. Note: This is used: to specify the order of the code and the required parameters when they are entered as part of the point code. during the import to determine the order the code and the required parameters are stored in the measurement code.
{p:Attribute name} [..n]	Indicates the position of the required parameter and specifies that the parameter value should be obtained from an attribute of the free code or code, for the measured point.
{0:Attribute name='Attribute value'}	If a measured point has an attribute with the specified attribute name and attribute value the control code action is performed.
Layer name	A hard coded layer name which specifies the layer for the second symbol inserted with the 'Add Symbol' control code action.
Attribute name	A hard coded attribute name which specifies the attribute that contains the depth to use with the 'Subsurface Diameter' control code action.
[]	Use to indicate the codes and attributes exported to the code list. Note: Codes and attributes is square brackets are exported as control codes or free codes. These codes are exported in addition to the point and line codes, and their attributes that are exported from the layer definitions.
()	Use to define acceptable attribute values that will be exported with the code list.

Where:

Character	Description
{ }	Braces are required when a control code action requires one or more parameters. Use braces to separate definitions for codes and parameters. Note: You can define the code and its parameters to be in any order.
Italics	Indicates a user entered value is required.
0	Identifies the code will instigate a control code action. Note: '0' is not required to identify the code for the control code action if it precedes the parameters.
p	The parameter identifier required for the control code action. Note: Some control code actions do not require parameters. '1' indicates the first parameter that is required. '2' indicates the second parameter that is required. '3' indicates the third parameter that is required.
[..n]	Repeat for the number of parameters required for the action. Do not type [..n].
:	Use when: the parameter is an attribute of the created object or the free code. the control is actioned only if the attributes value is equal to the specified value.

Examples

Examples using the syntax above.

Enter a value for the action 'Join to First'.
JTF

Enter a value for the action 'Join to Point' where the required point number follows the code.
{JTP} {1}

Enter a value for the action 'Join to Point' where the required point number precedes the code.
{1} {0=JTP}

Enter a value for the action 'Rectangle by Edge' where the width parameter is obtained from an attribute 'Width' entered for the first measured point in the rectangle.
[{0=RECT}] {1:Width}

Note

The square brackets indicate the code RECT is exported to the code list. You should export the Width attribute to the codelist as an attribute of a point code.

Enter a value for the action 'Rectangle By Edge' where the width parameter is obtained from the 'RectBy2Pt' codes 'Width' attribute.
[{0=RectBy2Pt} {1:Width} Description=Rectangle by 2 pts and width].

Note

The square brackets indicate that the control code RectBy2Pt, the description and the Width attribute are exported to the codelist. The width attribute will be an attribute of the free code or control code 'RectBy2Pt'.

Enter a value for the action 'Add Symbol' where the Trunk parameter precedes the code and the Spread parameter follows the code.
{2} {0=Tree} {1}

Enter a value for the action 'Add Symbol' where the Spread and Trunk parameters follow the code and the trunk symbol is to be placed on a layer 'Trunk'.
{Tree} {1} {2} Trunk

Enter a value for the action 'Height Remove' which is only actioned if the measured point has an attribute called 'Eave' with an attribute, 'yes'.
{0:Eave=Yes}

Enter a value for the action 'Subsurface Diameter' where the required depth attribute 'Depth' is entered as an attribute of the measured point and the Diameter and Location parameters are entered as attributes of the code 'SubSurfDiam'. The square brackets indicate what codes and attributes are passed to the codelist. The values in () define alternate values for the required parameter {3}.
[{0=SubSurfDiam}] Depth [{2:Diameter} {3:Location (INV=I, OBV=O, CL=M)} Description=Sub surface]

Notes

Adding more than one of the same action is valid.
Parameters units are in the configured project units.
When entering a definition for a control code action, separate braces with a space.
Control code names with spaces must be contained within " ".
Some parameters can only be obtained from an attribute of the measured point. See the specific control code topic for required parameters.
Some parameters can be defined in the control code definition and do not require entry in the field.
When square brackets are used to determine the values exported to the code list, the code for the control code action must be included within the brackets.
Control codes are used in conjunction with the point code.
If more than one parameter in a specified format uses the same attribute value then all required values are to be input in to the one attribute, separated by a space. You will need an attribute of type text to do this.
Select the control code list when you set processing, import or export options.
You can save a control code list to a customised template. The Alpha template contains a complete list of defined control codes.
You can input control codes using:
- Leica Freecodes - Input a control code as a free code prior to measuring the first point required by the control code.
- Measurement Codes - Input a control code as part of the measurement code. The control code (and its parameters) must follow the point code it is associated with.
You can input most parameters required by a control code either as
- an attribute of a Leica free code - Input the required parameter values as attributes of the free code prior to measuring the first point required by the control code.
- part of the measurement code - Input the required parameters as part of the measurement code. The order parameters are entered must follow the control code definition.
- an attribute of the measured point - The attribute name must be defined in the control code definition.
When you click OK any invalid codes are highlighted in red. Hover over the control code value to view the error.