Field-Map Scripting

About Field-Map Scripting > Field-Map script types > Global scripts > List of global events

2.5.6.1 List of global events

List of global scripts

Category: Field-Map

AfterOpenFieldMap
BeforeCloseFieldMap ABORT=YES
AfterOpenSystemTables
AfterOpenProject
BeforeRunDLL (ABORT=YES)

Variable: DLL_FileName (input), descr: Filename without extension
Variable: DLL_FilePath (input), descr: Path to DLL

AfterRunDLL

Variable: DLL_FileName (input), descr: Filename without extension
Variable: DLL_FilePath (input), descr: Path to DLL
Variable: DLL_Result (input), descr: Integer result value returned by DLL

BeforeSynchronization (ABORT=YES)
AfterSynchronization
BeforeRunDatabaseQueryTool (ABORT=YES)

Variable: IncludeAllInactiveLayers (output), descr: 0-no 1-true
Variable: IncludeInactiveLayers (output), descr: list of layernames separated by ; or |

AfterRunDatabaseQueryTool
OnKeyDown (ABORT=YES)

Variable: KeyCode (input), descr: key code [INT]
Variable: ShiftPressed (input), descr: SHIFT key pressed [BOOL]
Variable: CtrlPressed (input), descr: CTRL key pressed [BOOL]
Variable: AltPressed (input), descr: ALT key pressed [BOOL]

AfterNotebookPageChange

Variable: NotebookName (input), descr: name of active notebook in format Notebook_{LayerName}
Variable: ActivePageIndex (input), descr: index of currently active sheet in active notebook

AfterAdjustSettings descr: after FM settings being adjusted
OnReceiveDataFromAnotherProject descr: message/data coming from another running fmdc project

Variable: MessageID (input), descr: ID of the message defined by the sender
Variable: MessageGUID (input), descr: GUID of the message defined by the sender
Variable: SenderProjectDir (input), descr: [PROJECTDIR] of the data sender
Variable: MessageData (input), descr: string data coming from the sender

Category: Find Target Height (script) descr: script function supporting search for target height

OnInvalidHeight descr: raised when target height is not reached within tolerance

Variable: FindTargetHeight_Height_m (input)
Variable: FindTargetHeight_TargetHeight_m (input)
Variable: FindTargetHeight_HeightTolerance_m (input)
Variable: FindTargetHeight_RemainingDistance_m (input)

OnValidHeight descr: raised when target height was reached within tolerance

Variable: FindTargetHeight_Height_m (input)
Variable: FindTargetHeight_TargetHeight_m (input)
Variable: FindTargetHeight_HeightTolerance_m (input)
Variable: FindTargetHeight_RemainingDistance_m (input)

Category: Height descr: height dialog and/or height measurement in FMDC

BeforeMeasurement (ABORT=YES)

Variable: Height_LayerName (input), descr: layer name in which height measurement is performed
Variable: Height_AttributeName (input), descr: attribute name for which height measurement is performed
Variable: Height_HorizDistToStemCenter_m (output), descr: optional - premeasured distance to the tree; both HD and base INCL must be available
Variable: Height_InclinationToStemBase_deg (output), descr: optional - premeasured inclination to the tree base; both HD and base INCL must be available
Variable: Height_DBH_mm (output), descr: optional - value of DBH; half of it will be subtracted from mesured distance

AfterMeasurement

Variable: Height_LayerName (input), descr: layer name in which height measurement is performed
Variable: Height_AttributeName (input), descr: attribute name for which height measurement is performed
Variable: Height_HorizDistToStemCenter_m (input), descr: measured distance to the tree; both HD and base INCL must be available
Variable: Height_InclinationToStemBase_deg (input), descr: measured inclination to the tree base; both HD and base INCL must be available
Variable: Height_InclinationToTreeTop_deg (input), descr: measured inclination to the tree top; both HD and base INCL must be available
Variable: Height_Height_m (input, output), descr: measured inclination to the tree base; both HD and base INCL must be available; value can be changed by script

Category: Measurement

AfterReceiveVector (ABORT=YES)

Variable: Vector_HorizontalDistance_m (input)
Variable: Vector_SlopeDistance_m (input)
Variable: Vector_Inclination_deg (input)
Variable: Vector_Inclination_perc (input)
Variable: Vector_HorizontalAngle_deg (input)
Variable: Vector_HorizontalAngle_gon (input)
Variable: Vector_PenMapping (input), descr: 0=data from measurement device; 1-pen mapping data

BeforeInputData descr: user defined values which will be available in input dialog

Variable: Input_HorizontalDistance_m (output)
Variable: Input_Inclination_deg (output)
Variable: Input_HorizontalAngle_deg (output)

AfterInputData

Variable: Input_HorizontalDistance_m (input)
Variable: Input_SlopeDistance_m (input)
Variable: Input_Inclination_deg (input)
Variable: Input_Inclination_perc (input)
Variable: Input_HorizontalAngle_deg (input)
Variable: Input_HorizontalAngle_gon (input)

OnReceiveDataFromNonSpecificEquipment

Variable: EquipmentID (input), descr: Identification of equipment sending the data: 1 or 2 or 3
Variable: ReceivedData (input), descr: Data coming from the equipment

OnReceiveCalliperData (ABORT=YES)

Variable: ReceiveCalliperData_LayerName (input)
Variable: ReceiveCalliperData_AttributeName (input), descr: attribute for data saving
Variable: ReceiveCalliperData_Value (input), descr: value coming from calliper

Category: Mapping

BeforeMapDraw
AfterMapDraw
BeforeTrackingLayerDraw
AfterTrackingLayerDraw
AfterMeasurePolygonArea

Variable: CoordsOfMeasuredPolygon (output), descr: variant array [0..n,0..1] of [X,Y] i.e. coordinates of polygon drawing

BeforeSaveMapScreenshotToFile (ABORT=YES)

Variable: Screenshot_TargetDPI (input), descr: DPI
Variable: Screenshot_TargetImageWidth (input), descr: Image width
Variable: Screenshot_TargetScale (input), descr: Image width
Variable: Screenshot_Filename (output), descr: Suggested filename

AfterMapScreenshotTrackingLayerDraw

Category: Remote Diameter

BeforeMesurement (ABORT=YES)

Variable: RemoteDiameter_LayerName (input)
Variable: RemoteDiameter_AttributeName (input)
Variable: RemoteDiameter_DBH_mm (output)
Variable: RemoteDiameter_EnableReferenceDiameter (output), descr: 0-disabled 1-enabled; if disabled, then pole must by at center of stem sideways
Variable: RemoteDiameter_EnableUseDBH (output), descr: enabled button Use DBH: 0-disabled 1-enabled; if enabled and DBH available and EnableReferenceDiameter OFF => DBH will be automatically used for distanca to stem center
Variable: RemoteDiameter_TreeHeight_m (output)
Variable: RemoteDiameter_HorizDistToStemCenter_m (output), descr: optional - premeasured distance to the tree; both HD and base INCL must be available
Variable: RemoteDiameter_InclinationToStemBase_deg (output), descr: optional - premeasured inclination to the tree base; both HD and base INCL must be available
Variable: RemoteDiameter_CheckUseMainPole_Height (output), descr: checkbox: 1-checked for inclination 2-and for distance
Variable: RemoteDiameter_CheckUseMainPole_Offset (output), descr: checkbox: 1-checked
Variable: RemoteDiameter_Height_m (output), descr: optional - premeasured height to the point of the diameter measurement
Variable: RemoteDiameter_DistanceRepetitionCount (output), descr: optional - number of repeated distance measurement
Variable: StemProfile_DistanceRepetitionSound (output), descr: optional - file with sound to be played prior repeated dist measurement

BeforeHeightMeasurement

Variable: RemoteDiameter_LayerName (input)
Variable: RemoteDiameter_AttributeName (input), descr: Empty when measuring stem profile
Variable: RemoteDiameter_TargetHeight_m (output), descr: variable used in scripts before/after; it is removed when incl measurement is canceled

AfterHeightMeasurement (ABORT=YES)

Variable: RemoteDiameter_LayerName (input)
Variable: RemoteDiameter_AttributeName (input), descr: Empty when measuring stem profile
Variable: RemoteDiameter_Height_m (input), descr: current value of measured height

OnReferenceDiameterMeasurement descr: when main diameter is measured in remote diameter window

Variable: RefDiam_LayerName (input)
Variable: RefDiam_Diameter_mm (input), descr: main diameter
Variable: RefDiam_Height_m (input), descr: height of main diameter measurement

Category: Stem Profile

BeforeProfileMeasurement descr: Possibility of passing additional [H,D] data before local stem profile measurement

Variable: StemProfile_LayerName (input)
Variable: StemProfile_AttributeName (input)
Variable: StemProfile_Species (output)
Variable: StemProfile_DBH_mm (output)
Variable: StemProfile_EnableUseDBH (output), descr: enabled button Use DBH: 0-disabled 1-enabled
Variable: StemProfile_EnableReferenceDiameter (output), descr: 0-disabled 1-enabled; if disabled, then pole must by at center of stem sideways
Variable: StemProfile_TreeHeight_m (output)
Variable: StemProfile_DiameterUnit (output), descr: Value: 0-mm 1-cm
Variable: StemProfile_Point1...n (output), descr: Set of numbered additional points of stem profile; string containing H,m and D,mm: 'H|D'
Variable: StemProfile_HorizDistToStemCenter_m (output), descr: optional - premeasured distance to the tree; both HD and base INCL must be available
Variable: StemProfile_InclinationToStemBase_deg (output), descr: optional - premeasured inclination to the tree base; both HD and base INCL must be available
Variable: StemProfile_VolumeBottomType (output), descr: optional - mode of bottom height: 0-%TreeHeight, 1-%DBH 2-%StumpHeight 3-FixedHeight[m]
Variable: StemProfile_VolumeBottomValue (output), descr: optional - value of log top relevant for chosen type
Variable: StemProfile_VolumeTopType (output), descr: optional - mode of stem top: 0-%TreeHeight 1-diameter[cm]
Variable: StemProfile_VolumeTopValue (output), descr: optional - value of log top relevant for chosen type
Variable: StemProfile_DistanceRepetitionCount (output), descr: optional - number of repeated distance measurement
Variable: StemProfile_DistanceRepetitionSound (output), descr: optional - file with sound to be played prior repeated dist measurement

BeforeHeightMeasurement

Variable: RemoteDiameter_LayerName (input)
Variable: RemoteDiameter_AttributeName (input), descr: Empty when measuring stem profile
Variable: RemoteDiameter_HighestMeasuredHeight_m (input), descr: highest measured height sofar
Variable: RemoteDiameter_ArrayOfMeasuredHeights_m (input), descr: vector of data - existing measurements: VarArrayOf([h1,h2,...])
Variable: RemoteDiameter_TargetHeight_m (output), descr: variable used in scripts before/after; it is removed when incl measurement is canceled

AfterHeightMeasurement (ABORT=YES)

Variable: RemoteDiameter_LayerName (input)
Variable: RemoteDiameter_AttributeName (input), descr: Empty when measuring stem profile
Variable: RemoteDiameter_Height_m (input)
Variable: RemoteDiameter_HeightOk (output)

OnReferenceDiameterMeasurement descr: when main diameter is measured in remote diameter window

Variable: RefDiam_LayerName (input)
Variable: RefDiam_Ticks (input), descr: ticks of main diameter measurement
Variable: RefDiam_Diameter_mm (input), descr: main diameter
Variable: RefDiam_Height_m (input), descr: height of main diameter measurement

Category: Stand Density Measurement

BeforeStandDensityMeasurement

Variable: StandDensity_LayerName (input)
Variable: StandDensity_AttributeName (input)
Variable: StandDensity_PlotRadius_m (output)
Variable: StandDensity_MeanDBH_cm (output)

AfterTreeMeasurement

Variable: StandDensity_LayerName (input)
Variable: StandDensity_AttributeName (input)
Variable: StandDensity_Distance_m (input)
Variable: StandDensity_TreePosition (input), descr: Return value 0-inside plot 1-outside plot 2-tree already exists within search tolerance

Category: Sampling

ChooseSamplingMethod

Variable: Sampling_LayerName (input)
Variable: Sampling_AttributeName (input)
Variable: Sampling_Method (output), descr: Call specific sampling method: 20-angle count sampling 30-transect sampling