CMS X-Tools All Editions User Manual - 06 - Analyzing System - en

CMS X-Tools - User Manual - 06 - Analyzing System CMS
Preface 1
Analyzing System 2
Contact Information 3
CMS X-Tools
User Manual - 06 - Analyzing System
English
Release 2018-06
English
Release 2018-06 1 / 866
Safety Guidelines
This document contains notices which you should observe to ensure your own personal safety as well as to avoid property damage. The
notices referring to your personal safety are highlighted in the manual by a safety alert symbol, notices referring to property damage only
have no safety alert symbol
Danger
Indicates an imminently hazardous situation which, if not avoided, will result in death or serious injury.
Warning
Indicates a potentially hazardous situation which, if not avoided, could result in death or serious injury.
Caution
Used with the safety alert symbol indicates a potentially hazardous situation which, if not avoided, may result in minor or
moderate injury.
Notice
Used without the safety alert symbol indicates a potential situation which, if not avoided, may result in an undesirable result or
state.
When several danger levels apply, the notices of the highest level (lower number) are always displayed. If a notice refers to personal
damages with the safety alert symbol, then another notice may be added warning of property damage.
Qualified Personnel
The device/system may only be set up and operated in conjunction with this documentation. Only qualified personnel should be allowed to
install and work on the equipment. Qualified persons are defined as persons who are authorized to commission, to earth, and to tag cir-
cuits, equipment and systems in accordance with established safety practices and standards.
Intended Use
Please note the following:
Warning
This device and its components may only be used for the applications described in the catalog or technical description, and
only in connection with devices or components from other manufacturers approved or recommended by Siemens. This prod-
uct can only function correctly and safely if it is transported, stored, set up and installed correctly, and operated and main-
tained as recommended.
Trademarks
All designations marked with ® are registered trademarks of Siemens AG. Other designations in this documentation might be trademarks
which, if used by third parties for their purposes, might infringe upon the rights of the proprietors.
Copyright Siemens AG 2018. All rights reserved.
Reproduction, transmission or use of this document or its contents is not permitted without express written authority. Offenders will be
liable for damages. All rights, including rights created by patent grant or registration of a utility model or design, are reserved.
Disclaimer of Liability
We have checked the contents of this document for agreement with the hardware and software described. Since deviations cannot be
precluded entirely, we cannot guarantee full agreement. However, the data in the manual are reviewed regularly, and any necessary cor-
rections will be included in subsequent editions. Suggestions for improvement are welcomed.
Siemens AG
Industry Sector
P.O. Box 4848
90327 Nuremberg Siemens AG 2018
Germany Technical data subject to change
English
Release 2018-06 2 / 866
Table of Contents
1 Preface .............................................................................................................................................. 34
1.1 Purpose of this Document ............................................................................................................ 34
1.2 Validity of this Document.............................................................................................................. 34
1.3 Audience ...................................................................................................................................... 34
1.4 Notations ...................................................................................................................................... 35
2 Analyzing System .............................................................................................................................. 36
2.1 Analyzing System ......................................................................................................................... 36
2.1.1 Overview ................................................................................................................................. 36
2.1.2 Menu Bar................................................................................................................................. 37
2.2 Analyzing System Explorer .......................................................................................................... 38
2.2.1 Overview ................................................................................................................................. 38
2.2.2 Menu Bar................................................................................................................................. 39
2.2.3 ANS Explorer Tree .................................................................................................................. 40
2.2.3.1 Overview ............................................................................................................................ 40
2.2.3.2 Main Branch ....................................................................................................................... 40
2.2.3.3 Editors Branch ................................................................................................................... 40
2.2.3.4 Analyzing Model Editors Branch ........................................................................................ 40
2.2.3.5 Analyzing Model Editor Branch .......................................................................................... 41
2.2.3.6 Analyzing Script Editors Branch ........................................................................................ 41
2.2.3.7 Analyzing Script Editor Branch .......................................................................................... 41
2.2.3.8 User Function Editors Branch ............................................................................................ 41
2.2.3.9 User Function Editor Branch .............................................................................................. 41
2.2.3.10 Servers Branch .................................................................................................................. 41
2.2.3.11 Server Branch .................................................................................................................... 42
2.2.3.12 Files Branch ....................................................................................................................... 42
2.2.3.13 File Location Branch .......................................................................................................... 42
2.2.3.14 Analyzing Model Files Branch ........................................................................................... 42
2.2.3.15 Analyzing Script Files Branch ............................................................................................ 44
2.2.3.16 User Function Files Branch ............................................................................................... 45
2.2.3.17 Libraries Branch ................................................................................................................. 46
2.2.3.18 Analyzing Functions Branch .............................................................................................. 46
2.2.3.19 Analyzing Function Branch ................................................................................................ 46
2.2.3.20 User Functions Branch ...................................................................................................... 46
2.2.3.21 User Function Branch ........................................................................................................ 46
2.2.4 Find References Dialog .......................................................................................................... 47
2.2.4.1 Overview ............................................................................................................................ 47
2.2.4.2 Find Settings Table ............................................................................................................ 47
2.2.4.3 Find Results Table ............................................................................................................. 48
2.2.5 Analyzing Function Overview Dialog ...................................................................................... 48
2.2.5.1 Overview ............................................................................................................................ 48
English
Release 2018-06 3 / 866
2.2.5.2 Analyzing Function Properties Table ................................................................................. 49

2.2.5.2.1 Analyzing Function Arguments Table ........................................................................... 49
2.2.6 User Function Overview Dialog .............................................................................................. 49
2.2.7 View active Parameters Dialog ............................................................................................... 50
2.2.7.1 Overview ............................................................................................................................ 50
2.2.7.2 Properties Table................................................................................................................. 50
2.2.7.3 Parameters Table .............................................................................................................. 50
2.2.8 Search Area ............................................................................................................................ 51
2.2.8.1 Overview ............................................................................................................................ 51
2.2.8.2 Searchable Items ............................................................................................................... 51
2.2.8.3 Keyboard Operations ......................................................................................................... 51
2.2.8.3.1 Buttons .......................................................................................................................... 52
2.3 Analyzing Model Editors............................................................................................................... 52
2.3.1 Overview ................................................................................................................................. 52
2.3.2 Common Controls ................................................................................................................... 52
2.3.2.1 Overview ............................................................................................................................ 52
2.3.2.2 Menu Bar ........................................................................................................................... 53
2.3.2.3 Analyzing Model Settings Table ........................................................................................ 54
2.3.2.4 Provided Parameters Table ............................................................................................... 55
2.3.2.5 Analyzing Model Parameters Table ................................................................................... 56
2.3.2.6 Offline Time Configuration Table ....................................................................................... 61
2.3.2.7 Treatment of Status Codes Table ...................................................................................... 62
2.3.2.8 Log Entries Table ............................................................................................................... 62
2.3.3 AME Standard T001 ............................................................................................................... 63
2.3.3.1 Overview ............................................................................................................................ 63
2.3.3.2 Menu Bar ........................................................................................................................... 64
2.3.3.3 Analyzing Model Settings Table ........................................................................................ 64
2.3.3.5 Analyzing Model Parameters Table ................................................................................... 64
2.3.3.8 Action Area ........................................................................................................................ 64
2.3.3.10 Dropping of Items............................................................................................................... 71
2.3.3.11 Analyzing Function Properties Dialog ................................................................................ 72
2.3.3.11.1 Overview ....................................................................................................................... 72
2.3.3.11.2 Analyzing Function Properties Table ............................................................................ 72
2.3.3.11.3 Analyzing Function Arguments Table ........................................................................... 73
2.3.3.12 User Function Properties Dialog ........................................................................................ 73
2.3.3.13 Edit Group Box Dialog ....................................................................................................... 74
2.3.3.13.1 Overview ....................................................................................................................... 74
2.3.3.13.2 Group Box Parameters Table ....................................................................................... 74
English
Release 2018-06 4 / 866
2.4 Analyzing Script Editors ............................................................................................................... 75

2.4.1 Overview ................................................................................................................................. 75
2.4.2 Common Controls ................................................................................................................... 75
2.4.2.1 Overview ............................................................................................................................ 75
2.4.2.2 Menu Bar ........................................................................................................................... 76
2.4.2.3 Analyzing Script Settings Table ......................................................................................... 77
2.4.2.5 Analyzing Script Parameters Table ................................................................................... 79
2.4.3 ASE Standard T001 ................................................................................................................ 86
2.4.3.1 Overview ............................................................................................................................ 86
2.4.3.2 Menu Bar ........................................................................................................................... 87
2.4.3.3 Analyzing Script Settings Table ......................................................................................... 87
2.4.3.5 Analyzing Script Parameters Table ................................................................................... 87
2.4.3.8 Action Area ........................................................................................................................ 87
2.4.3.10 Dropping of Items............................................................................................................... 89
2.4.3.11 Syntax of Analyzing Scripts ............................................................................................... 89
2.4.3.11.1 Overview ....................................................................................................................... 89
2.4.3.11.2 Basics ........................................................................................................................... 90
2.4.3.11.3 Variables ....................................................................................................................... 90
2.4.3.11.4 Functions ...................................................................................................................... 92
2.4.3.11.5 Conditional Statements............................................................................................... 100
2.4.3.11.6 Loops .......................................................................................................................... 102
2.4.3.11.7 Includes....................................................................................................................... 106
2.4.3.11.8 Fast Analysis Scripts .................................................................................................. 106
2.4.3.11.9 Provided Parameters .................................................................................................. 107
2.5 User Function Editors................................................................................................................. 107
2.5.1 Overview ............................................................................................................................... 107
2.5.2 Common Controls ................................................................................................................. 107
2.5.2.1 Overview .......................................................................................................................... 107
2.5.2.2 Menu Bar ......................................................................................................................... 108
2.5.2.3 User Function Settings Table .......................................................................................... 109
2.5.2.4 User Function Parameters Table ..................................................................................... 110
2.5.2.5 User Function Properties Table ....................................................................................... 110
2.5.2.6 Provided Input Interfaces Table ....................................................................................... 111
2.5.2.7 Provided Output Interfaces Table .................................................................................... 111
English
Release 2018-06 5 / 866
2.5.3 UFE Standard T001 .............................................................................................................. 112

2.5.3.1 Overview .......................................................................................................................... 112
2.5.3.2 Menu Bar ......................................................................................................................... 113
2.5.3.3 User Function Settings Table .......................................................................................... 113
2.5.3.4 User Function Parameters Table ..................................................................................... 113
2.5.3.5 User Function Properties Table ....................................................................................... 113
2.5.3.6 Provided Input Interfaces Table ....................................................................................... 113
2.5.3.7 Provided Output Interfaces Table .................................................................................... 113
2.5.3.8 Action Area ...................................................................................................................... 113
2.5.3.9 Dropping of Items............................................................................................................. 120
2.5.3.10 Analyzing Function Properties Dialog .............................................................................. 120
2.5.3.10.1 Overview ..................................................................................................................... 120
2.5.3.10.2 Analyzing Function Properties Table .......................................................................... 121
2.5.3.10.3 Analyzing Function Arguments Table ......................................................................... 121
2.5.3.11 User Function Properties Dialog ...................................................................................... 121
2.5.3.12 Edit Group Box Dialog ..................................................................................................... 122
2.5.3.12.1 Overview ..................................................................................................................... 122
2.5.3.12.2 Group Box Parameters Table ..................................................................................... 122
2.6 Analyzing Functions ................................................................................................................... 123
2.6.1 General ................................................................................................................................. 123
2.6.1.1 Categories of Analyzing Functions .................................................................................. 123
2.6.1.2 Properties of Analyzing Functions ................................................................................... 123
2.6.1.3 Properties of Arguments of Analyzing Functions ............................................................. 124
2.6.1.4 Internals ........................................................................................................................... 125
2.6.1.5 Examples ......................................................................................................................... 127
2.6.2 Arithmetic .............................................................................................................................. 128
2.6.2.1 Abs() - AbsoluteValue() ................................................................................................... 128
2.6.2.1.1 General ....................................................................................................................... 128
2.6.2.1.2 Inputs .......................................................................................................................... 128
2.6.2.1.3 Outputs ....................................................................................................................... 129
2.6.2.1.4 Examples .................................................................................................................... 129
2.6.2.2 Add() - Addition().............................................................................................................. 130
2.6.2.2.1 General ....................................................................................................................... 130
2.6.2.2.2 Inputs .......................................................................................................................... 130
2.6.2.2.3 Outputs ....................................................................................................................... 131
2.6.2.2.4 Examples .................................................................................................................... 131
2.6.2.3 AddB2D() - AdditionBuffer2D() ........................................................................................ 132
2.6.2.3.1 General ....................................................................................................................... 132
2.6.2.3.2 Inputs .......................................................................................................................... 132
2.6.2.3.3 Outputs ....................................................................................................................... 133
2.6.2.3.4 Examples .................................................................................................................... 134
2.6.2.4 AddV2D() - AdditionVector2D() ....................................................................................... 135
English
Release 2018-06 6 / 866
2.6.2.4.1 General ....................................................................................................................... 135

2.6.2.4.2 Inputs .......................................................................................................................... 135
2.6.2.4.3 Outputs ....................................................................................................................... 136
2.6.2.4.4 Examples .................................................................................................................... 136
2.6.2.5 ArcCos() - ArcCosine() .................................................................................................... 137
2.6.2.5.1 General ....................................................................................................................... 137
2.6.2.5.2 Inputs .......................................................................................................................... 137
2.6.2.5.3 Outputs ....................................................................................................................... 138
2.6.2.5.4 Examples .................................................................................................................... 138
2.6.2.6 ArcCoTan() - ArcCoTangent() ......................................................................................... 139
2.6.2.6.1 General ....................................................................................................................... 139
2.6.2.6.2 Inputs .......................................................................................................................... 139
2.6.2.6.3 Outputs ....................................................................................................................... 140
2.6.2.6.4 Examples .................................................................................................................... 140
2.6.2.7 ArcSin() - ArcSine() .......................................................................................................... 141
2.6.2.7.1 General ....................................................................................................................... 141
2.6.2.7.2 Inputs .......................................................................................................................... 141
2.6.2.7.3 Outputs ....................................................................................................................... 142
2.6.2.7.4 Examples .................................................................................................................... 142
2.6.2.8 ArcTan() - ArcTangent() ................................................................................................... 143
2.6.2.8.1 General ....................................................................................................................... 143
2.6.2.8.2 Inputs .......................................................................................................................... 143
2.6.2.8.3 Outputs ....................................................................................................................... 144
2.6.2.8.4 Examples .................................................................................................................... 144
2.6.2.9 Ceil() - Ceil() ..................................................................................................................... 145
2.6.2.9.1 General ....................................................................................................................... 145
2.6.2.9.2 Inputs .......................................................................................................................... 145
2.6.2.9.3 Outputs ....................................................................................................................... 146
2.6.2.9.4 Examples .................................................................................................................... 146
2.6.2.10 Cos() - Cosine() ............................................................................................................... 147
2.6.2.10.1 General ....................................................................................................................... 147
2.6.2.10.2 Inputs .......................................................................................................................... 147
2.6.2.10.3 Outputs ....................................................................................................................... 148
2.6.2.10.4 Examples .................................................................................................................... 148
2.6.2.11 Dfrntl() - Differential() ....................................................................................................... 149
2.6.2.11.1 General ....................................................................................................................... 149
2.6.2.11.2 Inputs .......................................................................................................................... 149
2.6.2.11.3 Outputs ....................................................................................................................... 150
2.6.2.11.4 Examples .................................................................................................................... 151
2.6.2.12 Div() - Division() ............................................................................................................... 152
2.6.2.12.1 General ....................................................................................................................... 152
2.6.2.12.2 Inputs .......................................................................................................................... 152
English
Release 2018-06 7 / 866
2.6.2.12.3 Outputs ....................................................................................................................... 153

2.6.2.12.4 Examples .................................................................................................................... 153
2.6.2.13 Exp() - Exponential() ........................................................................................................ 154
2.6.2.13.1 General ....................................................................................................................... 154
2.6.2.13.2 Inputs .......................................................................................................................... 154
2.6.2.13.3 Outputs ....................................................................................................................... 155
2.6.2.13.4 Examples .................................................................................................................... 155
2.6.2.14 Extrplt() - Extrapolate() .................................................................................................... 156
2.6.2.14.1 General ....................................................................................................................... 156
2.6.2.14.2 Inputs .......................................................................................................................... 156
2.6.2.14.3 Outputs ....................................................................................................................... 159
2.6.2.14.4 Examples .................................................................................................................... 159
2.6.2.15 Pow() - Exponentiation() .................................................................................................. 160
2.6.2.15.1 General ....................................................................................................................... 160
2.6.2.15.2 Inputs .......................................................................................................................... 160
2.6.2.15.3 Outputs ....................................................................................................................... 161
2.6.2.15.4 Examples .................................................................................................................... 162
2.6.2.16 Floor() - Floor()................................................................................................................. 163
2.6.2.16.1 General ....................................................................................................................... 163
2.6.2.16.2 Inputs .......................................................................................................................... 163
2.6.2.16.3 Outputs ....................................................................................................................... 164
2.6.2.16.4 Examples .................................................................................................................... 164
2.6.2.17 Integral() - Integral() ......................................................................................................... 165
2.6.2.17.1 General ....................................................................................................................... 165
2.6.2.17.2 Inputs .......................................................................................................................... 165
2.6.2.17.3 Outputs ....................................................................................................................... 166
2.6.2.17.4 Examples .................................................................................................................... 167
2.6.2.18 Log() - Logarithm() ........................................................................................................... 168
2.6.2.18.1 General ....................................................................................................................... 168
2.6.2.18.2 Inputs .......................................................................................................................... 168
2.6.2.18.3 Outputs ....................................................................................................................... 169
2.6.2.18.4 Examples .................................................................................................................... 170
2.6.2.19 Log10() - Logarithm10() ................................................................................................... 171
2.6.2.19.1 General ....................................................................................................................... 171
2.6.2.19.2 Inputs .......................................................................................................................... 171
2.6.2.19.3 Outputs ....................................................................................................................... 172
2.6.2.19.4 Examples .................................................................................................................... 172
2.6.2.20 Log2() - Logarithm2() ....................................................................................................... 173
2.6.2.20.1 General ....................................................................................................................... 173
2.6.2.20.2 Inputs .......................................................................................................................... 173
2.6.2.20.3 Outputs ....................................................................................................................... 174
2.6.2.20.4 Examples .................................................................................................................... 174
English
Release 2018-06 8 / 866
2.6.2.21 Mod() - Modulo() .............................................................................................................. 175

2.6.2.21.1 General ....................................................................................................................... 175
2.6.2.21.2 Inputs .......................................................................................................................... 175
2.6.2.21.3 Outputs ....................................................................................................................... 176
2.6.2.21.4 Examples .................................................................................................................... 177
2.6.2.22 Mul() - Multiplication() ...................................................................................................... 178
2.6.2.22.1 General ....................................................................................................................... 178
2.6.2.22.2 Inputs .......................................................................................................................... 178
2.6.2.22.3 Outputs ....................................................................................................................... 179
2.6.2.22.4 Examples .................................................................................................................... 179
2.6.2.23 Ln() - NaturalLogarithm() ................................................................................................. 180
2.6.2.23.1 General ....................................................................................................................... 180
2.6.2.23.2 Inputs .......................................................................................................................... 180
2.6.2.23.3 Outputs ....................................................................................................................... 181
2.6.2.23.4 Examples .................................................................................................................... 181
2.6.2.24 Neg() - Negation() ............................................................................................................ 182
2.6.2.24.1 General ....................................................................................................................... 182
2.6.2.24.2 Inputs .......................................................................................................................... 182
2.6.2.24.3 Outputs ....................................................................................................................... 183
2.6.2.24.4 Examples .................................................................................................................... 183
2.6.2.25 NthRt() - NthRoot()........................................................................................................... 184
2.6.2.25.1 General ....................................................................................................................... 184
2.6.2.25.2 Inputs .......................................................................................................................... 184
2.6.2.25.3 Outputs ....................................................................................................................... 185
2.6.2.25.4 Examples .................................................................................................................... 186
2.6.2.26 Round() - Round() ............................................................................................................ 187
2.6.2.26.1 General ....................................................................................................................... 187
2.6.2.26.2 Inputs .......................................................................................................................... 187
2.6.2.26.3 Outputs ....................................................................................................................... 188
2.6.2.26.4 Examples .................................................................................................................... 188
2.6.2.27 Sin() - Sine() ..................................................................................................................... 189
2.6.2.27.1 General ....................................................................................................................... 189
2.6.2.27.2 Inputs .......................................................................................................................... 189
2.6.2.27.3 Outputs ....................................................................................................................... 190
2.6.2.27.4 Examples .................................................................................................................... 190
2.6.2.28 SqRt() - SquareRoot() ...................................................................................................... 191
2.6.2.28.1 General ....................................................................................................................... 191
2.6.2.28.2 Inputs .......................................................................................................................... 191
2.6.2.28.3 Outputs ....................................................................................................................... 192
2.6.2.28.4 Examples .................................................................................................................... 192
2.6.2.29 Sub() - Subtraction() ........................................................................................................ 193
2.6.2.29.1 General ....................................................................................................................... 193
English
Release 2018-06 9 / 866
2.6.2.29.2 Inputs .......................................................................................................................... 193

2.6.2.29.3 Outputs ....................................................................................................................... 194
2.6.2.29.4 Examples .................................................................................................................... 194
2.6.2.30 Tan() - Tangent().............................................................................................................. 195
2.6.2.30.1 General ....................................................................................................................... 195
2.6.2.30.2 Inputs .......................................................................................................................... 195
2.6.2.30.3 Outputs ....................................................................................................................... 196
2.6.2.30.4 Examples .................................................................................................................... 196
2.6.2.31 Trunc() - Truncate().......................................................................................................... 197
2.6.2.31.1 General ....................................................................................................................... 197
2.6.2.31.2 Inputs .......................................................................................................................... 197
2.6.2.31.3 Outputs ....................................................................................................................... 198
2.6.2.31.4 Examples .................................................................................................................... 198
2.6.3 Classification ......................................................................................................................... 199
2.6.3.1 RFC() – RainFlowCounting() ........................................................................................... 199
2.6.3.1.1 General ....................................................................................................................... 199
2.6.3.1.2 Inputs .......................................................................................................................... 200
2.6.3.1.3 Outputs ....................................................................................................................... 204
2.6.3.1.4 Examples .................................................................................................................... 206
2.6.3.2 TLC() – TimeAtLevelCounting() ....................................................................................... 207
2.6.3.2.1 General ....................................................................................................................... 207
2.6.3.2.2 Inputs .......................................................................................................................... 207
2.6.3.2.3 Outputs ....................................................................................................................... 210
2.6.3.2.4 Examples .................................................................................................................... 210
2.6.3.3 TLC2D() – TimeAtLevelCounting2D().............................................................................. 211
2.6.3.3.1 General ....................................................................................................................... 211
2.6.3.3.2 Inputs .......................................................................................................................... 212
2.6.3.3.3 Outputs ....................................................................................................................... 215
2.6.3.3.4 Examples .................................................................................................................... 216
2.6.4 Comparison ........................................................................................................................... 217
2.6.4.1 Cmp() - Compare()........................................................................................................... 217
2.6.4.1.1 General ....................................................................................................................... 217
2.6.4.1.2 Inputs .......................................................................................................................... 217
2.6.4.1.3 Outputs ....................................................................................................................... 219
2.6.4.1.4 Examples .................................................................................................................... 220
2.6.5 Control................................................................................................................................... 221
2.6.5.1 ChkNoP() - CheckNumberOfParameters() ...................................................................... 221
2.6.5.1.1 General ....................................................................................................................... 221
2.6.5.1.2 Inputs .......................................................................................................................... 221
2.6.5.1.3 Outputs ....................................................................................................................... 222
2.6.5.1.4 Examples .................................................................................................................... 222
2.6.5.2 Continue() - Continue() .................................................................................................... 223
English
Release 2018-06 10 / 866
2.6.5.2.1 General ....................................................................................................................... 223

2.6.5.2.2 Inputs .......................................................................................................................... 223
2.6.5.2.3 Outputs ....................................................................................................................... 225
2.6.5.2.4 Examples .................................................................................................................... 225
2.6.5.3 CreateCF() - CreateConfigurationFile() ........................................................................... 226
2.6.5.3.1 General ....................................................................................................................... 226
2.6.5.3.2 Inputs .......................................................................................................................... 226
2.6.5.3.3 Outputs ....................................................................................................................... 228
2.6.5.3.4 Examples .................................................................................................................... 228
2.6.5.4 CreateCFEx() - CreateConfigurationFileExtended() ........................................................ 229
2.6.5.4.1 General ....................................................................................................................... 229
2.6.5.4.2 Inputs .......................................................................................................................... 229
2.6.5.4.3 Outputs ....................................................................................................................... 231
2.6.5.4.4 Examples .................................................................................................................... 231
2.6.5.5 Exit() - Exit() ..................................................................................................................... 232
2.6.5.5.1 General ....................................................................................................................... 232
2.6.5.5.2 Inputs .......................................................................................................................... 232
2.6.5.5.3 Outputs ....................................................................................................................... 233
2.6.5.5.4 Examples .................................................................................................................... 233
2.6.5.6 IsDataPrsnt() - IsDataPresent() ....................................................................................... 234
2.6.5.6.1 General ....................................................................................................................... 234
2.6.5.6.2 Inputs .......................................................................................................................... 234
2.6.5.6.3 Outputs ....................................................................................................................... 235
2.6.5.6.4 Examples .................................................................................................................... 236
2.6.5.7 Pause() - Pause()............................................................................................................. 237
2.6.5.7.1 General ....................................................................................................................... 237
2.6.5.7.2 Inputs .......................................................................................................................... 237
2.6.5.7.3 Outputs ....................................................................................................................... 238
2.6.5.7.4 Examples .................................................................................................................... 238
2.6.5.8 RemoveData() - RemoveData() ....................................................................................... 239
2.6.5.8.1 General ....................................................................................................................... 239
2.6.5.8.2 Inputs .......................................................................................................................... 239
2.6.5.8.3 Outputs ....................................................................................................................... 240
2.6.5.8.4 Examples .................................................................................................................... 241
2.6.5.9 Start() - Start() .................................................................................................................. 242
2.6.5.9.1 General ....................................................................................................................... 242
2.6.5.9.2 Inputs .......................................................................................................................... 242
2.6.5.9.3 Outputs ....................................................................................................................... 244
2.6.5.9.4 Examples .................................................................................................................... 244
2.6.5.10 StartEx() - StartExtended() .............................................................................................. 245
2.6.5.10.1 General ....................................................................................................................... 245
2.6.5.10.2 Inputs .......................................................................................................................... 245
English
Release 2018-06 11 / 866
2.6.5.10.3 Outputs ....................................................................................................................... 247

2.6.5.10.4 Examples .................................................................................................................... 248
2.6.5.11 Stop() - Stop() .................................................................................................................. 249
2.6.5.11.1 General ....................................................................................................................... 249
2.6.5.11.2 Inputs .......................................................................................................................... 249
2.6.5.11.3 Outputs ....................................................................................................................... 250
2.6.5.11.4 Examples .................................................................................................................... 250
2.6.5.12 WaitForCF() – WaitForConfigurationFile() ....................................................................... 251
2.6.5.12.1 General ....................................................................................................................... 251
2.6.5.12.2 Inputs .......................................................................................................................... 251
2.6.5.12.3 Outputs ....................................................................................................................... 253
2.6.5.12.4 Examples .................................................................................................................... 253
2.6.5.13 WaitForEDT() – WaitForEventByDateAndTime() ............................................................ 254
2.6.5.13.1 General ....................................................................................................................... 254
2.6.5.13.2 Inputs .......................................................................................................................... 254
2.6.5.13.3 Outputs ....................................................................................................................... 256
2.6.5.13.4 Examples .................................................................................................................... 256
2.6.5.14 WaitForFS() – WaitForFileSplitting() ................................................................................ 257
2.6.5.14.1 General ....................................................................................................................... 257
2.6.5.14.2 Inputs .......................................................................................................................... 257
2.6.5.14.3 Outputs ....................................................................................................................... 258
2.6.5.14.4 Examples .................................................................................................................... 259
2.6.6 Conversion ............................................................................................................................ 260
2.6.6.1 ConvB1DToTS() - ConvertBuffer1DToTimeSeries() ....................................................... 260
2.6.6.1.1 General ....................................................................................................................... 260
2.6.6.1.2 Inputs .......................................................................................................................... 260
2.6.6.1.3 Outputs ....................................................................................................................... 263
2.6.6.1.4 Examples .................................................................................................................... 263
2.6.6.2 ConvCToSp() - ConvertCartesianToSpherical() .............................................................. 264
2.6.6.2.1 General ....................................................................................................................... 264
2.6.6.2.2 Inputs .......................................................................................................................... 264
2.6.6.2.3 Outputs ....................................................................................................................... 266
2.6.6.2.4 Examples .................................................................................................................... 267
2.6.6.3 ConvPToV2D() - ConvertPolarToVector2D() .................................................................. 268
2.6.6.3.1 General ....................................................................................................................... 268
2.6.6.3.2 Inputs .......................................................................................................................... 268
2.6.6.3.3 Outputs ....................................................................................................................... 270
2.6.6.3.4 Examples .................................................................................................................... 270
2.6.6.4 ConvSpm() - ConvertSpectrum() ..................................................................................... 271
2.6.6.4.1 General ....................................................................................................................... 271
2.6.6.4.2 Inputs .......................................................................................................................... 271
2.6.6.4.3 Outputs ....................................................................................................................... 273
English
Release 2018-06 12 / 866
2.6.6.4.4 Examples .................................................................................................................... 274

2.6.6.5 ConvSpToC() - ConvertSphericalToCartesian() .............................................................. 275
2.6.6.5.1 General ....................................................................................................................... 275
2.6.6.5.2 Inputs .......................................................................................................................... 275
2.6.6.5.3 Outputs ....................................................................................................................... 277
2.6.6.5.4 Examples .................................................................................................................... 278
2.6.6.6 ConvV2DToP() - ConvertVector2DToPolar() .................................................................. 279
2.6.6.6.1 General ....................................................................................................................... 279
2.6.6.6.2 Inputs .......................................................................................................................... 279
2.6.6.6.3 Outputs ....................................................................................................................... 280
2.6.6.6.4 Examples .................................................................................................................... 281
2.6.6.7 ConvVToB1D() - ConvertValueToBuffer1D() .................................................................. 282
2.6.6.7.1 General ....................................................................................................................... 282
2.6.6.7.2 Inputs .......................................................................................................................... 282
2.6.6.7.3 Outputs ....................................................................................................................... 283
2.6.6.7.4 Examples .................................................................................................................... 284
2.6.6.8 ConvVToVDMA() - ConvertValueToVDMA() ................................................................... 285
2.6.6.8.1 General ....................................................................................................................... 285
2.6.6.8.2 Inputs .......................................................................................................................... 285
2.6.6.8.3 Outputs ....................................................................................................................... 288
2.6.6.8.4 Examples .................................................................................................................... 289
2.6.6.9 GetVFrmB1D() - GetValueFromBuffer1D() ..................................................................... 290
2.6.6.9.1 General ....................................................................................................................... 290
2.6.6.9.2 Inputs .......................................................................................................................... 290
2.6.6.9.3 Outputs ....................................................................................................................... 292
2.6.6.9.4 Remarks...................................................................................................................... 292
2.6.6.9.5 Examples .................................................................................................................... 292
2.6.6.10 GetStrFrmSD() - GetStringFromSimpleData() ................................................................. 293
2.6.6.10.1 General ....................................................................................................................... 293
2.6.6.10.2 Inputs .......................................................................................................................... 293
2.6.6.10.3 Outputs ....................................................................................................................... 295
2.6.6.10.4 Examples .................................................................................................................... 295
2.6.6.11 GetVFrmSD() - GetValueFromSimpleData() ................................................................... 296
2.6.6.11.1 General ....................................................................................................................... 296
2.6.6.11.2 Inputs .......................................................................................................................... 296
2.6.6.11.3 Outputs ....................................................................................................................... 298
2.6.6.11.4 Examples .................................................................................................................... 298
2.6.7 Envelopes ............................................................................................................................. 299
2.6.7.1 ClcXYEnv() – CalculateXYEnvelope() ............................................................................. 299
2.6.7.1.1 General ....................................................................................................................... 299
2.6.7.1.2 Inputs .......................................................................................................................... 299
2.6.7.1.3 Outputs ....................................................................................................................... 303
English
Release 2018-06 13 / 866
2.6.7.1.4 Examples .................................................................................................................... 303

2.6.7.2 MonXYEnv() – MonitorXYEnvelope() .............................................................................. 304
2.6.7.2.1 General ....................................................................................................................... 304
2.6.7.2.2 Inputs .......................................................................................................................... 305
2.6.7.2.3 Outputs ....................................................................................................................... 309
2.6.7.2.4 Examples .................................................................................................................... 310
2.6.8 Filter ...................................................................................................................................... 311
2.6.8.1 BP() - BandPassFilter() .................................................................................................... 311
2.6.8.1.1 General ....................................................................................................................... 311
2.6.8.1.2 Inputs .......................................................................................................................... 311
2.6.8.1.3 Outputs ....................................................................................................................... 313
2.6.8.1.4 Examples .................................................................................................................... 313
2.6.8.2 BS() - BandStopFilter() .................................................................................................... 314
2.6.8.2.1 General ....................................................................................................................... 314
2.6.8.2.2 Inputs .......................................................................................................................... 314
2.6.8.2.3 Outputs ....................................................................................................................... 316
2.6.8.2.4 Examples .................................................................................................................... 316
2.6.8.3 HP() - HighPassFilter() .................................................................................................... 317
2.6.8.3.1 General ....................................................................................................................... 317
2.6.8.3.2 Inputs .......................................................................................................................... 317
2.6.8.3.3 Outputs ....................................................................................................................... 318
2.6.8.3.4 Examples .................................................................................................................... 319
2.6.8.4 IIRBPBT() - IIRBandPassFilterButterworth() ................................................................... 320
2.6.8.4.1 General ....................................................................................................................... 320
2.6.8.4.2 Inputs .......................................................................................................................... 320
2.6.8.4.3 Outputs ....................................................................................................................... 322
2.6.8.4.4 Examples .................................................................................................................... 322
2.6.8.5 IIRBSBT() - IIRBandStopFilterButterworth() .................................................................... 323
2.6.8.5.1 General ....................................................................................................................... 323
2.6.8.5.2 Inputs .......................................................................................................................... 323
2.6.8.5.3 Outputs ....................................................................................................................... 325
2.6.8.5.4 Examples .................................................................................................................... 325
2.6.8.6 IIRHPBT() - IIRHighPassFilterButterworth() .................................................................... 326
2.6.8.6.1 General ....................................................................................................................... 326
2.6.8.6.2 Inputs .......................................................................................................................... 326
2.6.8.6.3 Outputs ....................................................................................................................... 328
2.6.8.6.4 Examples .................................................................................................................... 328
2.6.8.7 IIRLPBT() - IIRLowPassFilterButterworth() ..................................................................... 329
2.6.8.7.1 General ....................................................................................................................... 329
2.6.8.7.2 Inputs .......................................................................................................................... 329
2.6.8.7.3 Outputs ....................................................................................................................... 331
2.6.8.7.4 Examples .................................................................................................................... 331
English
Release 2018-06 14 / 866
2.6.8.8 IIRBPCH1() – IIRBandPassFilterChebyshev1() .............................................................. 332

2.6.8.8.1 General ....................................................................................................................... 332
2.6.8.8.2 Inputs .......................................................................................................................... 332
2.6.8.8.3 Outputs ....................................................................................................................... 334
2.6.8.8.4 Examples .................................................................................................................... 335
2.6.8.9 IIRBSCH1() – IIRBandStopFilterChebyshev1() ............................................................... 336
2.6.8.9.1 General ....................................................................................................................... 336
2.6.8.9.2 Inputs .......................................................................................................................... 336
2.6.8.9.3 Outputs ....................................................................................................................... 338
2.6.8.9.4 Examples .................................................................................................................... 339
2.6.8.10 IIRHPCH1() – IIRHighPassFilterChebyshev1() ............................................................... 340
2.6.8.10.1 General ....................................................................................................................... 340
2.6.8.10.2 Inputs .......................................................................................................................... 340
2.6.8.10.3 Outputs ....................................................................................................................... 342
2.6.8.10.4 Examples .................................................................................................................... 342
2.6.8.11 IIRLPCH1() – IIRLowPassFilterChebyshev1() ................................................................ 343
2.6.8.11.1 General ....................................................................................................................... 343
2.6.8.11.2 Inputs .......................................................................................................................... 343
2.6.8.11.3 Outputs ....................................................................................................................... 345
2.6.8.11.4 Examples .................................................................................................................... 345
2.6.8.12 IIRBPCH2() – IIRBandPassFilterChebyshev2() .............................................................. 346
2.6.8.12.1 General ....................................................................................................................... 346
2.6.8.12.2 Inputs .......................................................................................................................... 346
2.6.8.12.3 Outputs ....................................................................................................................... 348
2.6.8.12.4 Examples .................................................................................................................... 349
2.6.8.13 IIRBSCH2() – IIRBandStopFilterChebyshev2() ............................................................... 350
2.6.8.13.1 General ....................................................................................................................... 350
2.6.8.13.2 Inputs .......................................................................................................................... 350
2.6.8.13.3 Outputs ....................................................................................................................... 352
2.6.8.13.4 Examples .................................................................................................................... 353
2.6.8.14 IIRHPCH2() – IIRHighPassFilterChebyshev2() ............................................................... 354
2.6.8.14.1 General ....................................................................................................................... 354
2.6.8.14.2 Inputs .......................................................................................................................... 354
2.6.8.14.3 Outputs ....................................................................................................................... 356
2.6.8.14.4 Examples .................................................................................................................... 356
2.6.8.15 IIRLPCH2() – IIRLowPassFilterChebyshev2() ................................................................ 357
2.6.8.15.1 General ....................................................................................................................... 357
2.6.8.15.2 Inputs .......................................................................................................................... 357
2.6.8.15.3 Outputs ....................................................................................................................... 359
2.6.8.15.4 Examples .................................................................................................................... 359
2.6.8.16 IIRVBPBT() - IIRVariableBandPassFilterButterworth() .................................................... 360
2.6.8.16.1 General ....................................................................................................................... 360
English
Release 2018-06 15 / 866
2.6.8.16.2 Inputs .......................................................................................................................... 360

2.6.8.16.3 Outputs ....................................................................................................................... 362
2.6.8.16.4 Examples .................................................................................................................... 362
2.6.8.17 LP() - LowPassFilter() ...................................................................................................... 363
2.6.8.17.1 General ....................................................................................................................... 363
2.6.8.17.2 Inputs .......................................................................................................................... 363
2.6.8.17.3 Outputs ....................................................................................................................... 364
2.6.8.17.4 Examples .................................................................................................................... 365
2.6.9 Generation ............................................................................................................................ 366
2.6.9.1 GenWF() - GenerateWaveForm() .................................................................................... 366
2.6.9.1.1 General ....................................................................................................................... 366
2.6.9.1.2 Inputs .......................................................................................................................... 366
2.6.9.1.3 Outputs ....................................................................................................................... 368
2.6.9.1.4 Examples .................................................................................................................... 369
2.6.9.2 Impulser() - Impulser() ..................................................................................................... 370
2.6.9.2.1 General ....................................................................................................................... 370
2.6.9.2.2 Inputs .......................................................................................................................... 370
2.6.9.2.3 Outputs ....................................................................................................................... 373
2.6.9.2.4 Examples .................................................................................................................... 373
2.6.9.3 Random() - Random() ...................................................................................................... 374
2.6.9.3.1 General ....................................................................................................................... 374
2.6.9.3.2 Inputs .......................................................................................................................... 374
2.6.9.3.3 Outputs ....................................................................................................................... 376
2.6.9.3.4 Examples .................................................................................................................... 376
2.6.10 Input ...................................................................................................................................... 377
2.6.10.1 In() - Input() ...................................................................................................................... 377
2.6.10.1.1 General ....................................................................................................................... 377
2.6.10.1.2 Inputs .......................................................................................................................... 377
2.6.10.1.3 Outputs ....................................................................................................................... 378
2.6.10.2 InAAF() - InputAntiAliasingFilter() .................................................................................... 380
2.6.10.2.1 General ....................................................................................................................... 380
2.6.10.2.2 Inputs .......................................................................................................................... 380
2.6.10.2.3 Outputs ....................................................................................................................... 382
2.6.10.2.4 Examples .................................................................................................................... 383
2.6.10.3 InAAFCH1() - InputAntiAliasingFilterChebyshev1() ......................................................... 384
2.6.10.3.1 General ....................................................................................................................... 384
2.6.10.3.2 Inputs .......................................................................................................................... 385
2.6.10.3.3 Outputs ....................................................................................................................... 387
2.6.10.3.4 Examples .................................................................................................................... 388
2.6.10.4 InB1D() - InputBuffer1D() ................................................................................................. 389
2.6.10.4.1 General ....................................................................................................................... 389
2.6.10.4.2 Inputs .......................................................................................................................... 389
English
Release 2018-06 16 / 866
2.6.10.4.3 Outputs ....................................................................................................................... 390

2.6.10.5 InB2D() – InputBuffer2D() ................................................................................................ 392
2.6.10.5.1 General ....................................................................................................................... 392
2.6.10.5.2 Inputs .......................................................................................................................... 392
2.6.10.5.3 Outputs ....................................................................................................................... 393
2.6.10.6 InConst() - InputConstant() .............................................................................................. 395
2.6.10.6.1 General ....................................................................................................................... 395
2.6.10.6.2 Inputs .......................................................................................................................... 395
2.6.10.6.3 Outputs ....................................................................................................................... 396
2.6.10.7 InOrdRsmpl() – InputOrderResampling() ........................................................................ 397
2.6.10.7.1 General ....................................................................................................................... 397
2.6.10.7.2 Inputs .......................................................................................................................... 398
2.6.10.7.3 Outputs ....................................................................................................................... 400
2.6.10.8 InSpm() - InputSpectrum() ............................................................................................... 402
2.6.10.8.1 General ....................................................................................................................... 402
2.6.10.8.2 Inputs .......................................................................................................................... 402
2.6.10.8.3 Outputs ....................................................................................................................... 404
2.6.10.9 InSpmEnv() - InputSpectrumEnvelope() .......................................................................... 406
2.6.10.9.1 General ....................................................................................................................... 406
2.6.10.9.2 Inputs .......................................................................................................................... 406
2.6.10.9.3 Outputs ....................................................................................................................... 408
2.6.10.10 InStr() - InputString() ........................................................................................................ 410
2.6.10.10.1 General ....................................................................................................................... 410
2.6.10.10.2 Inputs .......................................................................................................................... 410
2.6.10.10.3 Outputs ....................................................................................................................... 411
2.6.10.11 InTCP() - InputTCP()........................................................................................................ 413
2.6.10.11.1 General ....................................................................................................................... 413
2.6.10.11.2 Inputs .......................................................................................................................... 413
2.6.10.11.3 Outputs ....................................................................................................................... 415
2.6.10.11.4 Remarks...................................................................................................................... 416
2.6.10.11.5 Examples .................................................................................................................... 417
2.6.10.12 InV2D() - InputVector2D() ................................................................................................ 418
2.6.10.12.1 General ....................................................................................................................... 418
2.6.10.12.2 Inputs .......................................................................................................................... 418
2.6.10.12.3 Outputs ....................................................................................................................... 419
2.6.10.12.4 Examples .................................................................................................................... 420
2.6.11 Logic ...................................................................................................................................... 421
2.6.11.1 AND() - AND() .................................................................................................................. 421
2.6.11.1.1 General ....................................................................................................................... 421
2.6.11.1.2 Inputs .......................................................................................................................... 421
2.6.11.1.3 Outputs ....................................................................................................................... 422
2.6.11.1.4 Examples .................................................................................................................... 422
English
Release 2018-06 17 / 866
2.6.11.2 NAND() - NAND()............................................................................................................. 423

2.6.11.2.1 General ....................................................................................................................... 423
2.6.11.2.2 Inputs .......................................................................................................................... 423
2.6.11.2.3 Outputs ....................................................................................................................... 424
2.6.11.2.4 Examples .................................................................................................................... 424
2.6.11.3 NOR() - NOR() ................................................................................................................. 425
2.6.11.3.1 General ....................................................................................................................... 425
2.6.11.3.2 Inputs .......................................................................................................................... 425
2.6.11.3.3 Outputs ....................................................................................................................... 426
2.6.11.3.4 Examples .................................................................................................................... 426
2.6.11.4 NOT() - NOT() .................................................................................................................. 427
2.6.11.4.1 General ....................................................................................................................... 427
2.6.11.4.2 Inputs .......................................................................................................................... 427
2.6.11.4.3 Outputs ....................................................................................................................... 428
2.6.11.4.4 Examples .................................................................................................................... 428
2.6.11.5 NXOR() - NXOR() ............................................................................................................ 429
2.6.11.5.1 General ....................................................................................................................... 429
2.6.11.5.2 Inputs .......................................................................................................................... 429
2.6.11.5.3 Outputs ....................................................................................................................... 430
2.6.11.5.4 Examples .................................................................................................................... 431
2.6.11.6 OR() - OR() ...................................................................................................................... 432
2.6.11.6.1 General ....................................................................................................................... 432
2.6.11.6.2 Inputs .......................................................................................................................... 432
2.6.11.6.3 Outputs ....................................................................................................................... 433
2.6.11.6.4 Examples .................................................................................................................... 433
2.6.11.7 RSFF() - RSFlipFlop() ...................................................................................................... 434
2.6.11.7.1 General ....................................................................................................................... 434
2.6.11.7.2 Inputs .......................................................................................................................... 434
2.6.11.7.3 Outputs ....................................................................................................................... 435
2.6.11.7.4 Examples .................................................................................................................... 436
2.6.11.8 XOR() - XOR() ................................................................................................................. 437
2.6.11.8.1 General ....................................................................................................................... 437
2.6.11.8.2 Inputs .......................................................................................................................... 437
2.6.11.8.3 Outputs ....................................................................................................................... 438
2.6.11.8.4 Examples .................................................................................................................... 439
2.6.12 Machine Analysis .................................................................................................................. 440
2.6.12.1 RMSAcc() - RMSAcceleration() ....................................................................................... 440
2.6.12.1.1 General ....................................................................................................................... 440
2.6.12.1.2 Inputs .......................................................................................................................... 441
2.6.12.1.3 Outputs ....................................................................................................................... 444
2.6.12.1.4 Examples .................................................................................................................... 445
2.6.13 Miscellaneous ....................................................................................................................... 446
English
Release 2018-06 18 / 866
2.6.13.1 Cnt() - Count() .................................................................................................................. 446

2.6.13.1.1 General ....................................................................................................................... 446
2.6.13.1.2 Inputs .......................................................................................................................... 446
2.6.13.1.3 Outputs ....................................................................................................................... 448
2.6.13.1.4 Examples .................................................................................................................... 448
2.6.13.2 DeMux() - Demultiplexer() ............................................................................................... 449
2.6.13.2.1 General ....................................................................................................................... 449
2.6.13.2.2 Inputs .......................................................................................................................... 449
2.6.13.2.3 Outputs ....................................................................................................................... 450
2.6.13.2.4 Examples .................................................................................................................... 451
2.6.13.3 IsFlgEdg() - IsFallingEdge() ............................................................................................. 452
2.6.13.3.1 General ....................................................................................................................... 452
2.6.13.3.2 Inputs .......................................................................................................................... 452
2.6.13.3.3 Outputs ....................................................................................................................... 453
2.6.13.3.4 Examples .................................................................................................................... 453
2.6.13.4 IsRsgEdg() - IsRisingEdge() ............................................................................................ 454
2.6.13.4.1 General ....................................................................................................................... 454
2.6.13.4.2 Inputs .......................................................................................................................... 454
2.6.13.4.3 Outputs ....................................................................................................................... 455
2.6.13.4.4 Examples .................................................................................................................... 455
2.6.13.5 MonEdg() - MonitorEdge() ............................................................................................... 456
2.6.13.5.1 General ....................................................................................................................... 456
2.6.13.5.2 Inputs .......................................................................................................................... 456
2.6.13.5.3 Outputs ....................................................................................................................... 458
2.6.13.5.4 Examples .................................................................................................................... 458
2.6.13.6 Mux() - Multiplexer() ......................................................................................................... 459
2.6.13.6.1 General ....................................................................................................................... 459
2.6.13.6.2 Inputs .......................................................................................................................... 459
2.6.13.6.3 Outputs ....................................................................................................................... 460
2.6.13.6.4 Examples .................................................................................................................... 461
2.6.14 Orbit ...................................................................................................................................... 462
2.6.14.1 Orbit() - Orbit() ................................................................................................................. 462
2.6.14.1.1 General ....................................................................................................................... 462
2.6.14.1.2 Inputs .......................................................................................................................... 463
2.6.14.1.3 Outputs ....................................................................................................................... 466
2.6.14.1.4 Examples .................................................................................................................... 468
2.6.15 Output ................................................................................................................................... 469
2.6.15.1 Out() - Output() ................................................................................................................ 469
2.6.15.1.1 General ....................................................................................................................... 469
2.6.15.1.2 Inputs .......................................................................................................................... 470
2.6.15.1.3 Outputs ....................................................................................................................... 474
2.6.15.1.4 Examples .................................................................................................................... 475
English
Release 2018-06 19 / 866
2.6.15.2 OutB1D() - OutputBuffer1D() ........................................................................................... 476

2.6.15.2.1 General ....................................................................................................................... 476
2.6.15.2.2 Inputs .......................................................................................................................... 477
2.6.15.2.3 Outputs ....................................................................................................................... 481
2.6.15.2.4 Examples .................................................................................................................... 482
2.6.15.3 OutB2D() – OutputBuffer2D() .......................................................................................... 483
2.6.15.3.1 General ....................................................................................................................... 483
2.6.15.3.2 Inputs .......................................................................................................................... 484
2.6.15.3.3 Outputs ....................................................................................................................... 488
2.6.15.3.4 Examples .................................................................................................................... 489
2.6.15.4 OutOrbit() - OutputOrbit() ................................................................................................. 490
2.6.15.4.1 General ....................................................................................................................... 490
2.6.15.4.2 Inputs .......................................................................................................................... 491
2.6.15.4.3 Outputs ....................................................................................................................... 495
2.6.15.4.4 Examples .................................................................................................................... 496
2.6.15.5 OutSpm() - OutputSpectrum() ......................................................................................... 497
2.6.15.5.1 General ....................................................................................................................... 497
2.6.15.5.2 Inputs .......................................................................................................................... 498
2.6.15.5.3 Outputs ....................................................................................................................... 502
2.6.15.5.4 Examples .................................................................................................................... 503
2.6.15.6 OutSpmEnv() - OutputSpectrumEnvelope() .................................................................... 504
2.6.15.6.1 General ....................................................................................................................... 504
2.6.15.6.2 Inputs .......................................................................................................................... 505
2.6.15.6.3 Outputs ....................................................................................................................... 509
2.6.15.6.4 Examples .................................................................................................................... 510
2.6.15.7 OutStr() - OutputString() .................................................................................................. 511
2.6.15.7.1 General ....................................................................................................................... 511
2.6.15.7.2 Inputs .......................................................................................................................... 512
2.6.15.7.3 Outputs ....................................................................................................................... 517
2.6.15.7.4 Examples .................................................................................................................... 518
2.6.15.8 OutTCP() - OutputTCP() .................................................................................................. 519
2.6.15.8.1 General ....................................................................................................................... 519
2.6.15.8.2 Inputs .......................................................................................................................... 519
2.6.15.8.3 Outputs ....................................................................................................................... 521
2.6.15.8.4 Remarks...................................................................................................................... 522
2.6.15.8.5 Examples .................................................................................................................... 524
2.6.15.9 OutV2D() - OutputVector2D() .......................................................................................... 525
2.6.15.9.1 General ....................................................................................................................... 525
2.6.15.9.2 Inputs .......................................................................................................................... 526
2.6.15.9.3 Outputs ....................................................................................................................... 530
2.6.15.9.4 Examples .................................................................................................................... 531
2.6.16 Spectral ................................................................................................................................. 532
English
Release 2018-06 20 / 866
2.6.16.1 AppBhann() - ApplyBartlettHann() ................................................................................... 532

2.6.16.1.1 General ....................................................................................................................... 532
2.6.16.1.2 Inputs .......................................................................................................................... 532
2.6.16.1.3 Outputs ....................................................................................................................... 533
2.6.16.1.4 Examples .................................................................................................................... 534
2.6.16.2 AppBlack() - ApplyBlackmann() ....................................................................................... 535
2.6.16.2.1 General ....................................................................................................................... 535
2.6.16.2.2 Inputs .......................................................................................................................... 535
2.6.16.2.3 Outputs ....................................................................................................................... 536
2.6.16.2.4 Examples .................................................................................................................... 537
2.6.16.3 AppBlett() - ApplyBartlett() ............................................................................................... 538
2.6.16.3.1 General ....................................................................................................................... 538
2.6.16.3.2 Inputs .......................................................................................................................... 538
2.6.16.3.3 Outputs ....................................................................................................................... 539
2.6.16.3.4 Examples .................................................................................................................... 540
2.6.16.4 AppHamm() - ApplyHamming() ....................................................................................... 541
2.6.16.4.1 General ....................................................................................................................... 541
2.6.16.4.2 Inputs .......................................................................................................................... 541
2.6.16.4.3 Outputs ....................................................................................................................... 542
2.6.16.4.4 Examples .................................................................................................................... 543
2.6.16.5 AppHann() - ApplyHanning() ........................................................................................... 544
2.6.16.5.1 General ....................................................................................................................... 544
2.6.16.5.2 Inputs .......................................................................................................................... 544
2.6.16.5.3 Outputs ....................................................................................................................... 545
2.6.16.5.4 Examples .................................................................................................................... 546
2.6.16.6 AvgSpm() - AverageSpectrum() ...................................................................................... 547
2.6.16.6.1 General ....................................................................................................................... 547
2.6.16.6.2 Inputs .......................................................................................................................... 547
2.6.16.6.3 Outputs ....................................................................................................................... 548
2.6.16.6.4 Examples .................................................................................................................... 549
2.6.16.7 Cpstr() - Cepstrum() ......................................................................................................... 550
2.6.16.7.1 General ....................................................................................................................... 550
2.6.16.7.2 Inputs .......................................................................................................................... 550
2.6.16.7.3 Outputs ....................................................................................................................... 551
2.6.16.7.4 Examples .................................................................................................................... 552
2.6.16.8 EnvHlb() - EnvelopeHilbert() ............................................................................................ 553
2.6.16.8.1 General ....................................................................................................................... 553
2.6.16.8.2 Inputs .......................................................................................................................... 553
2.6.16.8.3 Outputs ....................................................................................................................... 554
2.6.16.8.4 Examples .................................................................................................................... 555
2.6.16.9 FFT() - FastFourierTransformation()................................................................................ 556
2.6.16.9.1 General ....................................................................................................................... 556
English
Release 2018-06 21 / 866
2.6.16.9.2 Inputs .......................................................................................................................... 556

2.6.16.9.3 Outputs ....................................................................................................................... 557
2.6.16.9.4 Examples .................................................................................................................... 558
2.6.16.10 GenAlrmBnd() - GenerateAlarmBand() ........................................................................... 559
2.6.16.10.1 General ....................................................................................................................... 559
2.6.16.10.2 Inputs .......................................................................................................................... 559
2.6.16.10.3 Outputs ....................................................................................................................... 562
2.6.16.10.4 Examples .................................................................................................................... 562
2.6.16.11 GetAlrmBnd() - GetAlarmBand()...................................................................................... 563
2.6.16.11.1 General ....................................................................................................................... 563
2.6.16.11.2 Inputs .......................................................................................................................... 563
2.6.16.11.3 Outputs ....................................................................................................................... 564
2.6.16.11.4 Examples .................................................................................................................... 567
2.6.16.12 GetAmpl() – GetAmplitude() ............................................................................................ 568
2.6.16.12.1 General ....................................................................................................................... 568
2.6.16.12.2 Inputs .......................................................................................................................... 568
2.6.16.12.3 Outputs ....................................................................................................................... 571
2.6.16.12.4 Examples .................................................................................................................... 572
2.6.16.13 MonAlrmSpm() - MonitorAlarmSpectrum() ...................................................................... 573
2.6.16.13.1 General ....................................................................................................................... 573
2.6.16.13.2 Inputs .......................................................................................................................... 574
2.6.16.13.3 Outputs ....................................................................................................................... 576
2.6.16.13.4 Examples .................................................................................................................... 579
2.6.16.14 MonAmpl() – MonitorAmplitude() ..................................................................................... 580
2.6.16.14.1 General ....................................................................................................................... 580
2.6.16.14.2 Inputs .......................................................................................................................... 580
2.6.16.14.3 Outputs ....................................................................................................................... 583
2.6.16.14.4 Examples .................................................................................................................... 584
2.6.16.15 MonAmpls() – MonitorAmplitudes() ................................................................................. 585
2.6.16.15.1 General ....................................................................................................................... 585
2.6.16.15.2 Inputs .......................................................................................................................... 585
2.6.16.15.3 Outputs ....................................................................................................................... 587
2.6.16.15.4 Examples .................................................................................................................... 588
2.6.16.16 MonBsBnd() – MonitorBaseBand() .................................................................................. 589
2.6.16.16.1 General ....................................................................................................................... 589
2.6.16.16.2 Inputs .......................................................................................................................... 589
2.6.16.16.3 Outputs ....................................................................................................................... 591
2.6.16.17 MonSpmEnv() – MonitorSpectrumEnvelope() ................................................................. 593
2.6.16.17.1 General ....................................................................................................................... 593
2.6.16.17.2 Inputs .......................................................................................................................... 594
2.6.16.17.3 Outputs ....................................................................................................................... 597
2.6.16.17.4 Examples .................................................................................................................... 598
English
Release 2018-06 22 / 866
2.6.16.18 MonSpmEnv2() – MonitorSpectrumEnvelope2() ............................................................. 599

2.6.16.18.1 General ....................................................................................................................... 599
2.6.16.18.2 Inputs .......................................................................................................................... 600
2.6.16.18.3 Outputs ....................................................................................................................... 602
2.6.16.18.4 Examples .................................................................................................................... 605
2.6.16.19 SelRMS() – SelectiveRootMeanSquare() ........................................................................ 606
2.6.16.19.1 General ....................................................................................................................... 606
2.6.16.19.2 Inputs .......................................................................................................................... 606
2.6.16.19.3 Outputs ....................................................................................................................... 608
2.6.16.19.4 Examples .................................................................................................................... 608
2.6.16.20 SpmAdd() - SpectrumAddition() ....................................................................................... 609
2.6.16.20.1 General ....................................................................................................................... 609
2.6.16.20.2 Inputs .......................................................................................................................... 609
2.6.16.20.3 Outputs ....................................................................................................................... 611
2.6.16.20.4 Examples .................................................................................................................... 611
2.6.16.21 SpmMax() - SpectrumMaximum().................................................................................... 613
2.6.16.21.1 General ....................................................................................................................... 613
2.6.16.21.2 Inputs .......................................................................................................................... 613
2.6.16.21.3 Outputs ....................................................................................................................... 614
2.6.16.21.4 Examples .................................................................................................................... 615
2.6.16.22 SpmMul() - SpectrumMultiplication() ............................................................................... 616
2.6.16.22.1 General ....................................................................................................................... 616
2.6.16.22.2 Inputs .......................................................................................................................... 616
2.6.16.22.3 Outputs ....................................................................................................................... 617
2.6.16.22.4 Examples .................................................................................................................... 618
2.6.16.23 THD() – TotalHarmonicDistortion() .................................................................................. 619
2.6.16.23.1 General ....................................................................................................................... 619
2.6.16.23.2 Inputs .......................................................................................................................... 619
2.6.16.23.3 Outputs ....................................................................................................................... 620
2.6.16.23.4 Examples .................................................................................................................... 621
2.6.17 Statistic .................................................................................................................................. 622
2.6.17.1 Avg() - Average() ............................................................................................................. 622
2.6.17.1.1 General ....................................................................................................................... 622
2.6.17.1.2 Inputs .......................................................................................................................... 622
2.6.17.1.3 Outputs ....................................................................................................................... 623
2.6.17.1.4 Examples .................................................................................................................... 624
2.6.17.2 AvgBffr() - AverageBuffer() .............................................................................................. 625
2.6.17.2.1 General ....................................................................................................................... 625
2.6.17.2.2 Inputs .......................................................................................................................... 625
2.6.17.2.3 Outputs ....................................................................................................................... 626
2.6.17.2.4 Examples .................................................................................................................... 626
2.6.17.3 Crest() - Crest() ................................................................................................................ 627
English
Release 2018-06 23 / 866
2.6.17.3.1 General ....................................................................................................................... 627

2.6.17.3.2 Inputs .......................................................................................................................... 627
2.6.17.3.3 Outputs ....................................................................................................................... 628
2.6.17.3.4 Examples .................................................................................................................... 629
2.6.17.4 GetPrd() - GetPeriod() ..................................................................................................... 630
2.6.17.4.1 General ....................................................................................................................... 630
2.6.17.4.2 Inputs .......................................................................................................................... 630
2.6.17.4.3 Outputs ....................................................................................................................... 631
2.6.17.4.4 Examples .................................................................................................................... 632
2.6.17.5 H1D() - Histogram1D() ..................................................................................................... 633
2.6.17.5.1 General ....................................................................................................................... 633
2.6.17.5.2 Inputs .......................................................................................................................... 634
2.6.17.5.3 Outputs ....................................................................................................................... 636
2.6.17.5.4 Examples .................................................................................................................... 637
2.6.17.6 H2D() – Histogram2D() .................................................................................................... 638
2.6.17.6.1 General ....................................................................................................................... 638
2.6.17.6.2 Inputs .......................................................................................................................... 639
2.6.17.6.3 Outputs ....................................................................................................................... 643
2.6.17.6.4 Examples .................................................................................................................... 644
2.6.17.7 Kurtosis() - Kurtosis() ....................................................................................................... 645
2.6.17.7.1 General ....................................................................................................................... 645
2.6.17.7.2 Inputs .......................................................................................................................... 645
2.6.17.7.3 Outputs ....................................................................................................................... 646
2.6.17.7.4 Examples .................................................................................................................... 647
2.6.17.8 Max() - Maximum()........................................................................................................... 648
2.6.17.8.1 General ....................................................................................................................... 648
2.6.17.8.2 Inputs .......................................................................................................................... 648
2.6.17.8.3 Outputs ....................................................................................................................... 649
2.6.17.8.4 Examples .................................................................................................................... 650
2.6.17.9 MaxBffr() - MaximumBuffer() ........................................................................................... 651
2.6.17.9.1 General ....................................................................................................................... 651
2.6.17.9.2 Inputs .......................................................................................................................... 651
2.6.17.9.3 Outputs ....................................................................................................................... 652
2.6.17.9.4 Examples .................................................................................................................... 652
2.6.17.10 Min() - Minimum()............................................................................................................. 653
2.6.17.10.1 General ....................................................................................................................... 653
2.6.17.10.2 Inputs .......................................................................................................................... 653
2.6.17.10.3 Outputs ....................................................................................................................... 654
2.6.17.10.4 Examples .................................................................................................................... 655
2.6.17.11 MinBffr() - MinimumBuffer() ............................................................................................. 656
2.6.17.11.1 General ....................................................................................................................... 656
2.6.17.11.2 Inputs .......................................................................................................................... 656
English
Release 2018-06 24 / 866
2.6.17.11.3 Outputs ....................................................................................................................... 657

2.6.17.11.4 Examples .................................................................................................................... 657
2.6.17.12 Range() - Range() ............................................................................................................ 658
2.6.17.12.1 General ....................................................................................................................... 658
2.6.17.12.2 Inputs .......................................................................................................................... 658
2.6.17.12.3 Outputs ....................................................................................................................... 659
2.6.17.12.4 Examples .................................................................................................................... 660
2.6.17.13 RMS() - RootMeanSquare() ............................................................................................. 661
2.6.17.13.1 General ....................................................................................................................... 661
2.6.17.13.2 Inputs .......................................................................................................................... 661
2.6.17.13.3 Outputs ....................................................................................................................... 662
2.6.17.13.4 Examples .................................................................................................................... 663
2.6.17.14 Skewness() - Skewness() ................................................................................................ 664
2.6.17.14.1 General ....................................................................................................................... 664
2.6.17.14.2 Inputs .......................................................................................................................... 664
2.6.17.14.3 Outputs ....................................................................................................................... 665
2.6.17.14.4 Examples .................................................................................................................... 666
2.6.17.15 StdDev() – StandardDeviation() ....................................................................................... 667
2.6.17.15.1 General ....................................................................................................................... 667
2.6.17.15.2 Inputs .......................................................................................................................... 667
2.6.17.15.3 Outputs ....................................................................................................................... 668
2.6.17.15.4 Examples .................................................................................................................... 669
2.6.17.16 StdDevN() – StandardDeviationN() ................................................................................. 670
2.6.17.16.1 General ....................................................................................................................... 670
2.6.17.16.2 Inputs .......................................................................................................................... 670
2.6.17.16.3 Outputs ....................................................................................................................... 671
2.6.17.16.4 Examples .................................................................................................................... 672
2.6.17.17 Vrnc() – Variance()........................................................................................................... 673
2.6.17.17.1 General ....................................................................................................................... 673
2.6.17.17.2 Inputs .......................................................................................................................... 673
2.6.17.17.3 Outputs ....................................................................................................................... 674
2.6.17.17.4 Examples .................................................................................................................... 675
2.6.17.18 VrncN() – VarianceN() ..................................................................................................... 676
2.6.17.18.1 General ....................................................................................................................... 676
2.6.17.18.2 Inputs .......................................................................................................................... 676
2.6.17.18.3 Outputs ....................................................................................................................... 677
2.6.17.18.4 Examples .................................................................................................................... 678
2.6.18 String ..................................................................................................................................... 679
2.6.18.1 CatStr() - ConcatenateString() ......................................................................................... 679
2.6.18.1.1 General ....................................................................................................................... 679
2.6.18.1.2 Inputs .......................................................................................................................... 679
2.6.18.1.3 Outputs ....................................................................................................................... 680
English
Release 2018-06 25 / 866
2.6.18.1.4 Examples .................................................................................................................... 680

2.6.18.2 CpySubStr() - CopySubString() ....................................................................................... 681
2.6.18.2.1 General ....................................................................................................................... 681
2.6.18.2.2 Inputs .......................................................................................................................... 681
2.6.18.2.3 Outputs ....................................................................................................................... 683
2.6.18.2.4 Examples .................................................................................................................... 683
2.6.18.3 FndStr() - FindString() ...................................................................................................... 684
2.6.18.3.1 General ....................................................................................................................... 684
2.6.18.3.2 Inputs .......................................................................................................................... 684
2.6.18.3.3 Outputs ....................................................................................................................... 686
2.6.18.3.4 Examples .................................................................................................................... 686
2.6.18.4 FrmtStr() - FormatString() ................................................................................................ 687
2.6.18.4.1 General ....................................................................................................................... 687
2.6.18.4.2 Inputs .......................................................................................................................... 687
2.6.18.4.3 Outputs ....................................................................................................................... 688
2.6.18.4.4 Examples .................................................................................................................... 689
2.6.18.5 GetStrLen() - GetStringLength() ...................................................................................... 690
2.6.18.5.1 General ....................................................................................................................... 690
2.6.18.5.2 Inputs .......................................................................................................................... 690
2.6.18.5.3 Outputs ....................................................................................................................... 691
2.6.18.5.4 Examples .................................................................................................................... 691
2.6.19 System .................................................................................................................................. 692
2.6.19.1 ExprtData() - ExportData() ............................................................................................... 692
2.6.19.1.1 General ....................................................................................................................... 692
2.6.19.1.2 Inputs .......................................................................................................................... 692
2.6.19.1.3 Outputs ....................................................................................................................... 697
2.6.19.1.4 Examples .................................................................................................................... 697
2.6.19.2 GetCalcTm() - GetCalculationTime() ............................................................................... 698
2.6.19.2.1 General ....................................................................................................................... 698
2.6.19.2.2 Inputs .......................................................................................................................... 698
2.6.19.2.3 Outputs ....................................................................................................................... 699
2.6.19.2.4 Examples .................................................................................................................... 699
2.6.19.3 GetEvnt() - GetEvent() ..................................................................................................... 700
2.6.19.3.1 General ....................................................................................................................... 700
2.6.19.3.2 Inputs .......................................................................................................................... 700
2.6.19.3.3 Outputs ....................................................................................................................... 702
2.6.19.3.4 Examples .................................................................................................................... 702
2.6.19.4 GetEvntCd() - GetEventCode() ........................................................................................ 703
2.6.19.4.1 General ....................................................................................................................... 703
2.6.19.4.2 Inputs .......................................................................................................................... 703
2.6.19.4.3 Outputs ....................................................................................................................... 704
2.6.19.4.4 Examples .................................................................................................................... 705
English
Release 2018-06 26 / 866
2.6.19.5 GetHBT() - GetHeartBeatTime() ...................................................................................... 706

2.6.19.5.1 General ....................................................................................................................... 706
2.6.19.5.2 Inputs .......................................................................................................................... 706
2.6.19.5.3 Outputs ....................................................................................................................... 707
2.6.19.5.4 Examples .................................................................................................................... 708
2.6.19.6 GetHBTDlt() - GetHeartBeatTimeDelta() ......................................................................... 709
2.6.19.6.1 General ....................................................................................................................... 709
2.6.19.6.2 Inputs .......................................................................................................................... 709
2.6.19.6.3 Outputs ....................................................................................................................... 710
2.6.19.6.4 Examples .................................................................................................................... 711
2.6.19.7 GetLclDate() - GetLocalDate() ......................................................................................... 712
2.6.19.7.1 General ....................................................................................................................... 712
2.6.19.7.2 Inputs .......................................................................................................................... 712
2.6.19.7.3 Outputs ....................................................................................................................... 713
2.6.19.7.4 Examples .................................................................................................................... 715
2.6.19.8 GetLctnPath() - GetLocationPath() .................................................................................. 716
2.6.19.8.1 General ....................................................................................................................... 716
2.6.19.8.2 Inputs .......................................................................................................................... 716
2.6.19.8.3 Outputs ....................................................................................................................... 717
2.6.19.8.4 Examples .................................................................................................................... 717
2.6.19.9 GetLogStat() - GetSystemLogStatistics() ........................................................................ 718
2.6.19.9.1 General ....................................................................................................................... 718
2.6.19.9.2 Inputs .......................................................................................................................... 718
2.6.19.9.3 Outputs ....................................................................................................................... 719
2.6.19.9.4 Examples .................................................................................................................... 721
2.6.19.10 GetNoE() - GetNumberOfEvents()................................................................................... 722
2.6.19.10.1 General ....................................................................................................................... 722
2.6.19.10.2 Inputs .......................................................................................................................... 722
2.6.19.10.3 Outputs ....................................................................................................................... 723
2.6.19.10.4 Examples .................................................................................................................... 724
2.6.19.11 GetNoV() - GetNumberOfValues()................................................................................... 725
2.6.19.11.1 General ....................................................................................................................... 725
2.6.19.11.2 Inputs .......................................................................................................................... 725
2.6.19.11.3 Outputs ....................................................................................................................... 726
2.6.19.11.4 Examples .................................................................................................................... 726
2.6.19.12 GetSrvStts() - GetServerStatus() ..................................................................................... 727
2.6.19.12.1 General ....................................................................................................................... 727
2.6.19.12.2 Inputs .......................................................................................................................... 728
2.6.19.12.3 Outputs ....................................................................................................................... 728
2.6.19.12.4 Examples .................................................................................................................... 732
2.6.19.13 GetStpTm() - GetStopTime() ........................................................................................... 733
2.6.19.13.1 General ....................................................................................................................... 733
English
Release 2018-06 27 / 866
2.6.19.13.2 Inputs .......................................................................................................................... 733

2.6.19.13.3 Outputs ....................................................................................................................... 734
2.6.19.13.4 Examples .................................................................................................................... 734
2.6.19.14 GetStrtTm() - GetStartTime() ........................................................................................... 735
2.6.19.14.1 General ....................................................................................................................... 735
2.6.19.14.2 Inputs .......................................................................................................................... 735
2.6.19.14.3 Outputs ....................................................................................................................... 736
2.6.19.14.4 Examples .................................................................................................................... 736
2.6.19.15 GetSttsCd() - GetStatusCode() ........................................................................................ 737
2.6.19.15.1 General ....................................................................................................................... 737
2.6.19.15.2 Inputs .......................................................................................................................... 737
2.6.19.15.3 Outputs ....................................................................................................................... 738
2.6.19.15.4 Examples .................................................................................................................... 739
2.6.19.16 GetTime() - GetTime() ..................................................................................................... 740
2.6.19.16.1 General ....................................................................................................................... 740
2.6.19.16.2 Inputs .......................................................................................................................... 740
2.6.19.16.3 Outputs ....................................................................................................................... 741
2.6.19.16.4 Examples .................................................................................................................... 741
2.6.19.17 IsPrcsBsy() - IsProcessBusy() ......................................................................................... 742
2.6.19.17.1 General ....................................................................................................................... 742
2.6.19.17.2 Inputs .......................................................................................................................... 742
2.6.19.17.3 Outputs ....................................................................................................................... 743
2.6.19.17.4 Examples .................................................................................................................... 743
2.6.19.18 IsPrcsPrsnt() - IsProcessPresent() .................................................................................. 744
2.6.19.18.1 General ....................................................................................................................... 744
2.6.19.18.2 Inputs .......................................................................................................................... 744
2.6.19.18.3 Outputs ....................................................................................................................... 745
2.6.19.18.4 Examples .................................................................................................................... 745
2.6.19.19 LoadData() - LoadData() .................................................................................................. 746
2.6.19.19.1 General ....................................................................................................................... 746
2.6.19.19.2 Inputs .......................................................................................................................... 747
2.6.19.19.3 Outputs ....................................................................................................................... 753
2.6.19.19.4 Examples .................................................................................................................... 753
2.6.19.20 MonCF() - MonitorConfigurationFile() .............................................................................. 754
2.6.19.20.1 General ....................................................................................................................... 754
2.6.19.20.2 Inputs .......................................................................................................................... 754
2.6.19.20.3 Outputs ....................................................................................................................... 756
2.6.19.20.4 Examples .................................................................................................................... 756
2.6.19.21 MonDev() - MonitorDevice() ............................................................................................ 757
2.6.19.21.1 General ....................................................................................................................... 757
2.6.19.21.2 Inputs .......................................................................................................................... 757
2.6.19.21.3 Outputs ....................................................................................................................... 758
English
Release 2018-06 28 / 866
2.6.19.21.4 Examples .................................................................................................................... 759

2.6.19.22 MonDisk() - MonitorDisk() ................................................................................................ 760
2.6.19.22.1 General ....................................................................................................................... 760
2.6.19.22.2 Inputs .......................................................................................................................... 760
2.6.19.22.3 Outputs ....................................................................................................................... 762
2.6.19.22.4 Examples .................................................................................................................... 763
2.6.19.23 MonFrBlck() - MonitorFreeBlock() ................................................................................... 764
2.6.19.23.1 General ....................................................................................................................... 764
2.6.19.23.2 Inputs .......................................................................................................................... 765
2.6.19.23.3 Outputs ....................................................................................................................... 766
2.6.19.23.4 Examples .................................................................................................................... 768
2.6.19.24 MonIM() – MonitorInternalMemory() ................................................................................ 769
2.6.19.24.1 General ....................................................................................................................... 769
2.6.19.24.2 Inputs .......................................................................................................................... 769
2.6.19.24.3 Outputs ....................................................................................................................... 771
2.6.19.24.4 Examples .................................................................................................................... 772
2.6.19.25 MonLog() - MonitorSystemLog() ...................................................................................... 773
2.6.19.25.1 General ....................................................................................................................... 773
2.6.19.25.2 Inputs .......................................................................................................................... 773
2.6.19.25.3 Outputs ....................................................................................................................... 775
2.6.19.25.4 Examples .................................................................................................................... 776
2.6.19.26 MonPC() - MonitorPerformanceCounter() ....................................................................... 777
2.6.19.26.1 General ....................................................................................................................... 777
2.6.19.26.2 Inputs .......................................................................................................................... 777
2.6.19.26.3 Outputs ....................................................................................................................... 779
2.6.19.26.4 Examples .................................................................................................................... 780
2.6.19.27 MonPM() - MonitorProcessMemory() .............................................................................. 781
2.6.19.27.1 General ....................................................................................................................... 781
2.6.19.27.2 Inputs .......................................................................................................................... 781
2.6.19.27.3 Outputs ....................................................................................................................... 783
2.6.19.27.4 Examples .................................................................................................................... 785
2.6.19.28 MonPT() - MonitorProcessTimes() .................................................................................. 786
2.6.19.28.1 General ....................................................................................................................... 786
2.6.19.28.2 Inputs .......................................................................................................................... 787
2.6.19.28.3 Outputs ....................................................................................................................... 788
2.6.19.28.4 Examples .................................................................................................................... 790
2.6.19.29 MonSM() - MonitorSystemMemory() ............................................................................... 791
2.6.19.29.1 General ....................................................................................................................... 791
2.6.19.29.2 Inputs .......................................................................................................................... 792
2.6.19.29.3 Outputs ....................................................................................................................... 793
2.6.19.29.4 Examples .................................................................................................................... 795
2.6.19.30 MonST() - MonitorSystemTimes() ................................................................................... 796
English
Release 2018-06 29 / 866
2.6.19.30.1 General ....................................................................................................................... 796

2.6.19.30.2 Inputs .......................................................................................................................... 797
2.6.19.30.3 Outputs ....................................................................................................................... 798
2.6.19.30.4 Examples .................................................................................................................... 800
2.6.19.31 NTPOffset() - NTPOffset() ............................................................................................... 801
2.6.19.31.1 General ....................................................................................................................... 801
2.6.19.31.2 Inputs .......................................................................................................................... 801
2.6.19.31.3 Outputs ....................................................................................................................... 803
2.6.19.31.4 Examples .................................................................................................................... 804
2.6.19.32 RdStrFrmFl() - ReadStringFromFile() .............................................................................. 805
2.6.19.32.1 General ....................................................................................................................... 805
2.6.19.32.2 Inputs .......................................................................................................................... 805
2.6.19.32.3 Outputs ....................................................................................................................... 807
2.6.19.32.4 Examples .................................................................................................................... 807
2.6.19.33 RdVlFrmFl() - ReadValueFromFile()................................................................................ 808
2.6.19.33.1 General ....................................................................................................................... 808
2.6.19.33.2 Inputs .......................................................................................................................... 808
2.6.19.33.3 Outputs ....................................................................................................................... 810
2.6.19.33.4 Examples .................................................................................................................... 810
2.6.19.34 RemCnt() - RemanentCounter() ...................................................................................... 811
2.6.19.34.1 General ....................................................................................................................... 811
2.6.19.34.2 Inputs .......................................................................................................................... 811
2.6.19.34.3 Outputs ....................................................................................................................... 813
2.6.19.34.4 Examples .................................................................................................................... 814
2.6.19.35 RmvEvnts() - RemoveEvents() ........................................................................................ 815
2.6.19.35.1 General ....................................................................................................................... 815
2.6.19.35.2 Inputs .......................................................................................................................... 815
2.6.19.35.3 Outputs ....................................................................................................................... 816
2.6.19.35.4 Examples .................................................................................................................... 817
2.6.19.36 SetEvntCd() - SetEventCode() ........................................................................................ 818
2.6.19.36.1 General ....................................................................................................................... 818
2.6.19.36.2 Inputs .......................................................................................................................... 818
2.6.19.36.3 Outputs ....................................................................................................................... 820
2.6.19.36.4 Examples .................................................................................................................... 820
2.6.19.37 SetSttsCd() - SetStatusCode() ........................................................................................ 821
2.6.19.37.1 General ....................................................................................................................... 821
2.6.19.37.2 Inputs .......................................................................................................................... 821
2.6.19.37.3 Outputs ....................................................................................................................... 823
2.6.19.37.4 Examples .................................................................................................................... 823
2.6.19.38 ShllExe() - ShellExecute() ................................................................................................ 824
2.6.19.38.1 General ....................................................................................................................... 824
2.6.19.38.2 Inputs .......................................................................................................................... 824
English
Release 2018-06 30 / 866
2.6.19.38.3 Outputs ....................................................................................................................... 826

2.6.19.38.4 Examples .................................................................................................................... 827
2.6.19.39 ShowLocation() - ShowLctn() .......................................................................................... 828
2.6.19.39.1 General ....................................................................................................................... 828
2.6.19.39.2 Inputs .......................................................................................................................... 828
2.6.19.39.3 Outputs ....................................................................................................................... 829
2.6.19.39.4 Examples .................................................................................................................... 829
2.6.19.40 ShowPath() - ShowPath() ................................................................................................ 830
2.6.19.40.1 General ....................................................................................................................... 830
2.6.19.40.2 Inputs .......................................................................................................................... 830
2.6.19.40.3 Outputs ....................................................................................................................... 831
2.6.19.40.4 Examples .................................................................................................................... 831
2.6.19.41 Sleep() - Sleep()............................................................................................................... 832
2.6.19.41.1 General ....................................................................................................................... 832
2.6.19.41.2 Inputs .......................................................................................................................... 832
2.6.19.41.3 Outputs ....................................................................................................................... 833
2.6.19.41.4 Examples .................................................................................................................... 833
2.6.19.42 SndEmail() - SendEmail() ................................................................................................ 834
2.6.19.42.1 General ....................................................................................................................... 834
2.6.19.42.2 Inputs .......................................................................................................................... 835
2.6.19.42.3 Outputs ....................................................................................................................... 838
2.6.19.42.4 Examples .................................................................................................................... 839
2.6.19.43 TstEyFrmFl() - TestEntryFromFile()................................................................................. 840
2.6.19.43.1 General ....................................................................................................................... 840
2.6.19.43.2 Inputs .......................................................................................................................... 840
2.6.19.43.3 Outputs ....................................................................................................................... 842
2.6.19.43.4 Examples .................................................................................................................... 842
2.6.19.44 WrtStrToFl() - WriteStringToFile() .................................................................................... 843
2.6.19.44.1 General ....................................................................................................................... 843
2.6.19.44.2 Inputs .......................................................................................................................... 843
2.6.19.44.3 Outputs ....................................................................................................................... 845
2.6.19.44.4 Examples .................................................................................................................... 845
2.6.19.45 WrtVlToFl() - WriteValueToFile() ..................................................................................... 847
2.6.19.45.1 General ....................................................................................................................... 847
2.6.19.45.2 Inputs .......................................................................................................................... 847
2.6.19.45.3 Outputs ....................................................................................................................... 849
2.6.19.45.4 Examples .................................................................................................................... 849
2.6.20 Time ...................................................................................................................................... 851
2.6.20.1 Bffr() - Buffer() .................................................................................................................. 851
2.6.20.1.1 General ....................................................................................................................... 851
2.6.20.1.2 Inputs .......................................................................................................................... 851
2.6.20.1.3 Outputs ....................................................................................................................... 853
English
Release 2018-06 31 / 866
2.6.20.1.4 Examples .................................................................................................................... 854

2.6.20.2 Dly() - Delay()................................................................................................................... 855
2.6.20.2.1 General ....................................................................................................................... 855
2.6.20.2.2 Inputs .......................................................................................................................... 855
2.6.20.2.3 Outputs ....................................................................................................................... 856
2.6.20.2.4 Examples .................................................................................................................... 857
2.6.20.3 GetBffrM() - GetBufferMember() ...................................................................................... 858
2.6.20.3.1 General ....................................................................................................................... 858
2.6.20.3.2 Inputs .......................................................................................................................... 858
2.6.20.3.3 Outputs ....................................................................................................................... 859
2.6.20.3.4 Examples .................................................................................................................... 860
2.6.20.4 Rsmpl() - Resample()....................................................................................................... 861
2.6.20.4.1 General ....................................................................................................................... 861
2.6.20.4.2 Inputs .......................................................................................................................... 861
2.6.20.4.3 Outputs ....................................................................................................................... 863
2.6.20.4.4 Examples .................................................................................................................... 863
2.6.20.5 Stopper() - Stopper() ........................................................................................................ 864
2.6.20.5.1 General ....................................................................................................................... 864
2.6.20.5.2 Inputs .......................................................................................................................... 864
2.6.20.5.3 Outputs ....................................................................................................................... 865
2.6.20.5.4 Examples .................................................................................................................... 865
3 Contact Information ......................................................................................................................... 866
English
Release 2018-06 32 / 866
Table of Figures
Figure 1: Example of an Analyzing System ........................................................................................................ 36

Figure 2: Example of an ANS Explorer ............................................................................................................... 38
Figure 3: Example of a Find References Dialog ................................................................................................. 47
Figure 4: Example of an Analyzing Function Overview Dialog ......................................................................... 48
Figure 5: Example of a View active Parameters Dialog ..................................................................................... 50
Figure 6: Example of a Search Area within the ANS Explorer ............................................................................ 51
Figure 7: Example of an AME Standard T001 ..................................................................................................... 63
Figure 8: Example of an Analyzing Function ........................................................................................................ 65
Figure 9: Example of a User Function .................................................................................................................. 65
Figure 10: Example of an Analyzing Function with outdated Interface Information ............................................. 65
Figure 11: Example of Group Boxes within the AME Standard T001 .................................................................. 66
Figure 12: Example of an Analyzing Function Properties Dialog ..................................................................... 72
Figure 13: Example of an Edit Group Box Dialog ............................................................................................... 74
Figure 14: Example of an ASE Standard T001 ................................................................................................... 86
Figure 15: Example of a UFE Standard T001 ................................................................................................... 112
Figure 16: Example of an Analyzing Function .................................................................................................... 114
Figure 17: Example of a User Function .............................................................................................................. 114
Figure 18: Example of an Analyzing Function with outdated Interface Information ........................................... 114
Figure 19: Example of Group Boxes within the UFE Standard T001 ................................................................. 115
Figure 20: Example of an Analyzing Function Properties Dialog ................................................................... 120
Figure 21: Example of an Edit Group Box Dialog ............................................................................................. 122
Figure 22: Example for the Configuration of the Analyzing Function InTCP() ................................................... 417
Figure 23: Example for the Configuration of the Analyzing Function OutTCP() ................................................. 523
English
Release 2018-06 33 / 866
1 Preface
1.1 Purpose of this Document
This document provides detailed information about the functionalities and usage of the software
 CMS X-Tools
of the CMS product line.
In addition to the detailed information about each dialog and functionality of the Analyzing System which is
found within this document, also the following documentation is available:
 CMS X-Tools - User Manual - 01 - Introduction
o provides an introduction into the basic functionalities of CMS X-Tools
 CMS X-Tools - User Manual - 02 - X-Tools Client
o provides detailed information about the functionality which is provided by the X-Tools Client
 CMS X-Tools - User Manual - 03 - Main Management System
o provides detailed information about the functionality which is provided by the Main Management Sys-
tem
 CMS X-Tools - User Manual - 04 - Device Management System
o provides detailed information about the functionality which is provided by the Device Management
System
 CMS X-Tools - User Manual - 05 - Monitoring System
o provides detailed information about the functionality which is provided by the Monitoring System
 CMS X-Tools - User Manual - 07 - Storage System
o provides detailed information about the functionality which is provided by the Storage System
 CMS X-Tools - Release Notes
o provides additional information about the released version of CMS X-Tools
 CMS X-Tools - Change Log
o provides an overview about the changes which have been introduced with the current version of CMS
X-Tools
1.2 Validity of this Document
This document is valid for the following software:

 CMS X-Tools V 5.0
During the following pages, these software packages will be referred to by the term X-Tools. Not all editions of
X-Tools provide all functionality, thus it may be that some of the descriptions within the user manual do not
apply to all editions.
1.3 Audience
This document is intended for personnel involved in the commissioning and using of the software:
 X-Tools
English
Release 2018-06 34 / 866
1.4 Notations
The following notations are used within this document:

 bold, italic text is being used for the main executables of X-Tools
o examples: X-Tools Client, X-Tools Server
 bold text is being used for the software modules of X-Tools
o examples: Main Management System, Device Profile Editor, IPE Socket T001
 green text is being used for controls like tables and trees
o examples: Main Profile Settings table, Device Profile Data table
 orange text is being used for simple controls like a menu button, a single row/column/cell of a table or a
branch of a tree
o examples: Open… menu button, IP Address column, Target Device Name cell, Interfaces Branch
 dark yellow text is being used for the entries of menus and context menus
o examples: Advanced Append…, Edit
 Camel Notation is being used for major terms of X-Tools
o examples: Main Profile, Interface Profile, User Accounts File, Analyzing Function
 < and > brackets are being used for keyboard keys
o examples: <Ctrl>, <Alt>, <Shift>, <Del>
 [ and ] brackets are being used for mouse operations
o examples: [left mouse button down], [mouse move]
English
Release 2018-06 35 / 866
2 Analyzing System
2.1 Analyzing System
2.1.1 Overview
The Analyzing System is used in order to perform calculations with the currently available (online, offline
and/or scalar) data. It also can be used in order to create and to maintain powerful and automatically running
measurement tasks via sequence control Analyzing Scripts.
The following screenshot shows an example of an Analyzing System:
Figure 1: Example of an Analyzing System
English
Release 2018-06 36 / 866
2.1.2 Menu Bar
The Menu Bar provides direct access to the functionality of the Analyzing System.
The following functionality is available via the File menu:
Menu Item Description
Open Analyzing Model Editor > … opens a new Analyzing Model Editor
Open Analyzing Script Editor > … opens a new Analyzing Script Editor
Open User Function Editor > … opens a new User Function Editor
Close closes the Analyzing System
The following functionality is available via the View menu:

Title Bar toggles whether the Title Bar shall be shown or hidden
Menu Bar toggles whether the Menu Bar shall be shown or hidden
ANS Explorer toggles whether the ANS Explorer shall be shown or hidden
The following functionality is available via the Window menu:

Size > … changes the size of the Analyzing System
Mode > … changes the window mode of the Analyzing System
Arrange > … allows to arrange the child dialogs which are opened within the Analyzing System automatically
Background Grid > … changes the resolution of the background grid of the Analyzing System, which is used for the
moving of child dialogs in case the manual window mode is active
The following functionality is available via the Sub-Windows menu:

Title Bar > … allows to show/hide the Title Bar of all child dialogs of the Analyzing System
Menu Bar > … allows to show/hide the Menu Bar of all child dialogs of the Analyzing System
Configuration Area > … allows to show/hide the Configuration Area of all child dialogs of the Analyzing System
Arrange > … allows to arrange the child dialogs which are opened within the child dialogs of the Analyzing
System automatically
Background Grid > … changes the resolution of the background grid of all child dialogs of the Analyzing System, which
is used for the moving of their child dialogs in case the manual window mode is active
English
Release 2018-06 37 / 866
2.2 Analyzing System Explorer
2.2.1 Overview
The Analyzing System Explorer (in the following, the ANS Explorer) is used in order to visualize and maintain
all of the files and modules which are relevant for the Analyzing System. It is displayed as a tree which con-
tains all of the relevant and available Analyzing System items. Via Drag&Drop the user is able to move items
within the ANS Explorer and from the ANS Explorer to other dialogs of the Analyzing System. The following
lines provide a short overview about the information that is available from the ANS Explorer.
The following screenshot shows an example of an ANS Explorer:
Figure 2: Example of an ANS Explorer
English
Release 2018-06 38 / 866
2.2.2 Menu Bar
The Menu Bar provides direct access to the functionality of the ANS Explorer. It can be used instead of and/or
in addition to the context menus which are provided by the different branches of the ANS Explorer.
Edit opens the currently selected file(s) within their editor
View active Parameters… opens the View active Parameters dialog for the currently selected item
Add Location… opens the Add Location dialog and adds the new location afterwards
Edit Location… opens the Edit Location dialog
Delete Location from Disk removes the file location from X-Tools and deletes it from the disk
Remove Location from X-Tools removes the file location from X-Tools
New Analyzing Model > … opens a new Analyzing Model Editor and creates a new Analyzing Model
New Analyzing Script > … opens a new Analyzing Script Editor and creates a new Analyzing Script
New User Function > … opens a new User Function Editor and creates a new User Function
Refresh re-reads all information from the currently connected X-Tools Servers
Hide hides the ANS Explorer
The following functionality is available via the Edit menu:

Expand expands the currently selected item(s)
Expand all expands all present items
Collapse collapses the currently selected item(s)
Collapse all collapses all present items
Cut cuts the currently selected item(s)
Copy copies the currently selected item(s)
Paste pastes the currently cut/copied item(s)
Delete from Disk deletes the currently selected item(s) from the disk
Rename allows to rename the selected item directly within the ANS Explorer
New Directory… opens the Add Directory dialog and creates a new directory afterwards
Find References… opens the Find References dialog
The following functionality is available via the Run menu:

Start starts the currently selected item(s)
Restart restarts (= stops and starts) the currently selected item(s)
Pause pauses the currently selected item(s)
Continue continues the currently selected item(s)
Stop stops the currently selected item(s)
Stop Location stops all Configuration Files of all selected locations

Overview… opens the Analyzing Function Overview dialog or the User Function Overview dialog
English
Release 2018-06 39 / 866

Dock toggles whether ANS Explorer shall be docked to the left or not
Size > … changes the size of the ANS Explorer
2.2.3 ANS Explorer Tree
2.2.3.1 Overview
Each branch of the ANS Explorer has a defined task and provides certain functionalities. The following major
branches are provided by the ANS Explorer:
 Main Branch
 Editors Branch
 Analyzing Model Editors Branch
 Analyzing Model Editor Branch
 Analyzing Script Editors Branch
 Analyzing Script Editor Branch
 User Function Editors Branch
 User Function Editor Branch
 Servers Branch
 Server Branch
 Files Branch
 File Location Branch
 Analyzing Model Files Branch
 Analyzing Script Files Branch
 User Function Files Branch
 Libraries Branch
 Analyzing Functions Branch
 Analyzing Function Branch
 User Functions Branch
 User Function Branch
2.2.3.2 Main Branch
The one and only Main Branch provides all of the other items of the ANS Explorer. It can be expanded and
collapsed in order to show or hide its sub-items.
2.2.3.3 Editors Branch
The one and only Editors Branch provides all of the editors which are available within the Analyzing System.
2.2.3.4 Analyzing Model Editors Branch
The one and only Analyzing Model Editors Branch provides all of the Analyzing Model Editors which are
available within the Analyzing System. The tree of shown Analyzing Model Editors is updated automatically
whenever an editor file at the local disk is added/removed/modified.
English
Release 2018-06 40 / 866
2.2.3.5 Analyzing Model Editor Branch
Each Analyzing Model Editor Branch represents one available Analyzing Model Editor. Dragging of an Analyz-
ing Model Editor Branch into the Analyzing System workspace opens an empty editor of the dragged type.
After the editor has been opened, any of the present files of correct type can be dragged into it for visualization
and/or editing.
The following specific context menu items are provided:
Context Menu Item Description
New Analyzing Model > … opens an Analyzing Model Editor of the chosen type within the Analyzing System workspace,
creates a new Analyzing Model and initializes it with default values
<Ctrl> + <N> can be pressed in order to achieve the same effect
2.2.3.6 Analyzing Script Editors Branch
The one and only Analyzing Script Editors Branch provides all of the Analyzing Script Editors which are avail-
able within the Analyzing System. The tree of shown Analyzing Script Editors is updated automatically
whenever an editor file at the local disk is added/removed/modified.
2.2.3.7 Analyzing Script Editor Branch
Each Analyzing Script Editor Branch represents one available Analyzing Script Editor. Dragging of an Analyz-
ing Script Editor Branch into the Analyzing System workspace opens an empty editor of the dragged type.
After the editor has been opened, any of the present files of correct type can be dragged into it for visualization
and/or editing.
New Analyzing Script > … opens an Analyzing Script Editor of the chosen type within the Analyzing System workspace,
creates a new Analyzing Script and initializes it with default values
2.2.3.8 User Function Editors Branch
The one and only User Function Editors Branch provides all of the User Function Editors which are available
within the Analyzing System. The tree of shown User Function Editors is updated automatically whenever an
editor file at the local disk is added/removed/modified.
2.2.3.9 User Function Editor Branch
Each User Function Editor Branch represents one available User Function Editor. Dragging of a User Function
Editor Branch into the Analyzing System workspace opens an empty editor of the dragged type. After the edi-
tor has been opened, any of the present files of correct type can be dragged into it for visualization and/or edit-
ing.
New User Function > … opens a User Function Editor of the chosen type within the Analyzing System workspace, cre-
ates a new User Function and initializes it with default values
2.2.3.10 Servers Branch
The one and only Servers Branch provides all of the X-Tools Servers which are connected at the moment. The
tree of shown X-Tools Servers is updated automatically whenever an X-Tools Server is attached or detached.
English
Release 2018-06 41 / 866
2.2.3.11 Server Branch
Each Server Branch represents one of the currently connected X-Tools Servers.
The following specific context menu item is provided:
Find References… opens the Find References dialog for the chosen X-Tools Server
2.2.3.12 Files Branch
The Files Branch of each connected X-Tools Server provides all of the files which are available within the Ana-
lyzing System.
Add Location… opens the Add Location dialog and adds a new Configuration File location afterwards
2.2.3.13 File Location Branch
Each File Location Branch provides all of the Analyzing System specific files which are available from the di-
rectory to which the Configuration File location points.
Edit Location… opens the Edit Location dialog for the chosen file location
Delete Location from Disk removes the chosen file location from X-Tools and deletes it from the hard disk
Remove Location from X-Tools removes the chosen file location from X-Tools
Stop Location stops all Configuration Files of all selected locations
2.2.3.14 Analyzing Model Files Branch
Each Analyzing Model Files Branch provides all of the Analyzing Models which are available from the directory
to which its Configuration File location points. The tree of shown Analyzing Models is updated automatically
whenever an Analyzing Model at the disk is added/deleted/modified.
Drag&Drop can be used in order to copy/move Analyzing Model directories and Analyzing Model files. The de-
fault Drag&Drop operation within an X-Tools Server is “move”, but when the <Ctrl> key is pressed a “copy”
operation is performed. The default Drag&Drop operation from one X-Tools Server to another is “copy”, but
when the <Shift> key is pressed a “move” operation is performed.
Analyzing Model directories and Analyzing Model files can be copied/moved within Analyzing Model Files
Branches (either within one X-Tools Server or over different X-Tools Servers) but they can not be cop-
ied/moved to another files branch. As the unique name of each Analyzing Model also includes its storage direc-
tory, multiple Analyzing Models with matching file names can be stored in different Analyzing Model directories.
Dragging of an Analyzing Model into the Analyzing System workspace opens the Analyzing Model Editor for
the dragged Analyzing Model.
In case an Analyzing Model Directory Branch (or any of its sub-branches) contains a suspended Analyzing
Model, the icon of the Analyzing Model Directory Branch shows an according overlay. When there is no sus-
pended Analyzing Model but there is at least one started Analyzing Model, the icon of the Analyzing Model Di-
rectory Branch shows an according overlay also.
English
Release 2018-06 42 / 866

creates a new Analyzing Model and initializes it with default values
View active Parameters… opens the View active Parameters dialog for the Analyzing Model from which the context menu
has been called
this context menu is enabled only in case the Analyzing Model is not in status “stopped” at the
moment
Edit opens a new Analyzing Model Editor for the chosen file(s) within the Analyzing System work-
space
Paste pastes currently copied/cut item(s)
Delete from Disk deletes the selected item(s) from the disk
The following icons are provided and indicate the current status of each Analyzing Model:
Icon Description
(stopped) The Analyzing Model is stopped and does not perform any operations.
(started) The Analyzing Model is started and performs the configured calculations. The resulting data is put
into the ring buffers and can be accessed via the MDS Explorer.
(paused) When the Analyzing Model is paused it freezes the current contents of the ring buffers of its data
and it stops to perform its calculations. The data which is produced by the Analyzing Model is not
removed from the MDS Explorer and keeps available.
(suspended) The Analyzing Model is suspended because it has detected an error condition (e.g. because the
input data became unavailable or because it was unable to perform its calculations in time, …).
The Analyzing Model will resume after the error condition has been solved and all of the data
which is produced by the Analyzing Model is being removed from the MDS Explorer until the
Analyzing Model can resume.
In case the Analyzing Model is suspended and its according Analyzing Model File at the disk is
being updated, the updated Analyzing Model File is being loaded and the Analyzing Model uses
the updated configuration for its further processing.
Each Analyzing Model contains information about the input and output interfaces of all functions which it con-
tains. The input and output interfaces of functions can change (e.g. a new version of X-Tools could provide
additional input and/or output arguments for an Analyzing Function, and the input and output arguments of
User Functions can be changed through the user at any time) and after each such change the Analyzing Model
must update its internal information.
In case an Analyzing Model with outdated interface information is opened within the Analyzing Model Editor,
the editor asks whether it shall update all outdated interfaces automatically. When the update succeeds, the
current interface information is stored when the Analyzing Model is stored.
In case an Analyzing Model with outdated interface information is started, the Analyzing Engine attempts to
update its temporary copy of the Analyzing Model. When the update succeeds, an according warning log entry
is created and the Analyzing Model starts. The Analyzing Model File at the disk is not changed in this case
(thus, each start of the Analyzing Model causes the same warning log entry).
English
Release 2018-06 43 / 866
2.2.3.15 Analyzing Script Files Branch
Each Analyzing Script Files Branch provides all of the Analyzing Scripts which are available from the directory to
which its Configuration File location points. The tree of shown Analyzing Scripts is updated automatically when-
ever an Analyzing Script at the disk is added/deleted/modified.
Drag&Drop can be used in order to copy/move Analyzing Script directories and Analyzing Script files. The de-
fault Drag&Drop operation within an X-Tools Server is “move”, but when the <Ctrl> key is pressed a “copy”
operation is performed. The default Drag&Drop operation from one X-Tools Server to another is “copy”, but
when the <Shift> key is pressed a “move” operation is performed.
Analyzing Script directories and Analyzing Script files can be copied/moved within Analyzing Script Files
Branches (either within one X-Tools Server or over different X-Tools Servers) but they can not be cop-
ied/moved to another files branch. As the unique name of each Analyzing Script also includes its storage direc-
tory, multiple Analyzing Scripts with matching file names can be stored in different Analyzing Script directories.
Dragging of an Analyzing Script into the Analyzing System workspace opens the Analyzing Script Editor for
the dragged Analyzing Script.
In case an Analyzing Script Directory Branch (or any of its sub-branches) contains a suspended Analyzing
Script, the icon of the Analyzing Script Directory Branch shows an according overlay. When there is no sus-
pended Analyzing Script but there is at least one started Analyzing Script, the icon of the Analyzing Script Direc-
tory Branch shows an according overlay also.
creates a new Analyzing Script and initializes it with default values
View active Parameters… opens the View active Parameters dialog for the Analyzing Script from which the context menu
has been called
this context menu is enabled only in case the Analyzing Script is not in status “stopped” at the
moment
Edit opens a new Analyzing Script Editor for the chosen file(s) within the Analyzing System work-
space
English
Release 2018-06 44 / 866
The following icons are provided and indicate the current status of each Analyzing Script:
Icon Description
(stopped) The Analyzing Script is stopped and does not perform any operations.
(started) The Analyzing Script is started and performs the configured calculations. The resulting data is put
into the ring buffers and can be accessed via the MDS Explorer.
(paused) When the Analyzing Script is paused it freezes the current contents of the ring buffers of its data
and it stops to perform its calculations. The data which is produced by the Analyzing Script is not
removed from the MDS Explorer and keeps available.
(suspended) The Analyzing Script is suspended because it has detected an error condition (e.g. because the
input data became unavailable or because it was unable to perform its calculations in time, …).
The Analyzing Script will resume after the error condition has been solved and all of the data
which is produced by the Analyzing Script is being removed from the MDS Explorer until the Ana-
lyzing Script can resume.
In case the Analyzing Script is suspended and its according Analyzing Script File at the disk is
being updated, the updated Analyzing Script File is being loaded and the Analyzing Script uses
the updated configuration for its further processing.
2.2.3.16 User Function Files Branch
Each User Function Files Branch provides all of the User Functions which are available from the directory to
which its Configuration File location points. The tree of shown User Functions is updated automatically whenev-
er a User Function at the disk is added/deleted/modified.
Drag&Drop can be used in order to copy/move User Function directories and User Function files. The default
Drag&Drop operation within an X-Tools Server is “move”, but when the <Ctrl> key is pressed a “copy” opera-
tion is performed. The default Drag&Drop operation from one X-Tools Server to another is “copy”, but when the
<Shift> key is pressed a “move” operation is performed.
User Function directories and User Function files can be copied/moved within User Function Files Branches
(either within one X-Tools Server or over different X-Tools Servers) but they can not be copied/moved to an-
other files branch. As the unique name of each User Function also includes its storage directory, multiple User
Functions with matching file names can be stored in different User Function directories.
Note
After copying of a User Function within one X-Tools Server, there will be two User Function Files with identical
information inside. As the short name and the full name of each User Function must be unique, a conflict will be
detected after the copy and both User Functions won’t be usable by Analyzing Models and Analyzing Scripts.
In order to resolve the conflict, open one of the User Functions within a User Function Editor and change its
full name and short name there.
Dragging of a User Function into the Analyzing System workspace opens the User Function Editor for the
dragged User Function.
ates a new User Function and initializes it with default values
Edit opens a new User Function Editor for the chosen file(s) within the Analyzing System work-
space
English
Release 2018-06 45 / 866
2.2.3.17 Libraries Branch
The Libraries Branch of each connected X-Tools Server provides all of the libraries which are available for the
Analyzing System.
2.2.3.18 Analyzing Functions Branch
The Analyzing Functions Branch of each connected X-Tools Server provides all of the Analyzing Functions
which are available for the Analyzing System. The tree of shown Analyzing Functions is updated automatically
whenever an Analyzing Function at the disk is added/removed/modified.
The categories below the Analyzing Functions Branch are determined automatically according to the categories
which are reported by the present Analyzing Functions and each present Analyzing Function is listed below its
reported category.
2.2.3.19 Analyzing Function Branch
Each Analyzing Function Branch represents one available Analyzing Function.

Dragging of an Analyzing Function Branch into the empty Analyzing System opens the default editor for the
dragged Analyzing Function as it is being specified via the Global Options.
Dragging of an Analyzing Function Branch into an AME Standard T001 or UFE Standard T001 adds the
dragged Analyzing Function to the already present Analyzing Model/User Function.
Dragging of an Analyzing Function Branch into an ASE Standard T001 adds the dragged Analyzing Function to
the already present Analyzing Script. <Alt> can be pressed at the moment of the drop in order to insert the
dragged Analyzing Function together with its default values and descriptive comments.
creates a new Analyzing Model, inserts the Analyzing Function from which the context menu has
been called and initializes it with default values
creates a new Analyzing Script, inserts the Analyzing Function from which the context menu has
been called and initializes it with default values
ates a new User Function, inserts the Analyzing Function from which the context menu has been
called and initializes it with default values
Overview… opens the Analyzing Function Overview dialog for the Analyzing Function from which the con-
text menu has been called
2.2.3.20 User Functions Branch
The User Functions Branch of each connected X-Tools Server provides all of the User Functions which are
available for the Analyzing System. The tree of shown User Functions is updated automatically whenever a
User Function at the disk is added/removed/modified.
The categories below the User Functions Branch are determined automatically according to the categories
which are reported by the present User Functions and each present User Function is listed below its reported
category.
2.2.3.21 User Function Branch
Each User Function Branch represents one available User Function.

Dragging of a User Function Branch into the empty Analyzing System opens the default editor for the dragged
User Function as it is being specified via the Global Options.
Dragging of a User Function Branch into an AME Standard T001 or UFE Standard T001 adds the dragged
User Function to the already present Analyzing Model/User Function.
Dragging of a User Function Branch into an ASE Standard T001 adds the dragged User Function to the al-
ready present Analyzing Script. <Alt> can be pressed at the moment of the drop in order to insert the dragged
User Function together with its default values and descriptive comments.
English
Release 2018-06 46 / 866

Edit
creates a new Analyzing Model, inserts the User Function from which the context menu has been
creates a new Analyzing Script, inserts the User Function from which the context menu has been
ates a new User Function, inserts the User Function from which the context menu has been called
and initializes it with default values
Overview… opens the User Function Overview dialog for the User Function from which the context menu
has been called
2.2.4 Find References Dialog
2.2.4.1 Overview
The following screenshot shows an example of a Find References dialog:
Figure 3: Example of a Find References Dialog
2.2.4.2 Find Settings Table
The Find Settings table contains the parameters which shall be used during the search of the references:
Parameter Description
Target Name Contains the name of the X-Tools Server for which the dialog has been called.
Find what Allows to enter the string which shall be found.
Scope Allows to choose where the search operation shall take place.
Find what
The search operation is not case sensitive and can be used in order to find data names within any of the Con-
figuration Files of X-Tools (Device Profiles, Monitoring Views, Analyzing Models, Analyzing Scripts, User Func-
tions, Storage Profiles and Loading Profiles).
It is not possible to find items or values which are not data names.
English
Release 2018-06 47 / 866
Scope
Scope Description
Search everywhere searches for the specified find string within all Configuration Files
Search only the DMS searches for the specified find string only within the Configuration Files of the
(Device Profiles) Device Management System
Search only the MTS searches for the specified find string only within the Configuration Files of the
(Monitoring Views) Monitoring System
Search only the ANS searches for the specified find string only within the Configuration Files of the
(Analyzing Models, Analyzing Scripts and User Functions) Analyzing System
Search only the STS searches for the specified find string only within the Configuration Files of the
(Loading Profiles and Storage Profiles) Storage System
2.2.4.3 Find Results Table
The Find Results table receives the the results of the search:
File Name receives the name of the Configuration File which contains the find string
File Type receives the type of the Configuration File which contains the find string
Modification Date receives the last modification date of the Configuration File which contains the find string
A double-click onto any row of the Find Results table opens the displayed Configuration File within its according
editor.
2.2.5 Analyzing Function Overview Dialog
2.2.5.1 Overview
The Analyzing Function Overview dialog is read-only and can be used in order to display an overview of the
chosen Analyzing Function. The following screenshot shows an example of an Analyzing Function Overview
dialog:
Figure 4: Example of an Analyzing Function Overview Dialog
English
Release 2018-06 48 / 866
2.2.5.2 Analyzing Function Properties Table
The Analyzing Function Properties table contains an overview about the properties of the Analyzing Function:
Full Name contains the full name of the Analyzing Function
Short Name contains the short name of the Analyzing Function
Description contains the description of the Analyzing Function
Parent Library contains the parent library of the Analyzing Function
Parent Category contains the parent category of the Analyzing Function
Equidistant Inputs indicates whether the Analyzing Function requires equidistant inputs
Supported Operating Modes contains the supported operating modes of the Analyzing Function
2.2.5.2.1 Analyzing Function Arguments Table
The Analyzing Function Arguments table contains an overview about the arguments of the Analyzing Function:
No. contains the row number
Full Name contains the full name of the argument
Short Name contains the short name of the argument
Dimension contains “1” when the argument is not configurable or the available number of sub-arguments in
case of configurable arguments
Value contains the value of the argument
Unit contains the unit of the argument
Description contains the description of the argument
Class contains the class of the argument
Direction contains the direction of the argument
Supported Data Types contains the supported data types of the argument
Default Value contains the default value of the argument
2.2.6 User Function Overview Dialog
The appearing and functionality of the User Function Overview dialog is identical to the appearing and func-
tionality of the Analyzing Function Overview dialog (see point 2.2.4).
English
Release 2018-06 49 / 866
2.2.7 View active Parameters Dialog
2.2.7.1 Overview
The following screenshot shows an example of a View active Parameters dialog:
Figure 5: Example of a View active Parameters Dialog
2.2.7.2 Properties Table
The Properties table contains an overview about the properties of the Analyzing Model/Analyzing Script:
Target Name contains the name of the X-Tools Server which provides the Analyzing Model/Analyzing Script
Analyzing Model or Analyzing Script contains the full symbolic path to the Analyzing Model/Analyzing Script
Creation Date contains the creation date of the Analyzing Model/Analyzing Script
Modification Date contains the modification date of the Analyzing Model/Analyzing Script
Model Description or Script Descrip- contains the description of the Analyzing Model/Analyzing Script
tion
Company Name contains the company name of the Analyzing Model/Analyzing Script
Author Name contains the author name of the Analyzing Model/Analyzing Script
2.2.7.3 Parameters Table
The Parameters table contains the currently used values of all parameters of the Analyzing Model/Analyzing
Script:
Full Name contains the full name of the parameter
Short Name contains the short name of the parameter
Unit contains the unit of the parameter
Description contains the description of the parameter
Active Value contains the value of the parameter which is used by the currently running Analyzing Mod-
el/Analyzing Script
English
Release 2018-06 50 / 866
2.2.8 Search Area
2.2.8.1 Overview
The following screenshot shows an example of the Search Area:
Figure 6: Example of a Search Area within the ANS Explorer
2.2.8.2 Searchable Items
The entered search string can be used in order to find items of the following types:
 Analyzing Function Category Branches
 Analyzing Function Branches (including their sub-items like “Vendor Name”, “Full Name”, …)
 User Function Category Branches
 User Function Branches (including their sub-items like “Vendor Name”, “Full Name”, …)
The search is case-insensitive and does not search for whole words (thus, also a search string like “arc” can be
entered in order to find something like “ArcCos”).
2.2.8.3 Keyboard Operations
The following operations can be performed via the keyboard:

Keyboard Operation Description
<Ctrl> + <F> puts the search string editing box into editing mode
<Enter> in case the search string edit box is in editing mode and <Enter> is pressed, the ANS Explorer
searches for the entered search string from the current selection within the ANS Explorer down-
wards
<F3> searches for the current search string from the current selection within the ANS Explorer down-
wards (this behavior is the same as if the Next button would be pressed)
<Shift> + <F3> searches for the current search string from the current selection within the ANS Explorer upwards
(this behavior is the same as if the Previous button would be pressed)
English
Release 2018-06 51 / 866
2.2.8.3.1 Buttons
The following operations can be performed via the displayed buttons:

Button Description
Previous searches for the current search string from the current selection within the ANS Explorer upwards
Next searches for the current search string from the current selection within the ANS Explorer down-
wards
2.3 Analyzing Model Editors
2.3.1 Overview
Analyzing Model Editors are used in order to edit Analyzing Models. An Analyzing Model contains all of the
information which is needed in order to start a model-based (online or offline) data calculation. Multiple Analyz-
ing Models can be maintained and/or executed at each X-Tools Server simultaneously.
Analyzing Model Editors are known and accessed exclusively by the X-Tools Client, the X-Tools Server has
no knowledge about Analyzing Model Editors at all. However, the X-Tools Server is responsible to maintain
Analyzing Model Files and therefore all Analyzing Model reading and writing operations are performed via the X-
Tools Server.
2.3.2 Common Controls
2.3.2.1 Overview
As all Analyzing Model Editors are built up in a similar way, they share some common controls (e.g. tables
and the menu bar) which are the same in all Analyzing Model Editors.
Each control of an Analyzing Model Editor has a defined task and provides certain functionalities. The follow-
ing major controls are provided by the Analyzing Model Editors. Depending to the Analyzing Model Editor,
one or more parts may not be supported (because they are not needed) and one or more parts may be present
in addition to the following ones (because they are necessary):
 Menu Bar
 Analyzing Model Settings Table
 Provided Parameters Table
 Analyzing Model Parameters Table
 Offline Time Configuration Table
 Treatment of Status Codes Table
 Log Entries Table
English
Release 2018-06 52 / 866
2.3.2.2 Menu Bar
The Menu Bar provides direct access to the functionality of each Analyzing Model Editor.
New creates a new, empty Analyzing Model and initializes the Analyzing Model Settings table with the
default values for new Analyzing Models
Open… opens the Open dialog where the to-be-opened file can be selected
<Ctrl> + <O> can be pressed in order to achieve the same effect
Save saves the currently opened Analyzing Model to the currently known storage location
<Ctrl> + <S> can be pressed in order to achieve the same effect
Save As… opens the Save As dialog where the desired storage location can be selected
Add Parameter adds the currently selected item as parameter of the Analyzing Model
Go to Parameter highlights the row within the Provided Parameters table which belongs to the currently selected
item
Remove Parameter removes the currently selected item as parameter of the Analyzing Model
Go to Definition highlights the item which belongs to the currently selected row from the Provided Parameters
table
Convert to User Function converts the currently opened Analyzing Model into a User Function and initializes it with the de-
fault values within a new User Function Editor
Print Report prints a report about the currently opened Analyzing Model
Save Report saves a report about the currently opened Analyzing Model to the file system
the storage location of the saved report is written to the system log of the X-Tools Client
Close closes the editor
<Ctrl> + <F4> can be pressed in order to achieve the same effect

Undo undoes one operation
Redo redoes one operation
Move up moves the currently selected row(s) of the Provided Parameters table up
Move down moves the currently selected row(s) of the Provided Parameters table down
Remove removes the currently selected row(s) of the Provided Parameters table
The following functionality is available via the Model menu:

Select all selects all items
Remove removes the currently selected item(s)
Remove all removes all items
Reassign Sequence IDs manually starts the manual assignment of sequence IDs
Reassign Sequence IDs automatically reassigns the sequence IDs of all present functions automatically so that the sequence IDs are
rising from the input Analyzing Functions to the output Analyzing Functions
Reroute Links automatically reroutes the currently selected link(s) or all of the currently present links
Zoom Factor > … sets the zoom factor
English
Release 2018-06 53 / 866

Start starts the Analyzing Model
Restart restarts (= stops and starts) the Analyzing Model
Pause pauses the Analyzing Model
Continue continues the Analyzing Model
Stop stops the Analyzing Model
The following functionality is available via the Log Entries menu:

Copy copies the currently selected log entries from the Log Entries table to the clipboard of Windows
Select all selects all of the currently present log entries from the Log Entries table
Clear all removes all entries from the Log Entries table
The following functionality is available via the Table menu:

Autofit to Contents automatically fits the width of all shown columns so that all contained texts are visible
Autofit to Width automatically fits the width of all shown columns so that all shown columns are visible
Restore Defaults restores the default configuration of all columns as it is after the installation of X-Tools
Show/Hide > … allows to show or hide the columns of the table
Minimize minimizes the table
Maximize maximizes the table

Configuration Area toggles whether the Configuration Area shall be shown or hidden

Size > … changes the size of the Analyzing Model Editor
2.3.2.3 Analyzing Model Settings Table
The Analyzing Model Settings table contains all of the model-dependent settings which can be configured within
an Analyzing Model:
Target Name contains the name of the target to which the Analyzing Model is stored
Storage Path contains the path to which the Analyzing Model is stored (absolute or symbolic path)
Creation Date contains the creation date of the Analyzing Model
Modification Date contains the last modification date of the Analyzing Model
Model Description contains the description of the Analyzing Model
Company Name contains the company name
Author Name contains the author name
Data Name Prefix for Input Data contains the data name prefix for the input data
Data Name Prefix for Output Data contains the data name prefix for the output data
English
Release 2018-06 54 / 866
Target Name
All of the information about the Target Name and Storage Path is set up within the Save As dialog.
Data Name Prefix for Input Data
The Data Name Prefix for Input Data is part of the final data name of all online and offline input data which is
being used by the Analyzing Model, but it is not applied to scalar input data. It is being inserted at the beginning
of the name of each online and each offline input data before the execution of the Analyzing Model.
The Data Name Prefix for Input Data can be used as parameter of the Analyzing Model. Therefore, the following
context menu items are provided:
Add Parameter adds the Data Name Prefix for Input Data as parameter of the Analyzing Model
Go to Parameter highlights the parameter which represents the Data Name Prefix for Input Data within the Provided
Parameters table
Remove Parameter removes the Data Name Prefix for Input Data as parameter of the Analyzing Model
Data Name Prefix for Output Data

The Data Name Prefix for Output Data is part of the final data name of all online and offline output data which is
being used by the Analyzing Model, but it is not applied to scalar output data. It is being inserted at the begin-
ning of the name of each online and each offline output data before the execution of the Analyzing Model.
The Data Name Prefix for Output Data can be used as parameter of the Analyzing Model. Therefore, the follow-
ing context menu items are provided:
Add Parameter adds the Data Name Prefix for Output Data as parameter of the Analyzing Model
Go to Parameter highlights the parameter which represents the Data Name Prefix for Output Data within the Pro-
vided Parameters table
Remove Parameter removes the Data Name Prefix for Output Data as parameter of the Analyzing Model
2.3.2.4 Provided Parameters Table
The Provided Parameters table contains all of the parameters which have been configured within an Analyzing
Model:
Full Name allows to enter the full name of the parameter
Short Name allows to enter the short name of the parameter
Unit allows to enter the unit of the parameter
Description allows to enter the description of the parameter
Default Value allows to enter the default value of the parameter
Parent Function contains the parent Function of the parameter
Parent Argument contains the parent argument of the parameter
Sequence ID contains the sequence ID of the parent function
Full Name
The Full Name of each parameter must be unique among the parameters of the Analyzing Model.
Short Name
The Short Name of each parameter must be unique among the parameters of the Analyzing Model.
English
Release 2018-06 55 / 866
Context Menu
The following context menu items are provided by the Provided Parameters table:
Move up moves the selected parameter(s) one row up
Move down moves the selected parameter(s) one row down
Go to Definition in case the parameter belongs to a (Analyzing or User) Function, this operation centers the Func-
tion for which the parameter from which the context menu has been called is assigned and high-
lights the argument which belongs to the parameter
in case the parameter belongs to a setting from a table, the parent table of the according setting is
expanded and the setting is highlighted
Remove removes the currently selected parameter(s)
2.3.2.5 Analyzing Model Parameters Table
The Analyzing Model Parameters table contains all of the model-dependent parameters which can be config-
ured within an Analyzing Model:
Operating Mode allows to switch between the available operating modes
Calculation Mode allows to switch between the available calculation modes
Action Mode allows to switch between the available action modes
Cycle Time/Rate contains the cycle time/rate of the Analyzing Model
Input Data Class allows to switch between the available input data classes
Output Data Class allows to switch between the available output data classes
Output Time Domain allows to switch between the available time domains
Output Time Base allows to switch between the available time bases
Default Input Data Interpolation Mode allows to switch between the available interpolation modes
Default Output Data Precision allows to switch between the available precisions
Default Output Data Record Mode allows to switch between the available record modes
Default Output Data Record Parame- allows to enter the record parameters
ters
Operating Mode
Operating Mode Description
Time Slice based In case of time-slice based operating modes, the complete Analyzing Model is being executed
time slice after time slice:
 at each time slice, all (Analyzing and User) functions within the Analyzing Model are being
called one after the other an in the order which is specified via their sequence ID
○ each function performs exactly one calculation out of the exactly one value which is
provided at each of its input arguments
○ each function outputs exactly one value to each of its output arguments
 the time of the current time slice is being called the “heart beat time”
○ the heart beat time is totally independent to the system time, it can be an absolute or
relative time and it can point to the past, to the present or to the future
○ the heart beat time is being determined according to the parameters of the Analyzing
Model
 advanced functions may have to collect the values of multiple cycles (e.g. the FFT Analyz-
ing Function, …) and perform their actual calculation when they have collected all needed
values
English
Release 2018-06 56 / 866
Calculation Mode
Calculation Mode Description
Equidistant In this calculation mode, the specified calculation instructions are being executed exactly each
defined time interval and with the interval which is specified via the cycle time/rate parameter.
Action based and cyclic In this calculation mode, the specified calculation instructions are being executed exactly each
defined time interval and with the interval which is specified via the cycle time/rate parameter. In
opposite to the calculation mode “Equidistant”, the execution of calculations is not done in case
the specified action (see Action Mode) did not take place within the last calculation interval. The
calculations are done again as soon as the specified action is detected again.
As the calculation is not necessarily performed equidistantly, calculations which require equidis-
tance (e.g. “FFT”, …) may produce warnings in combination with this calculation mode and may
not be able to perform their calculations.
Action based and once In this calculation mode, the specified calculation instructions are being executed exactly at the
times where the specified action (see Action Mode) takes place.
Compared to the “Action based and cyclic” calculation mode, this calculation mode does not cre-
ate an equidistant output data even in case the specified action is detected constantly. Instead,
the resulting output data contains exactly one calculation for each time at which the specified
action has been detected and therefore it can handle also high speed input data when it is being
received irregularly.
Action Mode
Action Mode Description
Run one Calculation when at least In this action mode, the specified calculation instructions are being executed whenever at least
one Input provides a new Value one of the inputs provides a new value.
This action mode can be used especially for applications where the input data is collected irregu-
larly (e.g. because a kind of data reduction is applied to the input data or because the source
provides data irregularly by design, …) and the amount of calculated data shall be optimized (be-
cause a calculation is performed only in case when there are new values available from at least
one of the inputs). For cases where the input data is received irregularly and with high speed, this
action mode allows much higher calculation intervals than the calculation mode “Equidistant”.
Run one Calculation when all Inputs In this action mode, the specified calculation instructions are being executed whenever all of the
provide a new Value inputs provide a new value.
cause a calculation is performed only in case when there are new values available from all of the
inputs). For cases where the input data is received irregularly and with high speed, this action
mode allows much higher calculation intervals than the calculation mode “Equidistant”.
Cycle Time/Rate
The specified Cycle Time/Rate is being used for the determination of the successive heart beat times of the to-
be executed calculations.
The Cycle Time/Rate can be used as parameter of the Analyzing Model. Therefore, the following context menu
items are provided:
Add Parameter adds the Cycle Time/Rate as parameter of the Analyzing Model
Go to Parameter highlights the parameter which represents the Cycle Time/Rate within the Provided Parameters
table
Remove Parameter removes the Cycle Time/Rate as parameter of the Analyzing Model
English
Release 2018-06 57 / 866
Input Data Class

Each data is uniquely identified via its data name and its data class (which can be online or offline). In order to
be able to determine whether the current Analyzing Model shall input online or offline data, the input data class
can be specified and the Analyzing Model operates on base of the specified data class (thus, all input data is
taken from the data pool which matches the specified input data class).
Input Data Class Description
Automatic When the input data class is set to “Automatic”, the Analyzing Model can input online data and
offline data. In this case, all input data of unspecified class is taken from the data pool which
matches the specified output data class.
Online Data When the input data class is set to “Online Data”, the Analyzing Model can input only online data
and scalar data.
Offline Data When the input data class is set to “Offline Data”, the Analyzing Model can input only offline data
and scalar data.
The input data class has been introduced with V 04.04 SP1 of X-Tools. In case an Analyzing Script from an
older version of X-Tools is opened or started, the input data class is set to “Automatic”.
Output Data Class
be able to determine whether the current Analyzing Model shall produce online or offline data, the output data
class can be specified. In case the input data class is “Automatic”, all input data of unspecified class is taken
from the data pool which matches the specified output data class.
Output Data Class Description
Online Data An executed Analyzing Model produces online data in case its “Output Data Class” parameter is
set to “Online Data”. This statement is true even in case one, multiple or all of the input data is
offline data.
Possible cases are:
 an Analyzing Model which bases only on online input data
○ all input Analyzing Functions use directly the time stamps from the (ring) buffers of
their data for the determination of the values and time stamps which shall be used
○ the input data class can be “Automatic” or “Online Data”
 an Analyzing Model which bases only on offline input data
○ when an input Analyzing Function detects that it shall read data of an offline data alt-
hough the parent Analyzing Model is configured for online output data, it determines
the offset in between the start time of the parent Analyzing Model and the first available
time stamp of its offline data
■ at each following call of the input Analyzing Function, it reads out the value of the
offline data shifted by the determined time offset
■ as the time offset is calculated for each offline data and by each input Analyzing
Function independently, offline data from different periods of time are shifted to
the heart beat time of the online data calculation automatically
■ in case of action-based calculation modes, all input Analyzing Functions which
base on offline data return exactly the start time of the parent Analyzing Model as
first possible heart beat time
○ in case of action-based calculation modes, the input Analyzing Functions can provide
the heart beat times because they apply the calculated time offset to their offline input
data in order to find out about the according online data time
○ when the end of the offline data has been reached, the input Analyzing Function
starts to read the offline data from its beginning again
○ the input data class can be “Automatic” or “Offline Data”
 an Analyzing Model which bases on online and offline input data
○ for input Analyzing Functions it is not known whether other input Analyzing Func-
tions within the same Analyzing Model base on online or on offline data, thus they be-
have like described above
○ the input data class must be “Automatic”
English
Release 2018-06 58 / 866

Offline Data An executed Analyzing Model produces offline data in case its “Output Data Class” parameter is
set to “Offline Data”. This statement is true even in case one, multiple or all of the input data is
online data. Produced offline data is returned to the system when the stop condition is reached.
Possible cases are:
 an Analyzing Model which bases only on offline data
○ all input Analyzing Functions use directly the time stamps from the buffers of their da-
ta for the determination of the values and time stamps which shall be used
 an Analyzing Model which bases only on online data
○ when an input Analyzing Function detects that it shall read data of an online data alt-
hough the parent Analyzing Model is configured for offline output data, it determines
the offset in between the start time (in system time) of the parent Analyzing Model and
the configured minimum time
online data shifted by the determined time offset
base on online data return exactly the start time of the parent Analyzing Model as
the heart beat times because they apply the calculated time offset to their online input
data in order to find out about the according offline data time
 an Analyzing Model which is based on online and offline data
tions within the same Analyzing Model base on online or on offline data, thus they be-
Output Time Domain

The output time domain specifies whether the timestamps of the created data have to be interpreted as absolute
time in ns since 1970-01-01 00:00:00.000.000.000 (GMT) or as relative time in ns (since 0).
Output Time Domain Description
Absolute Times An executed Analyzing Model produces absolute time stamps in case its “Output Time Domain”
parameter is set to “Absolute Times”. This statement is true even in case one, multiple or all of the
input data is of relative time.
Possible cases are:
 an Analyzing Model which bases on data with absolute time stamps
 an Analyzing Model which bases on data with relative time stamps
○ the relative time of all input data which is of relative time is converted to absolute time
by the input Analyzing Functions
■ the time offset is calculated for each data which is of relative time and by each in-
put Analyzing Function independently, so relative data from different periods of
time are shifted to the absolute heart beat time of the Analyzing Model
 an Analyzing Model which bases on data with relative and absolute time stamps
○ for input Analyzing Functions it is not known whether other input Analyzing Functions
within the same Analyzing Model base on absolute or relative time stamps, thus they
behave like described above
English
Release 2018-06 59 / 866

Relative Times An executed Analyzing Model produces relative time stamps in case its “Output Time Domain”
parameter is set to “Relative Times”. This statement is true even in case one, multiple or all of the
input data is of absolute time.
Possible cases are:
 an Analyzing Model which bases on data with relative time stamps
 an Analyzing Model which bases on data with absolute time stamps
○ the absolute time of all input data which is of absolute time is converted to relative time
■ the time offset is calculated for each data which is of absolute time and by each in-
put Analyzing Function independently, so absolute data from different periods of
time are shifted to the relative heart beat time of the Analyzing Model
 an Analyzing Model which bases on data with absolute and relative time stamp
○ for input Analyzing Functions it is not known whether other input Analyzing Functions
within the same Analyzing Model base on absolute or relative time stamps, thus they
behave like described above
Output Time Base

The output time base determines the time base (= time zone) which is used for the visualization of the
timestamps of the created offline data. This setting applies only in case the Analyzing Model outputs offline data
with absolute timestamps and is “N/A” in all other cases:
Output Time Base Description
Use the local Time of the Input Data The Analyzing Model determines the time base of the input data and applies it to all output data.
In case data with different time bases are used as input of the Analyzing Model, it suspends with
an according log entry.
Use the local Time of the Server The Analyzing Model uses the local time base (= time zone) of the X-Tools Server as time base
of all output data.
Use the Greeenwich Mean Time The Analyzing Model uses the Greenwich Mean Time (GMT) as time base of all output data.
(GMT)
all other time zones which are availa- The Analyzing Model uses the chosen time base (= time zone) as time base of all output data.
ble within the system
Default Input Data Interpolation Mode

The chosen Default Input Data Interpolation Mode can be overwritten by each input Analyzing Function.
Default Output Data Precision
The chosen Default Output Data Precision can be overwritten by each output Analyzing Function.
Default Output Data Record Mode
The chosen Default Output Data Record Mode can be overwritten by each output Analyzing Function.
Default Output Data Record Parameters
The chosen Default Output Data Record Parameters can be overwritten by each output Analyzing Function.
English
Release 2018-06 60 / 866
2.3.2.6 Offline Time Configuration Table
The Offline Time Configuration table contains all of the offline data calculation related parameters which can be
configured within an Analyzing Model:
Time Input Mode allows to switch between the available time input modes
Minimum Time Format allows to switch between the available input formats for the minimum time
Minimum Time Value allows to enter the minimum time of the scaling
Time Interval Format allows to switch between the available input formats of the time interval
Time Interval Value allows to enter the time interval of the scaling
Maximum Time Format allows to switch between the available input formats for the maximum time
Maximum Time Value allows to enter the maximum time of the scaling
Each parameter from the Offline Time Configuration table can be used as parameter of the Analyzing Model.
Therefore, the following context menu items are provided:
Add Parameter adds the parameter from where the context menu has been called as parameter of the Analyzing
Model
Go to Parameter highlights the parameter which represents the parameter from where the context menu has been
called within the Provided Parameters table
Remove Parameter removes the parameter from where the context menu has been called as parameter of the Analyz-
ing Model
Time Input Mode

Time Input Mode Description
Minimum Time and Time Interval In this time input mode, the Analyzing Model is executed from the specified minimum time and for
the specified time interval. The according maximum time is calculated automatically.
Minimum Time and Maximum Time In this time input mode, the Analyzing Model is executed from the specified minimum time to the
specified maximum time.
Time Interval and Maximum Time In this time input mode, the Analyzing Model is executed for the specified time interval and until
the specified maximum time. The according minimum time is calculated automatically.
Time Interval Format

In case the Time Interval Format is configured to “None (use shortest Time)”, the Analyzing Model calculates
the shortest time interval from all input data automatically and uses it as time interval for the calculation.
English
Release 2018-06 61 / 866
2.3.2.7 Treatment of Status Codes Table
The Treatment of Status Codes table contains all of the status code dependent parameters which can be con-
figured within an Analyzing Model:
Overflow contains the treatment of the status code “Overflow”
Underflow contains the treatment of the status code “Underflow”
Loss of Accuracy contains the treatment of the status code “Loss of Accuracy”
Division by Zero contains the treatment of the status code “Division by Zero”
Infinite Result contains the treatment of the status code “Infinite Result”
Undefined Result contains the treatment of the status code “Undefined Result”
Input out of Range contains the treatment of the status code “Input out of Range”
Input not available contains the treatment of the status code “Input not available”
Function specific Error contains the treatment of the status code “Function specific Error”
Value not available contains the treatment of the status code “Value not available”
Treatment of Status Code

Treatment of Status Code Description
Ignore Status and continue the Calcu- in case this status code occurs, the calculation continues
lation
see also point 2.6.1.4
Suspend the Calculation in case this status code occurs, the calculation suspends
2.3.2.8 Log Entries Table
The Log Entries table contains all of the events which apply to the currently opened Analyzing Model:
Date and Time contains the date and time of the entry
Entry contains the text of the entry
Source Module contains the source module of the entry
Source Machine contains the source machine of the entry
Source User contains the source user of the entry
Priority Class contains the priority class of the entry
Execution ID contains the execution ID of the entry
English
Release 2018-06 62 / 866
2.3.3 AME Standard T001
2.3.3.1 Overview
The AME Standard T001 is used in order to visualize, create and edit Analyzing Models of type “Standard
T001”. Multiple editors of this type can be opened and used simultaneously.
The following screenshot shows an example of an AME Standard T001:
Figure 7: Example of an AME Standard T001
English
Release 2018-06 63 / 866
Each control of the AME Standard T001 has a defined task and provides certain functionalities. The following
major controls are provided by the AME Standard T001:
 Menu Bar
 Analyzing Model Settings Table
 Analyzing Model Parameters Table
 Action Area
 Log Entries Area
 Dropping of Items
 Analyzing Function Properties Dialog
 User Function Properties Dialog
2.3.3.2 Menu Bar
The standard Menu Bar is being used by the AME Standard T001 (see point 2.3.2.2).
2.3.3.3 Analyzing Model Settings Table
The standard Analyzing Model Settings table is being used by the AME Standard T001 (see point 2.3.3.3).
The standard Provided Parameters table is being used by the AME Standard T001 (see point 2.3.2.4).
2.3.3.5 Analyzing Model Parameters Table
The standard Analyzing Model Parameters table is being used by the AME Standard T001 (see point 2.3.2.5).
The standard Offline Time Configuration table is being used by the AME Standard T001 (see point 2.3.2.6).
The standard Treatment of Status Codes table is being used by the AME Standard T001 (see point 2.3.2.7).
2.3.3.8 Action Area
The Action Area contains all of the functions and links of the current Analyzing Model. Via Drag&Drop, the cur-
rently present functions and links can be edited and additional functions and links can be added to the Analyzing
Model.
The zoom factor can be set to values from 10 to 100 %. In case zoom factor of “automatic” is chosen, the AME
Standard T001 always attempts to choose a zoom factor where all of the present functions fit into the available
space.
English
Release 2018-06 64 / 866
Symbol of Functions
Each present function is represented by a graphical symbol which provides the following information:
 name of the function
 sequence ID
 names of all input arguments
 names of all output arguments
The symbol of each function is divided into an upper and a lower rectangle. Different colors are used for the
background of the upper rectangle in order to divide Analyzing Functions and User Function. The background
color of the lower rectangle is typically blue - however, in case of Functions whose interface definitions are out-
dated, the background of the lower rectangle is highlighted with red color. The following examples show differ-
ent symbols of Functions:
Figure 8: Example of an Analyzing Function
Figure 9: Example of a User Function
Figure 10: Example of an Analyzing Function with outdated Interface Information

In case the interface information of a Function is out of date, the AME Standard T001 asks whether it shall up-
date the according Analyzing Model whenever it is opened. After the automatic update through the AME Stand-
ard T001, the interface information is corrected and the Function is displayed with the blue lower rectangle
again. In order to correct an Analyzing Model manually, all Functions which are out of date must be removed
and replaced through their current versions from the ANS Explorer. An Analyzing Model mostly can be started
even in case it contains Functions with outdated interface information - in case such an Analyzing Model is
started, the Analyzing Engine itself performs an automatic, temporary update (without changing of the file at the
disk) and adds an according log entry before it performs the actual start.
In case the mouse cursor is stopped above a function, a tool tip is displayed after a few moments. Independent-
ly to the current zoom factor, the tool tip always shows the below function with a zoom factor of 100 % and also
provides detailed information about the values/connections of each input and output argument.
English
Release 2018-06 65 / 866
Symbol of Group Boxes

Each present group box is displayed with the currently configured text, frame and background.
The following example shows different group boxes:
Figure 11: Example of Group Boxes within the AME Standard T001
English
Release 2018-06 66 / 866
Keyboard Operations
Operation Description
<F2> in case an input argument of a <F2> allows editing the value of the input argument directly within the Action Area of the Analyz-
function has the input focus ing Model Editor. Depending to the type of the input argument, an edit box or a combo box is
being displayed during the edit.
<Cursor Up> in case an input argu- moves the input focus one argument up
ment of a function has the input focus
<Cursor Down> in case an input ar- moves the input focus one argument down
gument of a function has the input
focus
<+> zooms into the Action Area
<-> zooms out of the Action Area
<F> <F> fits the scaling of the Action Area
<Ctrl> + <C> copies the currently selected items
<Ctrl> + <X> cuts the currently selected items
<Ctrl> + <V> pastes the currently copied/cut items
<Ctrl> + <A> select all items
<Del> deletes the currently selected items
<Esc> cancels the currently ongoing Drag&Drop operation
<Ctrl> + <Z> performs one undo operation
<Alt> + <Backspace> identical to <Ctrl> + <Z>
<Ctrl> + <Y> performs one redo operation
<Shift> + <Alt> + <Backspace> identical to <Ctrl> + <Y>
English
Release 2018-06 67 / 866
Operations via the Left Mouse Button

The following operations can be performed via the left mouse button:
single click with releasing the button A single click of the left mouse button with releasing the button above an item (function, link or
group box) selects or deselects the item below the current mouse position:
 <Ctrl> can be used in order to select/deselect multiple items one after the other
single click with keeping the button A single click of the left mouse button above a link starts to move the line or corner of the link
above a link manually:
 [left mouse button down] + [mouse move] moves the line or corner
 <Esc> cancels the current operation and keeps the original position of all lines of the af-
fected links
single click with keeping the button A single click of the left mouse button above a selected item with keeping the button starts a move
above a selected item or copy operation. The actual moving or copying is performed when the mouse is moved:
 [left mouse button down] + [mouse move] moves all currently selected items within the Ac-
tion Area into the direction of the mouse move
 <Esc> cancels the current operation and moves all items back to the positions which they
had before the move operation had been started
single click with keeping the button A single click of the left mouse button not above a selected item with keeping the button starts a
not above a selected item select operation. The actual selecting is performed when the left mouse button is released:
 [left mouse button down] + [mouse move] highlights all items which are within the area in
between the mouse position at the start of the select operation and the current mouse posi-
tion
o during the mouse move and before the left mouse button is being released, a rectan-
gular frame indicates the area of selection
o all items which are completely enclosed by the rectangular frame are highlighted in or-
der to show which items will be selected when the left mouse button is being released
 <Esc> cancels the current operation and sets the selection of all items back to the state
which they had before the selecting operation had been started
double click onto an Analyzing Func- A double click of the left mouse button onto any Analyzing Function opens the Analyzing Func-
tion tion Properties dialog for the Analyzing Function below the current mouse position.
double click onto an Analyzing Func- A double click of the left mouse button onto any argument of an Analyzing Function opens the
tion argument Analyzing Function Properties dialog for the Analyzing Function below the current mouse posi-
tion and sets the input focus to the value field of the clicked argument.
double click onto a User Function A double click of the left mouse button onto any User Function opens the User Function Proper-
ties dialog for the User Function below the current mouse position.
double click onto a User Function A double click of the left mouse button onto any argument of a User Function opens the User
argument Function Properties dialog for the User Function below the current mouse position and sets the
input focus to the value field of the clicked argument.
double click onto a group box A double click of the left mouse button onto a group box opens the Edit Group Box dialog for the
group box below the current mouse position and puts the value of the Text parameter into editing
mode.
Operations via the Right Mouse Button

The following operation can be performed via the right mouse button:
single click with releasing the button A single click of the right mouse button with releasing the button somewhere within the Action
Area opens the context menu for the below item.
Drag&Drop of a (Analyzing or User) Function

When a function is dragged into the Action Area, the size and position of the new function is visualized to the
user during the Drag&Drop operation. After the drop of the dragged function, the dragged function is inserted at
the specified position within the Action Area.
In case multiple functions are being selected simultaneously and dragged into the Action Area, the Action Area
processes all selected functions during the Drag&Drop operation and all functions are being inserted into the
Action Area simultaneously.
English
Release 2018-06 68 / 866
Drag&Drop of Data
The following operations can be performed via Drag&Drop:
dropping of data into empty space When data is dropped into empty space of the Action Area, a proper input Analyzing Function,
which fits the data type of the dragged data, is searched automatically. In case a proper input
Analyzing Function is available, the Drag&Drop operation behaves as if the determined input Ana-
lyzing Function would be dropped. After the drop of the dragged data, the determined input Ana-
lyzing Function is inserted and the name of the dropped data is added as input for the new Ana-
lyzing Function automatically.
dropping of data into an unclassified When data is dropped into an unclassified Analyzing Model (= an Analyzing Model whose default
Analyzing Model data class has not been set to online or offline yet), the default data class (online or offline) of the
unclassified Analyzing Model is set to the class of the dragged data (online or offline) automatical-
ly. In addition, the output time domain (absolute or relative times) of the unclassified Analyzing
Model is set to the time domain of the dragged data automatically.
dropping of data of different classes Analyzing Models allow to use online and offline data simultaneously (e.g., a neural cloud (Analyz-
ing or User) function may perform its confidence calculation for online data based on some key
values that are available as offline data). Via the standard, textual online/offline identifiers of the
system, the user can override the default data class of the Analyzing Model when a textual
online/offline identifier is being used for the specification of an input data name.
Creation of Links between (Analyzing or User) Functions

In order to create a link from the output argument of one function to the input argument of another function, click
onto one of the to-be-connected arguments first and onto the second one afterwards. After the first to-be-
connected argument has being clicked, all of the available target arguments of all functions within the Analyz-
ing Model Editor are being highlighted automatically.
Sequence IDs
Each (Analyzing or User) function receives a unique sequence ID which determines when it is being called dur-
ing the processing of one cycle:
 the function with the lowest sequence number is being called first
 the function with the highest sequence number is being called last
The sequence ID of each function can be assigned via the Analyzing Function Properties and User Function
Properties dialogs. In addition, the sequence IDs can be re-assigned in the following ways:
 automatically
o reassigns the sequence IDs of all present functions automatically so that the sequence IDs are rising
from the input Analyzing Functions to the output Analyzing Functions
 manually
o the present Analyzing Functions can be clicked one after the other in order to assign rising sequence
IDs to them
o in case the manual assignment of sequence IDs is started from a present Analyzing Function, the next
clicked Analyzing Function receives a sequence ID which is 1 higher than the sequence ID of the Ana-
lyzing Function from which the manual assignment was started
o the manual assignment of sequence IDs is ended in the following cases:
 when the last sequence ID of the current Analyzing Model has been assigned
 after <Esc> has been pressed
 in case a mouse click is performed into empty space
 in case the Analyzing Model Editor looses the input focus
 in case a context menu is opened
English
Release 2018-06 69 / 866
Context menu of a single Analyzing Function

Create Group Box creates a new group box which encloses all of the currently selected items
Cut cuts the currently selected Analyzing Function
Copy copies the currently selected Analyzing Function
Remove removes the currently selected Analyzing Function
Expand expands the Analyzing Function (displays the full names of all arguments)
Collapse collapses the Analyzing Function (displays the short names of all arguments)
Show Values of Inputs > … sets whether the values of the input arguments of the currently selected Analyzing Functions shall
be displayed within the Action Area
Analyzing Function Properties… opens the Analyzing Function Properties dialog
Context menu of a single User Function

Cut cuts the currently selected User Function
Copy copies the currently selected User Function
Remove removes the currently selected User Function
Expand expands the User Function (displays the full names of all arguments)
Collapse collapses the User Function (displays the short names of all arguments)
Show Values of Inputs > … sets whether the values of the input arguments of the currently selected User Functions shall be
displayed within the Action Area
User Function Properties… opens the User Function Properties dialog
Open… opens a new User Funciton Editor and opens the User Function within this User Function Edi-
tor
Context menu of a single Input Argument of a Function

Add Parameter adds the currently selected argument to the Provided Parameters table
this item is enabled only in case the data type of the input argument is Boolean, Integer8, Inte-
ger16, Integer32, Integer64, Decimal32, Decimal64 or String (extended data types are not sup-
ported)
Go to Parameter maximizes the Provided Parameters table and highlights the parameter which belongs to the cell
from which the context menu has been called
Remove Parameter removes the currently selected argument from the Provided Parameters table
Context Menu of a single Link

Reroute Link automatically reroutes the link from which the context menu has been called
Remove removes the currently selected link
Context menu of a single Group Box

Group > cuts/copies/removes the group box together with all of its contained items (Analyzing Functions,
User Functions and group boxes)
Group Box > cuts/copies/removes the group box but does not cut/copy/remove any of the contained items
(Analyzing Functions, User Functions and group boxes)
Edit Group Box … opens the Edit Group Box dialog
English
Release 2018-06 70 / 866
Context Menu of multiple selected Items

Create Group Box creates a new group box which encloses all of the currently selected item
Cut cuts the currently selected items
Copy copies the currently selected items
Remove removes the currently selected items
Expand expands the (Analyzing and User) functions (displays the full names of the functions and of all of
their arguments)
Collapse collapses the (Analyzing and User) functions (displays the short names of the functions and of all
of their arguments)
Show Values of Inputs > … sets whether the values of the input arguments of the currently selected functions shall be dis-
played within the Action Area
Analyzing Function Properties… opens the Analyzing Function Properties dialog of the Analyzing Function from which the
context menu has been called
User Function Properties… opens the User Function Properties dialog of the User Function from which the context menu
has been called
Context Menu of empty Space

Create Group Box creates a new group box with default size and position
The standard Log Entries table is being used by the AME Standard T001 (see point 2.3.2.8).
2.3.3.10 Dropping of Items

Dropped Item Description
Analyzing Model File Branches of opens the dropped Analyzing Model
type “AMF Standard T001”
Analyzing Function Branches in case creates a new Analyzing Model, initializes the target server to the parent server of the dragged
the AME Standard T001 is empty Analyzing Function and drops the Analyzing Function as seen above
User Function Branches in case the creates a new Analyzing Model, initializes the target server to the parent server of the dragged
AME Standard T001 is empty User Function and drops the User Function as seen above
Offline Data Branches in case the creates a new Analyzing Model, initializes the target server to the parent server of the dragged
AME Standard T001 is empty offline data and afterwards it drops the offline data as seen above
Online Data Branches in case the creates a new Analyzing Model, initializes the target server to the parent server of the dragged
AME Standard T001 is empty online data and afterwards it drops the online data as seen above
Analyzing Function Branches in case drops the Analyzing Function as seen above
the AME Standard T001 contains an
Analyzing Model
Analyzing Function Branches in case drops the User Function as seen above
the AME Standard T001 contains an
Analyzing Model
Offline Data Branches in case the drops the offline data as seen above
AME Standard T001 contains an
Analyzing Model
Online Data Branches in case the drops the online data as seen above
AME Standard T001 contains an
Analyzing Model
English
Release 2018-06 71 / 866
2.3.3.11 Analyzing Function Properties Dialog
2.3.3.11.1 Overview
The following screenshot shows an example of an Analyzing Function Properties dialog:
Figure 12: Example of an Analyzing Function Properties Dialog
2.3.3.11.2 Analyzing Function Properties Table
Sequence ID contains the sequence ID of the Analyzing Function
English
Release 2018-06 72 / 866
It is not possible to add or remove arguments to/from the Analyzing Function Properties table because each
Analyzing Function provides detailed information about all of its arguments by itself.
Dimension
In case of configurable arguments, the Dimension cell contains a combo box with the available dimensions.
In case of arguments which are not configurable, the Dimension cell contains the dimension as static text.
Value
Set to Default sets the value of the cell to its default value
2.3.3.12 User Function Properties Dialog
The appearing and functionality of the User Function Properties dialog is identical to the appearing and func-
tionality of the Analyzing Function Properties dialog (see point 2.3.3.11).
English
Release 2018-06 73 / 866
2.3.3.13 Edit Group Box Dialog
2.3.3.13.1 Overview
The following screenshot shows an example of an Edit Group Box dialog:
Figure 13: Example of an Edit Group Box Dialog
2.3.3.13.2 Group Box Parameters Table
The Group Box Parameters table contains the parameters of the to-be-edited group box:
Text allows to enter the text which shall be displayed within the group box
Horizontal Text Position allows to choose the horizontal position of the displayed text
Vertical Text Position allows to choose the vertical position of the displayed text
Text Color allows to choose the color of the displayed text
Text Size allows to choose the size of the displayed text
Frame Color allows to choose the color of the displayed frame
Frame Strength allows to choose the strength of the displayed frame
Background Color allows to choose the color of the displayed background
Text
The entered text can contain any characters. <Ctrl> + <Enter> can be used in order to insert multi-line texts.
There is no automatic wrapping of the text.
The entered text is not displayed outside the borders of its group box - in case the text does not fit into the cur-
rent dimensions of the group box, it is cut.
English
Release 2018-06 74 / 866
2.4 Analyzing Script Editors
2.4.1 Overview
Analyzing Script Editors are used in order to edit Analyzing Scripts. An Analyzing Script contains all of the
information which is needed in order to start a script-based (online or offline) data calculation. Multiple Analyzing
Scripts can be maintained and/or executed at each X-Tools Server simultaneously.
Analyzing Script Editors are known and accessed exclusively by the X-Tools Client, the X-Tools Server has
no knowledge about Analyzing Script Editors at all. However, the X-Tools Server is responsible to maintain
Analyzing Script Files and therefore all Analyzing Script reading and writing operations are performed via the X-
Tools Server.
2.4.2.1 Overview
As all Analyzing Script Editors are built up in a similar way, they share some common controls (e.g. tables
and the menu bar) which are the same in all Analyzing Script Editors.
Each control of an Analyzing Script Editor has a defined task and provides certain functionalities. The follow-
ing major controls are provided by the Analyzing Script Editors. Depending to the Analyzing Script Editor,
one or more parts may not be supported (because they are not needed) and one or more parts may be present
in addition to the following ones (because they are necessary):
 Menu Bar
 Analyzing Script Settings Table
 Analyzing Script Parameters Table
 Log Entries Table
English
Release 2018-06 75 / 866
2.4.2.2 Menu Bar
The Menu Bar provides direct access to the functionality of each Analyzing Script Editor.
New creates a new, empty Analyzing Script and initializes the Analyzing Script Settings table with the
default values for new Analyzing Scripts
Save saves the currently opened Analyzing Script to the currently known storage location
Add Parameter adds the currently selected item as parameter of the Analyzing Script
Go to Parameter highlights the row within the Provided Parameters table which belongs to the currently selected
item
Remove Parameter removes the currently selected item as parameter of the Analyzing Script
Go to Definition highlights the item which belongs to the currently selected row from the Provided Parameters
table

Move up moves the currently selected row(s) of the Provided Parameters table up
Move down moves the currently selected row(s) of the Provided Parameters table down
Remove removes the currently selected row(s) of the Provided Parameters table
The following functionality is available via the Script menu:

Cut cuts the currently selected text
Copy copies the currently selected text
Select all selects all text
Remove removes the currently selected text
Remove all removes all text
Find and Replace opens the Find and Replace dialog

Start starts the Analyzing Script
Restart restarts (= stops and starts) the Analyzing Script
Pause pauses the Analyzing Script
Continue continues the Analyzing Script
Stop stops the Analyzing Script
English
Release 2018-06 76 / 866
The following functionality is available via the Log Entries menu:

Copy copies the currently selected log entries from the Log Entries table to the clipboard of Windows
Select all selects all of the currently present log entries from the Log Entries table
Clear all removes all entries from the Log Entries table



Size > … changes the size of the Analyzing Script Editor
2.4.2.3 Analyzing Script Settings Table
The Analyzing Script Settings table contains all of the script-dependent settings which can be configured within
an Analyzing Script:
Target Name contains the name of the target to which the Analyzing Script is stored
Storage Path contains the path to which the Analyzing Script is stored (absolute or symbolic path)
Creation Date contains the creation date of the Analyzing Script
Modification Date contains the last modification date of the Analyzing Script
Script Description contains the description of the Analyzing Script
Data Name Prefix for Input Data contains the data name prefix for the input data
Data Name Prefix for Output Data contains the data name prefix for the output data
Target Name
Data Name Prefix for Input Data
The Data Name Prefix for Input Data is part of the final data name of all online and offline input data which is
being used by the Analyzing Script, but it is not applied to scalar input data. It is being inserted at the beginning
of the name of each online and each offline input data before the execution of the Analyzing Script.
The Data Name Prefix for Input Data is ignored by Analyzing Scripts whose operating mode is “Sequential”.
English
Release 2018-06 77 / 866
The Data Name Prefix for Input Data can be used as parameter of the Analyzing Script. Therefore, the following
context menu items are provided:
Add Parameter adds the Data Name Prefix for Input Data as parameter of the Analyzing Script
Go to Parameter highlights the parameter which represents the Data Name Prefix for Input Data within the Provided
Parameters table
Remove Parameter removes the Data Name Prefix for Input Data as parameter of the Analyzing Script
Data Name Prefix for Output Data

The Data Name Prefix for Output Data is part of the final data name of all online and offline output data which is
being used by the Analyzing Script, but it is not applied to scalar output data. It is being inserted at the begin-
ning of the name of each online and each offline output data before the execution of the Analyzing Script.
The Data Name Prefix for Output Data is ignored by Analyzing Scripts whose operating mode is “Sequential”.
The Data Name Prefix for Output Data can be used as parameter of the Analyzing Script. Therefore, the follow-
ing context menu items are provided:
Add Parameter adds the Data Name Prefix for Output Data as parameter of the Analyzing Script
Go to Parameter highlights the parameter which represents the Data Name Prefix for Output Data within the Pro-
vided Parameters table
Remove Parameter removes the Data Name Prefix for Output Data as parameter of the Analyzing Script
The Provided Parameters table contains all of the parameters which have been configured within an Analyzing
Script:
Full Name allows to enter the full name of the parameter
Short Name allows to enter the short name of the parameter
Unit allows to enter the unit of the parameter
Description allows to enter the description of the parameter
Default Value allows to enter the default value of the parameter
Full Name
The Full Name of each parameter must be unique among the parameters of the Analyzing Script.
New provided parameters can be added to the Analyzing Script through typing of the new full name into this edit
box.
Short Name
The Short Name of each parameter must be unique among the parameters of the Analyzing Script.
The %'ShortName' syntax can be used in order to use the value of a provided parameter at any place within
the Analyzing Script.
Context Menu
The following context menu items are provided by the Provided Parameters table:
Move up moves the selected parameter(s) one row up
Move down moves the selected parameter(s) one row down
Go to Definition in case the parameter belongs to an input argument, this context menu item is disabled
in case the parameter belongs to a setting from a table, the parent table of the according setting is
expanded and the setting is highlighted
Remove removes the currently selected parameter(s)
English
Release 2018-06 78 / 866
2.4.2.5 Analyzing Script Parameters Table
The Analyzing Script Parameters table contains all of the script-dependent parameters which can be configured
within an Analyzing Script:
Operating Mode allows to switch between the available operating modes
Calculation Mode allows to switch between the available calculation modes
Action Mode allows to switch between the available action modes
Cycle Time/Rate contains the cycle time/rate of the Analyzing Script
Input Data Class allows to switch between the available input data classes
Output Data Class allows to switch between the available output data classes
Output Time Domain allows to switch between the available time domains
Output Time Base allows to switch between the available time bases
Default Input Data Interpolation Mode allows to switch between the available interpolation modes
Default Output Data Precision allows to switch between the available precisions
Default Output Data Record Mode allows to switch between the available record modes
Default Output Data Record Parame- allows to enter the record parameters
ters
Password contains the password of the Analyzing Script which must be specified in order to open the Ana-
lyzing Script within an Analyzing Script Editor
Password (confirm) contains the password of the Analyzing Script (for confirmation) which must be specified in order
to open the Analyzing Script within an Analyzing Script Editor
Operating Mode
Operating Mode Description
Sequential In case of sequential operating mode, the specified Analyzing Script is being executed instruction
after instruction:
 each instruction is applied to the complete available input data and to all of its values at
once
 when the last instruction of the Analyzing Script has been processed, the Analyzing Script
is stopped automatically
 Analyzing Scripts in sequential mode support advanced grammar, including loops, condi-
tional statements, variables definitions and user defined functions
Time Slice based In case of time-slice based operating modes, the complete Analyzing Model is being executed
time slice after time slice:
 at each time slice, all Analyzing Functions within the Analyzing Model are being called
one after the other an in the order which is specified via their sequence ID
○ each Analyzing Function performs exactly one calculation out of the exactly one val-
ue which is provided at each of its input arguments
○ each Analyzing Function outputs exactly one value to each of its output arguments
 the time of the current time slice is being called the “heart beat time”
○ the heart beat time is totally independent to the system time, it can be an absolute or
relative time and it can point to the past, to the present or to the future
○ the heart beat time is being determined according to the parameters of the Analyzing
Model
 advanced Analyzing Functions may have to collect the values of multiple cycles (e.g. the
FFT Analyzing Function, …) and perform their actual calculation when they have collect-
ed all needed values
English
Release 2018-06 79 / 866
Calculation Mode
Calculation Mode Description
Equidistant In this calculation mode, the specified calculation instructions are being executed exactly each
defined time interval and with the interval which is specified via the cycle time/rate parameter.
Action based and cyclic In this calculation mode, the specified calculation instructions are being executed exactly each
defined time interval and with the interval which is specified via the cycle time/rate parameter. In
opposite to the calculation mode “Equidistant”, the execution of calculations is not done in case
the specified action (see Action Mode) did not take place within the last calculation interval. The
calculations are done again as soon as the specified action is detected again.
Action based and once In this calculation mode, the specified calculation instructions are being executed exactly at the
times where the specified action (see Action Mode) takes place.
Compared to the “Action based and cyclic” calculation mode, this calculation mode does not cre-
ate an equidistant output data even in case the specified action is detected constantly. Instead,
the resulting output data contains exactly one calculation for each time at which the specified
action has been detected and therefore it can handle also high speed input data when it is being
received irregularly.
Action Mode
Action Mode Description
Run one Calculation when at least In this action mode, the specified calculation instructions are being executed whenever at least
one Input provides a new Value one of the inputs provides a new value.
cause a calculation is performed only in case when there are new values available from at least
one of the inputs). For cases where the input data is received irregularly and with high speed, this
action mode allows much higher calculation intervals than the calculation mode “Equidistant”.
Run one Calculation when all Inputs In this action mode, the specified calculation instructions are being executed whenever all of the
provide a new Value inputs provide a new value.
cause a calculation is performed only in case when there are new values available from all of the
inputs). For cases where the input data is received irregularly and with high speed, this action
mode allows much higher calculation intervals than the calculation mode “Equidistant”.
Cycle Time/Rate
The specified Cycle Time/Rate is being used for the determination of the successive heart beat times of the to-
be executed calculations.
English
Release 2018-06 80 / 866
Input Data Class

be able to determine whether the current Analyzing Script shall input online or offline data, the input data class
can be specified and the Analyzing Script operates on base of the specified data class (thus, all input data is
taken from the data pool which matches the specified input data class).
Input Data Class Description
Automatic When the input data class is set to “Automatic”, the Analyzing Script can input online data and
offline data. In this case, all input data of unspecified class is taken from the data pool which
matches the specified output data class. For special applications the user is able to override the
specified input data class and to specify for each of the used input data independently whether it
shall be taken from the online or from the offline data pool.
Online Data When the input data class is set to “Online Data”, the Analyzing Script can input only online data
and scalar data.
Offline Data When the input data class is set to “Offline Data”, the Analyzing Script can input only offline data
and scalar data.
The input data class has been introduced with V 04.04 SP1 of X-Tools. In case an Analyzing Script from an
older version of X-Tools is opened or started, the input data class is set to “Automatic”.
Output Data Class
be able to determine whether the current Analyzing Script shall produce online or offline data, the output data
class can be specified. In case the input data class is “Automatic”, all input data of unspecified class is taken
from the data pool which matches the specified output data class.
Online Data An executed Analyzing Script produces online data in case its “Output Data Class” parameter is
set to “Online Data”. This statement is true even in case one, multiple or all of the input data is
offline data.
Possible cases are:
 an Analyzing Script which bases only on online input data
○ all input Analyzing Functions use directly the time stamps from the (ring) buffers of
their data for the determination of the values and time stamps which shall be used
 an Analyzing Script which bases only on offline input data
○ when an input Analyzing Function detects that it shall read data of an offline data alt-
hough the parent Analyzing Script is configured for online output data, it determines
the offset in between the start time of the parent Analyzing Script and the first available
time stamp of its offline data
offline data shifted by the determined time offset
■ as the time offset is calculated for each offline data and by each input Analyzing
Function independently, offline data from different periods of time are shifted to
the heart beat time of the online data calculation automatically
base on offline data return exactly the start time of the parent Analyzing Script as
the heart beat times because they apply the calculated time offset to their offline input
data in order to find out about the according online data time
○ when the end of the offline data has been reached, the input Analyzing Function
starts to read the offline data from its beginning again
 an Analyzing Script which bases on online and offline input data
tions within the same Analyzing Script base on online or on offline data, thus they be-
English
Release 2018-06 81 / 866

Offline Data An executed Analyzing Script produces offline data in case its “Output Data Class” parameter is
set to “Offline Data”. This statement is true even in case one, multiple or all of the input data is
online data. Produced offline data is returned to the system when the stop condition is reached.
Possible cases are:
 an Analyzing Script which bases only on offline data
○ all input Analyzing Functions use directly the time stamps from the buffers of their da-
ta for the determination of the values and time stamps which shall be used
 an Analyzing Script which bases only on online data
○ when an input Analyzing Function detects that it shall read data of an online data alt-
hough the parent Analyzing Script is configured for offline output data, it determines
the offset in between the start time (in system time) of the parent Analyzing Script and
the configured minimum time
online data shifted by the determined time offset
base on online data return exactly the start time of the parent Analyzing Script as
the heart beat times because they apply the calculated time offset to their online input
data in order to find out about the according offline data time
 an Analyzing Script which is based on online and offline data
tions within the same Analyzing Script base on online or on offline data, thus they be-
Output Time Domain

The output time domain specifies whether the timestamps of the created data have to be interpreted as absolute
time in ns since 1970-01-01 00:00:00.000.000.000 (GMT) or as relative time in ns (since 0).
Absolute Times An executed Analyzing Script produces absolute time stamps in case its “Output Time Domain”
parameter is set to “Absolute Times”. This statement is true even in case one, multiple or all of the
input data is of relative time.
Possible cases are:
 an Analyzing Script which bases on data with absolute time stamps
 an Analyzing Script which bases on data with relative time stamps
○ the relative time of all input data which is of relative time is converted to absolute time
■ the time offset is calculated for each data which is of relative time and by each in-
put Analyzing Function independently, so relative data from different periods of
time are shifted to the absolute heart beat time of the Analyzing Script
 an Analyzing Script which bases on data with relative and absolute time stamps
tions within the same Analyzing Script base on absolute or relative time stamps, thus
they behave like described above
English
Release 2018-06 82 / 866

Relative Times An executed Analyzing Script produces relative time stamps in case its “Output Time Domain”
parameter is set to “Relative Times”. This statement is true even in case one, multiple or all of the
input data is of absolute time.
Possible cases are:
 an Analyzing Script which bases on data with relative time stamps
 an Analyzing Script which bases on data with absolute time stamps
○ the absolute time of all input data which is of absolute time is converted to relative time
■ the time offset is calculated for each data which is of absolute time and by each in-
put Analyzing Function independently, so absolute data from different periods of
time are shifted to the relative heart beat time of the Analyzing Script
 an Analyzing Script which bases on data with absolute and relative time stamp
tions within the same Analyzing Script base on absolute or relative time stamps, thus
they behave like described above
Output Time Base

The output time base determines the time base (= time zone) which is used for the visualization of the
timestamps of the created offline data. This setting applies only in case the Analyzing Model outputs offline data
with absolute timestamps and is “N/A” in all other cases:
Output Time Base Description
Use the local Time of the Input Data The Analyzing Model determines the time base of the input data and applies it to all output data.
In case data with different time bases are used as input of the Analyzing Model, it suspends with
an according log entry.
Use the local Time of the Server The Analyzing Model uses the local time base (= time zone) of the X-Tools Server as time base
of all output data.
Use the Greeenwich Mean Time The Analyzing Model uses the Greenwich Mean Time (GMT) as time base of all output data.
(GMT)
all other time zones which are availa- The Analyzing Model uses the chosen time base (= time zone) as time base of all output data.
ble within the system
Default Input Data Interpolation Mode

The chosen Default Input Data Interpolation Mode can be overwritten by each input Analyzing Function. Im-
plict inputs like ~’Data’ or $’Data’ use the specified Default Input Data Interpolation Mode.
Default Output Data Precision
The chosen Default Output Data Precision can be overwritten by each output Analyzing Function. Implict out-
puts like ~’Data’ or $’Data’ use the specified Default Output Data Precision.
Default Output Data Record Mode
The chosen Default Output Data Record Mode can be overwritten by each output Analyzing Function. Implict
outputs like ~’Data’ or $’Data’ use the specified Default Output Data Record Mode.
Default Output Data Record Parameters
The chosen Default Output Data Record Parameters can be overwritten by each output Analyzing Function.
Implict outputs like ~’Data’ or $’Data’ use the specified Default Output Data Record Parameters.
Password
In case a password is specified for an Analyzing Script, the password must be provided before the contents of
the Analyzing Script are transmitted to the X-Tools Client. Contrary, the X-Tools Server always can access the
Analyzing Script, thus also a password-protected Analyzing Script can be started without any need to provide a
password.
English
Release 2018-06 83 / 866
The Offline Time Configuration table contains all of the offline data calculation related parameters which can be
configured within an Analyzing Script:
Time Input Mode allows to switch between the available time input modes
Minimum Time Format allows to switch between the available input formats for the minimum time
Minimum Time Value allows to enter the minimum time of the scaling
Time Interval Format allows to switch between the available input formats of the time interval
Time Interval Value allows to enter the time interval of the scaling
Maximum Time Format allows to switch between the available input formats for the maximum time
Maximum Time Value allows to enter the maximum time of the scaling
Time Input Mode

Time Input Mode Description
Minimum Time and Time Interval In this time input mode, the Analyzing Script is executed from the specified minimum time and for
the specified time interval. The according maximum time is calculated automatically.
Minimum Time and Maximum Time In this time input mode, the Analyzing Script is executed from the specified minimum time to the
specified maximum time.
Time Interval and Maximum Time In this time input mode, the Analyzing Script is executed for the specified time interval and until
the specified maximum time. The according minimum time is calculated automatically.
Time Interval Format

In case the Time Interval Format is configured to “None (use shortest Time)”, the Analyzing Script calculates the
shortest time interval from all input data automatically and uses it as time interval for the calculation.
English
Release 2018-06 84 / 866
The Treatment of Status Codes table contains all of the status code dependent parameters which can be con-
figured within an Analyzing Script:
Overflow contains the treatment of the status code “Overflow”
Underflow contains the treatment of the status code “Underflow”
Loss of Accuracy contains the treatment of the status code “Loss of Accuracy”
Division by Zero contains the treatment of the status code “Division by Zero”
Infinite Result contains the treatment of the status code “Infinite Result”
Undefined Result contains the treatment of the status code “Undefined Result”
Input out of Range contains the treatment of the status code “Input out of Range”
Input not available contains the treatment of the status code “Input not available”
Function specific Error contains the treatment of the status code “Function specific Error”
Value not available contains the treatment of the status code “Value not available”
Treatment of Status Code

Treatment of Status Code Description
Ignore Status and continue the Calcu- in case this status code occurs, the calculation continues
lation
Suspend the Calculation in case this status code occurs, the calculation suspends
The Log Entries table contains all of the events which apply to the currently opened Analyzing Script:
Date and Time contains the date and time of the entry
Entry contains the text of the entry
Source Module contains the source module of the entry
Source Machine contains the source machine of the entry
Source User contains the source user of the entry
Priority Class contains the priority class of the entry
Execution ID contains the execution ID of the entry
English
Release 2018-06 85 / 866
2.4.3 ASE Standard T001
2.4.3.1 Overview
The ASE Standard T001 is used in order to visualize, create and edit Analyzing Scripts of type “Standard
T001”. Multiple editors of this type can be opened and used simultaneously.
The following screenshot shows an example of an ASE Standard T001:
Figure 14: Example of an ASE Standard T001

Each control of the ASE Standard T001 has a defined task and provides certain functionalities. The following
major controls are provided by the ASE Standard T001:
 Menu Bar
 Analyzing Script Settings Table
 Analyzing Script Parameters Table
 Action Area
 Log Entries Area
English
Release 2018-06 86 / 866
2.4.3.2 Menu Bar
The standard Menu Bar is being used by the ASE Standard T001 (see point 2.4.2.2).
2.4.3.3 Analyzing Script Settings Table
The standard Analyzing Script Settings table is being used by the ASE Standard T001 (see point 2.4.2.3).
The standard Provided Parameters table is being used by the ASE Standard T001 (see point 0).
2.4.3.5 Analyzing Script Parameters Table
The standard Analyzing Script Parameters table is being used by the ASE Standard T001 (see point 2.4.2.5).
The standard Offline Time Configuration table is being used by the ASE Standard T001 (see point 0).
The standard Treatment of Status Codes table is being used by the ASE Standard T001 (see point 2.4.2.7).
2.4.3.8 Action Area
The Action Area contains the current Analyzing Script. The currently present Analyzing Script can be edited
here and Drag&Drop can be used in order to add additional Analyzing Functions to the Analyzing Script.
The current row and column of the text cursor position within the current Analyzing Script is displayed at the
bottom of the Action Area.
Keyboard Operations
<Ctrl> + <C> copies the currently selected text
<Ctrl> + <X> cuts the currently selected text
<Ctrl> + <V> pastes the currently copied/cut text
<Ctrl> + <A> select all text
<Del> deletes the currently selected text
<Ctrl> + <F> opens the Search and Replace dialog
<Ctrl> + <H> opens the Search and Replace dialog
English
Release 2018-06 87 / 866

single click with releasing the button A single click of the left mouse button with releasing the button moves the current text cursor to
the clicked position.
above a selected text operation. The actual moving is performed when the mouse is released:
 [left mouse button down] + [mouse move] moves the currently selected text within the Ac-
tion Area to the position which is indicated by the moved mouse cursor
 <Esc> cancels the current operation and moves all texts back to the positions which they
not above a selected text select operation. The actual selecting is performed when the left mouse button is released:
 [left mouse button down] + [mouse move] highlights all text which are within the area in be-
tween the mouse position at the start of the select operation and the current mouse posi-
tion
Drag&Drop of an Analyzing Function

When an Analyzing Function is dropped into the Action Area, it is being inserted at the current text cursor po-
sition.
In case multiple Analyzing Functions are being selected simultaneously and dragged into the Action Area, the
Action Area processes only the first selected Analyzing Function during all Drag&Drop operations. Drag&Drop
of multiple Analyzing Functions at once is not being supported.
The <Alt> key can be hold down during dropping of the Analyzing Function. In this case, the Analyzing Func-
tion is inserted together with comments which contain the name of each input and output argument as well as
with the default values of all input and output arguments.
Drag&Drop of Data
dropping of data into the Action Area When data is dragged into the Action Area, its name is being inserted at the current keyboard
cursor position.
In case multiple data are being selected simultaneously and dragged into the Action Area, the
Action Area processes the selected data during all Drag&Drop operations
dropping of data into an unclassified When data is dropped into an unclassified Analyzing Script (= an Analyzing Script whose default
Analyzing Script data class has not been set to online or offline yet), the default data class (online or offline) of the
unclassified Analyzing Script is set to the class of the dragged data (online or offline) automatical-
ly. In addition, the output time domain (absolute or relative times) of the unclassified Analyzing
Script is set to the time domain of the dragged data automatically.
dropping of data of different classes Analyzing Scripts allow to use online and offline data simultaneously (e.g., a neural cloud Analyz-
ing Function may perform its confidence calculation for online data based on some key values
that are available as offline data). Via the standard, textual online/offline identifiers of the system,
the user can override the default data class of the Analyzing Script when a textual online/offline
identifier is being used for the specification of an input data name.
The standard Log Entries table is being used by the ASE Standard T001 (see point 2.4.2.8).
English
Release 2018-06 88 / 866

Analyzing Script File Branches of type opens the dropped Analyzing Script
“ASF Standard T001”
Analyzing Function Branches in case creates a new Analyzing Script, initializes the target server to the parent server of the dragged
the ASE Standard T001 is empty Analyzing Function and drops the Analyzing Function as seen above
User Function Branches in case the creates a new Analyzing Script, initializes the target server to the parent server of the dragged
ASE Standard T001 is empty User Function and drops the User Function as seen above
Offline Data Branches in case the creates a new Analyzing Script, initializes the target server to the parent server of the dragged
ASE Standard T001 is empty offline data and afterwards it drops the offline data as seen above
Online Data Branches in case the creates a new Analyzing Script, initializes the target server to the parent server of the dragged
ASE Standard T001 is empty online data and afterwards it drops the online data as seen above
the ASE Standard T001 contains an
Analyzing Script
User Function Branches in case the drops the User Function as seen above
ASE Standard T001 contains an
Analyzing Script
Analyzing Script
Analyzing Script
2.4.3.11 Syntax of Analyzing Scripts
2.4.3.11.1 Overview
The syntax of Analyzing Scripts is similar to C. It provides the following features:

 Basics
 Variables
 Functions
 Conditional Statements
 Loops
 Includes
 Fast Analysis Scripts
 Provided Parameters
English
Release 2018-06 89 / 866
2.4.3.11.2 Basics
2.4.3.11.2.1 main()
Each Analyzing Script starts and ends within the main() function:
var main()
{
The processing starts with the first instruction within main() and ends with the last instruction within main(). In
case of sequential Analyzing Scripts the Analyzing Script is stopped automatically after the last instruction has
been processed. Time-slice based Analyzing Scripts continue to execute the first instruction again after the last
instruction has finished.
2.4.3.11.2.2 Comments
Comments can be used in order to add remarks to the Analyzing Script which shall be ignored by the calcula-
tion. A sequence of “//” comments out the rest of the current line, where as a pair of “/*” and “*/” comments out
all characters in between:
var main()
{
// this is a comment which covers one line
var bNQ, bQ;
bQ = RSFF($’Binary Data 1’,$’Binary Data 2’,true,bNQ);
/* the following calculations are commented out for now

Out("Q",bQ,true,"","","Boolean");
Out("QN",bNQ,true,"","","Boolean");
*/
}
2.4.3.11.3 Variables
2.4.3.11.3.1 Overview
There are three kinds of variables available:
 Generic Variables
 Variables which represent online Data
 Variables which represent offline Data
 Variables which represent Data that is passed to the Analyzing Script
 Constants
English
Release 2018-06 90 / 866
2.4.3.11.3.2 Generic Variables
Generic variables can be used in order to store any kind of information, e.g. a single value, a string or a com-
plete (online or offline) data. Examples:
var main()
{
var Value = 10.123;
var String = "Hello World";
var Data = GenWF("Sine",10,1,2);
}
2.4.3.11.3.3 Variables which represent online Data
In case an online data shall be read from the system, the following syntax must be used:
var main()
{
var Data = ~'My online Data';
}
The same syntax also can be used in order to write online data back to the system:
var main()
{
~'Output Data' = Data;
}
Within time slice based operating modes, ~’My online Data’ and ~’Output Data’ effectively always contain only
one value (the one which belongs to the current time slice).
2.4.3.11.3.4 Variables which represent offline Data
Variables for offline data can be used in the same way as variables for online data. In a simple example the
Analyzing Script outputs the specified input data directly as output data:
var main()
{
$'Output Data' = $'My offline Data';
}
Within time slice based operating modes, $’My offline Data’ and $’Output Data’ effectively always contain only
one value (the one which belongs to the current time slice).
2.4.3.11.3.5 Variables which represent Data that is passed to the Analyzing Script
Fast Analysis Scripts provide a special syntax for passing of data from the MDS Explorer to the Analyzing
Script. This special syntax can handle both online and offline data:
var main()
{
$'Output Data' = _'INPUT_DATA_1';
}
English
Release 2018-06 91 / 866
var main()
{
~'Fast Add' = Add(_'INPUT_DATA_1', _'INPUT_DATA_2';);
}
See also point 2.4.3.11.8.
2.4.3.11.3.6 Variables which represent provided Parameters
Provided parameters which have been defined within the Provided Parameters table can be used within the
Analyzing Script via the %’’ syntax:
var main()
{
$'Output Data' = GenWF( "Sine", %'Ampl' );
}
The short name which has been defined within the Provided Parameters table must be used in order to access
the value of the according parameter.
See also point 2.4.3.11.9.
2.4.3.11.3.7 Constants
The “const” keyword must be used for variables whose value is unchangeable. An example for the usage of
“const” are variables for input arguments of Analyzing Functions which are of type “Parameter” - these Analyz-
ing Functions do not accept non-constant values as input of their “Parameter” arguments:
const MyConst = 1024;
var main()
{
Bffr(3,MyConst);
}
Within time slice based Analyzing Scripts, “const” can be used only for global constants (it is not possible to
create a constant within the main() function, because this would mean to create a new constant each time slice,
which would rather not be a constant then).
Within sequential Analyzing Scripts, “const” can be used at any place.
2.4.3.11.4 Functions
2.4.3.11.4.1 Overview
There are five kinds of functions available:

 Internal Operators
 Internal Functions
 Built-in Analyzing Functions
 User-defined User Functions
 Local Functions
English
Release 2018-06 92 / 866
2.4.3.11.4.2 Internal Operators
2.4.3.11.4.2.1 Overview
Internal operators can be used in order to access frequently used operations in a fast way. The following inter-
nal operators are available:
 Arithmetic Operators
 Compound Assignment Operators
 Logical Operators
 Comparison Operators
 Other Operators
2.4.3.11.4.2.2 Arithmetic Operators
The following arithmetic operators are available:

 + (addition)
 - (subtraction)
 * (multiplication)
 / (division)
 % (modulo)
 ++ (as prefix increment and as postfix increment)
 -- (as prefix decrement and as postfix decrement)
 + (unary plus)
 - (unary minus)
Example:
var main()
{
var Value = 0;
$'Add' = $'My offline Data' + 10.0; // addition

$'Sub' = $'My offline Data' - 3; // subtraction
$'Mul' = $'My offline Data' * $'Sub'; // multiplication
$'Div' = $'My offline Data' / $'My offline Data'; // division
$'Mod' = $'My offline Data' % 50; // modulo
Value++; // postfix increment

++Value; // prefix increment
Value--; // postfix decrement
--Value; // prefix decrement
Value = +1; // unary plus

Value = -1; // unary minus
}
English
Release 2018-06 93 / 866
2.4.3.11.4.2.3 Compound Assignment Operators
The following compound assignment operators are available:

 += (addition assignment)
 -= (subtraction assignment)
 *= (multiplication assignment)
 /= (division assignment)
Example:
var main()
{
var Value = $'My offline Data';
Value += 10.0; // addition

Value -= 3; // subtraction
Value *= 3; // multiplication
Value /= 7; // division
$'My offline Data 66' = Value;

}
2.4.3.11.4.2.4 Logical Operators
The following logical operators are available:

 ! (negation)
Example:
var main()
{
var Value = 0;
Value = !Value; // negation

}
2.4.3.11.4.2.5 Comparison Operators
The following comparison operators are available:

 == (equal to)
 != (not equal to)
 > (greater than)
 >= (greater than or equal to)
 < (smaller than)
 <= (smaller than or equal to)
English
Release 2018-06 94 / 866
Example:
var main()
{
var Value = $'My offline Data';
Print(FrmtStr("Value is: {0}",Value;));
if(Value==5)
{
Print("Value is equal to 5");
}
if(Value!=5)
{
Print("Value is not equal to 5");
}
if(Value>5)
{
Print("Value is greater than 5");
}
if(Value>=5)
{
Print("Value is greater than or equal to 5");
}
if(Value<5)
{
Print("Value is smaller than 5");
}
if(Value<=5)
{
Print("Value is smaller than or equal to 5");
}
}
English
Release 2018-06 95 / 866
2.4.3.11.4.2.6 Other Operators
The following other operators are available:

 [] (array subscript)
 | (concatenation)
 |= (concatenation assignment)
Example:
var main()
{
var Array[4] = {0,2,4,6}; // declaration of an array
var String = "Hello " | "World"; // concatenation
var i;
for(i=0;i<4;i++)
{
Print(FrmtStr("Index: {0}, Value: {1}",i,Array[i];)); // array subscript
}
String |= "!!!"; // concatenation assignment

Print(String); // outputs "Hello World!!!"
}
2.4.3.11.4.3 Internal Functions
2.4.3.11.4.3.1 Overview
The following internal functions are available:

 Print()
 Implicit Inputs
 Implicit Outputs
2.4.3.11.4.3.2 Print()
Example:
var main()
{
if(IsDataPrsnt($'My offline Data'))
{
Print("The following data is present: 'My offline Data'");
}
else
{
Print("The following data is not present: 'My offline Data'");
}
}
English
Release 2018-06 96 / 866
In combination with the Analyzing Function FrmtStr(), Print() also can output current data values to the system
log:
var main()
{
var LastValue;
var MyPI = 3.1415927;
if( IsDataPrsnt($'My offline Data') )

{
LastValue = GetVFrmSD($'My offline Data');

Print(FrmtStr("Last value: {0}, PI: {1}",LastValue,MyPI;));
}
}
2.4.3.11.4.3.3 Implicit Inputs
Whenever the name of an online or offline data in form ~'My online Data' or $'My offline Data' is
being used as input directly, an implicit input is being called. Internally, the according Analyzing Function (e.g.
In(), InB1D(), InB2D(), …) is being used with default parameters in order to read the values of the data from the
system.
The following Analyzing Script uses implicit inputs:
var main()
{
}
The above Analyzing Script is equivalent to the following one, which calls the Analyzing Function In() explicitly:
var main()
{
var Data = In("My online data");
}
Using of implicit inputs is very useful in case reading of data values from the system shall be performed with the
default settings of the input Analyzing Function. Explicit calling of the input Analyzing Function allows to modify
the default settings of the input Analyzing Function and also allows to elegantly switch the Analyzing Script be-
tween operating on online or offline data.
2.4.3.11.4.3.4 Implicit Outputs
Whenever the name of an online or offline data in form ~'My online Data' or $'My offline Data' is
being used as output directly, an implicit output is being called. Internally, the according Analyzing Function (e.g.
Out(), OutB1D(), OutB2D(), …) is being used with default parameters in order to write the values of the data to
the system.
The following Analyzing Script uses implicit inputs:
var main()
{
var Data = GenWF();
~'My online Data' = Data;
}
English
Release 2018-06 97 / 866
The above Analyzing Script is equivalent to the following one, which calls the Analyzing Function Out() explicitly:
var main()
{
var Data = GenWF();
Out("My online Data",Data);
}
Using of implicit outputs is very useful in case writing of data values to the system shall be performed with the
default settings of the output Analyzing Function. Explicit calling of the output Analyzing Function allows to
modify the default settings of the output Analyzing Function and also allows to elegantly switch the Analyzing
Script between operating on online or offline data.
2.4.3.11.4.4 Built-in Analyzing Functions
The built-in Analyzing Functions which are available at each X-Tools Server are found within the ANS Explorer
in the following path:
 Main -> Servers -> YourServerName -> Libraries -> Analyzing Functions
The following example shows how to call a built-in Analyzing Function:
var main()
{
$'Output Data' = Abs($’My offline Data');
}
The “,” character separates the single arguments which are passed to an Analyzing Function. Some Analzying
Functions (e.g. Add(), …) accept a variable number of input arguments. At the end of the last value of a variable
input argument, the “;” character must be placed instead of the standard “,” in order to tell the Analyzing Script
that the following value will belong to the following argument (instead of being another value of the current, vari-
able argument):
var main()
{
$'Output Data' = Add($’My offline Data',10;true);
}
In case of Analyzing Functions which return more than one output, the variables for all except the first output
must be provided as additional parameters:
var main()
{
var bNQ, bQ;
bQ = RSFF($’Binary Data 1’,$’Binary Data 2’,true,bNQ);
// output the values of bQ and bNQ

Out("Q",bQ,true,"","","Boolean");
Out("QN",bNQ,true,"","","Boolean");
}
Arguments at the end of a called Analyzing Function can be omitted when they are not needed. The default
value is being used for each argument which has not been passed explicitly.
English
Release 2018-06 98 / 866
2.4.3.11.4.5 User-defined User Functions
The user-defined User Functions which are available at each X-Tools Server are found within the ANS Explor-
er in the following path:
 Main -> Servers -> YourServerName -> Libraries -> User Functions
The syntax for using of User Functions and the rest of the behavior of User Functions is identical to the usage of
Analyzing Functions:
var main()
{
MyFFT("NameOfMyInputData");
}
2.4.3.11.4.6 Local Functions
Local functions are available only in sequential Analyzing Scripts. They can be used in order to maintain func-
tionalities which are used by several places within the Analyzing Script:
var Normalize(var InputData, var OutputData, var M, var B)
{
var NormalizedData;
// get the input data from the system and normalize it

NormalizedData = In(InputData) * M + B;
// output the calculated data to the system

Out(OutputData,NormalizedData);
}
var main()
{
Normalize("NameOfMyInputData1","NameOfMyOutputData1",10.0,5.0);
Normalize("NameOfMyInputData2","NameOfMyOutputData2",20.0,0);
}
Local functions also can return a value or data to their caller. The example from above can be realized also like
this:
var Normalize(var InputData, var M, var B)
{
// get the input data from the system, normalize it and return the result
return In(InputData) * M + B;
}
var main()
{
$'NameOfMyOutputData1' = Normalize("NameOfMyInputData1",10.0,5.0);
$'NameOfMyOutputData2' = Normalize("NameOfMyInputData2",20.0,0);
}
It also is possible to include local functions from other Analyzing Scripts via the #include statement (see point
2.4.3.11.7).
English
Release 2018-06 99 / 866
2.4.3.11.5 Conditional Statements
2.4.3.11.5.1 Overview
The following conditional statements are available:

 if() - else
 switch()
2.4.3.11.5.2 if() - else
Example:
var main()
{
{
// this branch is entered in case the expression within the brackets of if() is not 0 (true)
}
else
{
// this branch is entered in case the expression within the brackets of if() is 0 (false)
Print("The following data is not present: 'My offline Data'");
}
}
The “else“ branch is not necessary and can be omitted, like in the following example:
var main()
{
{
}
}
The behavior of the “if()” statement can be different between the time slice based and sequential operating
modes. For example, the following Analyzing Script can not run in time-slice based operating mode because in
theory the condition of “if()” (= true or false) could change with each time slice, in which case there would be two
different output Analyzing Functions which would want to write to the same data of the system:
var main()
{
var Rand = Random(0,10);
var Data1 = $'My offline Data 1';
if(Rand<5)
{
Out("My offline Data",Data1);
}
else
{
Out("My offline Data",Data2);
}
}
English
Release 2018-06 100 / 866
Contrary, the same Analyzing Script runs perfectly in sequential operating mode, because the sequential Ana-
lyzing Script is running only once from the beginning to its end, thus it processes either only the “if()” or only the
“else” branch and only one of them needs to output data to the system.
In order to run the above Analyzing Script in time slice based operating mode, the two outputs must write to
different data. Example:
var main()
{
var Rand = Random(0,10);
if(Rand<5)
{
Out("My offline Data 1",Data1);
}
else
{
Out("My offline Data 2",Data2);
}
}
2.4.3.11.5.3 switch()
The “switch()” statement can be used in order to execute different execution paths depending to the current
value of the provided condition. Example:
var main()
{
var Value = Round(Random(1,10));
switch(Value)
{
case 1:
{
// we end up here in case "Value" contains "1"
Print("Current Value: 1");
break;
}
case 2:
{
// we end up here in case "Value" contains "2"
Print("Current Value: 2");
break;
}
default:
{
// we end up here in case "Value" contains anything else
Print(FrmtStr("Current Value: {0}",Value));
break;
}
}
}
At the end of each “case” branch, typically the “break” condition must be placed. In case “break” is missing, the
execution continues automatically with the following “case” branch. The “default” branch can be used in order to
handle all values which are not handled by any of the previous “case” branches.
English
Release 2018-06 101 / 866
2.4.3.11.6 Loops
2.4.3.11.6.1 Overview
The following loops are available:

 for()
 while()
 do - while()
Like conditional statements, also loops can show different behavior depending to whether they are used in time
slice based operating modes or in the sequential operating mode. Generally speaking, most applications which
include loops are based on sequential operating modes, because for time slice based Analyzing Scripts the
usage of loops is more limited. Examples:
 Reading from or writing to buffers. As the size of the internal buffers can not change, time slice based
Analyzing Scripts may run into invalid states. Contrary, sequential Analyzing Scripts do the read-
ing/writing only once, thus they can’t run into this issue.
 Variable data names. In case the name of the output data is created by some Analyzing Function within
the Analyzing Script, each time slice could create another data name. Within sequential Analyzing Scripts
this is less possible because the whole Analyzing Script is being processed only once.
2.4.3.11.6.2 for()
The “for()” loop can be used in order to run a certain amount of interations. Within the brackets, three parame-
ters are passed to “for()” - the semicolon (“;”) is being used in order to separate these three parameters:
 the first parameter contains the initial value of the to-be-examined variable
 the second parameter contains the break condition, how long the loop shall run (the loop runs as long as
this condition returns not 0 (not 0 = true))
 the third parameter can be used in order change the to-be-examined variable automatically at the end of
each loop
The following example shows how to use a “for()” loop in order to automatically process several input which
contain a counter as part of their name (the names of the present input data must be “My offline Data 1”, “My
offline Data 2”, “My offline Data 3” and “My offline Data 4” for running of the following example - the Analyzing
Script automatically generates the data names for each iteration):
var main()
{
var i;
var InputData;
var OutputData;
for(i=1;i<=4;i++)
{
// prepare the names of the input and output data for this interation of the loop
InputData = FrmtStr("My offline Data {0}",i;);
OutputData = FrmtStr("My result {0}",i;);
// do something with the determined input and output data

Out(OutputData,In(InputData));
}
}
English
Release 2018-06 102 / 866
Instead of a predefined, hard-coded value, also variables can be used for the parameters of the “for()” loop:
var main()
{
var i;
var Start = Round(Random(1,2));
var Max = Round(Random(3,4));
var InputData;
var OutputData;
for(i=Start;i<=Max;i++)
{

}
}
There also can be cases where the condition to abort the loop is not known at the line when the “for()” is config-
ured. For such cases, the “break” instruction can be used anywhere within the “for()” loop in order to exit the
loop immediately:
var main()
{
var i;
var InputData;
var OutputData;
{
if(i>4)
{
// this instruction jumps out of the loop
break;
}

}
}
English
Release 2018-06 103 / 866
In addition to “break”, also “continue” can be called within a “for()” loop. Instead of jumping out from the “for()”
loop, “continue” jumps back to the beginning of the loop:
var main()
{
var i;
var InputData;
var OutputData;
{
if(i%2)
{
// only each second data will be processed by this loop
continue;
}

}
}
The break condition (second parameter) of the “for()” loop also can be omitted. In this case, the “for()” loop can
be left either via a “break” condition or the Analyzing Script suspends at some moment, like in the following
case:
var main()
{
var i;
var BufferMember;
var Value;
for(i=0;;i++)
{
// we will suspend when i becomes bigger than the highest index of the buffer
BufferMember = GetBffrM($'H1D 02 H1DForSignal',true,i);
Value = GetVFrmSD(BufferMember);
Print(FrmtStr("Index: {0}, Value: {1}",i,Value;));

}
}
English
Release 2018-06 104 / 866
2.4.3.11.6.3 while()
The “while()” loop can be used in order to run until a certain condition is met.
The following example shows how to use a “while()” loop in combination with a simple counter variable:
var main()
{
var Array[4] = {0,2,4,6};
var i=0;
while(i<4)
{
Print(FrmtStr("Index: {0}, Value: {1}",i,Array[i];));
i++;
}
}
A more typical case for the usage of “while()” are checks of a simple status:
var main()
{
var Value = GetVFrmSD($'My offline Data');
while(Value <= 100)

{
// this will loop until the last value of the input data is above 100
$'My offline Data' = $'My offline Data' +10;
Value = GetVFrmSD($'My offline Data');
Print(FrmtStr("Current Value: {0}",Value;));

}
Print("We are done");

}
The “break” and “continue” statements are available also for the “while()” loop. They work in the same way as
for the “for()” loop:
 “break” jumps out of the current loop
 “continue” jumps back to the beginning of the current loop - depending to whether the break condition is
reached or not, the loop is executed again (or not)
English
Release 2018-06 105 / 866
2.4.3.11.6.4 do - while()
The “do - while()” loop is very similar to the “while()” loop and also can be used in order to run until a certain
condition is met. The main difference is that “while()” checks the break condition BEFORE the first run of the
internal loop and “do - while()” checks the break condition AFTER the first run of the internal loop.
The following example shows how to use a “do - while()” loop in combination with a check of a simple status:
var main()
{
var Value = GetVFrmSD($'My offline Data');
do
{
// this will loop until the last value of the input data is above 100
$'My offline Data' = $'My offline Data' +10;
Value = GetVFrmSD($'My offline Data');
Print(FrmtStr("Current Value: {0}",Value;));

}while(Value <= 100)
Print("We are done");

}
The “break” and “continue” statements are available also for the “do - while()” loop. They work in the same way
as for the “for()” and “while()” loops:
 “break” jumps out of the current loop
 “continue” jumps back to the beginning of the current loop - note that there is no break condition to check
at this point, thus the execution of the inner loop will start for sure after each call of “continue”
2.4.3.11.7 Includes
2.4.3.11.7.1 Overview
#include statements can be placed at the beginning of each Analyzing Script. They can be used in order to in-
clude variables, constants and functions which are present in any other Analyzing Script. The included varia-
bles, constants and functions are handled as if they would be part of the Analyzing Script which contains the
#include statement.
The following examples show how the #include statement can be used:
 #include “://Common Includes/My Great Types.asf.xts”
 #include “Include Location://My Great Functions.asf.xts”
Refer to the measurement tasks chapter “#include within Analyzing Scripts” for an example about how to use
#include statements within Analyzing Scripts.
2.4.3.11.8 Fast Analysis Scripts
Fast Analysis Scripts offer an additional syntax for passing of variable input data (see point 2.4.3.11.3.5).
In addition, the Analyzing Function ChkNoP() (see point 2.6.5.1) has been designed for Fast Analysis Scripts.
This Analyzing Function can be used in order to check whether the current number of passed input data match-
es the amount of data which is expected by the Analyzing Function. In case the amount of passed input data
does not match the amount of expected input data, the Fast Analysis Script is stopped with an according log
entry. When ChkNoP() is used within a Fast Analysis Script, it should be called as first function.
English
Release 2018-06 106 / 866
2.4.3.11.9 Provided Parameters
For Analyzing Scripts which provide parameters, the %’’ syntax for passing of values is used (see point
2.4.3.11.3.6).
2.5 User Function Editors
2.5.1 Overview
User Function Editors are used in order to edit User Functions. User Functions can be used in order to com-
bine multiple (Analyzing and User) functions to a new entity. Multiple User Functions can be maintained and/or
executed within Analyzing Models and Analyzing Scripts simultaneously.
User Function Editors are known and accessed exclusively by the X-Tools Client, the X-Tools Server has no
knowledge about User Function Editors at all. However, the X-Tools Server is responsible to maintain User
Function Files and therefore all User Function reading and writing operations are performed via the X-Tools
Server.
2.5.2.1 Overview
As all User Function Editors are built up in a similar way, they share some common controls (e.g. tables and
the menu bar) which are the same in all User Function Editors.
Each control of a User Function Editor has a defined task and provides certain functionalities. The following
major controls are provided by the User Function Editors. Depending to the User Function Editor, one or
more parts may not be supported (because they are not needed) and one or more parts may be present in addi-
tion to the following ones (because they are necessary):
 Menu Bar
 User Function Settings Table
 User Function Parameters Table
 User Function Properties Table
 Provided Input Interfaces Table
 Provided Output Interfaces Table
English
Release 2018-06 107 / 866
2.5.2.2 Menu Bar
The Menu Bar provides direct access to the functionality of each User Function Editor.
New creates a new, empty User Function and initializes the User Function Settings table with the de-
fault values for new User Functions
Save saves the currently opened User Function to the currently known storage location
Add Input Interface adds the currently selected input argument as input interface of the User Function
Go to Input Interface highlights the row within the Provided Input Interfaces table which belongs to the currently select-
ed input argument
Remove Input Interface removes the currently selected input argument as input interface of the User Function
Add Output Interface adds the currently selected output argument as output interface of the User Function
Go to Output Interface highlights the row within the Provided Output Interfaces table which belongs to the currently se-
lected output argument
Remove Output Interface removes the currently selected output argument as output interface of the User Function
Go to Definition highlights the input or output argument which belongs to the currently selected row from the Pro-
vided Input Interfaces table or Provided Output Interfaces table
Convert to Analyzing Model converts the currently opened User Function into an Analyzing Model and initializes it with the
default values within a new Analyzing Model Editor
Print Report prints a report about the currently opened User Function
Save Report saves a report about the currently opened User Function to the file system
the storage location of the saved report is written to the system log of the X-Tools Client

Move up moves the currently selected row(s) of the Provided Input Interfaces table or Provided Output
Interfaces table up
Move down moves the currently selected row(s) of the Provided Input Interfaces table or Provided Output
Interfaces table down
Remove removes the currently selected row(s) of the Provided Input Interfaces table or Provided Output
Interfaces table
English
Release 2018-06 108 / 866
The following functionality is available via the Function menu:

Remove removes the currently selected item(s)
Reassign Sequence IDs automatically reassigns the sequence IDs of all present functions automatically so that the sequence IDs are
rising from the input Analyzing Functions to the output Analyzing Functions
Reroute Links automatically reroutes the currently selected link(s) or all of the currently present links
Zoom Factor > … sets the zoom factor



Size > … changes the size of the User Function Editor
2.5.2.3 User Function Settings Table
The User Function Settings table contains all of the function-dependent settings which can be configured within
a User Function:
Target Name contains the name of the target to which the User Function is stored
Storage Path contains the path to which the User Function is stored (absolute or symbolic path)
Creation Date contains the creation date of the User Function
Modification Date contains the last modification date of the User Function
Function Description contains the description of the User Function
Target Name
English
Release 2018-06 109 / 866
2.5.2.4 User Function Parameters Table
The User Function Parameters table contains all of the function-dependent parameters which can be configured
within a User Function:
Enable Log Messages allows to enable or disable log the messages which are output by the (Analyzing and User) func-
tions within the parent User Function
Password contains the password of the User Function which must be specified in order to open the User
Function within a User Function Editor
Password (confirm) contains the password of the User Function (for confirmation) which must be specified in order to
open the User Function within a User Function Editor
Password
In case a password is specified for a User Function, the password must be provided before the contents of the
User Function File are transmitted to the X-Tools Client. Contrary, the X-Tools Server always can access the
User Function File, thus also a password-protected User Function can be used and runs within its parent Ana-
lyzing Model or Analyzing Script without any need to provide a password.
2.5.2.5 User Function Properties Table
The User Function Properties table contains all of the properties which can be configured within a User Func-
tion:
Full Name allows to enter the full name of the User Function
Short Name allows to enter the short name of the User Function
Description allows to enter the description of the User Function
Parent Category allows to enter the parent category of the User Function
Parent Library contains the parent library of the User Function
Equidistant Inputs contains information about whether the User Function requires equidistant inputs
Supported Operating Modes contains information about the operating modes which are supported by the User Function
Full Name
The Full Name of the User Function must be unique among all User Functions which are present at the X-Tools
Server. In addition, the Full Name must not match the Full Name of any Analyzing Function which is present at
the X-Tools Server.
Short Name
The Short Name of the User Function must be unique among all User Functions which are present at the X-
Tools Server. In addition, the Short Name must not match the Short Name of any Analyzing Function which is
present at the X-Tools Server.
Parent Category
The Parent Category is being used in order to group all User Functions of identical Parent Category together
below the “Main -> Servers -> YourServer -> Libraries -> User Functions” branch of the ANS Explorer.
English
Release 2018-06 110 / 866
2.5.2.6 Provided Input Interfaces Table
The Provided Input Interfaces table contains all of the input interfaces which have been configured within a User
Function:
Full Name allows to enter the full name of the input interface
Short Name allows to enter the short name of the input interface
Unit allows to enter the unit of the input interface
Description allows to enter the description of the input interface
Default Value allows to enter the default value of the input interface
Parent Function contains the parent Function of the input interface
Parent Argument contains the parent argument of the input interface
Sequence ID contains the sequence ID of the parent Function
Full Name
The Full Name of each input interface must be unique among the input and output interfaces of the User Func-
tion.
Short Name
The Short Name of each input interface must be unique among the input and output interfaces of the User
Function.
Context Menu
The following context menu items are provided by the Provided Input Interfaces table:
Move up moves the selected input interface(s) one row up
Move down moves the selected input interface (s) one row down
Go to Definition centers the Function for which the input interface from which the context menu has been called is
assigned and highlights the argument which belongs to the input interface
Remove removes the currently selected input interface (s)
2.5.2.7 Provided Output Interfaces Table
The Provided Output Interfaces table contains all of the output interfaces which have been configured within a
User Function:
Full Name allows to enter the full name of the output interface
Short Name allows to enter the short name of the output interface
Unit allows to enter the unit of the output interface
Description allows to enter the description of the output interface
Default Value allows to enter the default value of the output interface
Parent Function contains the parent Function of the output interface
Parent Argument contains the parent argument of the output interface
Sequence ID contains the sequence ID of the parent Function
Full Name
The Full Name of each output interface must be unique among the input and output interfaces of the User Func-
tion.
Short Name
The Short Name of each output interface must be unique among the input and output interfaces of the User
Function.
English
Release 2018-06 111 / 866
Context Menu
The following context menu items are provided by the Provided Output Interfaces table:
Move up moves the selected output interface(s) one row up
Move down moves the selected output interface (s) one row down
Go to Definition centers the Function for which the output interface from which the context menu has been called
is assigned and highlights the argument which belongs to the output interface
Remove removes the currently selected output interface (s)
2.5.3 UFE Standard T001
2.5.3.1 Overview
The UFE Standard T001 is used in order to visualize, create and edit User Functions of type “Standard T001”.
Multiple editors of this type can be opened and used simultaneously.
The following screenshot shows an example of an UFE Standard T001:
Figure 15: Example of a UFE Standard T001
English
Release 2018-06 112 / 866
Each control of the UFE Standard T001 has a defined task and provides certain functionalities. The following
major controls are provided by the UFE Standard T001:
 Menu Bar
 User Function Settings Table
 User Function Parameters Table
 User Function Properties Table
 Provided Input Interfaces Table
 Provided Output Interfaces Table
 Action Area
 Analyzing Function Properties Dialog
 User Function Properties Dialog
2.5.3.2 Menu Bar
The standard Menu Bar is being used by the UFE Standard T001 (see point 2.5.2.2).
2.5.3.3 User Function Settings Table
The standard User Function Settings table is being used by the UFE Standard T001 (see point 2.5.2.3).
2.5.3.4 User Function Parameters Table
The standard User Function Parameters table is being used by the UFE Standard T001 (see point 2.5.2.4).
2.5.3.5 User Function Properties Table
The standard User Function Properties table is being used by the UFE Standard T001 (see point 2.5.2.5).
2.5.3.6 Provided Input Interfaces Table
The standard Provided Input Interfaces table is being used by the UFE Standard T001 (see point 2.5.2.6).
2.5.3.7 Provided Output Interfaces Table
The standard Provided Output Interfaces table is being used by the UFE Standard T001 (see point 2.5.2.7).
2.5.3.8 Action Area
The Action Area contains all of the (Analyzing and User) functions and links of the current User Function. Via
Drag&Drop, the currently present functions and links can be edited and additional functions and links can be
added to the User Function.
The zoom factor can be set to values from 10 to 100 %. In case zoom factor of “automatic” is chosen, the UFE
Standard T001 always attempts to choose a zoom factor where all of the present functions fit into the available
space.
English
Release 2018-06 113 / 866
Symbol of Functions
Each present function is represented by a graphical symbol which provides the following information:
 name of the function
 sequence ID
 names of all input arguments
 names of all output arguments
The symbol of each function is divided into an upper and a lower rectangle. Different colors are used for the
background of the upper rectangle in order to divide Analyzing Functions and User Function. The background
color of the lower rectangle is typically blue - however, in case of Functions whose interface definitions are out-
dated, the background of the lower rectangle is highlighted with red color. The following examples show differ-
ent symbols of Functions:
Figure 16: Example of an Analyzing Function
Figure 17: Example of a User Function
Figure 18: Example of an Analyzing Function with outdated Interface Information

In case the interface information of a Function is out of date, the UFE Standard T001 asks whether it shall up-
date the according User Function whenever it is opened. After the automatic update through the UFE Standard
T001, the interface information is corrected and the Function is displayed with the blue lower rectangle again. In
order to correct a User Function manually, all Functions which are out of date must be removed and replaced
through their current versions from the ANS Explorer.
In case the mouse cursor is stopped above a function, a tool tip is displayed after a few moments. Independent-
ly to the current zoom factor, the tool tip always shows the below function with a zoom factor of 100 % and also
provides detailed information about the values/connections of each input and output argument.
English
Release 2018-06 114 / 866
Symbol of Group Boxes

Each present group box is displayed with the currently configured text, frame and background.
The following example shows different group boxes:
Figure 19: Example of Group Boxes within the UFE Standard T001
Keyboard Operations
<F2> in case an input argument of a <F2> allows editing the value of the input argument directly within the Action Area of the User
function has the input focus Function Editor. Depending to the type of the input argument, an edit box or a combo box is
being displayed during the edit.
<Cursor Up> in case an input argu- moves the input focus one argument up
ment of a function has the input focus
<Cursor Down> in case an input ar- moves the input focus one argument down
gument of a function has the input
focus
<+> zooms into the Action Area
<-> zooms out of the Action Area
<F> <F> fits the scaling of the Action Area
<Ctrl> + <C> copies the currently selected items
<Ctrl> + <X> cuts the currently selected items
<Ctrl> + <V> pastes the currently copied/cut items
<Ctrl> + <A> select all items
<Del> deletes the currently selected items
English
Release 2018-06 115 / 866

single click with releasing the button A single click of the left mouse button with releasing the button above an item (function, link or
group box) selects or deselects the item below the current mouse position:
 <Ctrl> can be used in order to select/deselect multiple items one after the other
single click with keeping the button A single click of the left mouse button above a link starts to move the line or corner of the link
above a link manually:
 [left mouse button down] + [mouse move] moves the line or corner
 <Esc> cancels the current operation and keeps the original position of all lines of the af-
fected links
above a selected item or copy operation. The actual moving or copying is performed when the mouse is moved:
 [left mouse button down] + [mouse move] moves all currently selected items within the Ac-
tion Area into the direction of the mouse move
 <Esc> cancels the current operation and moves all items back to the positions which they
not above a selected item select operation. The actual selecting is performed when the left mouse button is released:
 [left mouse button down] + [mouse move] highlights all items which are within the area in
between the mouse position at the start of the select operation and the current mouse posi-
tion
o during the mouse move and before the left mouse button is being released, a rectan-
gular frame indicates the area of selection
o all items which are completely enclosed by the rectangular frame are highlighted in or-
der to show which items will be selected when the left mouse button is being released
 <Esc> cancels the current operation and sets the selection of all items back to the state
which they had before the selecting operation had been started
double click onto an Analyzing Func- A double click of the left mouse button onto any Analyzing Function opens the Analyzing Func-
tion tion Properties dialog for the Analyzing Function below the current mouse position.
double click onto an Analyzing Func- A double click of the left mouse button onto any argument of an Analyzing Function opens the
tion argument Analyzing Function Properties dialog for the Analyzing Function below the current mouse posi-
tion and sets the input focus to the value field of the clicked argument.
double click onto a User Function A double click of the left mouse button onto any User Function opens the User Function Proper-
ties dialog for the User Function below the current mouse position.
double click onto a User Function A double click of the left mouse button onto any argument of a User Function opens the User
argument Function Properties dialog for the User Function below the current mouse position and sets the
input focus to the value field of the clicked argument.
double click onto a group box A double click of the left mouse button onto a group box opens the Edit Group Box dialog for the
group box below the current mouse position and puts the value of the Text parameter into editing
mode.
Operations via the Right Mouse Button

The following operation can be performed via the right mouse button:
single click with releasing the button A single click of the right mouse button with releasing the button somewhere within the Action
Area opens the context menu for the below item.
Drag&Drop of a (Analyzing or User) Function

When a function is dragged into the Action Area, the size and position of the new function is visualized to the
user during the Drag&Drop operation. After the drop of the dragged function, the dragged function is inserted at
the specified position within the Action Area.
In case multiple functions are being selected simultaneously and dragged into the Action Area, the Action Area
processes all selected functions during the Drag&Drop operation and all functions are being inserted into the
Action Area simultaneously.
English
Release 2018-06 116 / 866
Drag&Drop of Data
dropping of data into empty space When data is dropped into empty space of the Action Area, a proper input Analyzing Function,
which fits the data type of the dragged data, is searched automatically. In case a proper input
Analyzing Function is available, the Drag&Drop operation behaves as if the determined input Ana-
lyzing Function would be dropped. After the drop of the dragged data, the determined input Ana-
lyzing Function is inserted and the name of the dropped data is added as input for the new Ana-
lyzing Function automatically.
dropping of data into an unclassified When data is dropped into an unclassified User Function (= an User Function whose default data
User Function class has not been set to online or offline yet), the default data class (online or offline) of the un-
classified User Function is set to the class of the dragged data (online or offline) automatically. In
addition, the output time domain (absolute or relative times) of the unclassified User Function is
set to the time domain of the dragged data automatically.
dropping of data of different classes User Functions allow to use online and offline data simultaneously (e.g., a neural cloud (Analyzing
or User) function may perform its confidence calculation for online data based on some key values
that are available as offline data). Via the standard, textual online/offline identifiers of the system,
the user can override the default data class of the User Function when a textual online/offline
identifier is being used for the specification of an input data name.
Creation of Links between (Analyzing or User) Functions

In order to create a link from the output argument of one function to the input argument of another function, click
onto one of the to-be-connected arguments first and onto the second one afterwards. After the first to-be-
connected argument has being clicked, all of the available target arguments of all functions within the User
Functions Editor are being highlighted automatically.
Sequence IDs
Each (Analyzing or User) function receives a unique sequence ID which determines when it is being called dur-
ing the processing of one cycle:
 the function with the lowest sequence number is being called first
 the function with the highest sequence number is being called last
The sequence ID of each function can be assigned via the Analyzing Function Properties and User Function
Properties dialogs. In addition, the sequence IDs can be re-assigned in the following ways:
 automatically
o reassigns the sequence IDs of all present functions automatically so that the sequence IDs are rising
from the input Analyzing Functions to the output Analyzing Functions
 manually
o the present Analyzing Functions can be clicked one after the other in order to assign rising sequence
IDs to them
o in case the manual assignment of sequence IDs is started from a present Analyzing Function, the next
clicked Analyzing Function receives a sequence ID which is 1 higher than the sequence ID of the Ana-
lyzing Function from which the manual assignment was started
o the manual assignment of sequence IDs is ended in the following cases:
 when the last sequence ID of the current User Function has been assigned
 after <Esc> has been pressed
 in case a mouse click is performed into empty space
 in case the User Function Editor looses the input focus
 in case a context menu is opened
English
Release 2018-06 117 / 866
Context menu of a single Analyzing Function

Cut cuts the currently selected Analyzing Function
Copy copies the currently selected Analyzing Function
Remove removes the currently selected Analyzing Function
Expand expands the Analyzing Function (displays the full names of all arguments)
Collapse collapses the Analyzing Function (displays the short names of all arguments)
Show Values of Inputs > … sets whether the values of the input arguments of the currently selected Analyzing Functions shall
be displayed within the Action Area
Analyzing Function Properties… opens the Analyzing Function Properties dialog
Context menu of a single User Function

Cut cuts the currently selected User Function
Copy copies the currently selected User Function
Remove removes the currently selected User Function
Expand expands the User Function (displays the full names of all arguments)
Collapse collapses the User Function (displays the short names of all arguments)
Show Values of Inputs > … sets whether the values of the input arguments of the currently selected User Functions shall be
displayed within the Action Area
User Function Properties… opens the User Function Properties dialog
Open… opens a new User Funciton Editor and opens the User Function within this User Function Edi-
tor
Context Menu of a single Input Argument of a (Analyzing or User) Function

Add Input Interface adds the currently selected argument to the Provided Input Interfaces table
Go to Input Interface maximizes the Provided Input Interfaces table and highlights the input interface which belongs to
the cell from which the context menu has been called
Remove Input Interface removes the currently selected argument from the Provided Input Interfaces table
Context Menu of a single Output Argument of a (Analyzing or User) Function

Add Output Interface adds the currently selected argument to the Provided Output Interfaces table
Go to Output Interface maximizes the Provided Output Interfaces table and highlights the output interface which belongs
to the cell from which the context menu has been called
Remove Output Interface removes the currently selected argument from the Provided Output Interfaces table
Context Menu of a single Link

Reroute Link automatically reroutes the link from which the context menu has been called
Remove removes the currently selected link
English
Release 2018-06 118 / 866
Context menu of a single Group Box

Group > cuts/copies/removes the group box together with all of its contained items (Analyzing Functions,
User Functions and group boxes)
Group Box > cuts/copies/removes the group box but does not cut/copy/remove any of the contained items
(Analyzing Functions, User Functions and group boxes)
Edit Group Box … opens the Edit Group Box dialog
Context Menu of multiple selected Items

Cut cuts the currently selected items
Copy copies the currently selected items
Remove removes the currently selected items
Expand expands the (Analyzing and User) functions (displays the full names of the functions and of all of
their arguments)
Collapse collapses the (Analyzing and User) functions (displays the short names of the functions and of all
of their arguments)
Show Values of Inputs > … sets whether the values of the input arguments of the currently selected functions shall be dis-
played within the Action Area
Analyzing Function Properties… opens the Analyzing Function Properties dialog of the Analyzing Function from which the
context menu has been called
User Function Properties… opens the User Function Properties dialog of the User Function from which the context menu
has been called
Context Menu of empty Space

Create Group Box creates a new group box with default size and position
English
Release 2018-06 119 / 866

User Function File Branches of type opens the dropped User Function
“AMF Standard T001”
Analyzing Function Branches in case creates a new User Function, initializes the target server to the parent server of the dragged Ana-
the UFE Standard T001 is empty lyzing Function and drops the Analyzing Function as seen above
User Function Branches in case the creates a new User Function, initializes the target server to the parent server of the dragged User
UFE Standard T001 is empty Function and drops the User Function as seen above
Offline Data Branches in case the creates a new User Function, initializes the target server to the parent server of the dragged of-
UFE Standard T001 is empty fline data and afterwards it drops the offline data as seen above
Online Data Branches in case the creates a new User Function, initializes the target server to the parent server of the dragged
UFE Standard T001 is empty online data and afterwards it drops the online data as seen above
the UFE Standard T001 contains an
User Function
User Function Branches in case the drops the User Function as seen above
UFE Standard T001 contains an
User Function
User Function
User Function
2.5.3.10 Analyzing Function Properties Dialog
2.5.3.10.1 Overview
The following screenshot shows an example of an Analyzing Function Properties dialog:
Figure 20: Example of an Analyzing Function Properties Dialog
English
Release 2018-06 120 / 866
2.5.3.10.2 Analyzing Function Properties Table
Sequence ID contains the sequence ID of the Analyzing Function
It is not possible to add or remove arguments to/from the Analyzing Function Properties table because each
Analyzing Function provides detailed information about all of its arguments by itself.
Dimension
In case of configurable arguments, the Dimension cell contains a combo box with the available dimensions.
In case of arguments which are not configurable, the Dimension cell contains the dimension as static text.
Value
Set to Default sets the value of the cell to its default value
2.5.3.11 User Function Properties Dialog
The appearing and functionality of the User Function Properties dialog is identical to the appearing and func-
tionality of the Analyzing Function Properties dialog (see point 2.5.3.10).
English
Release 2018-06 121 / 866
2.5.3.12 Edit Group Box Dialog
2.5.3.12.1 Overview
The following screenshot shows an example of an Edit Group Box dialog:
Figure 21: Example of an Edit Group Box Dialog
2.5.3.12.2 Group Box Parameters Table
The Group Box Parameters table contains the parameters of the to-be-edited group box:
Text allows to enter the text which shall be displayed within the group box
Horizontal Text Position allows to choose the horizontal position of the displayed text
Vertical Text Position allows to choose the vertical position of the displayed text
Text Color allows to choose the color of the displayed text
Text Size allows to choose the size of the displayed text
Frame Color allows to choose the color of the displayed frame
Frame Strength allows to choose the strength of the displayed frame
Background Color allows to choose the color of the displayed background
Text
The entered text can contain any characters. <Ctrl> + <Enter> can be used in order to insert multi-line texts.
There is no automatic wrapping of the text.
The entered text is not displayed outside the borders of its group box - in case the text does not fit into the cur-
rent dimensions of the group box, it is cut.
English
Release 2018-06 122 / 866
2.6 Analyzing Functions
2.6.1 General
2.6.1.1 Categories of Analyzing Functions
Each Analyzing Function is assigned to a category in order to group Analyzing Functions of similar purpose
together. These categories of Analyzing Functions are being used also by this manual in order to structure the
provided Analyzing Functions.
2.6.1.2 Properties of Analyzing Functions
Each Analyzing Function provides the following properties:

Property Description
Full Name specifies the full name of the Analyzing Function, e.g. “AbsoluteValue”
Short Name specifies the short name of the Analyzing Function, e.g. “Abs”
Description specifies the description of the Analyzing Function, e.g. “Calculates the absolute of the input data
or values.”
Parent Library specifies the parent library of the Analyzing Function, e.g. “Base”
Parent Category specifies the parent category of the Analyzing Function, e.g. “Arithmetic”
Equidistant Inputs indicates whether the Analyzing Function can work on base of not-equidistant input data or not; for
example, the AbsoluteValue() Analyzing Function can work on not-equidistant input data but the
Histogram1D() Analyzing Function can’t
Supported Operating Modes Indicates whether the Analyzing Function can work in time-slice based calculations and/or in se-
quential calculations:
 time-slice based calculations
o all calculation instructions (from the Analyzing Model or Analyzing Script) are executed
each defined time slice, like it is known from standard automation systems
o time-slice based calculations can be of output data class “online” or ”offline”
o the input data for time-slice based calculations can be online and/or offline data, based
on absolute and/or relative time stamps
o the time-slice based execution is continued endless (in case online data is being out-
put) or when the specified stop time has been reached (in case offline data is being
output)
 sequential calculations
o each defined calculation instruction (from the Analyzing Model or Analyzing Script) is
executed in the defined order and processes all input data at once
o sequential calculations can be only of output data class “offline”, based on absolute or
relative times
o the sequential execution is finished when all defined calculation instructions have been
executed once
English
Release 2018-06 123 / 866
2.6.1.3 Properties of Arguments of Analyzing Functions
Each argument of an Analyzing Function provides the following properties:

Full Name specifies the full name of the argument, e.g. “Input0”
Short Name specifies the short name of the argument, e.g. “In0”
Description specifies the description of the argument, e.g. “data or values whose absolute value shall be cal-
culated”
Direction indicates whether the argument is an input argument (which provides data to the Analyzing Func-
tion) or an output argument (which receives the result of the execution of the Analyzing Function)
Class Specifies the class of the argument, which can be one of the following:
 Data
o data arguments carry any kind of values, which can be either time series or single val-
ues
o data arguments are used in order to transport the values which are to be used for the
calculation
o data arguments can be used as input and/or as output arguments of Analyzing Func-
tions
o each data argument can be assigned/connected to other data arguments (via links or
variables)
o each data argument can be assigned/connected to control arguments (via links or vari-
ables)
 Parameter
o parameter arguments carry any kind of single values (no time series)
o the values are assigned by the user and the algorithm uses the specified values during
the calculation
o parameter arguments can be used as input arguments of Analyzing Functions
o parameter arguments are used for providing of unchangeable values (like the number
of points of the FFT(), …)
o a value of a parameter argument which has been modified through the user can be
taken over only in case its parent Analyzing Model/Analyzing Script is being stopped
and restarted
 Control
o control arguments carry any kind of values, which can be either time series or single
values
o control arguments are to be used in order to reset, enable or disable the actual execu-
tion of the calculation
o control arguments can be used as input and/or as output arguments of Analyzing
Functions
o each control argument can be assigned/connected to other control arguments (via links
or variables)
o each control argument can be assigned/connected to data arguments (via links or vari-
ables)
Default Value specifies the default value of the argument
Unit specifies the unit of the argument, if applicable
Configurable indicates whether the argument is configurable; configurable arguments allow to use up to the
specified number of sub-arguments; for example, the Addition() Analyzing Function can be config-
ured to provide 2 to 8 input arguments which are added together during the execution then
Supported Data Types specifies which data types can be attached to an input argument or which data type are provided
to an output argument
Allowed manual Inputs specifies the values or the value range which can be assigned to the argument manually
English
Release 2018-06 124 / 866
2.6.1.4 Internals
Analyzing Functions exchange information with each other via links (in case of Analyzing Models and User
Functions) or variables (in case of Analyzing Models). In addition to the obvious value (e.g. the result of the
calculation), also a status code and an event code are hold and provided through each link or variable.
The following status codes are defined:
Value Name Description
-1 not initialized this status code is present for all output arguments until the Analyzing Function has processed the first
cycle time
0 value is valid the calculation has been performed without errors or warnings
1 overflow an overflow has been detected during the calculation
2 underflow an underflow has been detected during the calculation
3 loss of accuracy a loss of accuracy has been detected during the calculation
4 division by zero a division by zero has been detected during the calculation
5 infinite result an infinite result has been detected during the calculation
6 undefined result an undefined result has been detected during the calculation
7 input out of range the value of an input is out of range
8 result not available there is no result available yet (e.g. because an Analyzing Function like Bffr() is still collecting values)
9 input not available the input (e.g. an online data, offline data or scalar data) is not available
10 function specific error a function specific error has been detected during the calculation
11 value not available the input does not provide a value for the current cycle time (e.g. because the current cycle time is before
the start time of the input, after the stop time of the input or at a point in time where the input has a gap)
12 disabled the Analyzing Function is disabled
Status codes are propagated from one Analyzing Function to all of its following Analyzing Functions automati-
cally via the according link or variable. The worst status code from all input arguments (= the status code with
the highest value) is the best status code which can be set for the output arguments. In case the internal calcu-
lation of the Analyzing Function ends up with an even more worse status code, this status code is set for the
output arguments.
Most Analyzing Functions handle the worst status code of their input arguments as follows:
Value Name Behavior of the Analyzing Function
-1 not initialized the calculation is performed as if the value would be valid
0 value is valid the calculation is performed
1 overflow the calculation is performed as if the value would be valid
2 underflow the calculation is performed as if the value would be valid
3 loss of accuracy the calculation is performed as if the value would be valid
4 division by zero the calculation is performed as if the value would be valid
5 infinite result the calculation is performed as if the value would be valid
6 undefined result the calculation is performed as if the value would be valid
7 input out of range the calculation is performed as if the value would be valid
8 result not available no calculation is performed
9 input not available no calculation is performed, in case the Analyzing Function maintains internal status information about the
calculation, this information is reset
10 function specific error no calculation is performed, in case the Analyzing Function maintains internal status information about the
11 value not available no calculation is performed, in case the Analyzing Function maintains internal status information about the
12 disabled no calculation is performed, in case the Analyzing Function maintains internal status information about the
English
Release 2018-06 125 / 866
The above behavior is valid in case the according status code shall not be treated as an error by the Analyzing
Model/Analyzing Script (see point 2.3.2.7 and 2.3.3.7). In case any of the above status codes shall be treated as
an error, the Analyzing Model/Analyzing Script suspends as soon as the status code occurs.
Each status code correlates with an according value which is being set for the output argument:
Value Name Value of the Output Argument
-1 not initialized 0 / “” / NULL
0 value is valid the result of the calculation
1 overflow the result of the calculation
2 underflow the result of the calculation
3 loss of accuracy the result of the calculation
4 division by zero 0 / “” / NULL
5 infinite result 0 / “” / NULL
6 undefined result 0 / “” / NULL
7 input out of range 0 / “” / NULL
8 result not available = 0 / “” / NULL in case no last result of the calculation is available
= the last result of the calculation in case the last result of the calculation is known and still valid
9 input not available 0 / “” / NULL
10 function specific error 0 / “” / NULL
11 value not available 0 / “” / NULL
12 disabled 0 / “” / NULL
In most cases, all output arguments of an Analyzing Function receive the same status code. An important ex-
ception is the “OutReady” output argument, whose status code is “value is valid” whenever the Analyzing Func-
tion is not disabled. Thus, the value of “OutReady” can be used easily for collateral control tasks (which would
not be possible in case “OutReady” would toggle between “result not available” and “value is valid”, because per
definition an Analyzing Function shall not perform any calculation in case the status of its input argument is “re-
sult not available”).
The following event codes are defined:
Value Name Description
-1 not initialized this event code is present for all output arguments until the Analyzing Function has processed the first
cycle time
0 value available period the current cycle time is inside a period of time for which this link/variable provides values
inside = bigger than the corresponding “data available start” event and smaller than the corresponding
“data available stop” event
1 value available start the current cycle time is exactly at the moment of a “data available start” event of the link/variable
2 value available stop the current cycle time is exactly at the moment of a “data available stop” event of the link/variable
3 value available single- the current cycle time is exactly at the moment of a “data available start” event and of a “data available
ton stop” event of the link/variable
4 value not available the current cycle time is outside a period of time for which this link/variable provides values
outside = bigger than the corresponding “data available stop” event and/or smaller than the corresponding
“data available start” event
Event codes are propagated from one Analyzing Function to all of its following Analyzing Functions automatical-
ly via the according link or variable. The worst event code from all input arguments (= the event code with the
highest value) is the best event code which can be set for the output arguments. In case the Analyzing Function
is disabled, the event code of all output arguments is being set to “value not available”.
In most cases, all output arguments of an Analyzing Function receive the same event code. An important excep-
tion is the “OutReady” output argument, whose event code is “value available period” whenever the Analyzing
Function is not disabled.
English
Release 2018-06 126 / 866
The output Analyzing Functions use event codes in order to add the “data available start” and “data available
stop” events to the created data. These events are being used by all systems in order to handle gaps within the
processed data. Examples:
 the Monitoring System does not show values for periods of time which are outside a “data available” peri-
od
 following Analyzing Models and Analyzing Scripts do not calculated periods of time which are outside a
“data available” period
2.6.1.5 Examples
The following chapters contain examples for each Analyzing Function. All examples are found within the
“..\Server\User\Example Location” directory, which must be added to your system in order to be able to access
the examples (see tutorial, chapter “Configuration File Locations”).
Some examples use online data from simulated devices as input for the calculation. In case of these examples,
the example Interface Profile for the “Simulation T001” interface must be started and in addition also the accord-
ing Device Profile must be started (see tutorial, chapter “Simulated Devices and Interface Profiles” and chapter
“Device Configuration and Device Profiles”).
Several examples base on certain offline data as input for the calculation. In case of these examples, the ac-
cording input data must be loaded into the system before the example can run. All of the referenced offline data
are found within the “..\Server\User\Example X-Tools Files” directory - add this offline file location (see tutorial,
chapter “Offline File Locations”) and load the contained offline data via the ODL Standard T001 (see tutorial,
chapter “Loading of Data and Loading Profiles”) in order to be able to use all examples which base on offline
data.
English
Release 2018-06 127 / 866
2.6.2 Arithmetic
2.6.2.1 Abs() - AbsoluteValue()
2.6.2.1.1 General
Properties
Full Name AbsoluteValue
Short Name Abs
Description Calculates the absolute of the input data or values.
Parent Library Base
Parent Category Arithmetic
Equidistant Inputs No
Supported Operating Modes Time-Slice based, Sequential
Function Prototype
DataOrValue Out0 = Abs
(
DataOrValue In0 = 0,
DataOrValue EN = true
);
Symbol
2.6.2.1.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose absolute value shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Supported Data Types Boolean, Integer8, Integer16, Integer32, Integer64, Decimal32, Decimal64
Allowed manual Inputs min … max of Decimal64
Remark none
English
Release 2018-06 128 / 866
EN
Full Name Enable
Short Name EN
Description enables or disables the internal calculation
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Allowed manual Inputs false, true
Remark none
2.6.2.1.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the absolute value calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Supported Data Types Decimal64
Allowed manual Inputs n/a
Remark none
2.6.2.1.4 Examples
Analyzing Model
Name Output Data Class Description
Abs 01 Online Calculates the absolute value of a generated sine wave.
Abs 02 Offline Calculates the absolute value of an offline signal.
Analyzing Script
Abs 01 Online Calculates the absolute value of a generated sine wave.
Abs 02 Offline Calculates the absolute value of an offline signal.
English
Release 2018-06 129 / 866
2.6.2.2 Add() - Addition()
2.6.2.2.1 General
Properties
Full Name Addition
Short Name Add
Description Calculates the arithmetical addition of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Add
(
DataOrValue In0 ... In7 = 0;
);
Symbol
2.6.2.2.2 Inputs
In0 … In7
Full Name Input0 … Input7
Short Name In0 … In7
Description data or values which shall be added
Direction input
Class data
Default Value 0
Unit 1
Configurable 2…8
Remark within Analyzing Scripts, a semicolon must be placed after the last used value of the configurable
argument
English
Release 2018-06 130 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.2.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the addition
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.2.4 Examples
Analyzing Model
Add 01 Online Calculates the addition of a generated triangle wave and 1.
Add 02 Offline Calculates the addition of 2 offline signals.
Analyzing Script
Add 01 Online Calculates the addition of 5 generated sine waves.
Add 02 Offline Calculates the addition of 5 offline signals.
English
Release 2018-06 131 / 866
2.6.2.3 AddB2D() - AdditionBuffer2D()
2.6.2.3.1 General
Properties
Full Name AdditionBuffer2D
Short Name AddB2D
Description Calculates the addition of the 2-dimensional input buffers.
Parent Library Base
Supported Operating Modes Time-Slice-Based, Sequential
Function Prototype
Buffer2D Out0 = AddB2D
(
Buffer2D In0 ... In7 = 0;
DataOrValue* OutReady = NULL,
);
Symbol
2.6.2.3.2 Inputs
In0 … In7
Description 2-dimensional buffers which shall be added
Direction input
Class data
Default Value 0
Unit 1
Configurable 2…8
Supported Data Types Buffer2D
argument
English
Release 2018-06 132 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.3.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
OutReady
Full Name OutputReady
Short Name OutReady
Description indicates whether the buffer data in Output0 is valid
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Supported Data Types Boolean
Remark none
English
Release 2018-06 133 / 866
2.6.2.3.4 Examples
In order to be able to run the examples which base on offline data, the offline data from the “..\X-
Tools\Server\User\Example X-Tools Files\ION AnalogInput T001” directory, which is delivered together with X-
Tools, must be loaded.
Analyzing Model
AddB2D 01 Online Calculates the addition of two 2-dimensional buffers which are created on base of online
data.
AddB2D 02 Offline Calculates the addition of two 2-dimensional vectors which are created on base of offline
data.
Analyzing Script
AddB2D 01 Online Calculates the addition of two 2-dimensional buffers which are created on base of online
data.
AddB2D 02 Offline Calculates the addition of two 2-dimensional vectors which are created on base of offline
data.
English
Release 2018-06 134 / 866
2.6.2.4 AddV2D() - AdditionVector2D()
2.6.2.4.1 General
Properties
Full Name AdditionVector2D
Short Name AddV2D
Description Calculates the arithmetical addition of the 2-dimensional input vectors.
Parent Library Base
Function Prototype
Vector2D Out0 = AddV2D
(
Vector2D In0 ... In7 = 0;
);
Symbol
2.6.2.4.2 Inputs
In0 … In7
Description 2-dimensional vectors which shall be added
Direction input
Class data
Default Value 0
Unit 1
Configurable 2…8
Supported Data Types Vector2D
argument
English
Release 2018-06 135 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.4.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.4.4 Examples
Tools\Server\User\Example X-Tools Files\2-dimensional Vectors” directory, which is delivered together with X-
Analyzing Model
AddV2D 01 Online Calculates the addition of 2 generated 2-dimensional vectors.
AddV2D 02 Offline Calculates the addition of 2 offline 2-dimensional vectors.
Analyzing Script
AddV2D 01 Online Calculates the addition of 2 generated 2-dimensional vectors.
AddV2D 02 Offline Calculates the addition of 2 offline 2-dimensional vectors.
English
Release 2018-06 136 / 866
2.6.2.5 ArcCos() - ArcCosine()
2.6.2.5.1 General
Properties
Full Name ArcCosine
Short Name ArcCos
Description Calculates the arc cosine of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = ArcCos
(
);
Symbol
2.6.2.5.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose arc cosine shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Allowed manual Inputs -1 … +1
Remark none
English
Release 2018-06 137 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.5.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the arc cosine calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.5.4 Examples
Analyzing Model
ArcCos 01 Online Calculates the arc cosine of a generated triangle wave and than normalizes it.
ArcCos 02 Offline Calculates the arc cosine of an offline signal and than normalizes it.
Analyzing Script
ArcCos 01 Online Calculates the arc cosine of 0.
ArcCos 02 Offline Calculates the arc cosine of an offline signal and than normalizes it.
English
Release 2018-06 138 / 866
2.6.2.6 ArcCoTan() - ArcCoTangent()
2.6.2.6.1 General
Properties
Full Name ArcCoTangent
Short Name ArcCoTan
Description Calculates the arc cotangent of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = ArcCoTan
(
);
Symbol
2.6.2.6.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose arc cotangent shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 139 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.6.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the arc cotangent calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.6.4 Examples
Analyzing Model
ArcCoTan 01 Online Calculates the arc cotangent of a generated triangle wave and than normalizes it.
ArcCoTan 02 Offline Calculates the arc cotangent of an offline signal and than normalizes it.
Analyzing Script
ArcCoTan 01 Online Calculates the arc cotangent of 0.
ArcCoTan 02 Offline Calculates the arc cotangent of an offline signal and than normalizes it.
English
Release 2018-06 140 / 866
2.6.2.7 ArcSin() - ArcSine()
2.6.2.7.1 General
Properties
Full Name ArcSine
Short Name ArcSin
Description Calculates the arc sine of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = ArcSin
(
);
Symbol
2.6.2.7.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose arc sine shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Allowed manual Inputs -1 … +1
Remark none
English
Release 2018-06 141 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.7.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the arc sine calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.7.4 Examples
Analyzing Model
ArcSin 01 Online Calculates the arc sine of a generated triangle wave and than normalizes it.
ArcSin 02 Offline Calculates the arc sine of an offline signal and than normalizes it.
Analyzing Script
ArcSin 01 Online Calculates the arc sine of 0.8664.
ArcSin 02 Offline Calculates the arc sine of an offline signal and than normalizes it.
English
Release 2018-06 142 / 866
2.6.2.8 ArcTan() - ArcTangent()
2.6.2.8.1 General
Properties
Full Name ArcTangent
Short Name ArcTan
Description Calculates the arc tangent of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = ArcTan
(
);
Symbol
2.6.2.8.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose arc tangent shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 143 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.8.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the arc tangent calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.8.4 Examples
Analyzing Model
ArcTan 01 Online Calculates the arc tangent of a generated triangle wave.
ArcTan 02 Offline Calculates the arc tangent of an offline signal.
Analyzing Script
ArcTan 01 Online Calculates the arc tangent of 13.14159265.
ArcTan 02 Offline Calculates the arc tangent of an offline signal.
English
Release 2018-06 144 / 866
2.6.2.9 Ceil() - Ceil()
2.6.2.9.1 General
Properties
Full Name Ceil
Short Name Ceil
Description Calculates the smallest integer number that is greater than or equal to the input data or value.
Parent Library Base
Function Prototype
DataOrValue Out0 = Ceil
(
);
Symbol
2.6.2.9.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose ceil shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 145 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.9.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the ceil calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.9.4 Examples
Analyzing Model
Ceil 01 Online Calculates the ceil value of a generated sine wave.
Ceil 02 Offline Calculates the ceil value of an offline signal.
Analyzing Script
Ceil 01 Online Calculates the ceil value of 0.1.
Ceil 02 Offline Calculates the ceil value of an offline signal.
English
Release 2018-06 146 / 866
2.6.2.10 Cos() - Cosine()
2.6.2.10.1 General
Properties
Full Name Cosine
Short Name Cos
Description Calculates the cosine of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Cos
(
);
Symbol
2.6.2.10.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose cosine shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 147 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.10.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the cosine calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.10.4 Examples
Analyzing Model
Cos 01 Online Calculates the cosine of a generated triangle wave normalized to PI.
Cos 02 Offline Calculates the cosine of an offline signal.
Analyzing Script
Cos 01 Online Calculates the cosine of PI.
Cos 02 Offline Calculates the cosine of an offline signal.
English
Release 2018-06 148 / 866
2.6.2.11 Dfrntl() - Differential()
2.6.2.11.1 General
Properties
Full Name Differential
Short Name Dfrntl
Description Calculates the differential of the input data or values.
Parent Library Basic
Supported Operating Modes Time-Slice-based, Sequential
Function Prototype
DataOrValue Out0 = Dfrntl
(
DataOrValue Reset = false,
);
Symbol
2.6.2.11.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose differential shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 149 / 866
Reset
Full Name Reset
Short Name Reset
Description resets the differentiation
Direction input
Class control
Default Value false
Unit 1
Configurable 1
Remark the calculation continues in the cycle at which the value of the Reset input drops from true to false
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.11.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the differentiation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 150 / 866
2.6.2.11.4 Examples
Analyzing Model
Dfrntl 01 Online Calculates the differential of a generated sine wave.
Dfrntl 02 Offline Calculates the differential of an offline signal.
Analyzing Script
Dfrntl 01 Online Calculates the differential of a generated sine wave.
Dfrntl 02 Offline Calculates the differential of an offline signal.
English
Release 2018-06 151 / 866
2.6.2.12 Div() - Division()
2.6.2.12.1 General
Properties
Full Name Division
Short Name Div
Description Calculates the arithmetical division of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Div
(
DataOrValue In0 … In7 = 1;
);
Symbol
2.6.2.12.2 Inputs
In0 … In7
Description data or values which shall be used as dividend (In0) and divisors (In1 … In7)
Direction input
Class data
Default Value 1
Unit 1
Configurable 2…8
argument
English
Release 2018-06 152 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.12.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the division
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.12.4 Examples
Analyzing Model
Div 01 Online Calculates the division of a generated cosine wave by 3.
Div 02 Offline Calculates the division of 2 offline signal.
Analyzing Script
Div 01 Online Calculates the division of 8 defined values.
Div 02 Offline Calculates the division of 5 offline signal.
English
Release 2018-06 153 / 866
2.6.2.13 Exp() - Exponential()
2.6.2.13.1 General
Properties
Full Name Exponential
Short Name Exp
Description Calculates the exponential of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Exp
(
);
Symbol
2.6.2.13.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose exponential shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 154 / 866
EN
Full Name Enable
Short Name EN
Direction Input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.13.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the exponential calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.13.4 Examples
Analyzing Model
Exp 01 Online Calculates the exponential of 2.302585093.
Exp 02 Offline Calculates the exponential of an offline signal.
Analyzing Script
Exp 01 Online Calculates the exponential of a generated triangle wave.
Exp 02 Offline Calculates the exponential of an offline signal.
English
Release 2018-06 155 / 866
2.6.2.14 Extrplt() - Extrapolate()
2.6.2.14.1 General
Properties
Full Name Extrapolate
Short Name Extrplt
Description Extrapolates the specified time series into the future.
Parent Library Base
Supported Operating Modes Sequential
Function Prototype
Value Status = Extrplt
(
Value InData = “”,
Value OutData = “”,
Value Prcsn = “Default”,
Value Order = 2,
Value Range = 1,
Value Rate = 1,
);
Symbol
N/A
2.6.2.14.2 Inputs
InData
Full Name InputData
Short Name InData
Description name of the data from the system which shall be read
Direction input
Class parameter
Default Value “”
Unit 1
Configurable 1
Supported Data Types String
Allowed manual Inputs string which contains the name of the data from the system
Remark only simple data types (Boolean, Integer and Decimal) are supported as input data
in case a data name prefix is being specified for input data of the parent Analyzing Script, the
specified input data name prefix is being added to the specified name before the execution of the
Analyzing Script
English
Release 2018-06 156 / 866
OutData
Full Name OutputData
Short Name OutData
Description name of the extrapolated data which shall be written to the system
Direction input
Class parameter
Unit 1
Configurable 1
Allowed manual Inputs string which contains the name of the extrapolated data which shall be written to the system
Remark in case a data name prefix is being specified for output data of the parent Analyzing Script, the
specified output data name prefix is being added to the specified name before the execution of the
Analyzing Script
Prcsn
Full Name Precision
Short Name Prcsn
Description precision of the data which shall be written to the system
Direction input
Class parameter
Default Value precision of the parent Analyzing Model/Analyzing Script
Unit n/a
Configurable 1
Allowed manual Inputs “Boolean”, “Integer8”, “Integer16”, “Integer32”, “Integer64”, “Decimal32”, “Decimal64”
Remark none
Order
Full Name Order
Short Name Order
Description order of the polynomial extrapolation
Direction input
Class parameter
Default Value 2
Unit n/a
Configurable 1
Supported Data Types Integer8
Allowed manual Inputs 2 … 10
Remark none
English
Release 2018-06 157 / 866
Range
Full Name Range
Short Name Range
Description range of the extrapolation beyond the stop time of the input data
Direction input
Class parameter
Default Value 1
Unit s
Configurable 1
Allowed manual Inputs 0 … 315360000 (~ 10 years)
Remark in case the range is 0, the output data receives the same start and stop times as the input data
and in fact only an interpolation of the input data is performed (without any extrapolation)
Rate
Full Name Rate
Short Name Rate
Description number of values per second which shall be calculated
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Allowed manual Inputs 0 … 200000 (200 kHz)
Remark in case this value is 0 and the input data is equidistant, the value rate of the input data is used for
the calculation rate of the output data
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 158 / 866
2.6.2.14.3 Outputs
Status
Full Name Status
Short Name Status
Description receives the current status of the extrapolation
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark = true in case the length (in [s]) of the output data is smaller than or equal to the double length of
the input data
= false in case the length (in [s]) of the output data is bigger than the double length of the input
data
2.6.2.14.4 Examples
Tools\Server\User\Example X-Tools Files\MT14” directory, which is delivered together with X-Tools, must be
loaded.
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function Extrapolate().
Analyzing Script
See the example measurement task.

Example Measurement Task
The example measurement tasks are part of the “Introduction” document and provide a chapter “Extrapolation”
which shows in detail how to use the Analyzing Function Extrapolate() for the extrapolation of data.
The “Measurement Tasks” folder from the “..\Server\User” directory which is delivered together with X-Tools
can be added as Configuration File location to the X-Tools Server. All of the Configuration Files which are used
for the example of extrapolation are found within the “14” folders of their according explorer trees within the X-
Tools Client (e.g. “Measurement Tasks://Analyzing Script Files\14” within the ANS Explorer).
English
Release 2018-06 159 / 866
2.6.2.15 Pow() - Exponentiation()
2.6.2.15.1 General
Properties
Full Name Exponentiation
Short Name Pow
Description Calculates the exponentiation of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Pow
(
);
Symbol
2.6.2.15.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values used as base in the exponentiation calculation
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 160 / 866
In1
Full Name Input1
Short Name In1
Description data or values used as exponent in the exponentiation calculation
Direction input
Class data
Default Value 1
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.15.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the exponentiation calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 161 / 866
2.6.2.15.4 Examples
Analyzing Model
Pow 01 Online Calculates the exponentiation of a generated triangle wave to the power of 1.234.
Pow 02 Offline Calculates the exponentiation of one offline signal to the power of another offline signal.
Analyzing Script
Pow 01 Online Calculates the exponentiation of 1.356 to the power of 2.4545.
Pow 02 Offline Calculates the exponentiation of an offline signal to the power of 1.73.
English
Release 2018-06 162 / 866
2.6.2.16 Floor() - Floor()
2.6.2.16.1 General
Properties
Full Name Floor
Short Name Floor
Description Calculates the largest integer number that is less than or equal to the input data or value.
Parent Library Base
Function Prototype
DataOrValue Out0 = Floor
(
);
Symbol
2.6.2.16.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose floor shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 163 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.16.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the floor calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.16.4 Examples
Analyzing Model
Floor 01 Online Calculates the floor value of a generated sine wave.
Floor 02 Offline Calculates the floor value of an offline signal.
Analyzing Script
Floor 01 Online Calculates the floor value of 5.7.
Floor 02 Offline Calculates the floor value of an offline signal.
English
Release 2018-06 164 / 866
2.6.2.17 Integral() - Integral()
2.6.2.17.1 General
Properties
Full Name Integral
Short Name Integral
Description Calculates the integral of the input data or values.
Function Prototype
DataOrValue Out0 = Integral
(
);
Symbol
2.6.2.17.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose integral shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 165 / 866
Reset
Full Name Reset
Short Name Reset
Description resets the integration
Direction input
Class control
Default Value false
Unit 1
Configurable 1
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.17.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the integration
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 166 / 866
2.6.2.17.4 Examples
Analyzing Model
Integral 01 Online Calculates the integral of a generated sine wave.
Integral 02 Offline Calculates the integral of an offline signal.
Analyzing Script
Integral 01 Online Calculates the integral of a generated sine wave.
Integral 02 Offline Calculates the integral of an offline signal.
English
Release 2018-06 167 / 866
2.6.2.18 Log() - Logarithm()
2.6.2.18.1 General
Properties
Full Name Logarithm
Short Name Log
Description Calculates the logarithm to a defined base of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Log
(
DataOrValue Base = 10,
);
Symbol
2.6.2.18.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose logarithm shall be calculated
Direction input
Class data
Default Value 1
Unit 1
Configurable 1
Allowed manual Inputs > 0 … max of Decimal64
Remark none
English
Release 2018-06 168 / 866
Base
Full Name Base
Short Name Base
Description data or values which is used as the base in the logarithm calculation
Direction input
Class data
Default Value 10
Unit 1
Configurable 1
Allowed manual Inputs > 0 … < 1 & > 1 … max of the Decimal64
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.18.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the logarithm calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 169 / 866
2.6.2.18.4 Examples
Analyzing Model
Log 01 Online Calculates the logarithm of a generated triangle wave to the base 1.73.
Log 02 Offline Calculates the logarithm of an offline signal to the base 2.3 and to the base 50.
Analyzing Script
Log 01 Online Calculates the logarithm of 1.356 to the base 2.4545.
Log 02 Offline Calculates the logarithm of an offline signal to the base 2.23.
English
Release 2018-06 170 / 866
2.6.2.19 Log10() - Logarithm10()
2.6.2.19.1 General
Properties
Full Name Logarithm10
Short Name Log10
Description Calculates the base 10 logarithm of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Log10
(
);
Symbol
2.6.2.19.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose logarithm to the base 10 shall be calculated
Direction input
Class data
Default Value 1
Unit 1
Configurable 1
Remark none
English
Release 2018-06 171 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.19.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the base 10 logarithm calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.19.4 Examples
Analyzing Model
Log10 01 Online Calculates the base 10 logarithm of a generated triangle wave.
Log10 02 Offline Calculates the base 10 logarithm of an offline signal.
Analyzing Script
Log10 01 Online Calculates the base 10 logarithm of 122.5454.
English
Release 2018-06 172 / 866
2.6.2.20 Log2() - Logarithm2()
2.6.2.20.1 General
Properties
Full Name Logarithm2
Short Name Log2
Description Calculates the base 2 logarithm of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Log2
(
);
Symbol
2.6.2.20.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose logarithm to the base 2 shall be calculated
Direction input
Class data
Default Value 1
Unit 1
Configurable 1
Remark none
English
Release 2018-06 173 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.20.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the base 2 logarithm calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.20.4 Examples
Analyzing Model
Log2 01 Online Calculates the base 2 logarithm of a generated triangle wave.
Analyzing Script
Log2 01 Online Calculates the base 2 logarithm of 4.
English
Release 2018-06 174 / 866
2.6.2.21 Mod() - Modulo()
2.6.2.21.1 General
Properties
Full Name Modulo
Short Name Mod
Description Calculates the remainder of the division of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Mod
(
);
Symbol
2.6.2.21.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values used as the dividend in the modulo calculation
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 175 / 866
In1
Full Name Input1
Short Name In1
Description data or values used as the divisor in the modulo calculation
Direction input
Class data
Default Value 1
Unit 1
Configurable 1
Allowed manual Inputs min of Decimal64 … < 0 & > 0 … max of Decimal64
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.21.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the modulo calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 176 / 866
2.6.2.21.4 Examples
Analyzing Model
Mod 01 Online Calculates the modulo of a generated triangle wave with divisor 3.
Mod 02 Offline Calculates the modulo of an offline signal with divisor 2.
Analyzing Script
Mod 01 Online Calculates the modulo of 7 with divisor 4.
Mod 02 Offline Calculates the modulo of an offline signal with divisor 7.
English
Release 2018-06 177 / 866
2.6.2.22 Mul() - Multiplication()
2.6.2.22.1 General
Properties
Full Name Multiplication
Short Name Mul
Description Calculates the arithmetical multiplication of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Mul
(
DataOrValue In0 … In7 = 0;
);
Symbol
2.6.2.22.2 Inputs
In0 … In7
Description data or values which shall be multiplied
Direction input
Class data
Default Value 0
Unit 1
Configurable 2…8
argument
English
Release 2018-06 178 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.22.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the multiplication
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.22.4 Examples
Analyzing Model
Mul 01 Online Calculates the multiplication of a generated cosine wave by -2.5.
Mul 02 Offline Calculates the multiplication of 2 offline signals.
Analyzing Script
Mul 01 Online Calculates the multiplication of 3 defined values.
Mul 02 Offline Calculates the multiplication of 5 offline signals.
English
Release 2018-06 179 / 866
2.6.2.23 Ln() - NaturalLogarithm()
2.6.2.23.1 General
Properties
Full Name NaturalLogarithm
Short Name Ln
Description Calculates the natural logarithm of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Ln
(
);
Symbol
2.6.2.23.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose natural logarithm shall be calculated
Direction input
Class data
Default Value 1
Unit 1
Configurable 1
Remark none
English
Release 2018-06 180 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.23.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the natural logarithm calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.23.4 Examples
Analyzing Model
Ln 01 Online Calculates the natural logarithm of a generated triangle wave.
Ln 02 Offline Calculates the natural logarithm of an offline signal.
Analyzing Script
Ln 01 Online Calculates the natural logarithm of e.
Ln 02 Offline Calculates the natural logarithm of an offline signal.
English
Release 2018-06 181 / 866
2.6.2.24 Neg() - Negation()
2.6.2.24.1 General
Properties
Full Name Negation
Short Name Neg
Description Calculates the negative value of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Neg
(
);
Symbol
2.6.2.24.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose negation shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 182 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.24.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the negation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.24.4 Examples
Analyzing Model
Neg 01 Online Calculates the negative value of a generated cosine wave.
Neg 02 Offline Calculates the negative value of an offline signal.
Analyzing Script
Neg 01 Online Calculates the negative value of 5.7.
Neg 02 Offline Calculates the negative value of an offline signal.
English
Release 2018-06 183 / 866
2.6.2.25 NthRt() - NthRoot()
2.6.2.25.1 General
Properties
Full Name NthRoot
Short Name NthRt
Description Calculates the n-th root of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = NthRt
(
);
Symbol
2.6.2.25.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values used as radicand for the calculation of the n-th root
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Allowed manual Inputs 0 … max of Decimal64
Remark none
English
Release 2018-06 184 / 866
In1
Full Name Input1
Short Name In1
Description data or values used as radical for the calculation of the n-th root
Direction input
Class data
Default Value 1
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.25.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the n-th root calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 185 / 866
2.6.2.25.4 Examples
Analyzing Model
NthRt 01 Online Calculates the 2.2-root of a generated triangle wave.
NthRt 02 Offline Calculates the 3.333-root of an offline signal.
Analyzing Script
NthRt 01 Online Calculates the 12.45 -root of 671.356.
NthRt 02 Offline Calculates the 5.27-root of an offline signal.
English
Release 2018-06 186 / 866
2.6.2.26 Round() - Round()
2.6.2.26.1 General
Properties
Full Name Round
Short Name Round
Description Rounds the input data or values to the closest integer.
Parent Library Base
Function Prototype
DataOrValue Out0 = Round
(
);
Symbol
2.6.2.26.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values to be rounded by the calculation
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 187 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.26.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the round calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.26.4 Examples
Analyzing Model
Round 01 Online Rounds the generated sine wave to a close integer.
Round 02 Offline Rounds the offline signal to a close integer.
Analyzing Script
Round 01 Online Rounds 0.5 to a close integer.
Round 02 Offline Rounds the offline signal to a close integer.
English
Release 2018-06 188 / 866
2.6.2.27 Sin() - Sine()
2.6.2.27.1 General
Properties
Full Name Sine
Short Name Sin
Description Calculates the sine of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Sin
(
);
Symbol
2.6.2.27.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose sine shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 189 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.27.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the sine calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.27.4 Examples
Analyzing Model
Sin 01 Online Calculates the sine of a generated triangle wave normalized to PI.
Sin 02 Offline Calculates the sine of an offline signal.
Analyzing Script
Sin 01 Online Calculates the sine of PI.
Sin 02 Offline Calculates the sine of an offline signal.
English
Release 2018-06 190 / 866
2.6.2.28 SqRt() - SquareRoot()
2.6.2.28.1 General
Properties
Full Name SquareRoot
Short Name SqRt
Description Calculates the square root of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = SqRt
(
);
Symbol
2.6.2.28.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values used as radicand for the calculation of the square root
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 191 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.28.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the square root calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.28.4 Examples
Analyzing Model
SqRt 01 Online Calculates the square root of a generated cosine wave.
SqRt 02 Offline Calculates the square root of an offline signal.
Analyzing Script
SqRt 01 Online Calculates the square root of 2.25.
SqRt 02 Offline Calculates the square root of an offline signal.
English
Release 2018-06 192 / 866
2.6.2.29 Sub() - Subtraction()
2.6.2.29.1 General
Properties
Full Name Subtraction
Short Name Sub
Description Calculates the arithmetical subtraction of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Sub
(
DataOrValue In0 … In7 = 0,
);
Symbol
2.6.2.29.2 Inputs
In0 … In7
Description data or values which shall be used as minuend (In0) and subtrahend (In1 … In7)
Direction input
Class data
Default Value 0
Unit 1
Configurable 2…8
argument
English
Release 2018-06 193 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.29.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the subtraction
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.29.4 Examples
Analyzing Model
Sub 01 Online Calculates the subtraction of 2 from a generated cosine wave.
Sub 02 Offline Calculates the subtraction of 2 offline signals.
Analyzing Script
Sub 01 Online Calculates the subtraction of 3 defined values.
Sub 02 Offline Calculates the subtraction of 5 offline signals.
English
Release 2018-06 194 / 866
2.6.2.30 Tan() - Tangent()
2.6.2.30.1 General
Properties
Full Name Tangent
Short Name Tan
Description Calculates the tangent of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Tan
(
);
Symbol
2.6.2.30.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose tangent shall be calculated
Direction Input
Class Data
Default Value 0
Unit 1
Configurable 1
Allowed manual Inputs min … max of Decimal64 / π/2+ n*π, n = 0,1,2,…
Remark None
English
Release 2018-06 195 / 866
EN
Full Name Enable
Short Name EN
Direction Input
Class Control
Default Value True
Unit 1
Configurable 1
Remark None
2.6.2.30.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the tangent calculation
Direction Output
Class Data
Default Value 0
Unit 1
Configurable 1
Remark None
2.6.2.30.4 Examples
Analyzing Model
Tan 01 Online Calculates the tangent of a generated triangle wave normalized to PI.
Tan 02 Offline Calculates the tangent of an offline signal.
Analyzing Script
Tan 01 Online Calculates the tangent of PI.
Tan 02 Offline Calculates the tangent of an offline signal.
English
Release 2018-06 196 / 866
2.6.2.31 Trunc() - Truncate()
2.6.2.31.1 General
Properties
Full Name Truncate
Short Name Trunc
Description Calculates the largest integer number that is less than or equal to the absolute of the input data or
values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Trunc
(
);
Symbol
2.6.2.31.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values to be truncated by the calculation
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 197 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.2.31.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the truncation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.2.31.4 Examples
Analyzing Model
Trunc 01 Online Calculates the trunk value of a generated sine wave.
Trunc 02 Offline Calculates the trunk value of an offline signal.
Analyzing Script
Trunc 01 Online Calculates the truncated value of -5.8.
Trunc 02 Offline Calculates the truncated value of an offline signal.
English
Release 2018-06 198 / 866
2.6.3 Classification
2.6.3.1 RFC() – RainFlowCounting()
2.6.3.1.1 General
Properties
Full Name RainFlowCounting
Short Name RFC
Description Applies the rainflow counting algorithm to the input buffer.
Parent Library Base
Parent Category Classification
Function Prototype
Buffer2D OutRFM = RFC
(
Buffer1D In0 = 0,
Value NoP = 1024,
Value NRV = 0,
Value CRLowBrd = 0,
Value CRUppBrd = 1,
Value CRNoC = 2,
Value CRClssMd = “Outside”,
Value CMLowBrd = 0,
Value CMUppBrd = 1,
Value CMNoC = 2,
Value CMClssMd = “Outside”,
DataOrValue EN = true,
Buffer1D* OutCRH = NULL,
Buffer1D* OutCMH = NULL,
DataOrValue* NoC = NULL
);
Symbol
English
Release 2018-06 199 / 866
2.6.3.1.2 Inputs
In0
Full Name Input0
Short Name In0
Description buffer containing the values for the rainflow counting classification
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
NoP
Full Name NumberOfPoints
Short Name NoP
Description determines the number of points which shall be used for the rainflow counting
Direction input
Class parameter
Default Value 1024
Unit 1
Configurable 1
Allowed manual Inputs 2 … max of Integer32
Remark the NoP must be set equal to the number of points of the input buffer
English
Release 2018-06 200 / 866
NRV
Full Name NoiseReductionValue
Short Name NRV
Description threshold value of the noise reduction filter which shall be used by the extremes finding
Direction input
Class parameter
Default Value 0
Unit 1
Configurable 1
Remark none
CRLowBrd
Full Name CyclesRangeLowerBorder
Short Name CRLowBrd
Description determines the position of the lower borderline for the cycles range
Direction input
Class parameter
Default Value 0
Unit 1
Configurable 1
Remark none
CRUppBrd
Full Name CyclesRangeUpperBorder
Short Name CRUppBrd
Description determines the position of the upper borderline for the cycles range
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
English
Release 2018-06 201 / 866
CRNoC
Full Name CyclesRangeNumberOfClasses
Short Name CRNoC
Description determines the number of classes for the cycles range
Direction input
Class parameter
Default Value 2
Unit 1
Configurable 1
Remark none
CRClssMd
Full Name CyclesRangeClassificationMode
Short Name CRClssMd
Description contains the acquisition mode of the cycles range for the rainflow counting
Direction input
Class parameter
Default Value “Outside”
Unit n/a
Configurable 1
Allowed manual Inputs “Inside”, “Outside”
Remark none
CMLowBrd
Full Name CyclesMeanLowerBorder
Short Name CMLowBrd
Description determines the position of the lower borderline for the cycles mean
Direction input
Class parameter
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 202 / 866
CMUppBrd
Full Name CyclesMeanUpperBorder
Short Name CMUppBrd
Description determines the position of the upper borderline for the cycles mean
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
CMNoC
Full Name CyclesMeanNumberOfClasses
Short Name CMNoC
Description determines the number of classes for the cycles mean
Direction input
Class parameter
Default Value 2
Unit 1
Configurable 1
Remark none
CMClssMd
Full Name CyclesMeanClassificationMode
Short Name CMClssMd
Description contains the acquisition mode of the cycles mean for the rainflow counting
Direction input
Class parameter
Default Value “Outside”
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 203 / 866
Reset
Full Name Reset
Short Name Reset
Description resets the rainflow counting
Direction input
Class control
Default Value false
Unit 1
Configurable 1
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.3.1.3 Outputs
OutRFM
Full Name OutputRainFlowMatrix
Short Name OutRFM
Description receives the 2-dimensional buffer data with the result of the rainflow counting
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 204 / 866
OutReady
Short Name OutReady
Description indicates whether the output data are valid
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
OutCRH
Full Name OutputCyclesRangeHistogram
Short Name OutCRH
Description receives the 1-dimensional histogram of the cycles range values
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutCMH
Full Name OutputCyclesMeanHistogram
Short Name OutCMH
Description receives the 1-dimensional histogram of the cycles mean values
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 205 / 866
OutNoC
Full Name OutputNumberOfCycles
Short Name OutNoC
Description receives the detected number of rainflow cycles
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
2.6.3.1.4 Examples
Analyzing Model
RFC 01 Online Calculates the rainflow matrix for a generated online signal.
RFC 02 Offline Calculates the rainflow matrix for an offline signal.
Analyzing Script
RFC 01 Online Calculates the rainflow matrix for a generated online signal.
RFC 02 Offline Calculates the rainflow matrix for an offline signal.
English
Release 2018-06 206 / 866
2.6.3.2 TLC() – TimeAtLevelCounting()
2.6.3.2.1 General
Properties
Full Name TimeAtLevelCounting
Short Name TLC
Description Applies the time at level counting algorithm to the input buffer.
Parent Library Base
Function Prototype
Buffer1D Out0 = TLC
(
Buffer1D In0 = 0,
Value NoP = 1024,
Value LowBrd = 0,
Value UppBrd = 1,
Value NoC = 2,
DataOrValue* OutReady = NULL
);
Symbol
2.6.3.2.2 Inputs
In0
Full Name Input0
Short Name In0
Description buffer containing the values for the time at level counting classification
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 207 / 866
NoP
Short Name NoP
Description determines the number of points which shall be used for the time at level counting
Direction input
Class parameter
Default Value 1024
Unit 1
Configurable 1
Remark the NoP must be set equal to the number of points of the input buffer
LowBrd
Full Name LowerBorder
Short Name LowBrd
Description determines the position of the lower borderline for the classification
Direction input
Class parameter
Default Value 0
Unit 1
Configurable 1
Remark none
UppBrd
Full Name UpperBorder
Short Name UppBrd
Description determines the position of the upper borderline for the classification
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
English
Release 2018-06 208 / 866
NoC
Full Name NumberOfClasses
Short Name NoC
Description determines the number of classes for the classification
Direction input
Class parameter
Default Value 2
Unit 1
Configurable 1
Remark none
Reset
Full Name Reset
Short Name Reset
Description resets the time at level counting
Direction input
Class control
Default Value false
Unit 1
Configurable 1
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 209 / 866
2.6.3.2.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the buffer data with the result of the time at level counting
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
2.6.3.2.4 Examples
Analyzing Model
TLC 01 Online Calculates the time at level histogram for a generated online signal.
TLC 02 Offline Calculates the time at level histogram for an offline signal.
Analyzing Script
TLC 01 Online Calculates the time at level histogram for a generated online signal.
TLC 02 Offline Calculates the time at level histogram for an offline signal.
English
Release 2018-06 210 / 866
2.6.3.3 TLC2D() – TimeAtLevelCounting2D()
2.6.3.3.1 General
Properties
Full Name TimeAtLevelCounting2D
Short Name TLC2D
Description Applies the time at level counting algorithm to the input buffers.
Parent Library Base
Function Prototype
Buffer1D Out0 = TLC2D
(
Buffer1D InX = 0,
Buffer1D InZ = 0,
Value LowBrdX = 0,
Value UppBrdX = 1,
Value NoCX = 2,
Value LowBrdZ = 0,
Value UppBrdZ = 1,
Value NoZ = 2,
);
Symbol
English
Release 2018-06 211 / 866
2.6.3.3.2 Inputs
InX
Full Name InputX
Short Name InX
Description buffer containing the x values for the time at level counting classification
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
InZ
Full Name InputZ
Short Name InZ
Description buffer containing the z values for the time at level counting classification
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
LowBrdX
Full Name LowerBorderX
Short Name LowBrdX
Description determines the position of the x classes lower borderline
Direction input
Class parameter
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 212 / 866
UppBrdX
Full Name UpperBorderX
Short Name UppBrdX
Description determines the position of the x classes upper borderline
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
NoCX
Full Name NumberOfClassesX
Short Name NoCX
Description determines the number of classes on x axis for the classification
Direction input
Class parameter
Default Value 2
Unit 1
Configurable 1
Remark none
LowBrdZ
Full Name LowerBorderZ
Short Name LowBrdZ
Description determines the position of the z classes lower borderline
Direction input
Class parameter
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 213 / 866
UppBrdZ
Full Name UpperBorderZ
Short Name UppBrdZ
Description determines the position of the z classes upper borderline
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
NoCZ
Full Name NumberOfClassesZ
Short Name NoCZ
Description determines the number of classes on z axis for the classification
Direction input
Class parameter
Default Value 2
Unit 1
Configurable 1
Remark none
Reset
Full Name Reset
Short Name Reset
Description resets the time at level counting
Direction input
Class control
Default Value false
Unit 1
Configurable 1
English
Release 2018-06 214 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.3.3.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the buffer data with the result of the time at level counting
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 215 / 866
2.6.3.3.4 Examples
Analyzing Model
TLC2D 01 Online Calculates the 2-dimensional time at level histogram for a generated online signal.
TLC2D 02 Offline The offline data from “..\Example X-Tools Files\ION AnalogInput T001” must be loaded be-
fore “TLC2D 02” can run.
Calculates the 2-dimensional time at level histogram for an offline signal.
Analyzing Script
TLC2D 01 Online Calculates the 2-dimensional time at level histogram for a generated online signal.
TLC2D 02 Offline The offline data from “..\Example X-Tools Files\ION AnalogInput T001” must be loaded be-
fore “TLC2D 02” can run.
Calculates the 2-dimensional time at level histogram for an offline signal.
English
Release 2018-06 216 / 866
2.6.4 Comparison
2.6.4.1 Cmp() - Compare()
2.6.4.1.1 General
Properties
Full Name Compare
Short Name Cmp
Description Compares two input values and returns the comparison result.
Parent Library Base
Parent Category Comparison
Function Prototype
DataOrValue GT = Cmp
(
Value Tlr = 0,
DataOrValue* GE = NULL,
DataOrValue* EQ = NULL,
DataOrValue* LT = NULL,
DataOrValue* LE = NULL
);
Symbol
2.6.4.1.2 Inputs
In0
Full Name Input0
Short Name In0
Description first input value to compare
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 217 / 866
In1
Full Name Input1
Short Name In1
Description second input value to compare
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
Tlr
Full Name Tolerance
Short Name Tlr
Description indicates the tolerance interval by the comparison
Direction input
Class parameter
Default Value 0
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 218 / 866
2.6.4.1.3 Outputs
GT
Full Name GreaterThan
Short Name GT
Description indicates whether the actual value of Input0 is bigger than the correlating value of Input1
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark GT = true in case the value of ( Input0 - Tolerance ) is greater than the value of Input1, otherwise
is false
GE
Full Name GreaterEqual
Short Name GE
Description indicates whether the actual value of Input0 is bigger than or equal to the correlating value of In-
put1
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark GE = true in case the value of ( Input0 - Tolerance ) is greater than the value of Input1 or the ab-
solute value of ( Input0 – Input1 ) is lower than the value of Tolerance, otherwise is false
EQ
Full Name Equal
Short Name EQ
Description indicates whether the actual value of Input0 is equal to the correlating value of Input1
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark EQ = true in case the absolute value of ( Input0 – Input1 ) is lower than the value of Tolerance,
otherwise is false
English
Release 2018-06 219 / 866
LT
Full Name LowerThan
Short Name LT
Description indicates whether the actual value of Input0 is lower than the correlating value of Input1
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark LT = true in case the value of ( Input0 + Tolerance ) is lower than the value of Input1, otherwise is
false
LE
Full Name LowerEqual
Short Name LE
Description indicates whether the actual value of Input0 is lower than or equal to the correlating value of In-
put1
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark LE = true in case the value of ( Input0 + Tolerance ) is lower than the value of Input1 or the abso-
lute value of ( Input0 – Input1 ) is lower than the value of Tolerance, otherwise is false
2.6.4.1.4 Examples
Analyzing Model
Cmp 01 Online Compares a generated sine wave with a generated triangle wave.
Cmp 02 Offline Compares 2 offline signals.
Analyzing Script
Cmp 01 Online Compares 2 defined values.
Cmp 02 Offline Compares 2 offline signals.
English
Release 2018-06 220 / 866
2.6.5 Control
2.6.5.1 ChkNoP() - CheckNumberOfParameters()
2.6.5.1.1 General
Properties
Full Name CheckNumberOfParameters
Short Name ChkNoP
Description Stops the current Fast Analysis Script in case the number of currently passed parameters does
not match the number of expected parameters.
Parent Library Base
Parent Category Control
Equidistant Inputs N/A
Function Prototype
DataOrValue Status = ChkNoP
(
Value NoEP = 1,
);
Symbol
N/A
2.6.5.1.2 Inputs
NoEP
Full Name NumberOfExpectedParameters
Short Name NoEP
Description number of parameters which shall be provided to this Fast Analysis Script
Direction input
Class parameter
Unit n/a
Configurable 1
Remark in case the number of passed parameters does not match the value of NoEP, the Analyzing Func-
tion outputs an according log entry and stops the parent Fast Analysis Script
English
Release 2018-06 221 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.5.1.3 Outputs
Status
Full Name Status
Short Name Status
Description indicates whether the number of current parameters and the number of expected parameters
match
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark Status < 0 in case there are less current than expected parameters
Status = 0 in case the number of current and expected parameters match
Status > 0 in case there are more current than expected parameters
2.6.5.1.4 Examples
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function ChkNoP().
Analyzing Script
Fast Add Offline this example from the “Fast Analysis Location\Analyzing Script Files\Offline” directory
checks whether the number of passed parameteters is correct
Fast Add Online this example from the “Fast Analysis Location\Analyzing Script Files\Online” directory
checks whether the number of passed parameteters is correct
English
Release 2018-06 222 / 866
2.6.5.2 Continue() - Continue()
2.6.5.2.1 General
Properties
Full Name Continue
Short Name Continue
Description Continues the execution of the specified Configuration File.
Parent Library Base
Function Prototype
DataOrValue Status = Continue
(
Value FileName = “”,
Value WaitMode = “Wait”,
Value Timeout = 0,
);
Symbol
N/A
2.6.5.2.2 Inputs
FileName
Full Name FileName
Short Name FileName
Description full path and name of the Configuration File which shall be continued, in format “Location
Name://[Directory/]Configuration File Name.Extension”, e.g. “Example Location://Arithmetic/Abs
01.amf.xts”
when the name of the location is not provided (e.g. “://Arithmetic/Abs 01.amf.xts”), the location of
the calling Analyzing Program is used
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the file name and its symbolic path
Remark the value of FileName is case insensitive;
the specified file name must point to an existing Interface Profile File (“*.ipf.xts”), Device Profile
File (“*.dpf.xts”), Analyzing Model (“*.amf.xts”), Analyzing Script (“*.asf.xts”), Storage Profile File
(“*.spf.xts”) or Monitoring View File (“*.mvf.xts”)
English
Release 2018-06 223 / 866
WaitMode
Full Name WaitMode
Short Name WaitMode
Description specifies whether the function shall wait until the stop of the Configuration File
Direction input
Class parameter
Default Value “Wait”
Unit n/a
Configurable 1
Allowed manual Inputs “Wait”, “DoNotWait”
Remark in case “Wait” is being chosen, the function waits until the specified configuration enters the state
“stopped” again;
in case “DoNotWait” is being chosen, the function waits until the specified Configuration File en-
ters the state “started”
Timeout
Full Name Timeout
Short Name Timeout
Description specifies the maximum waiting time in case the Configuration File does not reach the expected
state (“stopped” in case of the WaitMode “Wait” or “started” in case of the WaitMode “DoNotWait”)
Direction input
Class parameter
Default Value 0
Unit s
Configurable 1
Remark a value of 0 disables the timeout and Continue() waits for the expected state forever
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 224 / 866
2.6.5.2.3 Outputs
Status
Full Name Status
Short Name Status
Description indicates how the function has exited
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark Status = true in case the function has exited because the expected state has been reached and
Status = false in case the function has exited because of any other reason (e.g. because of the
timeout)
2.6.5.2.4 Examples
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function Continue().
Analyzing Script
Pause 01 Offline Alternating pause and continue of two Configuration Files.
English
Release 2018-06 225 / 866
2.6.5.3 CreateCF() - CreateConfigurationFile()
2.6.5.3.1 General
Properties
Full Name CreateConfigurationFile
Short Name CreateCF
Description Copies the specified configuration file without modifying of its provided parameters.
Parent Library Base
Function Prototype
DataOrValue Status = CreateCF
(
Value InputFile = “”,
Value OutputFile = “”,
);
Symbol
N/A
2.6.5.3.2 Inputs
InputFile
Full Name InputFile
Short Name InFile
Description full path and name of the configuration file which shall be used as input, in format “Location
01.amf.xts”
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the file name of the input file and its symbolic path
Remark the value of InputFile is case insensitive;
the specified file name must point to an existing Device Profile File (“*.dpf.xts”), Analyzing Model
File (“*.amf.xts”), Analyzing Script File (“*.asf.xts”), Storage Profile File (“*.spf.xts”) or Monitoring
View File (“*.mvf.xts”)
English
Release 2018-06 226 / 866
OutputFile
Full Name OutputFile
Short Name OutFile
Description full path and name of the configuration file which shall be used as output, in format “Location
01.amf.xts”
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the file name of the output file and its symbolic path
Remark the value of OutputFile is case insensitive;
the specified file name must point to a Device Profile File (“*.dpf.xts”), Analyzing Model File
(“*.amf.xts”), Analyzing Script File (“*.asf.xts”), Storage Profile File (“*.spf.xts”) or Monitoring View
File (“*.mvf.xts”)
in case the specified output file is present already, it is overwritten without any further notice
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 227 / 866
2.6.5.3.3 Outputs
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark Status = true in case the output Configuration File has been created successfully
Status = false in case output Configuration File could not be created
2.6.5.3.4 Examples
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function CreateCF().
Analyzing Script
CreateCF 01 Offline Copies an existing Analyzing Model.
English
Release 2018-06 228 / 866
2.6.5.4 CreateCFEx() - CreateConfigurationFileExtended()
2.6.5.4.1 General
Properties
Full Name CreateConfigurationFileExtended
Short Name CreateCFEx
Description Takes a configuration file as input, passes the values of provided parameters to it and stores the
resulting configuration file into a new file at the disk.
Parent Library Base
Function Prototype
DataOrValue Status = CreateCFEx
(
Value InputFile = “”,
Value OutputFile = “”,
DataOrValue Prmtr0 ... Prmtr127 = “”,
);
Symbol
N/A
2.6.5.4.2 Inputs
InputFile
Full Name InputFile
Short Name InFile
Description full path and name of the configuration file which shall be used as input, in format “Location
01.amf.xts”
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the file name of the input file and its symbolic path
Remark the value of InputFile is case insensitive;
the specified file name must point to an existing Device Profile File (“*.dpf.xts”), Analyzing Model
English
Release 2018-06 229 / 866
OutputFile
Full Name OutputFile
Short Name OutFile
Description full path and name of the configuration file which shall be used as output, in format “Location
01.amf.xts”
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the file name of the output file and its symbolic path
Remark the value of OutputFile is case insensitive;
the specified file name must point to a Device Profile File (“*.dpf.xts”), Analyzing Model File
(“*.amf.xts”), Analyzing Script File (“*.asf.xts”), Storage Profile File (“*.spf.xts”) or Monitoring View
File (“*.mvf.xts”)
in case the specified output file is present already, it is overwritten without any further notice
Prmtr0 … Prmtr127
Full Name Parameter0 … Parameter127
Short Name Prmtr0 … Prmtr127
Description parameter which shall be passed to the Configuration File
Direction input
Class parameter
Unit 1
Configurable 0 … 128
Allowed manual Inputs string which contains the value of the parameter
Remark the order of the provided parameters must match the order of parameters as it is configured within
the called Configuration File
in case a Configuration File shall be copied without passing of any parameter to it, CreateCF()
must be used instead of CreateCFEx()
English
Release 2018-06 230 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.5.4.3 Outputs
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark Status = true in case the output Configuration File has been created successfully
Status = false in case output Configuration File could not be created
2.6.5.4.4 Examples
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function CreateCFEx().
Analyzing Script
CreateCFEx 01 Offline Creates a new Analyzing Model on base of an existing Analyzing Model.
Tutorial
The tutorials are part of the “Introduction” document and provide a chapter “Parameters for Configuration Files”
which shows in detail how to use the Analyzing Function CreateCFEx() for the automatic creation of Configura-
tion Files.
The “Tutorials” folder from the “..\Server\User” directory which is delivered together with X-Tools can be added
as Configuration File location to the X-Tools Server. All of the Configuration Files which are used for the tutorial
about the parameters of Configuration Files are found within the “32” folders of their according explorer trees
within the X-Tools Client (e.g. “Tutorials://Analyzing Script Files\32” within the ANS Explorer).
English
Release 2018-06 231 / 866
2.6.5.5 Exit() - Exit()
2.6.5.5.1 General
Properties
Full Name Exit
Short Name Exit
Description Stops current analyzing program.
Parent Library Base
Function Prototype
DataOrValue Status = Exit
(
DataOrValue EndAn = true,
);
Symbol
2.6.5.5.2 Inputs
EndAn
Full Name EndAnalysis
Short Name EndAn
Description controls condition for the exiting
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark in case EndAnalysis = true the current analyzing program will be stopped, otherwise it does noth-
ing
English
Release 2018-06 232 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.5.5.3 Outputs
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark Status = false in case the function does not cease time-slice and Status = true if function causes
time-sliced to cease
2.6.5.5.4 Examples
Analyzing Model
Exit 01 Online Stops execution of the current analyzing model after reaching of proper condition by a gen-
erated signal.
Exit 02 Offline Stops execution of the current analyzing model after reaching of proper condition by an
offline signal.
Analyzing Script
Exit 01 Online Stops execution of the current analyzing script after reaching of proper condition by a gen-
erated signal.
Exit 02 Offline Stops execution of the current analyzing script after reaching of proper condition by an of-
fline signal.
English
Release 2018-06 233 / 866
2.6.5.6 IsDataPrsnt() - IsDataPresent()
2.6.5.6.1 General
Properties
Full Name IsDataPresent
Short Name IsDataPrsnt
Description Detects whether the specified data is currently present.
Parent Library Base
Function Prototype
DataOrValue Status = IsDataPrsnt
(
Value Name = “”,
Value Type = “Offline Data”,
);
Symbol
N/A
2.6.5.6.2 Inputs
Name
Full Name Name
Short Name Name
Description name of the online, offline or scalar data whose presence shall be checked, e.g. “~’OnlineData_1’”
for online data, “$’OfflineData_1’” for offline data, “s’ScalarData_1’” for scalar data or “Data” and
Data in case the “Type” input argument shall define whether an online, offline or scalar data shall
be checked
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the data
Remark a possible present data name prefix for input data is not applied to the specified data name
English
Release 2018-06 234 / 866
Type
Full Name Type
Short Name Type
Description type of the data which shall be checked
Direction input
Class parameter
Default Value “Offline Data”
Unit n/a
Configurable 1
Allowed manual Inputs “Online Data”, “Offline Data”, “Scalar Data”
Remark this input argument is ignored in case the ~’’, $’’ or s’’ syntax is used for the Name input argument
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.5.6.3 Outputs
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark Status = true in case the specified data is present at the moment even if it does contain not any
data values, otherwise Status = false
English
Release 2018-06 235 / 866
2.6.5.6.4 Examples
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function IsDataPrsnt().
Analyzing Script
IsDataPrsnt 01 Offline Detects whether the offline data produced by the specified analyzing program is currently
present.
English
Release 2018-06 236 / 866
2.6.5.7 Pause() - Pause()
2.6.5.7.1 General
Properties
Full Name Pause
Short Name Pause
Description Pauses the execution of the specified Configuration File.
Parent Library Base
Function Prototype
DataOrValue Status = Pause
(
);
Symbol
N/A
2.6.5.7.2 Inputs
FileName
Full Name FileName
Short Name FileName
Description full path and name of the Configuration File which shall be paused, in format “Location
01.amf.xts”
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 237 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.5.7.3 Outputs
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark Status = true in case the function has exited because the state “paused” has been reached and
Status = false in case the function has exited because of any other reason
2.6.5.7.4 Examples
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function Pause().
Analyzing Script
Pause 01 Offline Alternating pause and continue of two Configuration Files.
English
Release 2018-06 238 / 866
2.6.5.8 RemoveData() - RemoveData()
2.6.5.8.1 General
Properties
Full Name RemoveData
Short Name RemoveData
Description Removes the data which has been created by the specified Analyzing Program or which has been
specified directly.
Parent Library Base
Function Prototype
DataOrValue Status = RemoveData
(
);
Symbol
N/A
2.6.5.8.2 Inputs
Name
Full Name Name
Short Name Name
Description either full path and name of the analyzing program whose created data shall be removed, in for-
mat “Location Name://[Directory/]Analyzing Program Name.Extension”, e.g. “Example Loca-
tion://Arithmetic/Abs 01.amf.xts” or “://Arithmetic/Abs 01.amf.xts” (when the name of the location is
not provided, the location of the calling Analyzing Program is used) or directly the name of the
offline or scalar data which shall be removed
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains either the file name and the symbolic path of an Analyzing Program or the
name of an offline or scalar data
Remark the value of Name is case insensitive
the specified name must point to an existing Analyzing Model (“*.amf.xts”), Analyzing Script
(“*.asf.xts”), offline data or scalar data
English
Release 2018-06 239 / 866
Type
Full Name Type
Short Name Type
Description type of the data which shall be removed
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs “Offline Data”, “Scalar Data”, “Offline Data and Scalar Data”
Remark RemoveData() always removes the type of the data which is specified via this parameter, no mat-
ter whether the path to an Analyzing Model/Analyzing Script has been specified via the “Name” or
whether the “Name” contains the name of a data
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.5.8.3 Outputs
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark Status = true in case the specified data has been removed successfully, otherwise Status = false
English
Release 2018-06 240 / 866
2.6.5.8.4 Examples
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function RemoveData().
Analyzing Script
RemoveData 01 Offline Removes all offline data created by the specified analyzing program.
English
Release 2018-06 241 / 866
2.6.5.9 Start() - Start()
2.6.5.9.1 General
Properties
Full Name Start
Short Name Start
Description Starts the execution of the specified Configuration File.
Parent Library Base
Function Prototype
DataOrValue Status = Start
(
Value Timeout = 0,
);
Symbol
N/A
2.6.5.9.2 Inputs
FileName
Full Name FileName
Short Name FileName
Description full path and name of the Configuration File which shall be started, in format “Location
01.amf.xts”
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 242 / 866
WaitMode
Full Name WaitMode
Short Name WaitMode
Direction input
Class parameter
Unit n/a
Configurable 1
Timeout
Full Name Timeout
Short Name Timeout
Direction input
Class parameter
Default Value 0
Unit s
Configurable 1
Remark a value of 0 disables the timeout and Start() waits for the expected state forever
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 243 / 866
2.6.5.9.3 Outputs
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
timeout)
Status = false also in case the wait mode is “Wait” and the last status before “stopped” was neither
“started” nor “triggering” (the last status can be only “started”, “suspended”, “paused” or “trigger-
ing”, the intermediate stati are ignored for this check)
2.6.5.9.4 Examples
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function Start().
Analyzing Script
Start 01 Offline Starts the specified Configuration File after reaching of defined conditions.
English
Release 2018-06 244 / 866
2.6.5.10 StartEx() - StartExtended()
2.6.5.10.1 General
Properties
Full Name StartExtended
Short Name StartEx
Description Starts the execution of the specified Configuration File and passes parameters to the Configura-
tion File.
Parent Library Base
Function Prototype
DataOrValue Status = StartEx
(
Value Timeout = 0,
DataOrValue Prmtr0 ... Prmtr127 = “”,
);
Symbol
N/A
2.6.5.10.2 Inputs
FileName
Full Name FileName
Short Name FileName
Description full path and name of the Configuration File which shall be started, in format “Location
01.amf.xts”
Direction input
Class parameter
Unit n/a
Configurable 1
he specified file name must point to an existing Device Profile File (“*.dpf.xts”), Analyzing Model
English
Release 2018-06 245 / 866
WaitMode
Full Name WaitMode
Short Name WaitMode
Direction input
Class parameter
Unit n/a
Configurable 1
Timeout
Full Name Timeout
Short Name Timeout
Direction input
Class parameter
Default Value 0
Unit s
Configurable 1
Remark a value of 0 disables the timeout and StartEx() waits for the expected state forever
Prmtr0 … Prmtr127
Full Name Parameter0 … Parameter127
Short Name Prmtr0 … Prmtr127
Description parameter which shall be passed to the Configuration File
Direction input
Class parameter
Unit 1
Allowed manual Inputs string which contains the value of the parameter
Remark the order of the provided parameters must match the order of parameters as it is configured within
the called Configuration File
in case a Configuration File shall be started without passing of any parameter to it, Start() must be
used instead of StartEx()
English
Release 2018-06 246 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.5.10.3 Outputs
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
timeout)
Status = false also in case the wait mode is “Wait” and the last status before “stopped” was neither
“started” nor “triggering” (the last status can be only “started”, “suspended”, “paused” or “trigger-
ing”, the intermediate stati are ignored for this check)
English
Release 2018-06 247 / 866
2.6.5.10.4 Examples
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function StartEx().
Analyzing Script
StartEx 01 Offline Starts an Analyzing Model and passes parameters to it.
Tutorial
The tutorials are part of the “Introduction” document and provide a chapter “Parameters for Configuration Files”
which shows in detail how to use the Analyzing Function StartEx() for the passing of parameters to Configura-
tion Files.
The “Tutorials” folder from the “..\Server\User” directory which is delivered together with X-Tools can be added
as Configuration File location to the X-Tools Server. All of the Configuration Files which are used for the tutorial
about the parameters for Configuration Files are found within the “32” folders of their according explorer trees
within the X-Tools Client (e.g. “Tutorials://Analyzing Script Files\32” within the ANS Explorer).
The example measurement tasks are part of the “Introduction” document and provide a chapter “Passing of
Parameters to Analyzing Models” which shows in detail how to use the Analyzing Function StartEx() for the
passing of parameters to Analyzing Models.
for the example about passing of parameters are found within the “13” folders of their according explorer trees
within the X-Tools Client (e.g. “Measurement Tasks://Analyzing Script Files\13” within the ANS Explorer).
English
Release 2018-06 248 / 866
2.6.5.11 Stop() - Stop()
2.6.5.11.1 General
Properties
Full Name Stop
Short Name Stop
Description Stops the execution of the specified Configuration File.
Parent Library Base
Function Prototype
DataOrValue Status = Stop
(
);
Symbol
N/A
2.6.5.11.2 Inputs
FileName
Full Name FileName
Short Name FileName
Description full path and name of the Configuration File which shall be stopped, in format “Location
01.amf.xts”
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 249 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.5.11.3 Outputs
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark Status = true in case the function has exited because the state “stopped” has been reached and
Status = false in case the function has exited because of any other reason
2.6.5.11.4 Examples
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function Stop().
Analyzing Script
Stop 01 Offline Stops the specified Configuration File after reaching of defined conditions.
English
Release 2018-06 250 / 866
2.6.5.12 WaitForCF() – WaitForConfigurationFile()
2.6.5.12.1 General
Properties
Full Name WaitForConfigurationFile
Short Name WaitForCF
Description Blocks the execution of the current calculation until the specified state of the specified Configura-
tion File is being reached.
Parent Library Base
Function Prototype
DataOrValue Status = WaitForCF
(
Value State0 ... State4 = “Stopped”;
Value Timeout = 0,
DataOrValue* Out0 = “”
);
Symbol
N/A
2.6.5.12.2 Inputs
FileName
Full Name FileName
Short Name FileName
Description full path and name of the Configuration File for which the function shall wait, in format “Location
01.amf.xts”
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 251 / 866
State0 … State4
Full Name State0 … State4
Short Name State0 … State4
Description specifies the states of the Configuration File for which the function shall wait
Direction input
Class parameter
Default Value “Stopped”
Unit n/a
Configurable 1…5
Allowed manual Inputs “Started”, “Stopped”, “Suspended”, “Paused”, “Triggering”
Remark in case the Configuration File is in a specified state already at the first call to WaitForCF(), Wait-
ForCF() returns immediately
within the Analyzing Script Editor, a semicolon must be placed after the last used value of the
configurable argument
Timeout
Full Name Timeout
Short Name Timeout
Description specifies the maximum waiting time in case the Configuration File does not reach any of the speci-
fied states
Direction input
Class parameter
Default Value 0
Unit s
Configurable 1
Remark a value of 0 disables the timeout and WaitForCF() waits for the specified state forever
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 252 / 866
2.6.5.12.3 Outputs
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark Status = true in case the function has exited because one of the specified states has been
reached and Status = false in case the function has exited because of any other reason (e.g. be-
cause of the timeout)
Status = false also in case the ANF waits for the status “stopped” and the last status before
“stopped” was neither “started” nor “triggering” (the last status can be only “started”, “suspended”,
“paused” or “triggering”, the intermediate stati are ignored for this check)
Out0
Full Name Output0
Short Name Out0
Description receives the state which caused the function to exit
Direction output
Class data
Unit n/a
Configurable 1
Remark Out0 = “” in case the Status is “false”
2.6.5.12.4 Examples
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function WaitForCF().
Analyzing Script
WaitForCF 01 Offline Waits for the specified state of the defined Configuration File and continues the current Ana-
lyzing Program afterwards.
English
Release 2018-06 253 / 866
2.6.5.13 WaitForEDT() – WaitForEventByDateAndTime()
2.6.5.13.1 General
Properties
Full Name WaitForEventByDateAndTime
Short Name WaitForEDT
Description Blocks the execution of the current calculation until the specified time event is being reached.
Parent Library Base
Function Prototype
DataOrValue Status = WaitForEDT
(
Value Date = “”,
Value Time = “”,
Value RptRate = 3600,
);
Symbol
N/A
2.6.5.13.2 Inputs
Date
Full Name Date
Short Name Date
Description specifies the date at which the first start shall be issued, in format “yyyy-mm-dd”, e.g. “2001-01-01”
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains start event by date
Remark none
English
Release 2018-06 254 / 866
Time
Full Name Time
Short Name Time
Description specifies the time at which the first start shall be issued, in format “hh:mm:ss”, e.g. “10:01:01”
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains start event by time
Remark none
RptRate
Full Name RepeatRate
Short Name RptRate
Description contains the repetition rate after the first start date and time at which the following starts shall be
issued
Direction input
Class parameter
Default Value 3600
Unit s
Configurable 1
Remark In case this ANF is being called after the specified Date and Time and the Repeat Rate is non-
zero, it waits until “Start Date/Time + next integer multiple of the RepeatRate” which is after the
Date/Time of the first check which is being performed by this ANF.
In case this ANF is being called after the specified Date and Time and the Repeat Rate is zero,
the ANF exits immediately.
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 255 / 866
2.6.5.13.3 Outputs
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark Status = true in case the specified event has been reached and Status = false in case the speci-
fied event could not be reached, e.g. in case the ANF is being called after the specified date and
time and the repeat rate is 0
2.6.5.13.4 Examples
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function WaitForEDT().
Analyzing Script
WaitForEDT 01 Offline Waits for the specified time event and continues the current Analyzing Program afterwards.
English
Release 2018-06 256 / 866
2.6.5.14 WaitForFS() – WaitForFileSplitting()
2.6.5.14.1 General
Properties
Full Name WaitForFileSplitting
Short Name WaitForFS
Description Blocks the execution of the current calculation until the specified Storage Profile completes anoth-
er file splitting.
Parent Library Base
Function Prototype
DataOrValue Status = WaitForFS
(
Value Timeout = 0,
);
Symbol
N/A
2.6.5.14.2 Inputs
FileName
Full Name FileName
Short Name FileName
Description full path and name of the Storage Profile for which the function shall wait, in format “Location
Name://[Directory/]Storage Profile Name.spf.xts”, e.g. “Default Location://Test/Trigger Test.spf.xts”
or “://Test/Trigger Test.spf.xts”
when the name of the location is not provided, the location of the calling Analyzing Program is
used
Direction input
Class parameter
Unit n/a
Configurable 1
the specified file name must point to an existing Storage Profile File (“*.spf.xts”)
English
Release 2018-06 257 / 866
Timeout
Full Name Timeout
Short Name Timeout
Description specifies the maximum waiting time in case the Storage Profile does not complete another file
splitting
Direction input
Class parameter
Default Value 0
Unit s
Configurable 1
Remark a value of 0 disables the timeout and WaitForFS() waits for the next file splitting forever
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.5.14.3 Outputs
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark Status = true in case the function has exited because another file splitting has completed and
timeout)
English
Release 2018-06 258 / 866
2.6.5.14.4 Examples
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function WaitForFS().
Analyzing Script
WaitForFS 01 Offline Waits for the next file splitting and continues the current Analyzing Program afterwards..
English
Release 2018-06 259 / 866
2.6.6 Conversion
2.6.6.1 ConvB1DToTS() - ConvertBuffer1DToTimeSeries()
2.6.6.1.1 General
Properties
Full Name ConvertBuffer1DToTimeSeries
Short Name ConvB1DToTS
Description Converts a 1-dimensional buffer into a time series.
Parent Library Base
Parent Category Conversion
Function Prototype
Value Status = ConvB1DToTS
(
Value TSMode = “Start with Input Data Time”,
Value TmInt = 0.001,
);
Symbol
N/A
2.6.6.1.2 Inputs
InData
Full Name InputData
Short Name InData
Description name of the 1-dimensional buffer data from the system which shall be read
Direction input
Class parameter
Unit 1
Configurable 1
Allowed manual Inputs string which contains the name of the 1-dimensional buffer data from the system
Remark in case a data name prefix is being specified for input data of the parent Analyzing Script, the
specified input data name prefix is being added to the specified name before the execution of the
Analyzing Script
English
Release 2018-06 260 / 866
OutData
Short Name OutData
Description name of the simple data which shall be written to the system
Direction input
Class parameter
Unit 1
Configurable 1
Allowed manual Inputs string which contains the name of the simple data which shall be written to the system
Remark in case a data name prefix is being specified for output data of the parent Analyzing Script, the
specified output data name prefix is being added to the specified name before the execution of the
Analyzing Script
TSMode
Full Name TimeStampMode
Short Name TSMode
Description mode which shall be used for the calculation of the timestamps of the output data
Direction input
Class parameter
Default Value “End with Input Data Time”
Unit n/a
Configurable 1
Allowed manual Inputs “Start with Input Data Time”, “End with Input Data Time”
Remark Start with Input Data Time = the first timestamp which is used for the output data for each probe of
the input data matches the timestamp of the input data, all following timestamps are calculated
according to the configured TimeInterval
End with Input Data Time = the last timestamp which is used for the output data for each probe of
the input data matches the timestamp of the input data, all previous timestamps are calculated
according to the configured TimeInterval (the first timestamp matches “last timestamp - TimeInter-
val * Dimension”)
in case TimeInterval is configured to 0, the timestamp mode always is “End with Input Data Time”
and an according warning is output during the initialization of the Analyzing Function
English
Release 2018-06 261 / 866
TmInt
Full Name TimeInterval
Short Name TmInt
Description time interval which shall be inserted between every two values of the resulting time series
Direction input
Class parameter
Default Value 0.001
Unit s
Configurable 1
Allowed manual Inputs 0 … 604800000000000 (1 week)
Remark a value of 0 enables the automatic determination of the time interval - when the automatic deter-
mination is enabled, the Analyzing Function calculates the time difference between two succes-
sive input buffers and uses this information for the determination of the time interval of the second
buffer: TimeInterval = (TimeStamp of Probe 2 - Timestamp of Probe 1) / Dimension
for the first probe of the input data, the same time interval is used as for the second probe (the
time interval of the first probe can not be calculated because there is no previous timestamp avail-
able)
in case the automatic determination of the time interval is enabled, the TimeStampMode “End with
Input Data Time” is being used always
Prcsn
Full Name Precision
Short Name Prcsn
Direction input
Class parameter
Default Value precision of the parent Analyzing Script
Unit n/a
Configurable 1
Allowed manual Inputs “Boolean”, “Integer8”, “Integer16”, “Integer32”, “Integer64”, “Decimal32”, “Decimal64”
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 262 / 866
2.6.6.1.3 Outputs
Status
Full Name Status
Short Name Status
Description receives the current status of the conversion
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark = 0 while the conversion of the input buffers is in progress
= -1 in case an error occurred during the conversion (e.g. wrongly configured time interval)
= 1 in case the conversion of the input buffers has been completed
2.6.6.1.4 Examples

The example measurement tasks are part of the “Introduction” document and provide a chapter “X/Y Envelopes”
which shows in detail how to use the Analyzing Function ConvB1DToTS() for the visualization of the envelopes
of x/y data.
for the example of x/y envelopes are found within the “06” folders of their according explorer trees within the X-
English
Release 2018-06 263 / 866
2.6.6.2 ConvCToSp() - ConvertCartesianToSpherical()
2.6.6.2.1 General
Properties
Full Name ConvertCartesianToSpherical
Short Name ConvCToSp
Description Converts Cartesian coordinates to the spherical coordinate system.
Parent Library Base
Function Prototype
DataOrValue R = ConvCToSp
(
DataOrValue X = 0,
DataOrValue Y = 0,
DataOrValue Z = 0,
DataOrValue* Phi = NULL,
DataOrValue* Theta = NULL
);
Symbol
2.6.6.2.2 Inputs
X
Full Name Abscissa
Short Name X
Description first input value representing x-coordinate
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 264 / 866
Y
Full Name Ordinate
Short Name Y
Description second input value representing y-coordinate
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
Z
Full Name Vertical
Short Name Z
Description third input value representing z-coordinate
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 265 / 866
2.6.6.2.3 Outputs
R
Full Name Radial
Short Name R
Description receives the result of the point radial distance calculation from the fixed origin
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
Phi
Full Name Phi
Short Name Phi
Description receives the result of the point horizontal azimuth angle calculation measured on the xy-plane
Direction output
Class data
Default Value 0
Unit rad
Configurable 1
Remark the angle is given in radians between 0 and 2π
Theta
Full Name Theta
Short Name Theta
Description receives the result of the point zenith angle calculation measured to the positive z-axis
Direction output
Class data
Default Value 0
Unit rad
Configurable 1
Remark the angle is given in radians between 0 and π
English
Release 2018-06 266 / 866
2.6.6.2.4 Examples
Analyzing Model
ConvCToSp 01 Online Converts generated signals from Cartesian to spherical coordinates.
ConvCToSp 02 Offline Converts offline signals from Cartesian to spherical coordinates.
Analyzing Script
ConvCToSp 01 Online Converts generated signals from Cartesian to spherical coordinates.
ConvCToSp 02 Offline Converts offline signals from Cartesian to spherical coordinates.
English
Release 2018-06 267 / 866
2.6.6.3 ConvPToV2D() - ConvertPolarToVector2D()
2.6.6.3.1 General
Properties
Full Name ConvertPolarToVector2D
Short Name ConPToV2D
Description Converts polar coordinates into data of type “2-dimensional vector”.
Parent Library Base
Function Prototype
Vector2D Out0 = ConvPToV2D
(
DataOrValue X0 = 0,
DataOrValue Y0 = 0,
DataOrValue Length = 1,
DataOrValue Angle = 0,
);
Symbol
2.6.6.3.2 Inputs
X0
Full Name X0
Short Name X0
Description X0 coordinate of the vector
Direction input
Class data
Unit 1
Configurable 1
Remark none
English
Release 2018-06 268 / 866
Y0
Full Name Y0
Short Name Y0
Description Y0 coordinate of the vector
Direction input
Class data
Unit 1
Configurable 1
Remark none
Length
Full Name Length
Short Name Length
Description length of the vector
Direction input
Class data
Unit 1
Configurable 1
Remark none
Angle
Full Name Angle
Short Name Angle
Description angle of the vector
Direction input
Class data
Unit °
Configurable 1
Remark none
English
Release 2018-06 269 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.6.3.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the 2-dimensional vector
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.6.3.4 Examples
See the examples for the AddV2D() Analyzing Function, which also show how to use ConvPToV2D().
English
Release 2018-06 270 / 866
2.6.6.4 ConvSpm() - ConvertSpectrum()
2.6.6.4.1 General
Properties
Full Name ConvertSpectrum
Short Name ConvSpm
Description Converts an input spectrum.
Parent Library Base
Function Prototype
Spectrum Out0 = ConvSpm
(
Spectrum In0 = 0,
Value Mode = “Integrate”,
DataOrValue CutFrq = 1,
DataOrValue Spd = 50,
);
Symbol
2.6.6.4.2 Inputs
In0
Full Name Input0
Short Name In0
Description order or frequency spectrum which shall be converted
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Supported Data Types Spectrum
Remark none
English
Release 2018-06 271 / 866
Mode
Full Name Mode
Short Name Mode
Description mode which shall be used
Direction input
Class parameter
Default Value “Integrate”
Unit n/a
Configurable 1
Allowed manual Inputs “Integrate”, “Derivate”
Remark none
CutFrq
Full Name CutoffFrequency
Short Name CutFrq
Description cutoff frequency of the function
Direction input
Class parameter
Default Value 1
Unit Hz
Configurable 1
Remark all amplitudes lower to the cutoff frequency will be set to 0
Spd
Full Name Speed
Short Name Spd
Description speed at which the input spectrum has been determined
Direction input
Class data
Default Value 1
Unit Hz
Configurable 1
Remark this input is ignored in case the input spectrum is not an order spectrum
English
Release 2018-06 272 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.6.4.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the converted spectrum
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Description indicates whether the spectrum data in Output0 is valid
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 273 / 866
2.6.6.4.4 Examples
Analyzing Model
ConvSpm 01 Online Integrates the frequency spectrum of a generated signal.
ConvSpm 02 Offline Integrates the frequency spectrum of an offline signal.
Analyzing Script
ConvSpm 01 Online Integrates the frequency spectrum of a generated signal.
ConvSpm 02 Offline Integrates the frequency spectrum of an offline signal.
English
Release 2018-06 274 / 866
2.6.6.5 ConvSpToC() - ConvertSphericalToCartesian()
2.6.6.5.1 General
Properties
Full Name ConvertSphericalToCartesian
Short Name ConvSpToC
Description Converts spherical coordinates to the Cartesian coordinate system.
Parent Library Base
Function Prototype
DataOrValue X = ConvSpToC
(
DataOrValue R = 0,
DataOrValue Phi = 0,
DataOrValue Theta = 0,
DataOrValue* Y = NULL,
DataOrValue* Z = NULL
);
Symbol
2.6.6.5.2 Inputs
R
Full Name Radial
Short Name R
Description first input value representing the point radial distance from the fixed origin
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 275 / 866
Phi
Full Name Phi
Short Name Phi
Description second input value representing the point horizontal azimuth angle measured on the xy-plane
Direction input
Class data
Default Value 0
Unit rad
Configurable 1
Allowed manual Inputs 0 … 2π)
Remark none
Theta
Full Name Theta
Short Name Theta
Description third input value representing the point zenith angle measured to the positive z-axis
Direction input
Class data
Default Value 0
Unit rad
Configurable 1
Allowed manual Inputs 0…π
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 276 / 866
2.6.6.5.3 Outputs
X
Full Name Abscissa
Short Name X
Description receives the result of the x-coordinate calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
Y
Full Name Ordinate
Short Name Y
Description receives the result of the y-coordinate calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
Z
Full Name Vertical
Short Name Z
Description receives the result of the z-coordinate calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 277 / 866
2.6.6.5.4 Examples
Analyzing Model
ConvSpToC 01 Online Converts generated signals from spherical to Cartesian coordinates.
ConvSpToC 02 Offline Converts offline signals from spherical to Cartesian coordinates.
Analyzing Script
ConvSpToC 01 Online Converts generated signals from spherical to Cartesian coordinates.
ConvSpToC 02 Offline Converts offline signals from spherical to Cartesian coordinates.
English
Release 2018-06 278 / 866
2.6.6.6 ConvV2DToP() - ConvertVector2DToPolar()
2.6.6.6.1 General
Properties
Full Name ConvertVector2DToPolar
Short Name ConV2DToPolar
Description Converts data of type “2-dimensional vector” into polar coordinates.
Parent Library Base
Function Prototype
DataOrValue X0 = ConvV2DToP
(
Vector2D In0 = 0,
DataOrValue* Y0 = NULL,
DataOrValue* Length = NULL,
DataOrValue* Angle = NULL
);
Symbol
2.6.6.6.2 Inputs
In0
Full Name Input0
Short Name In0
Description 2-dimensional vector which shall be converted to polar coordinates
Direction input
Class data
Unit 1
Configurable 1
Remark none
English
Release 2018-06 279 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.6.6.3 Outputs
X0
Full Name X0
Short Name X0
Description receives the X0 coordinate of the vector
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
Y0
Full Name Y0
Short Name Y0
Description receives the Y0 coordinate of the vector
Direction output
Class data
Unit 1
Configurable 1
Remark none
English
Release 2018-06 280 / 866
Length
Full Name Length
Short Name Length
Description length of the vector
Direction output
Class data
Unit 1
Configurable 1
Remark none
Angle
Full Name Angle
Short Name Angle
Description angle of the vector
Direction output
Class data
Unit °
Configurable 1
Remark none
2.6.6.6.4 Examples
Tools\Server\User\Example X-Tools Files\2-dimensional Vectors” directory, which is delivered together with X-
Analyzing Model
ConvV2DToP 01 Online Converts polar coordinates into a 2-dimensional vector and vice versa.
ConvV2DToP 02 Offline Converts a 2-dimensional vector into polar coordinates and vice versa.
Analyzing Script
ConvV2DToP 01 Online Converts polar coordinates into a 2-dimensional vector and vice versa.
ConvV2DToP 02 Offline Converts a 2-dimensional vector into polar coordinates and vice versa.
English
Release 2018-06 281 / 866
2.6.6.7 ConvVToB1D() - ConvertValueToBuffer1D()
2.6.6.7.1 General
Properties
Full Name ConvertValueToBuffer1D
Short Name ConvVToB1D
Description Converts input data or values to a 1-dimensional buffer.
Parent Library Base
Function Prototype
Buffer1D Out0 = ConvVToB1D
(
Value Prcsn = “Decimal64”,
);
Symbol
2.6.6.7.2 Inputs
In0 … In31
Description data or values which shall be converted
Direction input
Class data
Default Value 0
Unit 1
argument
English
Release 2018-06 282 / 866
Prcsn
Full Name Precision
Short Name Prcsn
Description precision of the data
Direction input
Class parameter
Default Value “Decimal64”
Unit n/a
Configurable 1
Allowed manual Inputs “Boolean“, “Integer8“, “Integer16“, “Integer32“, “Integer64“, “Decimal32“, “Decimal64“
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.6.7.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the 1-dimensional buffer with the input data or values
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 283 / 866
2.6.6.7.4 Examples
Analyzing Model
ConvVToB1D 01 Online Converts several generated signals into a 1-dimensional buffer.
ConvVToB1D 02 Offline Converts offline signals into a 1-dimensional buffer.
Analyzing Script
ConvVToB1D 01 Online Converts several generated signals into a 1-dimensional buffer.
ConvVToB1D 02 Offline Converts offline signals into a 1-dimensional buffer.
English
Release 2018-06 284 / 866
2.6.6.8 ConvVToVDMA() - ConvertValueToVDMA()
2.6.6.8.1 General
Properties
Full Name ConvertValueToVDMA
Short Name ConvVToVDMA
Description Converts input data or values to VDMA status codes.
Parent Library Base
Function Prototype
DataOrValue Out0 = ConvVToVDMA
(
Value DfctUp = 3,
Value CrtclUp = 2,
Value WrngUp = 1,
Value WrngLow = -1,
Value CrtclLow = -2,
Value DfctLow = -3,
);
Symbol
2.6.6.8.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values which shall be converted to a VDMA-compatible status information
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 285 / 866
DfctUp
Full Name DefectUpper
Short Name DfctUp
Description upper defect level
Direction input
Class data
Default Value 3
Unit 1
Configurable 1
Remark this value must be bigger than or equal to CriticalUpper
CrtclUp
Full Name CriticalUpper
Short Name CrtclUp
Description upper critical level
Direction input
Class data
Default Value 2
Unit 1
Configurable 1
Remark this value must be bigger than or equal to WarningUpper
WrngUp
Full Name WarningUpper
Short Name WrngUp
Description upper warning level
Direction input
Class data
Default Value 1
Unit 1
Configurable 1
Remark this value must be bigger than WarningLower
English
Release 2018-06 286 / 866
WrngLow
Full Name WarningLower
Short Name WrngLow
Description lower warning level
Direction input
Class data
Default Value -1
Unit 1
Configurable 1
Remark this value must be bigger than or equal to CriticalLower
CrtclLow
Full Name CriticalLower
Short Name CrtclLow
Description lower critical level
Direction input
Class data
Default Value -2
Unit 1
Configurable 1
Remark this value must be bigger than or equal to DefectLower
DfctLow
Full Name DefectLower
Short Name DfctLow
Description lower defect level
Direction input
Class data
Default Value -3
Unit 1
Configurable 1
Remark this value must be smaller than or equal to CriticalLower
English
Release 2018-06 287 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.6.8.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the VDMA-compatible status information which matches the input value
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark Input Value Output Value [Hex]
Input0 >= DefectUpper 0x82
Input0 < DefectUpper && Input Value >= CriticalUpper 0x42
Input0 < CriticalUpper && Input Value >= WarningUpper 0x22
Input0 < WarningUpper && Input Value > WarningLower 0x10
Input0 <= WarningLower && Input Value > CriticalLower 0x21
Input0 <= CriticalLower && Input Value > DefectLower 0x41
Input0 <= DefectLower 0x81
Input0 not available 0x08
English
Release 2018-06 288 / 866
2.6.6.8.4 Examples
Analyzing Model
ConvVToVDMA 01 Online Converts online data into a VDMA-compatible status.
ConvVToVDMA 02 Offline Converts offline data into a VDMA-compatible status.
Analyzing Script
ConvVToVDMA 01 Online Converts online data into a VDMA-compatible status.
ConvVToVDMA 02 Offline Converts offline data into a VDMA-compatible status.
English
Release 2018-06 289 / 866
2.6.6.9 GetVFrmB1D() - GetValueFromBuffer1D()
2.6.6.9.1 General
Properties
Full Name GetValueFromBuffer1D
Short Name GetVFrmB1D
Description Extracts one or multiple values out of a 1-dimensional buffer.
Parent Library Base
Function Prototype
DataOrValue OutReady = GetVFrmB1D
(
Buffer1D In0 = 0,
Value Offset = 0,
DataOrValue* Out0 ... Out7 = NULL
);
Symbol
2.6.6.9.2 Inputs
In0
Full Name Input0
Short Name In0
Description buffer from which the value(s) shall be extracted
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 290 / 866
Offset
Full Name Offset
Short Name Offset
Description specifies the offset within the 1-dimensional buffer at which the value of interest is located
Direction input
Class parameter
Default Value 0
Unit bytes
Configurable 1
Remark the offset begins from 0
Prcsn
Full Name Precision
Short Name Prcsn
Description specifies the data type of the value(s) which shall be extracted
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs “Boolean“, “Integer8“, “Integer16“, “Integer32“, “Integer64“, “Decimal32“, “Decimal64“
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 291 / 866
2.6.6.9.3 Outputs
OutReady
Full Name OutReady
Short Name OutReady
Description indicates whether the data in Output0 … Output7 is valid
Direction output
Class control
Default Value 0
Unit 1
Configurable 1
Remark none
Out0 … Out7
Full Name Output0 … Output7
Short Name Out0 … Out7
Description receives the extracted value(s)
Direction output
Class data
Default Value 0
Unit 1
Configurable 1…8
Remark within the Analyzing Script Editor, a semicolon must be placed after the last used value of the
2.6.6.9.4 Remarks
GetVFrmB1D() typically is being used in order to extract data out of the 1-dimensional buffer which is being
received by the Analyzing Function InTCP(). However, it also can be used for extracting of data from a 1-
dimensional buffer from any other data source.
2.6.6.9.5 Examples
Analyzing Model
InTCP 01 Online Extracts the data which is being received by the Analyzing Function InTCP().
Analyzing Script
InTCP 01 Online Extracts the data which is being received by the Analyzing Function InTCP().
English
Release 2018-06 292 / 866
2.6.6.10 GetStrFrmSD() - GetStringFromSimpleData()
2.6.6.10.1 General
Properties
Full Name GetStringFromSimpleData
Short Name GetStringFrmSD
Description Extracts one string out of a time series of strings.
Parent Library Base
Function Prototype
Value Out0 = GetStrFrmSD
(
DataOrValue Idx = 0,
);
Symbol
N/A
2.6.6.10.2 Inputs
Name
Full Name Name
Short Name Name
Description name of the online or offline data which shall be read, e.g. “~’OnlineData_1’” for online data, “$’Of-
flineData_1’” for offline data or “Data” and Data in case the “Type” input argument shall define
whether an online or offline data shall be checked
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the string from the system
Remark in case a data name prefix is being specified for input data of the parent Analyzing Mod-
el/Analyzing Script, the specified input data name prefix is being added to the specified name
before the execution of the Analyzing Model/Analyzing Script
English
Release 2018-06 293 / 866
Type
Full Name Type
Short Name Type
Description type of the data which shall be read
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs “Online Data”, “Offline Data”
Remark this input argument is ignored in case the ~’’ or $’’ syntax is used for the Name input argument
Index
Full Name Index
Short Name Idx
Description specifies the index within the buffer of the input data which shall be provided to the output
Direction input
Class control
Default Value -1
Unit 1
Configurable 1
Remark in case -1 is provided as index, the most recent (= newest) value of the data is returned
this parameter is ignored in case the input is an online data because the ANF always returns the
most recent value then
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 294 / 866
2.6.6.10.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the read data string
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark this output always returns a single value, also in sequential operating mode
2.6.6.10.4 Examples
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function GetStrFrmSD().
Analyzing Script
GetStrFrmSD 01 Online The Analyzing Script “OutStr 01” must be running before “GetStrFrmSD 01” can run.
Extracts one value out of the provided input data.
GetStrFrmSD 02 Offline The offline data from “..\Example X-Tools Files\Strings” must be loaded before
“GetStrFrmSD 02” can run.
Extracts two values out of the provided input data.
English
Release 2018-06 295 / 866
2.6.6.11 GetVFrmSD() - GetValueFromSimpleData()
2.6.6.11.1 General
Properties
Full Name GetValueFromSimpleData
Short Name GetVFrmSD
Description Extracts one value out of a time series of simple data.
Parent Library Base
Function Prototype
Value Out0 = GetVFrmSD
(
);
Symbol
N/A
2.6.6.11.2 Inputs
Name
Full Name Name
Short Name Name
Description name of the online or offline data which shall be read, e.g. “~’OnlineData_1’” for online data, “$’Of-
flineData_1’” for offline data or “Data” and Data in case the “Type” input argument shall define
whether an online or offline data shall be checked
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the simple data from the system
English
Release 2018-06 296 / 866
Type
Full Name Type
Short Name Type
Description type of the data which shall be read
Direction input
Class parameter
Unit n/a
Configurable 1
Index
Full Name Index
Short Name Idx
Description specifies the index within the buffer of the input data which shall be provided to the output
Direction input
Class control
Default Value -1
Unit 1
Configurable 1
Remark in case -1 is provided as index, the most recent (= newest) value of the data is returned
this parameter is ignored in case the input is an online data because the ANF always returns the
most recent value then
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 297 / 866
2.6.6.11.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the read data value
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark this output always returns a single value, also in sequential operating mode
2.6.6.11.4 Examples
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function GetVFrmSD().
Analyzing Script
GetVFrmSD 01 Online The Analyzing Script “Abs 01” must be running before “GetVFrmSD 01” can run.
GetVFrmSD 02 Offline The Analyzing Script “Abs 02” must have been executed before “GetVFrmSD 02” can run.
English
Release 2018-06 298 / 866
2.6.7 Envelopes
2.6.7.1 ClcXYEnv() – CalculateXYEnvelope()
2.6.7.1.1 General
Properties
Full Name CalculateXYEnvelope
Short Name ClcXYEnv
Description Calculates the envelope for the given x and y input data.
Parent Library Base
Parent Category Envelopes
Function Prototype
Value Status = ClcXYEnv
(
DataOrValue InX = 0,
DataOrValue InY = 0,
Value Dim = 1024,
Value PosTdX = 1,
Value NegTdX = 1,
Value PosTdY = 1,
Value NegTdY = 1,
Value XBffr = “”,
Value UprBnd = “”,
Value LwrBnd = “”,
);
Symbol
N/A
2.6.7.1.2 Inputs
InX
Full Name InputX
Short Name InX
Description x-data which shall be used for the calculation of the envelopes
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark the calculation of the envelope takes place from the first common timestamp of the x and y data
until the last common timestamp of the x and y data
English
Release 2018-06 299 / 866
InY
Full Name InputY
Short Name InY
Description y-data which shall be used for the calculation of the envelopes
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark the calculation of the envelope takes place from the first common timestamp of the x and y data
until the last common timestamp of the x and y data
Dim
Full Name Dimension
Short Name Dim
Description desired dimension of the output buffers
Direction input
Class parameter
Default Value 1024
Unit 1
Configurable 1
Remark none
PosTdX
Full Name PositiveThresholdX
Short Name PosTdX
Description positive threshold in x-direction
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
English
Release 2018-06 300 / 866
NegTdX
Full Name NegativeThresholdX
Short Name NegTdX
Description negative threshold in x-direction
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
PosTdY
Full Name PositiveThresholdY
Short Name PosTdY
Description positive threshold in y-direction
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
NegTdY
Full Name NegativeThresholdY
Short Name NegTdY
Description negative threshold in y-direction
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
English
Release 2018-06 301 / 866
XBuffer
Full Name XBuffer
Short Name XBffr
Description name of the 1-dimensional buffer which shall be written to the system and which contains the x-
values for the y-values within the UpperBand and LowerBand data
Direction input
Class data
Unit 1
Configurable 1
Allowed manual Inputs string which contains the name of the 1-dimensional buffer data which shall be written to the sys-
tem
Remark in case a data name prefix is being specified for output data of the parent Analyzing Mod-
el/Analyzing Script, the specified output data name prefix is being added to the specified name
UpperBand
Full Name UpperBand
Short Name UpperBnd
Description receives a 1-dimensional buffer which contains the calculated upper band of the envelope
Direction input
Class data
Unit 1
Configurable 1
tem
LowerBand
Full Name LowerBand
Short Name LowerBnd
Description receives a 1-dimensional buffer which contains the calculated lower band of the envelope
Direction input
Class data
Unit 1
Configurable 1
tem
English
Release 2018-06 302 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.7.1.3 Outputs
Status
Full Name Status
Short Name Status
Description receives the current status of the calculation of the envelopes
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark = 0 while the calculation of the envelopes is in progress
= -1 in case an error occurred during the calculation of the envelopes
= 1 in case the calculation of the envelopes has been completed
2.6.7.1.4 Examples

which shows in detail how to use the Analyzing Function ClcXYEnv()for the calculation of the envelopes of x/y
data.
English
Release 2018-06 303 / 866
2.6.7.2 MonXYEnv() – MonitorXYEnvelope()
2.6.7.2.1 General
Properties
Full Name MonitorXYEnvelope
Short Name MonXYEnv
Description Monitors whether the given x/y data violates the given envelopes.
Parent Library Base
Parent Category Envelopes
Function Prototype
DataOrValue Cntrl = MonXYEnv
(
Buffer1D XBuffer1 = 0,
Buffer1D UpperBnd1 = 0,
Buffer1D LowerBnd1 = 0,
DataOrValue CntrlUpper = 0,
DataOrValue CntrlLower = 0
);
Symbol
English
Release 2018-06 304 / 866
2.6.7.2.2 Inputs
InX
Full Name InputX
Short Name InX
Description x-data which shall be used for the monitoring against the envelopes
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
InY
Full Name InputY
Short Name InY
Description y-data which shall be used for the monitoring against the envelopes
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
XBuffer1
Full Name XBuffer1
Short Name XBuffer1
Description 1-dimensional buffer which contains the x-values for the y-values within the UpperBand1 and
LowerBand1 buffers
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark XBuffer1 must be valid in case either UpperBand1 or LowerBand1 is specified
in case XBuffer1 is not available, the values of UpperBand1 and LowerBand1 are ignored
English
Release 2018-06 305 / 866
UpperBand1
Full Name UpperBand1
Short Name UpperBnd1
Description 1-dimensional buffer which contains the y-values for 1. upper band to the x-values within the
XBuffer1buffer
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark the number of values within the provided UpperBand1 buffer must be identical to the number of
values within the XBuffer1 buffer
0 can be passed for this argument in case monitoring of the 1. upper band is not needed
LowerBand1
Full Name LowerBand1
Short Name LowerBnd1
Description 1-dimensional buffer which contains the y-values for the 1. lower band to the x-values within the
XBuffer1 buffer
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark the number of values within the provided LowerBand1 buffer must be identical to the number of
0 can be passed for this argument in case monitoring of the 1. lower band is not needed
XBuffer2
Full Name XBuffer2
Short Name XBuffer2
LowerBand2 buffers
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
English
Release 2018-06 306 / 866
UpperBand2
XBuffer2 buffer
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
LowerBand2
XBuffer2 buffer
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
XBuffer3
Full Name XBuffer3
Short Name XBuffer3
LowerBand3 buffers
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
English
Release 2018-06 307 / 866
UpperBand3
XBuffer3 buffer
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
LowerBand3
XBuffer3 buffer
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 308 / 866
2.6.7.2.3 Outputs
Cntrl
Full Name Control
Short Name Cntrl
Description receives the result of the monitoring
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark Control is 0 in case none of the bands is violated by the current x and y input data
Control is positive in case one of the upper bands is violated (1 in case the UpperBand1 is violat-
ed, 2 in case the UpperBand2 is violated, …) - in case multiple of the upper bands are violated,
the value of Control matches the topmost upper band which has been violated
Control is negative in case one of the lower bands is violated (1 in case the LowerBand1 is violat-
ed, 2 in case the LowerBand2 is violated, …) - in case multiple of the lower bands are violated, the
value of Control matches the bottommost lower band which has been violated
in case none of the bands is violated but the x-value of the current input data is outside the range
of x-values of a band, Control shows a violation of the topmost band which does not cover the
current x-value
CntrlUpper
Full Name ControlUpper
Short Name CntrlUpper
Description receives the result of the monitoring of the upper bands
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark ControlUpper is 0 in case none of the upper bands is violated by the current x and y input data
ControlUpper is positive in case one of the upper bands is violated (1 in case the UpperBand1 is
violated, 2 in case the UpperBand2 is violated, …) - in case multiple of the upper bands are violat-
ed, the value of ControlUpper matches the topmost upper band which has been violated
of x-values of an upper band, ControlUpper shows a violation of the topmost upper band which
does not cover the current x-value
English
Release 2018-06 309 / 866
CntrlLower
Full Name ControlLower
Short Name CntrlLower
Description receives the result of the monitoring of the lower bands
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark ControlLower is 0 in case none of the lower bands is violated by the current x and y input data
ControlLower is negative in case one of the lower bands is violated (1 in case the LowerBand1 is
violated, 2 in case the LowerBand2 is violated, …) - in case multiple of the lower bands are violat-
ed, the value of ControlLower matches the bottommost lower band which has been violated
of x-values of a lower band, ControlLower shows a violation of the topmost lower band which does
not cover the current x-value
2.6.7.2.4 Examples

which shows in detail how to use the Analyzing Function MonXYEnv() for the monitoring of the envelopes of x/y
data.
English
Release 2018-06 310 / 866
2.6.8 Filter
2.6.8.1 BP() - BandPassFilter()
2.6.8.1.1 General
Properties
Full Name BandPassFilter
Short Name BP
Description First order Butterworth band pass filter for the input data or values.
Parent Library Base
Parent Category Filter
Equidistant Inputs Yes
Function Prototype
DataOrValue Out0 = BP
(
Value LCutFrq = 0,
Value HCutFrq = 1,
);
Symbol
2.6.8.1.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values which shall be filtered
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 311 / 866
LCutFrq
Full Name LowCutoffFrequency
Short Name LCutFrq
Description lower cutoff frequency of the filter
Direction input
Class parameter
Default Value 0
Unit Hz
Configurable 1
Allowed manual Inputs > 0 … < HCutFrq
Remark the cycle time of the parent Analyzing Program must be more than the double of the defined cutoff
frequency
HCutFrq
Full Name HighCutoffFrequency
Short Name HCutFrq
Description higher cutoff frequency of the filter
Direction input
Class parameter
Default Value 1
Unit Hz
Configurable 1
Allowed manual Inputs > LCutFrq … max of Decimal64
Remark the higher cutoff frequency must be bigger than the lower cutoff frequency
the cycle time of the parent Analyzing Program must be more than the double of the defined cutoff
frequency
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 312 / 866
2.6.8.1.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the filtering
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.8.1.4 Examples
Analyzing Model
BP 01 Online Uses a first order band pass filter on a generated rectangle signal and calculates the spec-
tra.
BP 02 Offline Uses a first order band pass filter on an offline rectangle signal and calculates the spectra.
Analyzing Script
BP 01 Online Uses a first order band pass filter on a generated rectangle signal.
BP 02 Offline Uses a first order band pass filter on an offline rectangle signal.
English
Release 2018-06 313 / 866
2.6.8.2 BS() - BandStopFilter()
2.6.8.2.1 General
Properties
Full Name BandStopFilter
Short Name BS
Description First order Butterworth band stop filter for the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = BS
(
Value LCutFrq = 0,
Value HCutFrq = 1,
);
Symbol
2.6.8.2.2 Inputs
In0
Full Name Input0
Short Name In0
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 314 / 866
LCutFrq
Short Name LCutFrq
Direction input
Class parameter
Default Value 0
Unit Hz
Configurable 1
frequency
HCutFrq
Short Name HCutFrq
Direction input
Class parameter
Default Value 1
Unit Hz
Configurable 1
frequency
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 315 / 866
2.6.8.2.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.8.2.4 Examples
Analyzing Model
BS 01 Online Uses a first order band stop filter on a generated rectangle signal and calculates the spec-
tra.
BS 02 Offline Uses a first order band stop filter on an offline rectangle signal and calculates the spectra.
Analyzing Script
BS 01 Online Uses a first order band stop filter on a generated rectangle signal.
BS 02 Offline Uses a first order band stop filter on an offline rectangle signal.
English
Release 2018-06 316 / 866
2.6.8.3 HP() - HighPassFilter()
2.6.8.3.1 General
Properties
Full Name HighPassFilter
Short Name HP
Description First order Butterworth high pass filter for the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = HP
(
Value CutFrq = 1,
);
Symbol
2.6.8.3.2 Inputs
In0
Full Name Input0
Short Name In0
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 317 / 866
CutFrq
Short Name CutFrq
Description cutoff frequency of the filter
Direction input
Class parameter
Default Value 1
Unit Hz
Configurable 1
frequency
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.8.3.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 318 / 866
2.6.8.3.4 Examples
Analyzing Model
HP 01 Online Uses a first order high pass filter on a generated rectangle signal and calculates the spectra.
HP 02 Offline Uses a first order high pass filter on an offline rectangle signal and calculates the spectra.
Analyzing Script
HP 01 Online Uses a first order high pass filter on a generated rectangle signal.
HP 02 Offline Uses a first order high pass filter on an offline rectangle signal.
English
Release 2018-06 319 / 866
2.6.8.4 IIRBPBT() - IIRBandPassFilterButterworth()
2.6.8.4.1 General
Properties
Full Name IIRBandPassFilterButterworth
Short Name IIRBPBT
Description Butterworth band pass filter for the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = IIRBPBT
(
Value Order = 1,
Value LCutFrq = 0,
Value HCutFrq = 1,
);
Symbol
2.6.8.4.2 Inputs
In0
Full Name Input0
Short Name In0
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 320 / 866
Order
Full Name FilterOrder
Short Name Order
Description order of the filter
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Allowed manual Inputs 1, 2, 3, … , 10
Remark none
LCutFrq
Short Name LCutFrq
Direction input
Class parameter
Default Value 0
Unit Hz
Configurable 1
frequency
HCutFrq
Short Name HCutFrq
Direction input
Class parameter
Default Value 1
Unit Hz
Configurable 1
frequency
English
Release 2018-06 321 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.8.4.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.8.4.4 Examples
Analyzing Model
IIRBPBT 01 Online Uses a tenth order band pass filter on a generated rectangle signal and calculates the spec-
tra.
IIRBPBT 02 Offline Uses a tenth order band pass filter on an offline rectangle signal and calculates the spectra.
Analyzing Script
IIRBPBT 01 Online Uses a tenth order band pass filter on a generated rectangle signal.
IIRBPBT 02 Offline Uses a tenth order band pass filter on an offline rectangle signal.
English
Release 2018-06 322 / 866
2.6.8.5 IIRBSBT() - IIRBandStopFilterButterworth()
2.6.8.5.1 General
Properties
Full Name IIRBandStopFilterButterworth
Short Name IIRBSBT
Description Butterworth band stop filter for the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = IIRBSBT
(
Value Order = 1,
Value LCutFrq = 0,
Value HCutFrq = 1,
);
Symbol
2.6.8.5.2 Inputs
In0
Full Name Input0
Short Name In0
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 323 / 866
Order
Short Name Order
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
LCutFrq
Short Name LCutFrq
Direction input
Class parameter
Default Value 0
Unit Hz
Configurable 1
frequency
HCutFrq
Short Name HCutFrq
Direction input
Class parameter
Default Value 1
Unit Hz
Configurable 1
frequency
English
Release 2018-06 324 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.8.5.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.8.5.4 Examples
Analyzing Model
IIRBSBT 01 Online Uses a tenth order band stop filter on a generated rectangle signal and calculates the spec-
tra.
IIRBSBT 02 Offline Uses a tenth order band stop filter on an offline rectangle signal and calculates the spectra.
Analyzing Script
IIRBSBT 01 Online Uses a tenth order band stop filter on a generated rectangle signal and calculates the spec-
tra.
IIRBSBT 02 Offline Uses a tenth order band stop filter on an offline rectangle signal.
English
Release 2018-06 325 / 866
2.6.8.6 IIRHPBT() - IIRHighPassFilterButterworth()
2.6.8.6.1 General
Properties
Full Name IIRHighPassFilterButterworth
Short Name IIRHPBT
Description Butterworth high pass filter for the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = IIRHPBT
(
Value Order = 1,
Value CutFrq = 1,
);
Symbol
2.6.8.6.2 Inputs
In0
Full Name Input0
Short Name In0
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 326 / 866
Order
Short Name Order
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Allowed manual Inputs 1, 2, 3, … 20
Remark none
CutFrq
Short Name CutFrq
Direction input
Class parameter
Default Value 1
Unit Hz
Configurable 1
frequency
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 327 / 866
2.6.8.6.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.8.6.4 Examples
Analyzing Model
IIRHPBT 01 Online Uses a fifteenth order high pass filter on a generated rectangle signal and calculates the
spectra.
IIRHPBT 02 Offline Uses a twentieth order high pass filter on an offline rectangle signal and calculates the spec-
tra.
Analyzing Script
IIRHPBT 01 Online Uses a fifteenth order high pass filter on a generated rectangle signal.
IIRHPBT 02 Offline Uses a tenth order high pass filter on an offline rectangle signal.
English
Release 2018-06 328 / 866
2.6.8.7 IIRLPBT() - IIRLowPassFilterButterworth()
2.6.8.7.1 General
Properties
Full Name IIRLowPassFilterButterworth
Short Name IIRLPBT
Description Butterworth low pass filter for the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = IIRLPBT
(
Value Order = 1,
Value CutFrq = 1,
);
Symbol
2.6.8.7.2 Inputs
In0
Full Name Input0
Short Name In0
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 329 / 866
Order
Short Name Order
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
CutFrq
Short Name CutFrq
Direction input
Class parameter
Default Value 1
Unit Hz
Configurable 1
frequency
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 330 / 866
2.6.8.7.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.8.7.4 Examples
Analyzing Model
IIRLPBT 01 Online Uses a fifteenth order low pass filter on a generated rectangle signal and calculates the
spectra.
IIRLPBT 02 Offline Uses a twentieth order low pass filter on an offline rectangle signal and calculates the spec-
tra.
Analyzing Script
IIRLPBT 01 Online Uses a fifteenth order low pass filter on a generated rectangle signal.
IIRLPBT 02 Offline Uses a tenth order low pass filter on an offline rectangle signal.
English
Release 2018-06 331 / 866
2.6.8.8 IIRBPCH1() – IIRBandPassFilterChebyshev1()
2.6.8.8.1 General
Properties
Full Name IIRBandPassFilterChebyshev1
Short Name IIRBPCH1
Description Chebyshev1 band pass filter for the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = IIRBPCH1
(
Value Order = 1,
Value LCutFrq = 0,
Value HCutFrq = 1,
Value Rppl = 0.1,
);
Symbol
2.6.8.8.2 Inputs
In0
Full Name Input0
Short Name In0
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 332 / 866
Order
Short Name Order
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
LCutFrq
Short Name LCutFrq
Direction input
Class parameter
Default Value 0
Unit Hz
Configurable 1
frequency
HCutFrq
Short Name HCutFrq
Direction input
Class parameter
Default Value 1
Unit Hz
Configurable 1
frequency
English
Release 2018-06 333 / 866
Rppl
Full Name Ripple
Short Name Rppl
Description ripple depth for the passband
Direction input
Class parameter
Default Value 0.1
Unit dB
Configurable 1
Allowed manual Inputs 0.1 … 3
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.8.8.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 334 / 866
2.6.8.8.4 Examples
Analyzing Model
IIRBPCH1 01 Online Uses a tenth order band pass filter on a generated rectangle signal and calculates the spec-
tra.
IIRBPCH1 02 Offline Uses a tenth order band pass filter on an offline rectangle signal and calculates the spectra.
Analyzing Script
IIRBPCH1 01 Online Uses a tenth order band pass filter on a generated rectangle signal.
IIRBPCH1 02 Offline Uses a tenth order band pass filter on an offline rectangle signal.
English
Release 2018-06 335 / 866
2.6.8.9 IIRBSCH1() – IIRBandStopFilterChebyshev1()
2.6.8.9.1 General
Properties
Full Name IIRBandStopFilterChebyshev1
Short Name IIRBSCH1
Description Chebyshev1 band stop filter for the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = IIRBSCH1
(
Value Order = 1,
Value LCutFrq = 0,
Value HCutFrq = 1,
Value Rppl = 0.1,
);
Symbol
2.6.8.9.2 Inputs
In0
Full Name Input0
Short Name In0
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 336 / 866
Order
Short Name Order
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
LCutFrq
Short Name LCutFrq
Direction input
Class parameter
Default Value 0
Unit Hz
Configurable 1
frequency
HCutFrq
Short Name HCutFrq
Direction input
Class parameter
Default Value 1
Unit Hz
Configurable 1
frequency
English
Release 2018-06 337 / 866
Rppl
Full Name Ripple
Short Name Rppl
Direction input
Class parameter
Default Value 0.1
Unit dB
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.8.9.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 338 / 866
2.6.8.9.4 Examples
Analyzing Model
IIRBSCH1 01 Online Uses a tenth order band stop filter on a generated rectangle signal and calculates the spec-
tra.
IIRBSCH1 02 Offline Uses a tenth order band stop filter on an offline rectangle signal and calculates the spectra.
Analyzing Script
IIRBSCH1 01 Online Uses a tenth order band stop filter on a generated rectangle signal.
IIRBSCH1 02 Offline Uses a tenth order band stop filter on an offline rectangle signal.
English
Release 2018-06 339 / 866
2.6.8.10 IIRHPCH1() – IIRHighPassFilterChebyshev1()
2.6.8.10.1 General
Properties
Full Name IIRHighPassFilterChebyshev1
Short Name IIRHPCH1
Description Chebyshev1 high pass filter for the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = IIRHPCH1
(
Value Order = 1,
Value CutFrq = 1,
Value Rppl = 0.1,
);
Symbol
2.6.8.10.2 Inputs
In0
Full Name Input0
Short Name In0
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 340 / 866
Order
Short Name Order
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
CutFrq
Short Name CutFrq
Direction input
Class parameter
Default Value 1
Unit Hz
Configurable 1
frequency
Rppl
Full Name Ripple
Short Name Rppl
Direction input
Class parameter
Default Value 0.1
Unit dB
Configurable 1
Remark none
English
Release 2018-06 341 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.8.10.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.8.10.4 Examples
Analyzing Model
IIRHPCH1 01 Online Uses a fifteenth order high pass filter on a generated rectangle signal and calculates the
spectra.
IIRHPCH1 02 Offline Uses a twentieth order high pass filter on an offline rectangle signal and calculates the spec-
tra.
Analyzing Script
IIRHPCH1 01 Online Uses a fifteenth order high pass filter on a generated rectangle signal.
IIRHPCH1 02 Offline Uses a tenth order high pass filter on an offline rectangle signal.
English
Release 2018-06 342 / 866
2.6.8.11 IIRLPCH1() – IIRLowPassFilterChebyshev1()
2.6.8.11.1 General
Properties
Full Name IIRLowPassFilterChebyshev1
Short Name IIRLPCH1
Description Chebyshev1 low pass filter for the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = IIRLPCH1
(
Value Order = 1,
Value CutFrq = 1,
Value Rppl = 0.1,
);
Symbol
2.6.8.11.2 Inputs
In0
Full Name Input0
Short Name In0
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 343 / 866
Order
Short Name Order
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
CutFrq
Short Name CutFrq
Direction input
Class parameter
Default Value 1
Unit Hz
Configurable 1
frequency
Rppl
Full Name Ripple
Short Name Rppl
Direction input
Class parameter
Default Value 0.1
Unit dB
Configurable 1
Remark none
English
Release 2018-06 344 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.8.11.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.8.11.4 Examples
Analyzing Model
IIRLPCH1 01 Online Uses a fifteenth order low pass filter on a generated rectangle signal and calculates the
spectra.
IIRLPCH1 02 Offline Uses a twentieth order low pass filter on an offline rectangle signal and calculates the spec-
tra.
Analyzing Script
IIRLPCH1 01 Online Uses a fifteenth order low pass filter on a generated rectangle signal.
IIRLPCH1 02 Offline Uses a tenth order low pass filter on an offline rectangle signal.
English
Release 2018-06 345 / 866
2.6.8.12 IIRBPCH2() – IIRBandPassFilterChebyshev2()
2.6.8.12.1 General
Properties
Full Name IIRBandPassFilterChebyshev2
Short Name IIRBPCH2
Description Chebyshev2 band pass filter for the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = IIRBPCH2
(
Value Order = 1,
Value LCutFrq = 0,
Value HCutFrq = 1,
Value Rppl = 0.1,
);
Symbol
2.6.8.12.2 Inputs
In0
Full Name Input0
Short Name In0
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 346 / 866
Order
Short Name Order
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
LCutFrq
Short Name LCutFrq
Direction input
Class parameter
Default Value 0
Unit Hz
Configurable 1
frequency
HCutFrq
Short Name HCutFrq
Direction input
Class parameter
Default Value 1
Unit Hz
Configurable 1
frequency
English
Release 2018-06 347 / 866
Rppl
Full Name Ripple
Short Name Rppl
Description ripple depth for the stopband
Direction input
Class parameter
Default Value 0.1
Unit dB
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.8.12.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 348 / 866
2.6.8.12.4 Examples
Analyzing Model
IIRBPCH2 01 Online Uses a tenth order band pass filter on a generated rectangle signal and calculates the spec-
tra.
IIRBPCH2 02 Offline Uses a tenth order band pass filter on an offline rectangle signal and calculates the spectra.
Analyzing Script
IIRBPCH2 01 Online Uses a tenth order band pass filter on a generated rectangle signal.
IIRBPCH2 02 Offline Uses a tenth order band pass filter on an offline rectangle signal.
English
Release 2018-06 349 / 866
2.6.8.13 IIRBSCH2() – IIRBandStopFilterChebyshev2()
2.6.8.13.1 General
Properties
Full Name IIRBandStopFilterChebyshev2
Short Name IIRBSCH2
Description Chebyshev2 band stop filter for the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = IIRBSCH2
(
Value Order = 1,
Value LCutFrq = 0,
Value HCutFrq = 1,
Value Rppl = 0.1,
);
Symbol
2.6.8.13.2 Inputs
In0
Full Name Input0
Short Name In0
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 350 / 866
Order
Short Name Order
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
LCutFrq
Short Name LCutFrq
Direction input
Class parameter
Default Value 0
Unit Hz
Configurable 1
frequency
HCutFrq
Short Name HCutFrq
Direction input
Class parameter
Default Value 1
Unit Hz
Configurable 1
frequency
English
Release 2018-06 351 / 866
Rppl
Full Name Ripple
Short Name Rppl
Direction input
Class parameter
Default Value 0.1
Unit dB
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.8.13.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 352 / 866
2.6.8.13.4 Examples
Analyzing Model
IIRBSCH2 01 Online Uses a tenth order band stop filter on a generated rectangle signal and calculates the spec-
tra.
IIRBSCH2 02 Offline Uses a tenth order band stop filter on an offline rectangle signal and calculates the spectra.
Analyzing Script
IIRBSCH2 01 Online Uses a tenth order band stop filter on a generated rectangle signal.
IIRBSCH2 02 Offline Uses a tenth order band stop filter on an offline rectangle signal.
English
Release 2018-06 353 / 866
2.6.8.14 IIRHPCH2() – IIRHighPassFilterChebyshev2()
2.6.8.14.1 General
Properties
Full Name IIRHighPassFilterChebyshev2
Short Name IIRHPCH2
Description Chebyshev2 high pass filter for the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = IIRHPCH2
(
Value Order = 1,
Value CutFrq = 1,
Value Rppl = 0.1,
);
Symbol
2.6.8.14.2 Inputs
In0
Full Name Input0
Short Name In0
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 354 / 866
Order
Short Name Order
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
CutFrq
Short Name CutFrq
Direction input
Class parameter
Default Value 1
Unit Hz
Configurable 1
frequency
Rppl
Full Name Ripple
Short Name Rppl
Direction input
Class parameter
Default Value 0.1
Unit dB
Configurable 1
Remark none
English
Release 2018-06 355 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.8.14.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.8.14.4 Examples
Analyzing Model
IIRHPCH2 01 Online Uses a fifteenth order high pass filter on a generated rectangle signal and calculates the
spectra.
IIRHPCH2 02 Offline Uses a twentieth order high pass filter on an offline rectangle signal and calculates the spec-
tra.
Analyzing Script
IIRHPCH2 01 Online Uses a fifteenth order high pass filter on a generated rectangle signal.
IIRHPCH2 02 Offline Uses a tenth order high pass filter on an offline rectangle signal.
English
Release 2018-06 356 / 866
2.6.8.15 IIRLPCH2() – IIRLowPassFilterChebyshev2()
2.6.8.15.1 General
Properties
Full Name IIRLowPassFilterChebyshev2
Short Name IIRLPCH2
Description Chebyshev2 low pass filter for the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = IIRLPCH2
(
Value Order = 1,
Value CutFrq = 1,
Value Rppl = 0.1,
);
Symbol
2.6.8.15.2 Inputs
In0
Full Name Input0
Short Name In0
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 357 / 866
Order
Short Name Order
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
CutFrq
Short Name CutFrq
Direction input
Class parameter
Default Value 1
Unit Hz
Configurable 1
frequency
Rppl
Full Name Ripple
Short Name Rppl
Direction input
Class parameter
Default Value 0.1
Unit dB
Configurable 1
Remark none
English
Release 2018-06 358 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.8.15.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.8.15.4 Examples
Analyzing Model
IIRLPCH2 01 Online Uses a fifteenth order low pass filter on a generated rectangle signal and calculates the
spectra.
IIRLPCH2 02 Offline Uses a twentieth order low pass filter on an offline rectangle signal and calculates the spec-
tra.
Analyzing Script
IIRLPCH2 01 Online Uses a fifteenth order low pass filter on a generated rectangle signal.
IIRLPCH2 02 Offline Uses a tenth order low pass filter on an offline rectangle signal.
English
Release 2018-06 359 / 866
2.6.8.16 IIRVBPBT() - IIRVariableBandPassFilterButterworth()
2.6.8.16.1 General
Properties
Full Name IIRVariableBandPassFilterButterworth
Short Name IIRBPBT
Description Butterworth band pass filter for the input data or values with variable band pass.
Parent Library Base
Function Prototype
DataOrValue Out0 = IIRVBPBT
(
Value Order = 1,
DataOrValue CntrFrq = 1,
Value BndWd = 0,
);
Symbol
2.6.8.16.2 Inputs
In0
Full Name Input0
Short Name In0
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 360 / 866
Order
Short Name Order
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
CntrFrq
Full Name CenterFrequency
Short Name CntrFrq
Description center frequency of the pass band
Direction input
Class data
Default Value 1
Unit Hz
Configurable 1
Remark
BndWd
Full Name BandWidth
Short Name BndWdth
Description width of the pass band
Direction input
Class parameter
Default Value 1
Unit Hz
Configurable 1
Remark “CenterFrequency – BandWidth” must be bigger than 0
the cycle time of the parent Analyzing Program must be more than the double of “CenterFrequen-
cy + BandWidth”
English
Release 2018-06 361 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.8.16.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.8.16.4 Examples
Analyzing Model
IIRVBPBT 01 Online Uses a tenth order band pass filter on a generated rectangle signal and calculates the spec-
tra.
IIRVBPBT 02 Offline Uses a tenth order band pass filter on an offline rectangle signal and calculates the spectra.
Analyzing Script
IIRVBPBT 01 Online Uses a tenth order band pass filter on a generated rectangle signal.
IIRVBPBT 02 Offline Uses a tenth order band pass filter on an offline rectangle signal.
English
Release 2018-06 362 / 866
2.6.8.17 LP() - LowPassFilter()
2.6.8.17.1 General
Properties
Full Name LowPassFilter
Short Name LP
Description First order Butterworth low pass filter for the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = LP
(
Value CutFrq = 1,
);
Symbol
2.6.8.17.2 Inputs
In0
Full Name Input0
Short Name In0
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 363 / 866
CutFrq
Short Name CutFrq
Direction input
Class parameter
Default Value 1
Unit Hz
Configurable 1
frequency
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.8.17.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 364 / 866
2.6.8.17.4 Examples
Analyzing Model
LP 01 Online Uses a first order low pass filter on a generated rectangle signal and calculates the spectra.
LP 02 Offline Uses a first order low pass filter on an offline rectangle signal and calculates the spectra.
Analyzing Script
LP 01 Online Uses a first order low pass filter on a generated rectangle signal.
LP 02 Offline Uses a first order low pass filter on an offline rectangle signal.
English
Release 2018-06 365 / 866
2.6.9 Generation
2.6.9.1 GenWF() - GenerateWaveForm()
2.6.9.1.1 General
Properties
Full Name GenerateWaveForm
Short Name GenWF
Description Generates a periodical signal with a chosen shape.
Parent Library Base
Parent Category Generation
Function Prototype
DataOrValue Out0 = GenWF
(
Value Shape = “Sine”,
DataOrValue Amp = 1,
DataOrValue Frq = 1,
DataOrValue Offset = 0,
Value Phase = 0,
);
Symbol
2.6.9.1.2 Inputs
Shape
Full Name Shape
Short Name Shape
Description form of the wave which shall be generated
Direction input
Class parameter
Default Value “Sine”
Unit n/a
Configurable 1
Allowed manual Inputs “Sine”, “Cosine”, “Rectangle”, “Triangle”, “Sawtooth”
Remark none
English
Release 2018-06 366 / 866
Amp
Full Name Amplitude
Short Name Amp
Description amplitude of the waveform which shall be generated
Direction input
Class data
Default Value 1
Unit 1
Configurable 1
Remark none
Frq
Full Name Frequency
Short Name Frq
Description frequency of the waveform which shall be generated
Direction input
Class data
Default Value 1
Unit Hz
Configurable 1
Remark none
Offset
Full Name Offset
Short Name Offset
Description steady component of the waveform which shall be generated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 367 / 866
Phase
Full Name Phase
Short Name Phase
Description phase-shift of the waveform which shall be generated
Direction input
Class parameter
Default Value 0
Unit rad
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.9.1.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the values which has been generated
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 368 / 866
2.6.9.1.4 Examples
Analyzing Model
GenWF 01 Online Generates different kinds of signals.
GenWF 02 Offline Generates 2 modulated sine waves depending on 2 offline signals.
Analyzing Script
GenWF 01 Online Generates different kinds of signals.
English
Release 2018-06 369 / 866
2.6.9.2 Impulser() - Impulser()
2.6.9.2.1 General
Properties
Full Name Impulser
Short Name Impulser
Description Generates an impulse signal with a chosen shape.
Parent Library Base
Function Prototype
DataOrValue Out0 = Impulser
(
Value Shape = “Rectangle”,
DataOrValue Amp = 1,
DataOrValue Offset = 0,
DataOrValue CT = 1,
DataOrValue IT = 0.1,
Value DT = 0,
);
Symbol
2.6.9.2.2 Inputs
Shape
Full Name Shape
Short Name Shape
Description form of the impulse which shall be generated
Direction input
Class parameter
Default Value “Rectangle”
Unit n/a
Configurable 1
Allowed manual Inputs “Rectangle”
Remark none
English
Release 2018-06 370 / 866
Amp
Full Name Amplitude
Short Name Amp
Description amplitude of the impulse which shall be generated
Direction input
Class data
Default Value 1
Unit 1
Configurable 1
Remark none
Offset
Full Name Offset
Short Name Offset
Description steady component of the impulse which shall be generated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
CT
Full Name CycleTime
Short Name CT
Description cycle time of the impulse signal which shall be generated
Direction input
Class data
Default Value 1
Unit s
Configurable 1
Remark none
English
Release 2018-06 371 / 866
IT
Full Name ImpulseTime
Short Name IT
Description duration of the impulse which shall be generated
Direction input
Class data
Default Value 0.1
Unit s
Configurable 1
Remark none
DT
Full Name DelayTime
Short Name DT
Description delay time of the impulse signal which shall be generated
Direction input
Class parameter
Default Value 0
Unit s
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 372 / 866
2.6.9.2.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the values which has been generated
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.9.2.4 Examples
Analyzing Model
Impulser 01 Online Generates an impulse signal with variable cycle time.
Impulser 02 Offline Generates modulated impulse signal depending on offline signal.
Analyzing Script
Impulser 01 Online Generates an impulse signal with variable cycle time.
Impulser 02 Offline Generates modulated impulse signal depending on offline signal.
English
Release 2018-06 373 / 866
2.6.9.3 Random() - Random()
2.6.9.3.1 General
Properties
Full Name Random
Short Name Random
Description Generates random values within a defined range.
Parent Library Base
Function Prototype
DataOrValue Out0 = Random
(
DataOrValue Min = 0,
DataOrValue Max = 1,
);
Symbol
2.6.9.3.2 Inputs
Min
Full Name Minimum
Short Name Min
Description minimum level of the random values which shall be generated
Direction input
Class data
Default Value 1
Unit 1
Configurable 1
Remark none
English
Release 2018-06 374 / 866
Max
Full Name Maximum
Short Name Max
Description maximum level of the random values which shall be generated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
Prcsn
Full Name Precision
Short Name Prcsn
Description precision of the random values which shall be generated
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs “Integer32”, “Decimal64”
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 375 / 866
2.6.9.3.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the random values which has been generated
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.9.3.4 Examples
Analyzing Model
Random 01 Online Generates a random signal within variable range.
Random 02 Offline Generates modulated random signal depending on 2 offline signals.
Analyzing Script
Random 01 Online Generates a random signal within variable range.
Random 02 Offline Generates modulated random signal depending on 2 offline signals.
English
Release 2018-06 376 / 866
2.6.10 Input
2.6.10.1 In() - Input()
2.6.10.1.1 General
Properties
Full Name Input
Short Name In
Description Reads simple values (Booleans, Integers or decimals) from the system which can be used by
following Analyzing Functions afterwards.
Parent Library Base
Parent Category Input
Function Prototype
DataOrValue Out0 = In
(
Value Name = 0,
Value Int = “Default”,
DataOrValue* Unit = NULL,
DataOrValue* Desc = NULL
);
Symbol
2.6.10.1.2 Inputs
Name
Full Name Name
Short Name Name
Description name of the data from the system whose values shall be provided to Output0
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 377 / 866
Int
Full Name Interpolation
Short Name Int
Description determines the interpolation method which is used when reading the data from the system
Direction input
Class parameter
Default Value “Default”
Unit n/a
Configurable 1
Allowed manual Inputs “Default”, “Stairs”, “None”, “Lines”, “Nearest Neighbor”, “Last Probe”
Remark in case the argument is set to "Default" but the currently chosen "Default Input Data Interpolation
Mode" of the owning Analyzing Model/Analyzing Script is not supported by the Analyzing Func-
tion, "Stairs" is being chosen as interpolation mode
in case the input of the Analyzing Function is online data, only “Stairs”, “None” and “Last Probe”
can be used as interpolation mode - in case any other interpolation mode would be specified, an
according warning is added to the system log and the Analyzing Function uses the interpolation
mode “Stairs” for its processing
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.10.1.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the value which has been read from the system
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 378 / 866
Unit
Full Name Unit
Short Name Unit
Description receives the unit of the data from the system
Direction output
Class data
Unit n/a
Configurable 1
Remark none
Desc
Full Name Description
Short Name Desc
Description receives the description of the data from the system
Direction output
Class data
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 379 / 866
2.6.10.2 InAAF() - InputAntiAliasingFilter()
2.6.10.2.1 General
Properties
Full Name InputAntiAliasingFilter
Short Name InAAF
Description Reads anti aliasing filtered simple values (Booleans, Integers or decimals) from the system which
can be used by following Analyzing Functions afterwards.
Parent Library Base
Function Prototype
DataOrValue Out0 = InAAF
(
Value Name = 0,
);
Symbol
2.6.10.2.2 Inputs
Name
Full Name Name
Short Name Name
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 380 / 866
Int
Short Name Int
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs “Default”, “Stairs”, “Lines”, “Nearest Neighbor”
in case the input of the Analyzing Function is online data, only “Stairs” can be used as interpola-
tion mode - in case any other interpolation mode would be specified, an according warning is
added to the system log and the Analyzing Function uses the interpolation mode “Stairs” for its
processing
the interpolation mode is applied only in case the anti-aliasing filter is disabled
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 381 / 866
2.6.10.2.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the data interpolation
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
Unit
Full Name Unit
Short Name Unit
Direction output
Class data
Unit n/a
Configurable 1
Remark none
Desc
Short Name Desc
Direction output
Class data
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 382 / 866
2.6.10.2.4 Examples
Analyzing Model
InAAF 01 (Genera- Online Generates the input data for the Analyzing Model “InAAF 01”.
tor)
InAAF 01 Online Downsamples the input data from 12 kHz to 4 kHz.
Analyzing Script
InAAF 01 (Genera- Online Generates the input data for the Analyzing Script “InAAF 01”.
tor)
InAAF 01 Online Downsamples the input data from 12 kHz to 4 kHz.
English
Release 2018-06 383 / 866
2.6.10.3 InAAFCH1() - InputAntiAliasingFilterChebyshev1()
2.6.10.3.1 General
Properties
Full Name InputAntiAliasingFilterChebyshev1
Short Name InAAFCH1
Description Reads anti aliasing filtered simple values (Booleans, Integers or decimals) from the system which
Parent Library Base
Function Prototype
DataOrValue Out0 = InAAFCH1
(
Value Order = 16,
Value CutFrq = 0,
Value Rppl = 0.1,
);
Symbol
English
Release 2018-06 384 / 866
2.6.10.3.2 Inputs
Name
Full Name Name
Short Name Name
Direction input
Class parameter
Unit n/a
Configurable 1
Int
Short Name Int
Direction input
Class parameter
Unit n/a
Configurable 1
processing
the interpolation mode is applied only in case the anti-aliasing filter is disabled
English
Release 2018-06 385 / 866
Order
Short Name Order
Direction input
Class parameter
Default Value 16
Unit 1
Configurable 1
Remark none
CutFrq
Short Name CutFrq
Direction input
Class parameter
Default Value 0
Unit Hz
Configurable 1
Remark in case a value of 0 is specified, the cutoff-frequency is determined automatically
in case the specified value is not 0, the cycle time of the parent Analyzing Program must be more
than the double of the defined cutoff frequency
Rppl
Full Name Ripple
Short Name Rppl
Description ripple depth of the passband
Direction input
Class parameter
Default Value 0.1
Unit dB
Configurable 1
Allowed manual Inputs >0
Remark none
English
Release 2018-06 386 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.10.3.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the data interpolation
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
Unit
Full Name Unit
Short Name Unit
Direction output
Class data
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 387 / 866
Desc
Short Name Desc
Direction output
Class data
Unit n/a
Configurable 1
Remark none
2.6.10.3.4 Examples
Analyzing Model
InAAFCH1 01 (Gen- Online Generates the input data for the Analyzing Model “InAAFCH1 01”.
erator)
InAAFCH1 01 Online Downsamples the input data from 12 kHz to 4 kHz.
Analyzing Script
InAAFCH1 01 (Gen- Online Generates the input data for the Analyzing Script “InAAFCH1 01”.
erator)
InAAFCH1 01 Online Downsamples the input data from 12 kHz to 4 kHz.
English
Release 2018-06 388 / 866
2.6.10.4 InB1D() - InputBuffer1D()
2.6.10.4.1 General
Properties
Full Name InputBuffer1D
Short Name InB1D
Description Reads 1-dimensional buffer values from the system which can be used by following Analyzing
Functions afterwards.
Parent Library Base
Function Prototype
Buffer1D Out0 = InB1D
(
Value Int = “Last Probe”,
);
Symbol
2.6.10.4.2 Inputs
Name
Full Name Name
Short Name Name
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 389 / 866
Int
Short Name Int
Description determines the interpolation method which is used when reading the buffer data from the system
Direction input
Class parameter
Default Value “Last Probe”
Unit n/a
Configurable 1
Allowed manual Inputs “Default”, “Stairs”, “None”, “Nearest Neighbor”, “Last Probe”
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.10.4.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 390 / 866
OutReady
Short Name OutReady
Description indicates whether the data in Output0 is valid
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
Unit
Full Name Unit
Short Name Unit
Direction output
Class data
Unit n/a
Configurable 1
Remark none
Desc
Short Name Desc
Direction output
Class data
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 391 / 866
2.6.10.5 InB2D() – InputBuffer2D()
2.6.10.5.1 General
Properties
Full Name InputBuffer2D
Short Name InB2D
Description Reads 2-dimensional buffer values from the system which can be used by following Analyzing
Parent Library Base
Function Prototype
Buffer2D Out0 = InB2D
(
);
Symbol
2.6.10.5.2 Inputs
Name
Full Name Name
Short Name Name
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 392 / 866
Int
Short Name Int
Description determines the interpolation method which is used when reading the buffer data from the system
Direction input
Class parameter
Unit n/a
Configurable 1
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.10.5.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 393 / 866
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
Unit
Full Name Unit
Short Name Unit
Direction output
Class data
Unit n/a
Configurable 1
Remark none
Desc
Short Name Desc
Direction output
Class data
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 394 / 866
2.6.10.6 InConst() - InputConstant()
2.6.10.6.1 General
Properties
Full Name InputConstant
Short Name InConst
Description Takes the value from its input and passes it to all connected input arguments of other Analyz-
ing/User Functions before the parent Analyzing Program is initialized.
Parent Library Base
Function Prototype
Value Out0 = InConst
(
Value In0 = 0
);
Symbol
2.6.10.6.2 Inputs
In0
Full Name Input0
Short Name In0
Description value which shall be provided to Output0
Direction input
Class parameter
Default Value 0
Unit n/a
Configurable 1
Supported Data Types Boolean, Integer8, Integer16, Integer32, Integer64, Decimal32, Decimal64, String
Allowed manual Inputs any Boolean, Integer, Decimal or String value
Remark none
English
Release 2018-06 395 / 866
2.6.10.6.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the value which has been provided via Input0
Direction output
Class parameter
Default Value 0
Unit n/a
Configurable 1
Supported Data Types Boolean, Integer8, Integer16, Integer32, Integer64, Decimal32, Decimal64, String
Remark within Analyzing Models and User Functions, this output argument can be linked to any input ar-
gument of matching data type
English
Release 2018-06 396 / 866
2.6.10.7 InOrdRsmpl() – InputOrderResampling()
2.6.10.7.1 General
Properties
Full Name InputOrderResampling
Short Name InOrdRsmpl
Description Reads order resampled simple values (Booleans, Integers or decimals) from the system which
Parent Library Base
Function Prototype
Buffer1D Out0 = InOrdRsmpl
(
Value Signal = “”,
DataOrValue Trigger = “”,
Value NoI = 1,
Value MaxOrder = 64,
Value NoP = 1024,
Value Lap = 0,
);
Symbol
English
Release 2018-06 397 / 866
2.6.10.7.2 Inputs
Signal
Full Name SignalName
Short Name Signal
Description name of the data from the system whose values shall be order-resampled and provided to Out-
put0
Direction input
Class parameter
Unit n/a
Configurable 1
Supported Data Types String, Boolean, Integer8, Integer16, Integer32, Integer64, Decimal32, Decimal64
Trigger
Full Name TriggerName
Short Name Trigger
Description trigger data which shall be used to resample the signal
Direction input
Class data
Default Value false
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the trigger data
Int
Short Name Int
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 398 / 866
NoI
Full Name NumberOfImpulses
Short Name NoI
Description determines the number of trigger impulses per revolution
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Allowed manual Inputs 1…8
Remark none
MaxOrder
Full Name MaximumOrder
Short Name MaxOrder
Description determines the maximum order of the afterwards calculated order spectrum
Direction input
Class parameter
Default Value 64
Unit 1
Configurable 1
Remark none
NoP
Short Name NoP
Description determines the number of signal points which are used for the order FFT calculation afterwards
Direction input
Class parameter
Default Value 1024
Unit 1
Configurable 1
Allowed manual Inputs 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536
Remark none
English
Release 2018-06 399 / 866
Lap
Full Name Overlap
Short Name Lap
Description defines the overlapping length of the values which are input by SignalName
Direction input
Class parameter
Default Value 0
Unit 1
Configurable 1
Allowed manual Inputs 0 … 1)
Remark in case Overlap = 0 no overlapping will be occurred
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.10.7.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the 1-dimensional buffer with the order resampled values
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 400 / 866
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
Unit
Full Name Unit
Short Name Unit
Direction output
Class data
Unit n/a
Configurable 1
Remark none
Desc
Short Name Desc
Direction output
Class data
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 401 / 866
2.6.10.8 InSpm() - InputSpectrum()
2.6.10.8.1 General
Properties
Full Name InputSpectrum
Short Name InSpm
Description Reads spectrum values from the system which can be used by following Analyzing Functions
afterwards.
Parent Library Base
Function Prototype
Spectrum Out0 = InSpm
(
);
Symbol
2.6.10.8.2 Inputs
Name
Full Name Name
Short Name Name
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the spectrum data from the system
English
Release 2018-06 402 / 866
Int
Short Name Int
Description determines the interpolation method which is used when reading the spectrum data from the sys-
tem
Direction input
Class parameter
Unit n/a
Configurable 1
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 403 / 866
2.6.10.8.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
Unit
Full Name Unit
Short Name Unit
Direction output
Class data
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 404 / 866
Desc
Short Name Desc
Direction output
Class data
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 405 / 866
2.6.10.9 InSpmEnv() - InputSpectrumEnvelope()
2.6.10.9.1 General
Properties
Full Name InputSpectrumEnvelope
Short Name InSpmEnv
Description Reads spectrum envelope data from the system which can be used by following Analyzing Func-
tions afterwards.
Parent Library Base
Function Prototype
SpectrumEnvelope Out0 = InSpmEnv
(
);
Symbol
2.6.10.9.2 Inputs
Name
Full Name Name
Short Name Name
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the spectrum envelope data from the system
English
Release 2018-06 406 / 866
Int
Short Name Int
Description determines the interpolation method which is used when reading the spectrum envelope data from
the system
Direction input
Class parameter
Unit n/a
Configurable 1
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 407 / 866
2.6.10.9.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Supported Data Types Spectrum Envelope
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
Unit
Full Name Unit
Short Name Unit
Direction output
Class data
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 408 / 866
Desc
Short Name Desc
Direction output
Class data
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 409 / 866
2.6.10.10 InStr() - InputString()
2.6.10.10.1 General
Properties
Full Name InputString
Short Name InStr
Description Reads strings from the system which can be used by following Analyzing Functions afterwards.
Parent Library Base
Function Prototype
DataOrValue Out0 = InStr
(
Value Name = 0,
DataOrValue* Size = NULL,
);
Symbol
2.6.10.10.2 Inputs
Name
Full Name Name
Short Name Name
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the string data from the system
English
Release 2018-06 410 / 866
Int
Short Name Int
Direction input
Class parameter
Unit n/a
Configurable 1
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.10.10.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 411 / 866
Size
Full Name Size
Short Name Size
Description receives the number of characters of the data from the system
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
Unit
Full Name Unit
Short Name Unit
Direction output
Class data
Unit n/a
Configurable 1
Remark none
Desc
Short Name Desc
Direction output
Class data
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 412 / 866
2.6.10.11 InTCP() - InputTCP()
2.6.10.11.1 General
Properties
Full Name InputTCP
Short Name InTCP
Description Receives a data buffer from the specified IP address.
Parent Library Base
Supported Operating Modes Time-Slice based
Function Prototype
Buffer1D Out0 = InTCP
(
Value IP = “”,
Value Port = 1,
Value WatchDog = 0,
DataOrValue* Length = NULL,
DataOrValue* Index = NULL,
DataOrValue* Conn = NULL
);
Symbol
2.6.10.11.2 Inputs
IP
Full Name IPAddress
Short Name IP
Description receives the IP address which is allowed to transmit data to this Analyzing Function
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the IP address
Remark none
English
Release 2018-06 413 / 866
Port
Full Name Port
Short Name Port
Description receives the port at which the Analyzing Function waits for a connection from the specified IP
address
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
Watchdog
Full Name Watchdog
Short Name Watchdog
Description allows to monitor whether there are still packets arriving from the specified IP address
Direction input
Class parameter
Default Value 0
Unit s
Configurable 1
Remark in case the value of Watchdog is 0, the watchdog is disabled
in case there is no TCP packet for longer than the specified watchdog time, the Analyzing Func-
tion breaks the current connection and starts to wait for new connections again
EN
Full Name Enable
Short Name EN
Description enables or disables the internal function
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 414 / 866
2.6.10.11.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the latest data buffer whenever a new data packet has been received from the specified
IP address
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
Length
Full Name Length
Short Name Length
Description contains the size of the buffer which is provided via Output0
Direction output
Class data
Default Value 0
Unit bytes
Configurable 1
Remark none
English
Release 2018-06 415 / 866
Index
Full Name Index
Short Name Index
Description contains the index of the TCP telegram which has been received
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.10.11.4 Remarks
In order to use this Analyzing Function, a TCP client must be provided for the other side of the connection.
The IP address of the TCP client must match the specified “IP” input arguments of this Analyzing Function.
The Analyzing Function waits for a connecting TCP client at the specified “Port”.
In case multiple TCP packets arrive within two calculations of the parent Analyzing Model/Analyzing Script, only
the data from the last TCP packet is used and the other TCP packets are discarded.
There is no handling of timestamps or time information - the last known TCP packet simply is inserted into the
next calculation of a heart beat time.
Besides the standard TCP framework bytes, the following data is being expected by this Analyzing Function:
Length Type Data Type Description
4 Byte Timestamp unsigned long reserved for future use
4 Byte Length unsigned long contains the length of the payload (without the “Timestamp”, “Length”, “Index”
and “End Delimiter” fields)
the length includes also includes possible present padding bytes
the received length is output via the “Length” output argument
4 Byte Index unsigned long contains the index
the received index is not examined by the Analyzing Function but it is output
via the “Index” output argument
x Byte Payload variable contains the payload which is provided to “Output0”
4 Byte End Delimiter unsigned long contains the end delimiter (0x7FFFFFFF)
The Analyzing Function GetVFrmB1D() must be used in order to extract the single values out of the “Output0”
output of InTCP().
English
Release 2018-06 416 / 866
Example
Figure 22: Example for the Configuration of the Analyzing Function InTCP()
2.6.10.11.5 Examples
Analyzing Model
InTCP 01 Online Different online data is received via TCP. This Analyzing Model also uses the Analyzing
Function OutTCP() in order to provide the counterpart which sends the online data.
Analyzing Script
InTCP 01 Online Different online data is received via TCP. This Analyzing Script also uses the Analyzing
Function OutTCP() in order to provide the counterpart which sends the online data.
English
Release 2018-06 417 / 866
2.6.10.12 InV2D() - InputVector2D()
2.6.10.12.1 General
Properties
Full Name InputVector2D
Short Name InV2D
Description Reads 2-dimensional vector values from the system which can be used by following Analyzing
Parent Library Base
Function Prototype
DataOrValue Out0 = InV2D
(
);
Symbol
2.6.10.12.2 Inputs
Name
Full Name Name
Short Name Name
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the 2-dimensional vector data from the system
English
Release 2018-06 418 / 866
Int
Short Name Int
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs “Default”, “Stairs”, “None”, “Lines”, “Nearest Neighbor”, “Last Probe”
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.10.12.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 419 / 866
Unit
Full Name Unit
Short Name Unit
Direction output
Class data
Unit n/a
Configurable 1
Remark none
Desc
Short Name Desc
Direction output
Class data
Unit n/a
Configurable 1
Remark none
See the examples for the ConvV2DToP() Analyzing Function, which also show how to use InV2D().
English
Release 2018-06 420 / 866
2.6.11 Logic
2.6.11.1 AND() - AND()
2.6.11.1.1 General
Properties
Full Name AND
Short Name AND
Description Calculates the logical AND for binary data or values.
Parent Library Base
Parent Category Logic
Function Prototype
DataOrValue Out0 = AND
(
DataOrValue In0 … In7 = false;
);
Symbol
2.6.11.1.2 Inputs
In0 … In7
Description binary data or values for the AND logical operation
Direction input
Class data
Default Value false
Unit 1
Configurable 2…8
argument
English
Release 2018-06 421 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.11.1.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the AND logical operation
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark none
2.6.11.1.4 Examples
Analyzing Model
AND 01 Online Calculates the logic AND for 2 generated signals.
AND 02 Offline Calculates the logic AND for 2 offline signals.
Analyzing Script
AND 01 Online Calculates the logic AND for 2 generated signals.
AND 02 Offline Calculates the logic AND for 2 offline signals.
English
Release 2018-06 422 / 866
2.6.11.2 NAND() - NAND()
2.6.11.2.1 General
Properties
Full Name NAND
Short Name NAND
Description Calculates the logical NAND for binary data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = NAND
(
);
Symbol
2.6.11.2.2 Inputs
In0 … In7
Description binary data or values for the NAND logical operation
Direction input
Class data
Default Value false
Unit 1
Configurable 2…8
argument
English
Release 2018-06 423 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.11.2.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the NAND logical operation
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark none
2.6.11.2.4 Examples
Analyzing Model
NAND 01 Online Calculates the logic NAND for 2 generated signals.
NAND 02 Offline Calculates the logic NAND for 2 offline signals.
Analyzing Script
NAND 01 Online Calculates the logic NAND for 2 generated signals.
NAND 02 Offline Calculates the logic NAND for 2 offline signals.
English
Release 2018-06 424 / 866
2.6.11.3 NOR() - NOR()
2.6.11.3.1 General
Properties
Full Name NOR
Short Name NOR
Description Calculates the logical NOR for binary data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = NOR
(
);
Symbol
2.6.11.3.2 Inputs
In0 … In7
Description binary data or values for the NOR logical operation
Direction input
Class data
Default Value false
Unit 1
Configurable 2…8
argument
English
Release 2018-06 425 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.11.3.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the NOR logical operation
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark none
2.6.11.3.4 Examples
Analyzing Model
NOR 01 Online Calculates the logic NOR for 2 generated signals.
NOR 02 Offline Calculates the logic NOR for 2 offline signals.
Analyzing Script
NOR 01 Online Calculates the logic NOR for 2 generated signals.
NOR 02 Offline Calculates the logic NOR for 2 offline signals.
English
Release 2018-06 426 / 866
2.6.11.4 NOT() - NOT()
2.6.11.4.1 General
Properties
Full Name NOT
Short Name NOT
Description Calculates the logical NOT for binary data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = NOT
(
DataOrValue In0 = false,
);
Symbol
2.6.11.4.2 Inputs
In0
Full Name Input0
Short Name In0
Description binary data or values for the NOT logical operation
Direction input
Class data
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 427 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.11.4.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the NOT logical operation
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark none
2.6.11.4.4 Examples
Analyzing Model
NOT 01 Online Calculates the logic NOT for 2 generated signals.
NOT 02 Offline Calculates the logic NOT for 2 offline signals.
Analyzing Script
NOT 01 Online Calculates the logic NOT for 2 generated signals.
NOT 02 Offline Calculates the logic NOT for 2 offline signals.
English
Release 2018-06 428 / 866
2.6.11.5 NXOR() - NXOR()
2.6.11.5.1 General
Properties
Full Name NXOR
Short Name NXOR
Description Calculates the logical NXOR for binary data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = NXOR
(
);
Symbol
2.6.11.5.2 Inputs
In0
Full Name Input0
Short Name In0
Description first binary data or values for the NXOR logical operation
Direction input
Class data
Default Value false
Unit 1
Configurable 1
Allowed manual Inputs min … max of the Decimal64
Remark none
English
Release 2018-06 429 / 866
In1
Full Name Input1
Short Name In1
Description second binary data or values for the NXOR logical operation
Direction input
Class data
Default Value false
Unit 1
Configurable 1
Allowed manual Inputs min … max of Deciamal64
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.11.5.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the NXOR logical operation
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 430 / 866
2.6.11.5.4 Examples
Analyzing Model
NXOR 01 Online Calculates the logic NXOR for 2 generated signals.
NXOR 02 Offline Calculates the logic NXOR for 2 offline signals.
Analyzing Script
NXOR 01 Online Calculates the logic NXOR for 2 generated signals.
NXOR 02 Offline Calculates the logic NXOR for 2 offline signals.
English
Release 2018-06 431 / 866
2.6.11.6 OR() - OR()
2.6.11.6.1 General
Properties
Full Name OR
Short Name OR
Description Calculates the logical OR for binary data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = OR
(
);
Symbol
2.6.11.6.2 Inputs
In0 … In7
Description binary data or values for the OR logical operation
Direction input
Class data
Default Value false
Unit 1
Configurable 2…8
argument
English
Release 2018-06 432 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.11.6.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the OR logical operation
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark none
2.6.11.6.4 Examples
Analyzing Model
OR 01 Online Calculates the logic OR for 2 generated signals.
OR 02 Offline Calculates the logic OR for 2 offline signals.
Analyzing Script
OR 01 Online Calculates the logic OR for 2 generated signals.
OR 02 Offline Calculates the logic OR for 2 offline signals.
English
Release 2018-06 433 / 866
2.6.11.7 RSFF() - RSFlipFlop()
2.6.11.7.1 General
Properties
Full Name RSFlipFlop
Short Name RSFF
Description Simulates a R-dominant RS Flip-Flop.
Parent Library Base
Function Prototype
DataOrValue Q = RSFF
(
DataOrValue S = false,
DataOrValue R = false,
DataOrValue* QN = NULL
);
Symbol
2.6.11.7.2 Inputs
S
Full Name Set
Short Name S
Description binary data or values for the Set input
Direction input
Class data
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 434 / 866
R
Full Name Reset
Short Name R
Description binary data or values for the Reset input
Direction input
Class data
Default Value false
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.11.7.3 Outputs
Q
Full Name Q
Short Name Q
Description receives the state of the Flip Flop simulation
Direction output
Class data
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 435 / 866
QN
Full Name QN
Short Name QN
Description receives the complement state of the Flip Flop simulation
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark none
2.6.11.7.4 Examples
Analyzing Model
RSFF 01 Online Calculates the S-dominant RS Flip-Flop of 2 generated signals.
RSFF 02 Offline Calculates the S-dominant RS Flip-Flop of 2 offline signal.
Analyzing Script
RSFF 01 Online Calculates the S-dominant RS Flip-Flop of 2 generated signals.
RSFF 02 Offline Calculates the S-dominant RS Flip-Flop of 2 offline signal.
English
Release 2018-06 436 / 866
2.6.11.8 XOR() - XOR()
2.6.11.8.1 General
Properties
Full Name XOR
Short Name XOR
Description Calculates the logical XOR for binary data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = XOR
(
);
Symbol
2.6.11.8.2 Inputs
In0
Full Name Input0
Short Name In0
Description first binary data or values for the XOR logical operation
Direction input
Class data
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 437 / 866
In1
Full Name Input1
Short Name In1
Description second binary data or values for the XOR logical operation
Direction input
Class data
Default Value false
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.11.8.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the XOR logical operation
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 438 / 866
2.6.11.8.4 Examples
Analyzing Model
XOR 01 Online Calculates the logic XOR for 2 generated signals.
XOR 02 Offline Calculates the logic XOR for 2 offline signals.
Analyzing Script
XOR 01 Online Calculates the logic XOR for 2 generated signals.
XOR 02 Offline Calculates the logic XOR for 2 offline signals.
English
Release 2018-06 439 / 866
2.6.12 Machine Analysis
2.6.12.1 RMSAcc() - RMSAcceleration()
2.6.12.1.1 General
Properties
Full Name RMSAcceleration
Short Name RMSAcc
Description Calculates the Root Mean Square of an acceleration signal according to VDI 3834, part 1.
Parent Library Base
Parent Category Machine Analysis
Function Prototype
DataOrValue Out0 = RMSAcc
(
Value NoP = 1000,
Value Dly = 5,
Value LCutFrq = 2,
Value HCutFrq = 5000,
Value Order = 4,
Value Rppl = 0.1,
);
Symbol
English
Release 2018-06 440 / 866
2.6.12.1.2 Inputs
Name
Full Name Name
Short Name Name
Direction input
Class parameter
Unit n/a
Configurable 1
Int
Short Name Int
Direction input
Class parameter
Unit n/a
Configurable 1
processing
English
Release 2018-06 441 / 866
NoP
Short Name NoP
Description number of points which shall be used for the root mean square calculation
Direction input
Class parameter
Default Value 1000
Unit 1
Configurable 1
Remark none
Dly
Full Name Delay
Short Name Dly
Description inactivity time in order to ignore the values during the transient oscillation time of the (low and high
pass) filters
Direction input
Class parameter
Default Value 5
Unit s
Configurable 1
Remark the inactivity time starts each time when the EN input changes from false to true
LCutFrq
Short Name LCutFrq
Description lower cutoff frequency of the Tschebyscheff high pass filter
Direction input
Class parameter
Default Value 2
Unit Hz
Configurable 1
frequency
English
Release 2018-06 442 / 866
HCutFrq
Short Name HCutFrq
Description cutoff frequency of the Tschebyscheff low pass filter
Direction input
Class parameter
Default Value 5000
Unit Hz
Configurable 1
frequency
Order
Full Name Order
Short Name Order
Description order of the Tschebyscheff band pass filter
Direction input
Class parameter
Default Value 4
Unit 1
Configurable 1
Remark none
Rppl
Full Name Ripple
Short Name Rppl
Description ripple depth of the passband
he specified ripple depth is applied to the high and low pass filters separately
Direction input
Class parameter
Default Value 0.1
Unit dB
Configurable 1
Allowed manual Inputs >0
Remark none
English
Release 2018-06 443 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark in case the calculation is disabled, all internal status and buffers are reset so that the Analyzing
Function continues to run virgin as if it would be called for the first time when EN becomes true
again
2.6.12.1.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the calculated root mean square value
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 444 / 866
2.6.12.1.4 Examples
Analyzing Model
RMSAcc 01 (Genera- Online Generates the input data for the Analyzing Model “RMSAcc 01”.
tor)
RMSAcc 01 Online Downsamples the input data and calculates the RMS value afterwards.
Analyzing Script
RMSAcc 01 (Genera- Online Generates the input data for the Analyzing Script “RMSAcc 01”.
tor)
RMSAcc 01 Online Downsamples the input data and calculates the RMS value afterwards.
English
Release 2018-06 445 / 866
2.6.13 Miscellaneous
2.6.13.1 Cnt() - Count()
2.6.13.1.1 General
Properties
Full Name Count
Short Name Cnt
Description Counts the rising or falling edges of the input data or values.
Parent Library Base
Parent Category Miscellaneous
Function Prototype
DataOrValue Out0 = Cnt
(
Value CntPrm = “Rising Edge”,
);
Symbol
2.6.13.1.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose rising or falling edges shall be counted
Direction input
Class data
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 446 / 866
CntPrm
Full Name CountParameter
Short Name CntPrm
Description indicates whether rising or falling edges shall be counted
Direction input
Class parameter
Default Value “Rising Edge”
Unit n/a
Configurable 1
Allowed manual Inputs “Rising Edge”, “Falling Edge”
Remark none
Reset
Full Name Reset
Short Name Reset
Description resets the edges counting
Direction input
Class control
Default Value false
Unit 1
Configurable 1
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 447 / 866
2.6.13.1.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the edges counting
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.13.1.4 Examples
Analyzing Model
Cnt 01 Online Counts the rising and falling edges of a generated signal.
Cnt 02 Offline Counts the rising and falling edges of an offline signal.
Analyzing Script
Cnt 01 Online Counts the rising and falling edges of a generated signal.
Cnt 02 Offline Counts the rising and falling edges of an offline signal.
English
Release 2018-06 448 / 866
2.6.13.2 DeMux() - Demultiplexer()
2.6.13.2.1 General
Properties
Full Name Demultiplexer
Short Name DeMux
Description Provides input signal to the selected output.
Parent Library Base
Function Prototype
DataOrValue Out0 = DeMux
(
DataOrValue Slct = 0,
DataOrValue* Out1 ... Out7 = NULL
);
Symbol
2.6.13.2.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values which shall be provided to the selected output
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 449 / 866
Slct
Full Name Select
Short Name Slct
Description identity number of the output which shall be connected to the input signal
Direction input
Class control
Default Value 0
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.13.2.3 Outputs
Out0 … Out7
Full Name Output0 … Output7
Short Name Out0 … Out7
Description receives the input signal to the selected output
Direction output
Class data
Default Value 0
Unit 1
Configurable 2…8
Remark none
English
Release 2018-06 450 / 866
2.6.13.2.4 Examples
Analyzing Model
DeMux 01 Online Uses DeMux to provide a generated signal to different output signals.
DeMux 02 Offline Uses DeMux to provide an offline signal to a selected output signals.
Analyzing Script
The usage within Analyzing Scripts is not supported by the Analyzing Function DeMux().
English
Release 2018-06 451 / 866
2.6.13.3 IsFlgEdg() - IsFallingEdge()
2.6.13.3.1 General
Properties
Full Name IsFallingEdge
Short Name IsFlgEdg
Description Detects the falling edges of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = IsFlgEdg
(
);
Symbol
2.6.13.3.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose falling edges shall be detected
Direction input
Class data
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 452 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.13.3.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the falling edges detection
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark none
2.6.13.3.4 Examples
Analyzing Model
IsFlgEdg 01 Online Detects falling edges of a generated rectangular signal.
IsFlgEdg 02 Offline Detects falling edges of an offline signal.
Analyzing Script
IsFlgEdg 01 Online Detects falling edges of a generated rectangular signal.
IsFlgEdg 02 Offline Detects falling edges of an offline signal.
English
Release 2018-06 453 / 866
2.6.13.4 IsRsgEdg() - IsRisingEdge()
2.6.13.4.1 General
Properties
Full Name IsRisingEdge
Short Name IsRsgEdg
Description Detects the rising edges of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = IsRsgEdg
(
);
Symbol
2.6.13.4.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose rising edges shall be detected
Direction input
Class data
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 454 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.13.4.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the rising edges detection
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark none
2.6.13.4.4 Examples
Analyzing Model
IsFlgEdg 01 Online Detects rising edges of a generated rectangular signal.
IsFlgEdg 02 Offline Detects rising edges of an offline signal.
Analyzing Script
IsFlgEdg 01 Online Detects rising edges of a generated rectangular signal.
IsFlgEdg 02 Offline Detects rising edges of an offline signal.
English
Release 2018-06 455 / 866
2.6.13.5 MonEdg() - MonitorEdge()
2.6.13.5.1 General
Properties
Full Name MonitorEdge
Short Name MonEdg
Description Detects the occurrences of a certain number of edges in a defined time period.
Parent Library Base
Function Prototype
DataOrValue Out0 = MonEdg
(
Value NoE = 1,
Value PoT = 1,
);
Symbol
2.6.13.5.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose edges shall be monitored
Direction input
Class data
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 456 / 866
NoE
Full Name NumberOfEdges
Short Name NoE
Description number of edges for occurrences monitoring
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
PoT
Full Name PeriodOfTime
Short Name PoT
Description acquisition time of data for the edges monitoring
Direction input
Class parameter
Default Value 1
Unit s
Configurable 1
Allowed manual Inputs > 0 … 120
Remark none
Reset
Full Name Reset
Short Name Reset
Description resets the edges monitoring
Direction input
Class control
Default Value false
Unit 1
Configurable 1
English
Release 2018-06 457 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.13.5.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the edges monitoring
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark none
2.6.13.5.4 Examples
Analyzing Model
MonEdg 01 Online Monitors rising edges of a simulated signal. (Start IPF and DPF)
MonEdg 02 Offline Monitors rising edges of an offline signal.
Analyzing Script
MonEdg 01 Online Monitors rising edges of a simulated signal. (Start IPF and DPF)
MonEdg 02 Offline Monitors rising edges of an offline signal.
English
Release 2018-06 458 / 866
2.6.13.6 Mux() - Multiplexer()
2.6.13.6.1 General
Properties
Full Name Multiplexer
Short Name Mux
Description Provides a selected input signal to the output.
Parent Library Base
Function Prototype
DataOrValue Out0 = Mux
(
DataOrValue Slct = 0,
);
Symbol
2.6.13.6.2 Inputs
In0 … In7
Description data or values which shall be multiplexed
Direction input
Class data
Default Value 0
Unit 1
Configurable 2…8
argument
English
Release 2018-06 459 / 866
Slct
Full Name Select
Short Name Slct
Description identity number of the input signal which shall be provided to the output
Direction input
Class control
Default Value 0
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.13.6.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of multiplexing
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 460 / 866
2.6.13.6.4 Examples
Analyzing Model
Mux 01 Online Uses Mux to provide different generated signals to the output.
Mux 02 Offline Uses Mux to provide different offline signals to the output.
Analyzing Script
Mux 01 Online Uses Mux to provide different generated signals to the output.
Mux 02 Offline Uses Mux to provide different offline signals to the output.
English
Release 2018-06 461 / 866
2.6.14 Orbit
2.6.14.1 Orbit() - Orbit()
2.6.14.1.1 General
Properties
Full Name Orbit
Short Name Orbit
Description Calculates the orbit data of the input data.
Parent Library Base
Parent Category Orbit
Function Prototype
Orbit Out0 = Orbit
(
DataOrValue Trigger = 0,
Value NoIpR = 1,
Value NoR = 100,
Value NoPpR = 64,
Value AvgR = 1,
Value AngleX = 0,
Value AngleY = 90,
DataOrValue* NrmSmax = 0,
DataOrValue* AglSmax = 0,
DataOrValue* NrmSpp = 0
);
Symbol
English
Release 2018-06 462 / 866
2.6.14.1.2 Inputs
InX
Full Name InputX
Short Name InX
Description data or value which shall be used as x-data for the orbit calculation
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
InY
Full Name InputX
Short Name InY
Description data or value which shall be used as y-data for the orbit calculation
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
Trigger
Full Name Trigger
Short Name Trigger
Description trigger data which provides information about the number of revolutions
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 463 / 866
NoIpR
Full Name NumberOfImpulsesPerRevolution
Short Name NoIpR
Description specifies the number of trigger impulses per revolution
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
NoR
Full Name NumberOfRevolution
Short Name NoR
Description specifies the number of revolutions which shall be collected for one calculation
Direction input
Class parameter
Default Value 100
Unit 1
Configurable 1
Remark none
NoPpR
Full Name NumberOfPointsPerRevolution
Short Name NoPpR
Description specifies the number of points per revolution to which the collected input data shall be resampled
Direction input
Class parameter
Default Value 64
Unit 1
Configurable 1
Remark none
English
Release 2018-06 464 / 866
AvgR
Full Name AverageRevolutions
Short Name AvgR
Description specifies the number of revolutions over which an average shall be built
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Allowed manual Inputs 1 … NoR
Remark in case NoR is not an Integer multiple of AvgR, the averages are built for the first AvgR * n revolu-
tions and the last x revolutions (x < AvgR) are ignored for the orbit calculation
AngleX
Full Name AngleX
Short Name AngleX
Description specifies the angle between the x-axis sensor and 0°
Direction input
Class parameter
Default Value 0
Unit °
Configurable 1
Allowed manual Inputs 0.0360.0
Remark
AngleY
Full Name AngleY
Short Name AngleY
Description specifies the angle between the y-axis sensor and 0°
Direction input
Class parameter
Default Value 90
Unit °
Configurable 1
Allowed manual Inputs 1.0360.0
Remark
English
Release 2018-06 465 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark if the internal calculation is disabled, the already received input buffer is discarded and the filling of
the internal buffer is restarted when the internal calculation is enabled again
2.6.14.1.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the orbit calculation
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Supported Data Types Orbit
Remark none
OutReady
Short Name OutReady
Description indicates whether the orbit data in Output0 is valid
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 466 / 866
NrmSmax
Full Name NormSmax
Short Name NrmSmax
Description receives the calculated norm of Smax
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
AglSmax
Full Name AngelSmax
Short Name AglSmax
Description receives the calculated angle of Smax
Direction output
Class data
Default Value 0
Unit °
Configurable 1
Remark none
NrmSpp
Full Name NormSpp
Short Name NrmSpp
Description receives the calculated norm of Spp
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 467 / 866
2.6.14.1.4 Examples
Analyzing Model
Orbit 01 Online Calculates the orbit of some simulated input data.
Orbit 02 Offline Calculates the orbit value of an offline signal.
Analyzing Script
Orbit 01 Online Calculates the orbit of some simulated input data.
Orbit 02 Offline Calculates the orbit value of an offline signal.
English
Release 2018-06 468 / 866
2.6.15 Output
2.6.15.1 Out() - Output()
2.6.15.1.1 General
Properties
Full Name Output
Short Name Out
Description Writes simple values (Booleans, Integers or decimals) to the system which have been calculated
by previous Analyzing Functions.
Parent Library Base
Parent Category Output
Function Prototype
DataOrValue Out0 = Out
(
DataOrValue Unit = “”,
DataOrValue Desc = “”,
DataOrValue Ctgry = “”,
Value RcMd = “Default”,
Value RcPrm = “”,
Value BffrMd = “Relative Size”,
Value BffrPrm = “100”,
Value OtptMd = “Overwrite”,
);
Symbol
English
Release 2018-06 469 / 866
2.6.15.1.2 Inputs
Name
Full Name Name
Short Name Name
Description name of the data which shall be written to the system
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the data which shall be written to the system
In0
Full Name Input0
Short Name In0
Description value which shall be written to the system
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Allowed manual Inputs min … max of the chosen precision which is chosen via Precision argument
Remark none
Unit
Full Name Unit
Short Name Unit
Description unit of the data which shall be written to the system
Direction input
Class data
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the unit of the data which shall be written to the system
Remark none
English
Release 2018-06 470 / 866
Desc
Short Name Desc
Description description of the data which shall be written to the system
Direction input
Class data
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the description of the data which shall be written to the system
Remark none
Ctgry
Full Name Category
Short Name Ctgry
Description category of the data which shall be written to the system
Direction input
Class data
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the category of the data which shall be written to the system
Remark in case a category is specified, the data is added to the specified (online or offline) data category
automatically after the start of the Analyzing Model/Analyzing Script
a backslash (“\”) or slash (“/”) can be used in order to specify sub-categories
examples:
 Some Category
 Plant\Machine\Sensor
Prcsn
Full Name Precision
Short Name Prcsn
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs “Default”, “Boolean”, “Integer8”, “Integer16”, “Integer32”, “Integer64”, “Decimal32”, “Decimal64”
Remark in case the argument is set to "Default" the current "Default Output Data Precision" of the owning
Analyzing Model/Analyzing Script is being chosen as precision
English
Release 2018-06 471 / 866
RcMd
Full Name RecordMode
Short Name RcMd
Description record mode which shall be used when writing the data to the system
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs “Default”, “Each Value”, “Changes only”, “Changes and Interval”, “Interval only”
Remark in case the argument is set to “Default” but the currently chosen “Default Output Data Record
Mode” of the owning Analyzing Model/Analyzing Script is not supported by the ANF, “Each Value”
is being chosen as record mode
RcPrm
Full Name RecordParameters
Short Name RcPrm
Description record parameters which shall be used when writing the data to the system
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs standard input behavior of record parameters edit boxes
Remark see the examples below for information about how to configure the available record parameters
out of Analyzing Scripts
BffrMd
Full Name BufferMode
Short Name BffrMd
Description buffer mode which shall be used when writing the data to the system
Direction input
Class parameter
Default Value “Relative Size”
Unit n/a
Configurable 1
Allowed manual Inputs “Absolute Size”, “Relative Size”
Remark in case the output data is offline data, the value of this argument is used only when the output
mode is “Advanced Append”
English
Release 2018-06 472 / 866
BffrPrm
Full Name BufferParameters
Short Name BffrPrm
Description buffer parameters which shall be used when writing the data to the system
Direction input
Class parameter
Default Value “100”
Unit % or Values
Configurable 1
Allowed manual Inputs standard input behavior of buffer parameters edit boxes
see the examples below for information about how to configure the available buffer parameters
OtptMd
Full Name OutputMode
Short Name OtptMd
Description output mode which shall be used when writing the data to the system
Direction input
Class parameter
Default Value “Overwrite”
Unit n/a
Configurable 1
Allowed manual Inputs “Overwrite”, “Append”, “Advanced Append”, “Single Value”
Remark this setting is ignored in case the output data is online data
 in case the output data is offline data and the output mode is “Overwrite”, the calculation
result overwrites the eventually already present values of the offline data with the specified
name
 in case the output data is offline data and the output mode is “Append”, the calculation re-
sult is appended to the eventually already present values of the offline data with the speci-
fied name
 in case the output data is offline data and the output mode is “Advanced Append”, the cal-
culation result is appended to the eventually already present values of the offline data with
the specified name
o the total size of the data (size of the already existing part + size of the new calculation
result) can not exceed the amount of values which are specified via “BufferMode” and
“BufferParameters”
 in case the total size of the data would exceed this maximal number of values, the
first values from the buffer are removed in order to provide the space for the new
values
 in case the output data is offline data and the output mode is “Single Value”, the created
offline data contains exactly one probe (= timestamp + value)
o in case multiple values are written to the output data during the processing of the par-
ent Analyzing Program, the probe from the last write always overwrites the probe from
all previous writes
English
Release 2018-06 473 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.15.1.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the value which has been written to the system
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Supported Data Types equal to the supported precisions of the Analyzing Function
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 474 / 866
2.6.15.1.4 Examples
Analyzing Model
There is no separate example for the Analyzing Function Out() because it is being used by various other Ana-
lyzing Models which output simple data types.
Analyzing Script
Out 01 Online Shows how to configure the available record modes and buffer modes out of Analyzing
Scripts.
There are no additional examples for the Analyzing Function Out() because it is being used by various other
Analyzing Scripts which output simple data types.
English
Release 2018-06 475 / 866
2.6.15.2 OutB1D() - OutputBuffer1D()
2.6.15.2.1 General
Properties
Full Name OutputBuffer1D
Short Name OutB1D
Description Writes 1-dimensional buffer values to the system which have been calculated by previous Analyz-
ing Functions.
Parent Library Base
Function Prototype
Buffer1D Out0 = OutB1D
(
Buffer1D In0 = 0,
Value BffrMd = “Absolute Size”,
);
Symbol
English
Release 2018-06 476 / 866
2.6.15.2.2 Inputs
Name
Full Name Name
Short Name Name
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the buffer data which shall be written to the system
In0
Full Name Input0
Short Name In0
Description 1-dimensional buffer which shall be written to the system
Direction input
Class data
Default Value
Unit n/a
Configurable 1
Remark none
Unit
Full Name Unit
Short Name Unit
Direction input
Class data
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 477 / 866
Desc
Short Name Desc
Direction input
Class data
Unit n/a
Configurable 1
Remark none
Ctgry
Full Name Category
Short Name Ctgry
Direction input
Class data
Unit n/a
Configurable 1
examples:
 Some Category
Prcsn
Full Name Precision
Short Name Prcsn
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 478 / 866
RcMd
Short Name RcMd
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs “Default”, “Each Value”, “Interval only”
RcPrm
Short Name RcPrm
Direction input
Class parameter
Unit n/a
Configurable 1
BffrMd
Short Name BffrMd
Direction input
Class parameter
Default Value “Absolute Size”
Unit n/a
Configurable 1
English
Release 2018-06 479 / 866
BffrPrm
Short Name BffrPrm
Direction input
Class parameter
Unit % or Values
Configurable 1
OtptMd
Short Name OtptMd
Direction input
Class parameter
Unit n/a
Configurable 1
name
fied name
the specified name
values
all previous writes
English
Release 2018-06 480 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.15.2.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 481 / 866
2.6.15.2.4 Examples
Analyzing Model
There is no separate example for the Analyzing Function OutB1D() because it is being used by various other
Analyzing Models which output 1-dimensional buffers.
Analyzing Script
Analyzing Scripts which output 1-dimensional buffers.
The Analyzing Script “Out 01” from the example location can be used in order to see how the available record
modes and buffer modes can be configured out of Analyzing Scripts (because the according syntax is identical
for Out() and OutB1D()).
English
Release 2018-06 482 / 866
2.6.15.3 OutB2D() – OutputBuffer2D()
2.6.15.3.1 General
Properties
Full Name OutputBuffer2D
Short Name OutB2D
Description Writes 2-dimensional buffer values to the system which have been calculated by previous Analyz-
ing Functions.
Parent Library Base
Function Prototype
Buffer2D Out0 = OutB2D
(
Buffer2D In0 = 0,
);
Symbol
English
Release 2018-06 483 / 866
2.6.15.3.2 Inputs
Name
Full Name Name
Short Name Name
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the buffer data which shall be written to the system
In0
Full Name Input0
Short Name In0
Description 2-dimensional buffer which shall be written to the system
Direction input
Class data
Default Value
Unit n/a
Configurable 1
Remark none
Unit
Full Name Unit
Short Name Unit
Direction input
Class data
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 484 / 866
Desc
Short Name Desc
Direction input
Class data
Unit n/a
Configurable 1
Remark none
Ctgry
Full Name Category
Short Name Ctgry
Direction input
Class data
Unit n/a
Configurable 1
examples:
 Some Category
Prcsn
Full Name Precision
Short Name Prcsn
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 485 / 866
RcMd
Short Name RcMd
Direction input
Class parameter
Unit n/a
Configurable 1
RcPrm
Short Name RcPrm
Direction input
Class parameter
Unit n/a
Configurable 1
BffrMd
Short Name BffrMd
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 486 / 866
BffrPrm
Short Name BffrPrm
Direction input
Class parameter
Unit % or Values
Configurable 1
OtptMd
Short Name OtptMd
Direction input
Class parameter
Unit n/a
Configurable 1
name
fied name
the specified name
values
all previous writes
English
Release 2018-06 487 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.15.3.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 488 / 866
2.6.15.3.4 Examples
Analyzing Model
Analyzing Models which output 2-dimensional buffers.
Analyzing Script
Analyzing Scripts which output 2-dimensional buffers.
for Out() and OutB2D()).
English
Release 2018-06 489 / 866
2.6.15.4 OutOrbit() - OutputOrbit()
2.6.15.4.1 General
Properties
Full Name OutputOrbit
Short Name OutOrbit
Description Writes orbit values to the system which have been calculated by previous Analyzing Functions.
Parent Library Base
Function Prototype
Orbit Out0 = OutOrbit
(
Orbit In0 = 0,
);
Symbol
English
Release 2018-06 490 / 866
2.6.15.4.2 Inputs
Name
Full Name Name
Short Name Name
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the spectrum data which shall be written to the system
In0
Full Name Input0
Short Name In0
Description orbit which shall be written to the system
Direction input
Class data
Default Value
Unit n/a
Configurable 1
Remark none
Unit
Full Name Unit
Short Name Unit
Direction input
Class data
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 491 / 866
Desc
Short Name Desc
Direction input
Class data
Unit n/a
Configurable 1
Remark none
Ctgry
Full Name Category
Short Name Ctgry
Direction input
Class data
Unit n/a
Configurable 1
examples:
 Some Category
Prcsn
Full Name Precision
Short Name Prcsn
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs “Default”, “Decimal32”, “Decimal64”
English
Release 2018-06 492 / 866
RcMd
Short Name RcMd
Direction input
Class parameter
Unit n/a
Configurable 1
RcPrm
Short Name RcPrm
Direction input
Class parameter
Unit n/a
Configurable 1
BffrMd
Short Name BffrMd
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 493 / 866
BffrPrm
Short Name BffrPrm
Direction input
Class parameter
Unit % or Values
Configurable 1
OtptMd
Short Name OtptMd
Direction input
Class parameter
Unit n/a
Configurable 1
name
fied name
the specified name
values
all previous writes
English
Release 2018-06 494 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.15.4.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 495 / 866
2.6.15.4.4 Examples
Analyzing Model
There is no separate example for the Analyzing Function OutOrbit() because it is being used by various other
Analyzing Models which output an orbit.
Analyzing Script
There is no separate example for the Analyzing Function OutOrbit() because it is being used by various other
Analyzing Scripts which output an orbit.
for Out() and OutOrbit()).
English
Release 2018-06 496 / 866
2.6.15.5 OutSpm() - OutputSpectrum()
2.6.15.5.1 General
Properties
Full Name OutputSpectrum
Short Name OutSpm
Description Writes spectrum values to the system which have been calculated by previous Analyzing Func-
tions.
Parent Library Base
Function Prototype
Spectrum Out0 = OutSpm
(
Spectrum In0 = 0,
);
Symbol
English
Release 2018-06 497 / 866
2.6.15.5.2 Inputs
Name
Full Name Name
Short Name Name
Direction input
Class parameter
Unit n/a
Configurable 1
In0
Full Name Input0
Short Name In0
Description spectrum which shall be written to the system
Direction input
Class data
Default Value
Unit n/a
Configurable 1
Remark none
Unit
Full Name Unit
Short Name Unit
Direction input
Class data
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 498 / 866
Desc
Short Name Desc
Direction input
Class data
Unit n/a
Configurable 1
Remark none
Ctgry
Full Name Category
Short Name Ctgry
Direction input
Class data
Unit n/a
Configurable 1
examples:
 Some Category
Prcsn
Full Name Precision
Short Name Prcsn
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 499 / 866
RcMd
Short Name RcMd
Direction input
Class parameter
Unit n/a
Configurable 1
RcPrm
Short Name RcPrm
Direction input
Class parameter
Unit n/a
Configurable 1
BffrMd
Short Name BffrMd
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 500 / 866
BffrPrm
Short Name BffrPrm
Direction input
Class parameter
Unit % or Values
Configurable 1
OtptMd
Short Name OtptMd
Direction input
Class parameter
Unit n/a
Configurable 1
name
fied name
the specified name
values
all previous writes
English
Release 2018-06 501 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.15.5.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 502 / 866
2.6.15.5.4 Examples
Analyzing Model
There is no separate example for the Analyzing Function OutSpm() because it is being used by various other
Analyzing Models which output a spectrum.
Analyzing Script
There is no separate example for the Analyzing Function OutSpm() because it is being used by various other
Analyzing Scripts which output a spectrum.
for Out() and OutSpm()).
English
Release 2018-06 503 / 866
2.6.15.6 OutSpmEnv() - OutputSpectrumEnvelope()
2.6.15.6.1 General
Properties
Full Name OutputSpectrumEnvelope
Short Name OutSpmEnv
Description Writes spectrum envelope values to the system which have been calculated by previous Analyzing
Functions.
Parent Library Base
Function Prototype
SpectrumEnvelope Out0 = OutSpmEnv
(
SpectrumEnvelope In0 = 0,
);
Symbol
English
Release 2018-06 504 / 866
2.6.15.6.2 Inputs
Name
Full Name Name
Short Name Name
Direction input
Class parameter
Unit n/a
Configurable 1
In0
Full Name Input0
Short Name In0
Description spectrum envelope which shall be written to the system
Direction input
Class data
Default Value
Unit n/a
Configurable 1
Supported Data Types SpectrumEnvelope
Remark none
Unit
Full Name Unit
Short Name Unit
Direction input
Class data
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 505 / 866
Desc
Short Name Desc
Direction input
Class data
Unit n/a
Configurable 1
Remark none
Ctgry
Full Name Category
Short Name Ctgry
Direction input
Class data
Unit n/a
Configurable 1
examples:
 Some Category
Prcsn
Full Name Precision
Short Name Prcsn
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 506 / 866
RcMd
Short Name RcMd
Direction input
Class parameter
Unit n/a
Configurable 1
RcPrm
Short Name RcPrm
Direction input
Class parameter
Unit n/a
Configurable 1
BffrMd
Short Name BffrMd
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 507 / 866
BffrPrm
Short Name BffrPrm
Direction input
Class parameter
Unit % or Values
Configurable 1
OtptMd
Short Name OtptMd
Direction input
Class parameter
Unit n/a
Configurable 1
name
fied name
the specified name
values
all previous writes
English
Release 2018-06 508 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.15.6.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 509 / 866
2.6.15.6.4 Examples
Analyzing Model
There is no separate example for the Analyzing Function OutSpmEnv().

Analyzing Script
There is no separate example for the Analyzing Function OutSpmEnv().

for Out() and OutSpmEnv()).
English
Release 2018-06 510 / 866
2.6.15.7 OutStr() - OutputString()
2.6.15.7.1 General
Properties
Full Name OutputString
Short Name OutStr
Description Writes strings to the system which have been calculated by previous Analyzing Functions.
Parent Library Base
Function Prototype
DataOrValue Out0 = OutStr
(
DataOrValue Size = 32,
);
Symbol
English
Release 2018-06 511 / 866
2.6.15.7.2 Inputs
Name
Full Name Name
Short Name Name
Direction input
Class parameter
Unit n/a
Configurable 1
In0
Full Name Input0
Short Name In0
Description string shall be written to the system
Direction input
Class data
Unit 1
Configurable 1
Allowed manual Inputs any kind of string which is shorter than the specified “Size”
Remark in case the current string is shorter than the specified “Size”, the remaining bytes are filled up with
0x00
in case the current string is longer than the specified “Size”, it is truncated and 0x00 is inserted as
last character
English
Release 2018-06 512 / 866
Size
Full Name Size
Short Name Size
Description number of characters per string value which shall be reserved
Direction input
Class data
Default Value 32
Unit bytes
Configurable 1
Remark the value of the size is read during the first cycle where Enable is true and it is applied to the out-
put data then
in case the size changes during following cycles, the size of the output data is not changed and an
according warning log entry is output once
Unit
Full Name Unit
Short Name Unit
Direction input
Class data
Unit n/a
Configurable 1
Remark the value of the unit is read during the first cycle where Enable is true and it is applied to the out-
put data then
in case the unit changes during following cycles, the unit of the output data is not changed and an
according warning log entry is output once
English
Release 2018-06 513 / 866
Desc
Short Name Desc
Direction input
Class data
Unit n/a
Configurable 1
Remark the value of the description is read during the first cycle where Enable is true and it is applied to
the output data then
in case the description changes during following cycles, the description of the output data is not
changed and an according warning log entry is output once
Ctgry
Full Name Category
Short Name Ctgry
Direction input
Class data
Unit n/a
Configurable 1
examples:
 Some Category
English
Release 2018-06 514 / 866
RcMd
Short Name RcMd
Direction input
Class parameter
Unit n/a
Configurable 1
RcPrm
Short Name RcPrm
Direction input
Class parameter
Unit n/a
Configurable 1
BffrMd
Short Name BffrMd
Direction input
Class parameter
Default Value “Relative Size”
Unit n/a
Configurable 1
English
Release 2018-06 515 / 866
BffrPrm
Short Name BffrPrm
Direction input
Class parameter
Unit % or Values
Configurable 1
OtptMd
Short Name OtptMd
Direction input
Class parameter
Unit n/a
Configurable 1
name
fied name
the specified name
values
all previous writes
English
Release 2018-06 516 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.15.7.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 517 / 866
2.6.15.7.4 Examples
Analyzing Model
There is no separate example for the Analyzing Function OutStr() because it is being used by various other
Analyzing Models which output data of type “string”.
Analyzing Script
OutStr 01 Online Shows how to configure the available record modes and buffer modes out of Analyzing
Scripts.
There are no additional examples for the Analyzing Function OutStr() because it is being used by various other
Analyzing Scripts which output data of type “string”.
English
Release 2018-06 518 / 866
2.6.15.8 OutTCP() - OutputTCP()
2.6.15.8.1 General
Properties
Full Name OutputTCP
Short Name OutTCP
Description Sends a data buffer to the specified IP address.
Parent Library Base
Function Prototype
DataOrValue OutReady = OutTCP
(
Buffer1D In0 ... In7 = 0,
Value IP = “”,
Value Port = 1,
Value Idx = 4,
DataOrValue Send = false,
);
Symbol
2.6.15.8.2 Inputs
In0 … In7
Description 1-dimensional buffer which shall be sent
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1…8
argument
English
Release 2018-06 519 / 866
IP
Full Name IPAddress
Short Name IP
Description receives the IP address for sending the buffer data
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the IP address
Remark none
Port
Full Name Port
Short Name Port
Description receives the port for sending the buffer data
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
Idx
Full Name Index
Short Name Idx
Description receives the index for sending the buffer data
Direction input
Class parameter
Default Value 4
Unit 1
Configurable 1
Remark see Examples
English
Release 2018-06 520 / 866
Send
Full Name Send
Short Name Send
Description indicates whether the current buffer data shall be sent
Direction input
Class control
Default Value false
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Description enables or disables the internal function
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.15.8.3 Outputs
OutReady
Short Name OutReady
Description indicates whether the input buffer has been sent to the IP address
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 521 / 866
2.6.15.8.4 Remarks
In order to use this Analyzing Function, a TCP server must be provided for the other side of the connection.
The IP address and port which are being used by the TCP server must be specified for the “IP” and “Port” input
arguments of this Analyzing Function.
Besides the standard TCP framework bytes, the following data is being transmitted by this Analyzing Function:
Length Type Data Type Description
4 Byte Timestamp unsigned long contains the current micro seconds (0 … 3600000000), relative to the time of
the executing Analyzing Model/Analyzing Script
4 Byte Length unsigned long contains the length of the payload (without the “Timestamp”, “Length”, “Index”
and “End Delimiter” fields), which is calculated automatically according to the
provided inputs (“Input0” … “Input7”)
the length includes also includes possible present padding bytes
4 Byte Index unsigned long contains the index which is defined at input argument “Index”
x Byte Payload variable contains the payload which is provided through “Input0” … “Input7”
4 Byte End Delimiter unsigned long contains the end delimiter (0x7FFFFFFF)
Data Value Assignment

Precision Length per Val- Remarks
ue
Boolean 1 Byte one byte is being used for each bit (the Analyzing Function does not put multiple bits together to
one byte)
in case the number of Boolean values of an input is not a multiple of 4, padding bytes (with a val-
ue of 0) are being inserted after the Boolean values of the input
Integer8 1 Byte in case the number of Integer8 values of an input is not a multiple of 4, padding bytes (with a val-
ue of 0) are being inserted after the Integer8 values of the input
Integer16 2 Byte in case the number of Integer16 values of an input is not a multiple of 4, padding bytes (with a
value of 0) are being inserted after the Integer16 values of the input
Integer32 4 Byte
Integer64 8 Byte
Decimal32 4 Byte
Decimal64 8 Byte
English
Release 2018-06 522 / 866
Example:
Figure 23: Example for the Configuration of the Analyzing Function OutTCP()
English
Release 2018-06 523 / 866
Data Segment
Byte Value (Hex) Description
01 … 04 … timestamp
05 … 08 0x00000010 length
09 … 12 0x00000004 index
13 0x00 first value of ConvVToB1D (ID 000) of precision Boolean
14 0x01 second value of ConvVToB1D (ID 000) of precision Boolean
15 0x00 filled up with 0, because the number of Booleans is not a multiple of 4
17 0x01 first value of ConvVToB1D (ID 001) of precision Integer8
18 0x02 second value of ConvVToB1D (ID 001) of precision Integer8
19 0x03 third value of ConvVToB1D (ID 001) of precision Integer8
20 0x00 filled up with 0, because the number of Integer8s is not a multiple of 4
21 … 24 0x00000005 first value of ConvVToB1D (ID 002) of precision Integer32
25 0x01 first value of ConvVToB1D (ID 003) of precision Boolean
26 0x01 second value of ConvVToB1D (ID 003) of precision Boolean
29 … 32 0x7FFFFFFF end delimiter
2.6.15.8.5 Examples
Analyzing Model
OutTCP 01 Online Different online data is sent via TCP (server needed).
OutTCP 02 Offline Different offline data is sent via TCP (server needed).
Analyzing Script
OutTCP 01 Online Different online data is sent via TCP (server needed).
OutTCP 02 Offline Different offline data is sent via TCP (server needed).
English
Release 2018-06 524 / 866
2.6.15.9 OutV2D() - OutputVector2D()
2.6.15.9.1 General
Properties
Full Name OutputVector2D
Short Name OutV2D
Description Writes 2-dimensional vector values to the system which have been calculated by previous Analyz-
ing Functions.
Parent Library Base
Function Prototype
Vector2D Out0 = OutV2D
(
Vector2D In0 = 0,
);
Symbol
English
Release 2018-06 525 / 866
2.6.15.9.2 Inputs
Name
Full Name Name
Short Name Name
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the 2-dimensional vector which shall be written to the system
In0
Full Name Input0
Short Name In0
Description 2-dimensional vector which shall be written to the system
Direction input
Class data
Default Value
Unit n/a
Configurable 1
Remark none
Unit
Full Name Unit
Short Name Unit
Direction input
Class data
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 526 / 866
Desc
Short Name Desc
Direction input
Class data
Unit n/a
Configurable 1
Remark none
Ctgry
Full Name Category
Short Name Ctgry
Direction input
Class data
Unit n/a
Configurable 1
examples:
 Some Category
Prcsn
Full Name Precision
Short Name Prcsn
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 527 / 866
RcMd
Short Name RcMd
Direction input
Class parameter
Unit n/a
Configurable 1
RcPrm
Short Name RcPrm
Direction input
Class parameter
Unit n/a
Configurable 1
BffrMd
Short Name BffrMd
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 528 / 866
BffrPrm
Short Name BffrPrm
Direction input
Class parameter
Unit % or Values
Configurable 1
OtptMd
Short Name OtptMd
Direction input
Class parameter
Unit n/a
Configurable 1
name
fied name
the specified name
values
all previous writes
English
Release 2018-06 529 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.15.9.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 530 / 866
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
2.6.15.9.4 Examples
Analyzing Model
There is no separate example for the Analyzing Function OutV2D() because it is being used by various other
Analyzing Models which output a 2-dimensional vector.
Analyzing Script
There is no separate example for the Analyzing Function OutV2D() because it is being used by various other
Analyzing Scripts which output a 2-dimensional vector.
for Out() and OutV2D()).
English
Release 2018-06 531 / 866
2.6.16 Spectral
2.6.16.1 AppBhann() - ApplyBartlettHann()
2.6.16.1.1 General
Properties
Full Name ApplyBartlettHann
Short Name AppBhann
Description Applies Bartlett Hanning window to the input buffer.
Parent Library Base
Parent Category Spectral
Function Prototype
Buffer1D Out0 = AppBhann
(
Buffer1D In0 = 0,
);
Symbol
2.6.16.1.2 Inputs
In0
Full Name Input0
Short Name In0
Description buffer containing the values for the windowing
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark the provided buffer must contain 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768,
65536, 131072 or 262144 values
English
Release 2018-06 532 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.16.1.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the buffer with the result of the windowing data calculation
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 533 / 866
2.6.16.1.4 Examples
Analyzing Model
AppBhann 01 Online Applies a Bartlett Hanning window to a buffered sine wave.
AppBhann 02 Offline Applies a Bartlett Hanning window to a buffered offline signal.
Analyzing Script
AppBhann 01 Online Applies a Bartlett Hanning window to a buffered sine wave.
AppBhann 02 Offline Applies a Bartlett Hanning window to a buffered offline signal.
English
Release 2018-06 534 / 866
2.6.16.2 AppBlack() - ApplyBlackmann()
2.6.16.2.1 General
Properties
Full Name ApplyBlackmann
Short Name AppBlack
Description Applies Blackmann window to the input buffer.
Parent Library Base
Function Prototype
Buffer1D Out0 = AppBlack
(
Buffer1D In0 = 0,
);
Symbol
2.6.16.2.2 Inputs
In0
Full Name Input0
Short Name In0
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
65536, 131072 or 262144 values
English
Release 2018-06 535 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.16.2.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 536 / 866
2.6.16.2.4 Examples
Analyzing Model
AppBlack 01 Online Applies a Blackman Hanning window to a buffered sine wave.
AppBlack 02 Offline Applies a Blackman Hanning window to a buffered offline signal.
Analyzing Script
AppBlack 01 Online Applies a Blackman Hanning window to a buffered sine wave.
AppBlack 02 Offline Applies a Blackman Hanning window to a buffered offline signal.
English
Release 2018-06 537 / 866
2.6.16.3 AppBlett() - ApplyBartlett()
2.6.16.3.1 General
Properties
Full Name ApplyBartlett
Short Name AppBlett
Description Applies Bartlett window to the input buffer.
Parent Library Base
Function Prototype
Buffer1D Out0 = AppBlett
(
Buffer1D In0 = 0,
);
Symbol
2.6.16.3.2 Inputs
In0
Full Name Input0
Short Name In0
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
65536, 131072 or 262144 values
English
Release 2018-06 538 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.16.3.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 539 / 866
2.6.16.3.4 Examples
Analyzing Model
AppBlett 01 Online Applies a Bartlett Hanning window to a buffered sine wave.
AppBlett 02 Offline Applies a Bartlett Hanning window to a buffered offline signal.
Analyzing Script
AppBlett 01 Online Applies a Bartlett Hanning window to a buffered sine wave.
AppBlett 02 Offline Applies a Bartlett Hanning window to a buffered offline signal.
English
Release 2018-06 540 / 866
2.6.16.4 AppHamm() - ApplyHamming()
2.6.16.4.1 General
Properties
Full Name ApplyHamming
Short Name AppHamm
Description Applies Hamming window to the input buffer.
Parent Library Base
Function Prototype
Buffer1D Out0 = AppHamm
(
Buffer1D In0 = 0,
);
Symbol
2.6.16.4.2 Inputs
In0
Full Name Input0
Short Name In0
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
65536, 131072 or 262144 values
English
Release 2018-06 541 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.16.4.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 542 / 866
2.6.16.4.4 Examples
Analyzing Model
AppHamm 01 Online Applies a Hamming window to a buffered sine wave.
AppHamm 02 Offline Applies a Hamming window to a buffered offline signal.
Analyzing Script
AppHamm 01 Online Applies a Hamming window to a buffered sine wave.
AppHamm 02 Offline Applies a Hamming window to a buffered offline signal.
English
Release 2018-06 543 / 866
2.6.16.5 AppHann() - ApplyHanning()
2.6.16.5.1 General
Properties
Full Name ApplyHanning
Short Name AppHann
Description Applies Hanning window to the input buffer.
Parent Library Base
Function Prototype
Buffer1D Out0 = AppHann
(
Buffer1D In0 = 0,
);
Symbol
2.6.16.5.2 Inputs
In0
Full Name Input0
Short Name In0
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
65536, 131072 or 262144 values
English
Release 2018-06 544 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.16.5.3 Outputs
Out0
Full Name Output0
Short Name Out0
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 545 / 866
2.6.16.5.4 Examples
Analyzing Model
AppHann 01 Online Applies a Hanning window to a buffered sine wave.
AppHann 02 Offline Applies a Hanning window to a buffered offline signal.
Analyzing Script
AppHann 01 Online Applies a Hanning window to a buffered sine wave.
AppHann 02 Offline Applies a Hanning window to a buffered offline signal.
English
Release 2018-06 546 / 866
2.6.16.6 AvgSpm() - AverageSpectrum()
2.6.16.6.1 General
Properties
Full Name AverageSpectrum
Short Name AvgSpm
Description Averages two or more input frequency spectrums.
Parent Library Base
Function Prototype
Spectrum Out0 = AvgSpm
(
Spectrum In0 = 0,
Value NoS = 2,
);
Symbol
2.6.16.6.2 Inputs
In0
Full Name Input0
Short Name In0
Description frequency spectrums which shall be averaged
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 547 / 866
NoS
Full Name NumberOfSpectrums
Short Name NoS
Description determines number of spectrums which shall be used by the averaging
Direction input
Class parameter
Default Value 2
Unit 1
Configurable 1
Remark In case the input is 1, no averaging is done. Instead the input spectrum is directly given to the
output.
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.16.6.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the averaged frequency spectrum
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 548 / 866
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
2.6.16.6.4 Examples
Analyzing Model
AvgSpm 01 Online Calculates the average spectrum of spectra of a generated sine wave with changing fre-
quency.
AvgSpm 02 Offline Calculates the average spectrum of spectra of an offline signal.
Analyzing Script
AvgSpm 01 Online Calculates the average spectrum of spectra of a generated sine wave with changing fre-
quency.
AvgSpm 02 Offline Calculates the average spectrum of spectra of an offline signal.
English
Release 2018-06 549 / 866
2.6.16.7 Cpstr() - Cepstrum()
2.6.16.7.1 General
Properties
Full Name Cepstrum
Short Name Cpstr
Description Calculates the cepstrum of the input buffer.
Parent Library Base
Function Prototype
Buffer1D Out0 = Cpstr
(
Buffer1D In0 = 0,
);
Symbol
2.6.16.7.2 Inputs
In0
Full Name Input0
Short Name In0
Description buffer containing the values whose cepstrum shall be calculated
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
65536, 131072 or 262144 values
English
Release 2018-06 550 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.16.7.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the cepstrum calculation
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 551 / 866
2.6.16.7.4 Examples
Analyzing Model
Cpstr 01 Online Calculates cepstrum for a generated signal.
Cpstr 02 Offline Calculates cepstrum for an offline signal.
Analyzing Script
Cpstr 01 Online Calculates cepstrum for a generated signal.
Cpstr 02 Offline Calculates cepstrum for an offline signal.
English
Release 2018-06 552 / 866
2.6.16.8 EnvHlb() - EnvelopeHilbert()
2.6.16.8.1 General
Properties
Full Name EnvelopeHilbert
Short Name EnvHlb
Description Calculates the envelope of the input data or values by using the Hilbert transformation.
Parent Library Base
Function Prototype
Buffer1D Out0 = EnvHlb
(
Buffer1D In0 = 0,
);
Symbol
2.6.16.8.2 Inputs
In0
Full Name Input0
Short Name In0
Description buffer containing the values whose envelope shall be calculated
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
65536, 131072 or 262144 values
English
Release 2018-06 553 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.16.8.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the envelope calculation
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 554 / 866
2.6.16.8.4 Examples
Analyzing Model
EnvHlb 01 Online Calculates envelope for a generated signal by using the Hilbert transformation.
EnvHlb 02 Offline Calculates envelope for an offline signal by using the Hilbert transformation.
Analyzing Script
EnvHlb 01 Online Calculates envelope for a generated signal by using the Hilbert transformation.
EnvHlb 02 Offline Calculates envelope for an offline signal by using the Hilbert transformation.
English
Release 2018-06 555 / 866
2.6.16.9 FFT() - FastFourierTransformation()
2.6.16.9.1 General
Properties
Full Name FastFourierTransformation
Short Name FFT
Description Calculates the spectrum of the input buffer by using the fast Fourier transformation.
Parent Library Base
Function Prototype
Spectrum Out0 = FFT
(
Buffer1D In0 = 0,
);
Symbol
2.6.16.9.2 Inputs
In0
Full Name Input0
Short Name In0
Description buffer containing the values whose spectrum shall be calculated
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
65536, 131072 or 262144 values
English
Release 2018-06 556 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.16.9.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the spectrum calculation
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 557 / 866
2.6.16.9.4 Examples
Analyzing Model
FFT 01 Online Calculates the spectrum of a generated sine wave by using Fast Fourier Transformation.
FFT 02 Offline Calculates the spectrum of an offline signal by using Fast Fourier Transformation.
FFT 03 Online Calculates the spectrum of 2 generated sine waves by using Fast Fourier Transformation.
Analyzing Script
FFT 01 Online Calculates the spectrum of a generated sine wave by using Fast Fourier Transformation.
FFT 02 Offline Calculates the spectrum of an offline signal by using Fast Fourier Transformation.
FFT 03 Online Calculates the spectrum of 2 generated sine waves by using Fast Fourier Transformation.
English
Release 2018-06 558 / 866
2.6.16.10 GenAlrmBnd() - GenerateAlarmBand()
2.6.16.10.1 General
Properties
Full Name GenerateAlarmBand
Short Name GenAlrmBnd
Description Generates an alarm band.
Parent Library Base
Function Prototype
Buffer1D Out0 = GenAlrmBnd
(
DataOrValue CoB = 0,
DataOrValue Width = 0,
DataOrValue AmplL0 = 0,
Value Mode = “Peak”,
);
Symbol
2.6.16.10.2 Inputs
CoB
Full Name CenterOfBand
Short Name CoB
Description center of the alarm band which shall be generated
Direction input
Class data
Default Value 0
Unit 1 or Hz
Configurable 1
Remark the unit of CenterOfBand is dependent on the following used Analyzing Function and is “Hz” for
the frequency analyzing or “1” for the order analyzing of the alarm spectrum
English
Release 2018-06 559 / 866
Width
Full Name Width
Short Name Width
Description width of the alarm band which shall be generated
Direction input
Class data
Default Value 0
Unit 1 or Hz
Configurable 1
Remark the value of Width must be smaller than or equal to the half of CenterOfBand
AmplL0
Full Name AmplitudeLevel0
Short Name AmplL0
Description amplitude level 0 of the alarm band which shall be generated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
AmplL1
Short Name AmplL1
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 560 / 866
AmplL2
Short Name AmplL2
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
Mode
Full Name Mode
Short Name Mode
Description mode which is used for calculation within a given band
Direction input
Class parameter
Default Value “Peak”
Unit n/a
Configurable 1
Allowed manual Inputs “Peak”, “Power”
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 561 / 866
2.6.16.10.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the buffer data with the amount of information describing the alarm band
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Supported Data Type Buffer1D
Remark none
See the introduction document, chapter “Measurement Tasks” - “Spectrum Monitoring”.
English
Release 2018-06 562 / 866
2.6.16.11 GetAlrmBnd() - GetAlarmBand()
2.6.16.11.1 General
Properties
Full Name GetAlarmBand
Short Name GetAlrmBnd
Description Returns the properties of the specified alarm band of the specified spectrum envelope.
Parent Library Base
Function Prototype
DataOrValue Name = GetAlrmBnd
(
SpectrumEnvelope InSpmEnv = 0,
DataOrValue Cntr = NULL,
DataOrValue Wdth = NULL,
DataOrValue WrngLvl = NULL,
DataOrValue CrtclLvl = NULL,
DataOrValue DfctLvl = NULL,
DataOrValue RefSpd = NULL
);
Symbol
2.6.16.11.2 Inputs
InSpmEnv
Short Name InSpmEnv
Description spectrum envelope whose alarm band properties shall be returned
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 563 / 866
Idx
Full Name Index
Short Name Idx
Description index of the alarm band whose properties shall be returned
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark in case Index is higher than or equal to the number of present alarm bands, a value of “” (empty
string) respective -1 is returned by all output arguments
a specified index is interpreted as alarm band index, mask bands can not be accessed via the
index
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.16.11.3 Outputs
Name
Full Name Name
Short Name Name
Description receives the name of the specified alarm band
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Supported Data Type String
Remark = “” (empty string) in case the specified alarm band does not exist
English
Release 2018-06 564 / 866
Cntr
Full Name Center
Short Name Cntr
Description receives the center (frequency or order) of the specified alarm band
Direction output
Class data
Default Value 0
Unit Hz or 1
Configurable 1
Supported Data Type Decimal64
Remark = -1 in case the specified alarm band does not exist
Wdth
Full Name Width
Short Name Wdth
Description receives the center (frequency or order) of the specified alarm band
Direction output
Class data
Default Value 0
Unit Hz or 1
Configurable 1
WrngLvl
Full Name WarningLevel
Short Name WrngLvl
Description receives the warning level of the alarm band
Direction output
Class data
Default Value 0
Unit
Configurable 1
Remark the unit of the warning level is identical to the unit of the amplitudes of the input spectrum
= -1 in case the specified alarm band does not exist
= -2 in case the specified spectrum envelope does not contain a warning envelope
English
Release 2018-06 565 / 866
CrtclLvl
Full Name CriticalLevel
Short Name CrtclLvl
Description receives the critical level of the alarm band
Direction output
Class data
Default Value 0
Unit
Configurable 1
Remark the unit of the critical level is identical to the unit of the amplitudes of the input spectrum
= -2 in case the specified spectrum envelope does not contain a critical envelope
DfctLvl
Full Name DefectLevel
Short Name DfctLvl
Description receives the defect level of the alarm band
Direction output
Class data
Default Value 0
Unit
Configurable 1
Remark the unit of the defect level is identical to the unit of the amplitudes of the input spectrum
= -2 in case the specified spectrum envelope does not contain a defect envelope
RefSpd
Full Name ReferenceSpeed
Short Name RefSpd
Description receives the reference speed for which this alarm band has been defined
Direction output
Class data
Default Value 0
Unit Hz
Configurable 1
= 0 in case this alarm band is an absolute alarm band
= > 0 in case this alarm band is a relative alarm band
English
Release 2018-06 566 / 866
In order to be able to run the examples, the offline data from the “..\X-Tools\Server\User\Example X-Tools
Files\MT08” directory, which is delivered together with X-Tools, must be loaded.
Analyzing Model
GetAlrmBnd 01 Online Reads the parameters of one alarm band and outputs these parameters as online data.
Analyzing Script
GetAlrmBnd 01 Online Reads the parameters of one alarm band and outputs these parameters as online data.
GetAlrmBnd 02 Offline Reads the parameters of one alarm band and outputs these parameters to the system log.
English
Release 2018-06 567 / 866
2.6.16.12 GetAmpl() – GetAmplitude()
2.6.16.12.1 General
Properties
Full Name GetAmplitude
Short Name GetAmpl
Description Returns the magnitude and phase of the specified amplitude of the input spectrum.
Parent Library Base
Function Prototype
DataOrValue Mgntd = GetAmpl
(
Spectrum In0 = 0,
DataOrValue FrqOrOrder = 1,
DataOrValue Tlrnce = 0,
Value Int = “Nearest Neighbor”,
DataOrValue* PhsDgr = NULL,
DataOrValue* PhsRd = NULL
);
Symbol
2.6.16.12.2 Inputs
In0
Full Name Input0
Short Name In0
Description order or frequency spectrum whose amplitude shall be returned
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 568 / 866
FrqOrOrdr
Full Name FrequencyOrOrder
Short Name FrqOrOrdr
Description frequency or order of the amplitude which shall be returned
Direction input
Class data
Default Value 1
Unit Hz or 1
Configurable 1
Remark none
Tlrnc
Full Name Tolerance
Short Name Tlrnc
Description tolerance around the specified frequency or order
Direction input
Class data
Default Value 0
Unit Hz or 1
Configurable 1
Remark the Analyzing Function returns the magnitude and phase of the highest amplitude which is in the
range of (FrequencyOrOrder – Tolerance) … (FrequencyOrOrder + Tolerance)
English
Release 2018-06 569 / 866
Int
Short Name Int
Description determines the interpolation method which is used in case there is no amplitude within the speci-
fied range
Direction input
Class parameter
Default Value “Nearest Neighbor”
Unit n/a
Configurable 1
Allowed manual Inputs “None”, “Linear”, “Nearest Neighbor”
Remark the interpolation is performed only in case there is no amplitude within the range of (FrequencyO-
rOrder – Tolerance) … (FrequencyOrOrder + Tolerance)
 None
o all outputs are set to 0
 Linear
o a linear interpolation of the magnitude and phase is performed between the next lower
and the next higher amplitudes
o in case there is no next lower and/or no next higher amplitude, all outputs are set to 0
 Nearest Neighbor
o the magnitude and phase of the amplitude which is closest to the specified Frequen-
cyOrOrder are output
o in case there are two amplitudes with the same distance to the specified FrequencyO-
rOrder, the magnitude and phase of the higher amplitude are returned
o in case both of these amplitudes have the same value, the magnitude and phase from
the amplitude with the lower FrequencyOrOrder are returned
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 570 / 866
2.6.16.12.3 Outputs
Mgntd
Full Name Magnitude
Short Name Mgntd
Description receives the magnitude of the determined amplitude
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
PhsDgr
Full Name PhaseDegree
Short Name PhsDgr
Description receives the phase of the determined amplitude in degrees
Direction output
Class data
Default Value 0
Unit °
Configurable 1
Remark none
PhsRd
Full Name PhaseRad
Short Name PhsRd
Description receives the phase of the determined amplitude in rad
Direction output
Class data
Default Value 0
Unit rad
Configurable 1
Remark none
English
Release 2018-06 571 / 866
Analyzing Model
GetAmpl 01 Online Returns the magnitude and the phase of an amplitude from an online spectrum.
GetAmpl 02 Offline Returns the magnitude and the phase of an amplitude from an offline spectrum.
Analyzing Script
GetAmpl 01 Online Returns the magnitude and the phase of an amplitude from an online spectrum.
GetAmpl 02 Offline Returns the magnitude and the phase of an amplitude from an offline spectrum.
English
Release 2018-06 572 / 866
2.6.16.13 MonAlrmSpm() - MonitorAlarmSpectrum()
2.6.16.13.1 General
Properties
Full Name MonitorAlarmSpectrum
Short Name MonAlrmSpm
Description Monitors a spectrum with an alarm spectrum.
Parent Library Base
Function Prototype
DataOrValue Cntrl = MonAlrmSpm
(
Spectrum InSpm = 0,
DataOrValue BaseL0 = 0,
DataOrValue EnOutSpm = true,
DataOrValue AlrmBnd0 ... AlrmBnd31 = 0;
Buffer1D* MaxBndAmp = NULL,
Spectrum* OutSpm = NULL
Spectrum* AlrmPeL0 = NULL,
Spectrum* AlrmPwL0 = NULL,
);
Symbol
English
Release 2018-06 573 / 866
2.6.16.13.2 Inputs
InSpm
Short Name InSpm
Description spectrum which shall be monitored
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
BaseL0
Full Name BaseLevel0
Short Name BaseL0
Description base amplitude level 0 of the alarm spectrum
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
BaseL1
Short Name BaseL1
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 574 / 866
BaseL2
Short Name BaseL2
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
EnOutSpm
Full Name EnableOutputSpectrum
Short Name EnOutSpm
Description enables or disables the calculation and generation of the output spectrum
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Supported Precisions Boolean, Integer8, Integer16, Integer32, Integer64, Decimal32, Decimal64
Remark none
AlrmBnd0 … AlrmBnd31
Full Name AlarmBand0 … AlarmBand31
Short Name AlrmBnd0 … AlrmBnd31
Description alarm bands which shall be used for the monitoring
Direction input
Class data
Default Value 0
Unit n/a
Remark the amplitudes of alarm bands which are attached to inputs with a higher number can overwrite
the amplitudes of alarm bands which are attached to inputs with lower numbers - thus, in case two
or more alarm bands overlap at any frequency, the amplitude from the alarm band which is con-
nected to the highest input is being used
English
Release 2018-06 575 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Supported Precisions Boolean, Integer8, Integer16, Integer32, Integer64, Decimal32, Decimal64
Remark none
2.6.16.13.3 Outputs
Cntrl
Full Name Control
Short Name Cntrl
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
MaxBndAmp
Full Name MaxBandAmplitude
Short Name MaxBndAmp
Description receives the buffer data with the maximum amplitude of each alarm band
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Supported Data Type Buffer1D
Remark none
English
Release 2018-06 576 / 866
OutSpm
Full Name OutputSpectrum
Short Name OutSpm
Description receives the result of the derivated spectrum
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
AlrmPeL0
Full Name AlarmSpectrumPeakLevel0
Short Name AlrmPeL0
Description receives the result of the “Peak” alarm spectrum level 0
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
AlrmPeL1
Short Name AlrmPeL1
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 577 / 866
AlrmPeL2
Short Name AlrmPeL2
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
AlrmPwL0
Full Name AlarmSpectrumPowerLevel0
Short Name AlrmPwL0
Description receives the result of the “Power” alarm spectrum level 0
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
AlrmPwL1
Short Name AlrmPwL1
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 578 / 866
AlrmPwL2
Short Name AlrmPwL2
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
Analyzing Model
MonAlrmSpm 01 Online Monitors the spectrum of a superposition of three sine waves.
MonAlrmSpm 02 Offline Monitors the spectrum of an offline signal.
Analyzing Script
MonAlrmSpm 01 Online Monitors the spectrum of a superposition of three sine waves.
MonAlrmSpm 02 Offline Monitors the spectrum of an offline signal.
English
Release 2018-06 579 / 866
2.6.16.14 MonAmpl() – MonitorAmplitude()
2.6.16.14.1 General
Properties
Full Name MonitorAmplitude
Short Name MonAmpl
Description Monitors the amplitude below the specified alarm band of the spectrum envelope.
Parent Library Base
Function Prototype
DataOrValue Cntrl = MonAmpl
(
Spectrum InSpm = 0,
DataOrValue RefTyp = “Index”,
DataOrValue RefVl = “”,
DataOrValue* Ampl = NULL,
);
Symbol
2.6.16.14.2 Inputs
InSpm
Short Name InSpm
Description frequency or order spectrum whose alarm band amplitudes shall be monitored
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 580 / 866
InSpmEnv
Short Name InSpmEnv
Description spectrum envelope whose alarm bands shall be used for the monitoring
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark the provided spectrum envelope type (frequency or order) must match the spectrum type (fre-
quency or order) of InSpm
Spd
Full Name Speed
Short Name Spd
Description current speed
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark the absolute value of the provided speed is calculated and used internally
the unit of the reference speed from the provided spectrum envelope is used as unit of the provid-
ed speed value
in case the speed has a value of 0, all mask bands and alarm bands whose x-position is relative to
the speed are ignored
in case the speed has a value different to 0, the ratio between the current speed and the reference
speed of the spectrum envelope is used in order to recalculate the x-position of all relative mask
bands and alarm bands
this input is ignored in case InSpm provides an order spectrum
English
Release 2018-06 581 / 866
RefTyp
Full Name ReferenceType
Short Name RefTyp
Description type of the specified ReferenceValue
Direction input
Class data
Default Value “Index”
Unit n/a
Configurable 1
Allowed manual Inputs “Index”, “Name”
Remark none
RefVl
Full Name ReferenceValue
Short Name RefVl
Description index or name of the alarm band whose amplitude shall be returned
Direction input
Class data
Unit n/a
Configurable 1
Allowed manual Inputs 0 … 31 or the name of the alarm band
Remark in case the specified alarm band does not exist, -1 is returned as Control and Amplitude
a specified index is interpreted as alarm band index, mask bands can not be accessed via the
index
a specified name must be the name of an alarm band, mask bands can not be accessed via the
name even in case the name of a mask band would match the specified name
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 582 / 866
2.6.16.14.3 Outputs
Cntrl
Full Name Control
Short Name Cntrl
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Supported Data Type Integer32
Remark = 3 in case the amplitude violates the defect level of the alarm band
= 2 in case the amplitude violates the critical level and does not violate the defect level alarm band
= 1 in case the amplitude violates the warning level and does not violate the critical level alarm
band
= 0 in case the amplitude does not violate any level of the alarm band
= -2 in case the type of the input spectrum does not match the type of the input spectrum enve-
lope
= -3 in case the specified alarm band is a relative one and the current speed is 0
Ampl
Full Name Amplitude
Short Name Ampl
Description receives the maximal amplitude of the input spectrum which is present within the specified alarm
band
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
lope
= -3 in case the specified alarm band is a relative one and the current speed is 0
English
Release 2018-06 583 / 866
Analyzing Model
Analyzing Script
The example measurement tasks are part of the “Introduction” document and provide a chapter “Advanced
Spectrum Envelopes” which shows in detail how to use the Analyzing Function MonAmpl() for the monitoring of
the amplitudes below an alarm band.
for the example of advanced spectrum envelopes are found within the “08” folders of their according explorer
trees within the X-Tools Client (e.g. “Measurement Tasks://Analyzing Script Files\08” within the ANS Explor-
er).
English
Release 2018-06 584 / 866
2.6.16.15 MonAmpls() – MonitorAmplitudes()
2.6.16.15.1 General
Properties
Full Name MonitorAmplitudes
Short Name MonAmpls
Description Monitors the amplitude below each alarm band of the spectrum envelope.
Parent Library Base
Function Prototype
DataOrValue AlrmBnds = MonAmpls
(
Spectrum InSpm = 0,
DataOrValue* Ampl0 … Ampl31 = NULL
);
Symbol
2.6.16.15.2 Inputs
InSpm
Short Name InSpm
Description frequency or order spectrum whose alarm band amplitudes shall be monitored
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 585 / 866
InSpmEnv
Short Name InSpmEnv
Description spectrum envelope whose alarm bands shall be used for the monitoring
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Spd
Full Name Speed
Short Name Spd
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
ed speed value
English
Release 2018-06 586 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.16.15.3 Outputs
AlrmBnds
Full Name AlarmBands
Short Name AlrmBnds
Description receives the number of alarm bands which are present within the spectrum envelope
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark the returned number of alarm bands includes also all relative alarm bands even in case the current
speed is 0
the number of present alarm bands is returned also in case the format of the input spectrum does
not match the format of the input spectrum envelope
eventually present mask bands are not includeded within the returned number of alarm bands
English
Release 2018-06 587 / 866
Ampl0 … Ampl31
Full Name Amplitude0 … Amplitude31
Short Name Ampl0 … Ampl31
Description receives the maximal amplitude of the input spectrum which is present within the alarm band
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark = -1 in case the alarm band does not exist
lope
= -3 in case the alarm band is a relative one and the current speed is 0
Analyzing Model
Analyzing Script
Spectrum Envelopes” which shows in detail how to use the Analyzing Function MonAmpls() for the monitoring
of the amplitudes below the present alarm bands.
er).
English
Release 2018-06 588 / 866
2.6.16.16 MonBsBnd() – MonitorBaseBand()
2.6.16.16.1 General
Properties
Full Name MonitorBaseBand
Short Name MonBsBnd
Description Monitors the selective RMS and the maximal amplitude below the base band of the specified
spectrum envelope.
Parent Library Base
Function Prototype
DataOrValue SelRMS = MonBsBnd
(
Spectrum InSpm = 0,
DataOrValue* ForO = NULL,
DataOrValue* Ampl = NULL
);
Symbol
2.6.16.16.2 Inputs
InSpm
Short Name InSpm
Description frequency or order spectrum whose base band shall be monitored
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 589 / 866
InSpmEnv
Short Name InSpmEnv
Description spectrum envelope whose base band shall be used for the monitoring
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Spd
Full Name Speed
Short Name Spd
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
ed speed value
in case the speed has a value of 0, all mask and alarm bands whose x-position is relative to the
speed are ignored
and alarm bands
English
Release 2018-06 590 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.16.16.3 Outputs
SelRMS
Full Name SelectiveRootMeanSquare
Short Name SelRMS
Description receives the result of the selective root mean square calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark = -1 in case the provided input spectrum and/or the provided input spectrum format do not match
a supported format
lope
English
Release 2018-06 591 / 866
ForO
Short Name ForO
Description receives the frequency or order at which the maximal amplitude has been detected
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark in case there a several x-positions with the same maximal amplitude, the smallest of these x-
positions is returned
= -1 in case the provided input spectrum and/or the provided input spectrum format do not match
a supported format
lope
Ampl
Full Name Amplitude
Short Name Ampl
Description receives the maximal amplitude of the input spectrum which is present within the base band
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark = -1 in case the provided input spectrum and/or the provided input spectrum format do not match
a supported format
lope
Examples
Analyzing Model
Analyzing Script
Spectrum Envelopes” which shows in detail how to use the Analyzing Function MonBsBnd() for the monitoring
of the base band of a spectrum.
er).
English
Release 2018-06 592 / 866
2.6.16.17 MonSpmEnv() – MonitorSpectrumEnvelope()
2.6.16.17.1 General
Properties
Full Name MonitorSpectrumEnvelope
Short Name MonSpmEnv
Description Monitors whether the given spectrum violates the given envelopes.
Parent Library Base
Function Prototype
DataOrValue Cntrl = MonSpmEnv
(
Spectrum In0 = 0,
Spectrum UpperBnd1 = 0,
Spectrum LowerBnd1 = 0,
DataOrValue CntrlUpper = 0,
DataOrValue CntrlLower = 0
);
Symbol
English
Release 2018-06 593 / 866
2.6.16.17.2 Inputs
In0
Full Name Input0
Short Name In0
Description spectrum which shall be used for the monitoring against the envelopes
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
UpperBand1
Description spectrum which contains the 1. upper band
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark 0 can be passed for this argument in case monitoring of the 1. upper band is not needed
LowerBand1
Description spectrum which contains the 1. lower band
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark 0 can be passed for this argument in case monitoring of the 1. lower band is not needed
English
Release 2018-06 594 / 866
UpperBand2
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
LowerBand2
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
UpperBand3
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
English
Release 2018-06 595 / 866
LowerBand3
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 596 / 866
2.6.16.17.3 Outputs
Cntrl
Full Name Control
Short Name Cntrl
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark Control is 0 in case none of the bands is violated by the current input spectrum
Control is positive in case one of the upper bands is violated (1 in case the UpperBand1 is violat-
ed, 2 in case the UpperBand2 is violated, …) - in case multiple of the upper bands are violated,
the value of Control matches the topmost upper band which has been violated
Control is negative in case one of the lower bands is violated (1 in case the LowerBand1 is violat-
ed, 2 in case the LowerBand2 is violated, …) - in case multiple of the lower bands are violated, the
value of Control matches the bottommost lower band which has been violated
Control is positive in case both an upper band and a lower band are violated simultaneously
in case none of the bands is violated but the x-value (order or frequency) of the current input spec-
trum is outside the range (order or frequency) of a band, Control shows a violation of the topmost
band which does not cover the frequency range
CntrlUpper
Full Name ControlUpper
Short Name CntrlUpper
Description receives the result of the monitoring of the upper bands
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark ControlUpper is 0 in case none of the upper bands is violated by the current input spectrum
ControlUpper is positive in case one of the upper bands is violated (1 in case the UpperBand1 is
violated, 2 in case the UpperBand2 is violated, …) - in case multiple of the upper bands are violat-
ed, the value of ControlUpper matches the topmost upper band which has been violated
trum is outside the range (order or frequency) of an upper band, ControlUpper shows a violation of
the topmost upper band which does not cover the frequency range
English
Release 2018-06 597 / 866
CntrlLower
Full Name ControlLower
Short Name CntrlLower
Description receives the result of the monitoring of the lower bands
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark ControlLower is 0 in case none of the lower bands is violated by the current input spectrum
ControlLower is negative in case one of the lower bands is violated (1 in case the LowerBand1 is
violated, 2 in case the LowerBand2 is violated, …) - in case multiple of the lower bands are violat-
ed, the value of ControlLower matches the bottommost lower band which has been violated
trum is outside the range (order or frequency) of a lower band, ControlLower shows a violation of
the topmost lower band which does not cover the frequency range

The example measurement tasks are part of the “Introduction” document and provide a chapter “Basic Spec-
trum Envelopes” which shows in detail how to use the Analyzing Function MonSpmEnv() for the monitoring of
the envelopes of a spectrum.
for the example of basic spectrum envelopes are found within the “07” folders of their according explorer trees
English
Release 2018-06 598 / 866
2.6.16.18 MonSpmEnv2() – MonitorSpectrumEnvelope2()
2.6.16.18.1 General
Properties
Full Name MonitorSpectrumEnvelope2
Short Name MonSpmEnv2
Description Monitors whether the input spectrum violates the spectrum envelope.
Parent Library Base
Function Prototype
DataOrValue Cntrl = MonSpmEnv2
(
Spectrum InSpm = 0,
DataOrValue* Name = NULL,
DataOrValue* ForO = NULL,
DataOrValue* Ampl = NULL,
DataOrValue* Idx = NULL,
DataOrValue* WrngLvl = NULL,
DataOrValue* CrtclLvl = NULL,
DataOrValue* DfctLvl = NULL
);
Symbol
English
Release 2018-06 599 / 866
2.6.16.18.2 Inputs
InSpm
Short Name InSpm
Description frequency or order spectrum which shall be monitored against the spectrum envelope
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
InSpmEnv
Short Name InSpmEnv
Description spectrum envelope which shall be used for the monitoring
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
English
Release 2018-06 600 / 866
Spd
Full Name Speed
Short Name Spd
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
ed speed value
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 601 / 866
2.6.16.18.3 Outputs
Cntrl
Full Name Control
Short Name Cntrl
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark = -4 in case the format of the input spectrum does not match the format of the input spectrum
envelope
= -3 in case
 the smallest x-position which violates the defect base band (including defect mask bands)
is smaller than the smallest x-position which violates a defect alarm band
o this value is returned also in case the defect base band (including defect mask bands)
is violated and no defect alarm band is violated
= -2 in case
 there is no violation of the defect base band (including defect mask bands) and no viola-
tion of a defect alarm band
 the smallest x-position which violates the critical base band (including critical mask
bands) is smaller than the smallest x-position which violates a defect alarm band
o this value is returned also in case the critical base band (including critical mask bands)
is violated and no critical alarm band is violated
= -1 in case
 there is no violation of the critical/defect base bands (including critical/defect mask bands)
and no violation of a critical/defect alarm band
 the smallest x-position which violates the warning base band (including warning mask
bands) is smaller than the smallest x-position which violates a warning alarm band
o this value is returned also in case the warning base band (including warning mask
bands) is violated and no warning alarm band is violated
= 0 in case none of the alarm bands is violated and also the base bands (including mask bands)
are not violated by the current input spectrum
= 1 in case
 there is no violation of the critical/defect base bands (including critical/defect mask bands)
and no violation of a critical/defect alarm band
 the smallest x-position which violates a warning alarm band is smaller than the smallest x-
position which violates the warning base band (including warning mask bands)
o this value is returned also in case a warning alarm band is violated and the warning
base band (including warning mask bands) is not violated
= 2 in case
 there is no violation of the defect base band (including defect mask bands) and no viola-
tion of a defect alarm band
 the smallest x-position which violates a critical alarm band is smaller than the smallest x-
position which violates the critical base band (including critical mask bands)
o this value is returned also in case a critical alarm band is violated and the critical base
band (including critical mask bands) is not violated
= 3 in case
 the smallest x-position which violates a defect alarm band is smaller than the smallest x-
position which violates the defect base band (including defect mask bands)
o this value is returned also in case a defect alarm band is violated and the defect base
band (including defect mask bands) is not violated
English
Release 2018-06 602 / 866
Name
Full Name Name
Short Name Name
Description receives the name of the alarm band which has detected the violation
Direction output
Class data
Unit 1
Configurable 1
Supported Data Type String
Remark in case multiple alarm bands of the same type (warning, critical or defect) are violated at the same
time, the name of the alarm band with the smallest center (frequency or order) is output
in case only a base band (including mask bands) is violated, the name of the violated base band
is output by this argument
ForO
Short Name ForO
Description receives the frequency or order at which the violation has been detected
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
time, the frequency or order within the alarm band with the smallest center (frequency or order)
and with the highest amplitude is output
in case only a base band (including mask bands) is violated, the frequency or order with the high-
est amplitude which violates the base band is output
English
Release 2018-06 603 / 866
Ampl
Full Name Amplitude
Short Name Ampl
Description receives the amplitude which has caused the violation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
time, the highest amplitude within the alarm band with the smallest center (frequency or order) is
output
in case only a base band (including mask bands) is violated, the highest amplitude which violates
the base band is output
Idx
Full Name Index
Short Name Idx
Description receives the index of the alarm band which has detected the violation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
time, the index of the alarm band with the smallest center (frequency or order) is output
in case only a base band is violated, -1 is output by this argument
WrngLvl
Full Name WarningLevel
Short Name WrngLvl
Description receives the warning level at the frequency or order at which the violation has been detected
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark
English
Release 2018-06 604 / 866
CrtclLvl
Full Name CriticalLevel
Short Name CrtclLvl
Description receives the critical level at the frequency or order at which the violation has been detected
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark
DfctLvl
Full Name DefectLevel
Short Name CrtclLvl
Description receives the defect level at the frequency or order at which the violation has been detected
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark
Analyzing Model
Analyzing Script
Spectrum Envelopes” which shows in detail how to use the Analyzing Function MonSpmEnv2() for the monitor-
ing of the envelopes of a spectrum.
er).
English
Release 2018-06 605 / 866
2.6.16.19 SelRMS() – SelectiveRootMeanSquare()
2.6.16.19.1 General
Properties
Full Name SelectiveRootMeanSquare
Short Name SelRMS
Description Calculates the root mean square for the specified order or frequency range of the input spectrum.
Parent Library Base
Function Prototype
DataOrValue Out0 = SelRMS
(
Spectrum In0 = 0,
Value LFrqBrd = 0,
Value HFrqBrd = 0,
);
Symbol
2.6.16.19.2 Inputs
In0
Full Name Input0
Short Name In0
Description order or frequency spectrum whose selective root mean square shall be calculated
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 606 / 866
LowBrd
Full Name LowerBorder
Short Name LowBrd
Description lower border of the order or frequency range used for the selective root mean square calculation
Direction input
Class parameter
Default Value 0
Unit 1 or Hz
Configurable 1
Remark none
UppBrd
Full Name UpperBorder
Short Name UppBrd
Description upper border of the order or frequency range used for the selective root mean square calculation
Direction input
Class parameter
Default Value 0
Unit 1 or Hz
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 607 / 866
2.6.16.19.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the selective root mean square calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
Analyzing Model
SelRMS 01 Online Calculates root mean square of a generated signal by using its frequency spectrum.
SelRMS 02 Offline Calculates root mean square of an offline signal by using its frequency spectrum.
Analyzing Script
SelRMS 01 Online Calculates root mean square of a generated signal by using its frequency spectrum.
SelRMS 02 Offline Calculates root mean square of an offline signal by using its frequency spectrum.
English
Release 2018-06 608 / 866
2.6.16.20 SpmAdd() - SpectrumAddition()
2.6.16.20.1 General
Properties
Full Name SpectrumAddition
Short Name SpmAdd
Description Calculates the arithmetical addition for the amplitudes of the given input spectrum.
Parent Library Base
Function Prototype
Spectrum Out0 = SpmAdd
(
Spectrum In0 = 0,
Value Mode = “Absolute Value”,
DataOrValue Value = 0,
);
Symbol
2.6.16.20.2 Inputs
In0
Full Name Input0
Short Name In0
Description spectrum whose amplitudes shall be used for the addition
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 609 / 866
Mode
Full Name Mode
Short Name Mode
Description mode of the addition
Direction input
Class parameter
Default Value “Absolute Value”
Unit 1
Configurable 1
Allowed manual Inputs “Absolute Value”, “Relative Value”
Remark Absolute Value = the Analyzing Function adds the absolute value from the Value argument to
each amplitude
Relative Value = the Analyzing Function calculates the absolute value for each amplitude out of
the relative value from the Value argument and the actual value of the amplitude (example: in
case the amplitude is 50 and (the relative) Value is 20, an absolute value of (50 * 0.20 =) 10 is
added to the amplitude
Value
Full Name Value
Short Name Value
Description value which shall be added to each amplitude of the input spectrum
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark depending to the chosen Mode, Value is interpreted as absolute or relative value
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 610 / 866
2.6.16.20.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the spectrum data with the updated amplitudes
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
Analyzing Model
SpmAdd 01 Online Adds the specified relative value to each amplitude of the input spectrum.
SpmAdd 02 Offline Adds the specified absolute value to each amplitude of the input spectrum.
Analyzing Script
SpmAdd 01 Online Adds the specified relative value to each amplitude of the input spectrum.
SpmAdd 02 Offline Adds the specified absolute value to each amplitude of the input spectrum.
English
Release 2018-06 611 / 866

The example measurement tasks are part of the “Introduction” document and provide a chapter “Basic Spec-
trum Envelopes” which shows in detail how to use the Analyzing Function SpmAdd() for the creation of the
envelopes of a spectrum.
for the example of basic spectrum envelopes are found within the “07” folders of their according explorer trees
English
Release 2018-06 612 / 866
2.6.16.21 SpmMax() - SpectrumMaximum()
2.6.16.21.1 General
Properties
Full Name SpectrumMaximum
Short Name SpmMax
Description Determines the maximum of the amplitudes of the given input spectrum.
Parent Library Base
Function Prototype
Spectrum Out0 = SpmMax
(
Spectrum In0 = 0,
);
Symbol
2.6.16.21.2 Inputs
In0
Full Name Input0
Short Name In0
Description spectrum whose maximums of amplitudes shall be determined
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 613 / 866
Reset
Full Name Reset
Short Name Reset
Description resets the determined maximums of all amplitudes
Direction input
Class control
Default Value false
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.16.21.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives a spectrum data whose amplitudes are the maximums of the amplitudes of the input
spectrum since the last reset
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 614 / 866
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
Analyzing Model
SpmMax 01 Online Determines the maximum amplitudes of the input spectrum since the start of the Analyzing
Model.
SpmMax 02 Offline Determines the maximum amplitudes of the input spectrum over its whole time interval.
Analyzing Script
SpmMax 01 Online Determines the maximum amplitudes of the input spectrum since the start of the Analyzing
Script.
SpmMax 02 Offline Determines the maximum amplitudes of the input spectrum over its whole time interval.
English
Release 2018-06 615 / 866
2.6.16.22 SpmMul() - SpectrumMultiplication()
2.6.16.22.1 General
Properties
Full Name SpectrumMultiplication
Short Name SpmMul
Description Calculates the arithmetical multiplication for the amplitudes of the given input spectrum.
Parent Library Base
Function Prototype
Spectrum Out0 = SpmMul
(
Spectrum In0 = 0,
);
Symbol
2.6.16.22.2 Inputs
In0
Full Name Input0
Short Name In0
Description spectrum whose amplitudes shall be used for the multiplication
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 616 / 866
Value
Full Name Value
Short Name Value
Description value which shall be multiplied with each amplitude of the input spectrum
Direction input
Class data
Default Value 1
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.16.22.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the spectrum data with the updated amplitudes
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 617 / 866
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
Analyzing Model
SpmMul 01 Online Multiplies each amplitude of the input spectrum with the specified value.
SpmMul 02 Offline Multiplies each amplitude of the input spectrum with the specified value.
Analyzing Script
SpmMul 01 Online Multiplies each amplitude of the input spectrum with the specified value.
SpmMul 02 Offline Multiplies each amplitude of the input spectrum with the specified value.
English
Release 2018-06 618 / 866
2.6.16.23 THD() – TotalHarmonicDistortion()
2.6.16.23.1 General
Properties
Full Name TotalHarmonicDistortion
Short Name THD
Description Calculates the total harmonic distortion of the input signals.
Parent Library Base
Function Prototype
DataOrValue Out0 = THD
(
Spectrum In0 = 0,
Value NoH = 1,
);
Symbol
2.6.16.23.2 Inputs
In0
Full Name Input0
Short Name In0
Description spectrum containing the values whose total harmonic distortion shall be calculated
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 619 / 866
NoH
Full Name NumberOfHarmonics
Short Name NoH
Description determines number of harmonics which shall be used by the total harmonic distortion calculation
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.16.23.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the total harmonic distortion calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 620 / 866
Analyzing Model
THD 01 Online Calculates total harmonic distortion of a generated signal.
THD 02 Offline Calculates total harmonic distortion of an offline signal.
Analyzing Script
THD 01 Online Calculates total harmonic distortion of a generated signal.
THD 02 Offline Calculates total harmonic distortion of an offline signal.
English
Release 2018-06 621 / 866
2.6.17 Statistic
2.6.17.1 Avg() - Average()
2.6.17.1.1 General
Properties
Full Name Average
Short Name Avg
Description Calculates arithmetical average of the input data or values.
Parent Library Base
Parent Category Statistic
Function Prototype
DataOrValue Out0 = Avg
(
Value NoP = 1,
);
Symbol
2.6.17.1.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose arithmetical average shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 622 / 866
NoP
Short Name NoP
Description determines number of points which shall be used for the arithmetical average calculation
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.17.1.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the arithmetical average calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 623 / 866
2.6.17.1.4 Examples
Analyzing Model
Avg 01 Online Calculates the average of a generated sine wave.
Avg 02 Offline Calculates the average of an offline signal.
Analyzing Script
Avg 01 Online Calculates the average of a generated sine wave.
Avg 02 Offline Calculates the average of an offline signal.
English
Release 2018-06 624 / 866
2.6.17.2 AvgBffr() - AverageBuffer()
2.6.17.2.1 General
Properties
Full Name AverageBuffer
Short Name AvgBffr
Description Calculates arithmetical average of the input buffer.
Parent Library Base
Function Prototype
DataOrValue Out0 = AvgBffr
(
Buffer1D In0 = 0,
);
Symbol
2.6.17.2.2 Inputs
In0
Full Name Input0
Short Name In0
Description buffer containing the values whose arithmetical average shall be calculated
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 625 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.17.2.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the buffer arithmetical average calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.17.2.4 Examples
Analyzing Model
AvgBffr 01 Online Calculates the average of a buffered generated sine wave.
AvgBffr 02 Offline Calculates the average of a buffered offline signal.
Analyzing Script
AvgBffr 01 Online Calculates the average of a buffered generated sine wave.
AvgBffr 02 Offline Calculates the average of a buffered offline signal.
English
Release 2018-06 626 / 866
2.6.17.3 Crest() - Crest()
2.6.17.3.1 General
Properties
Full Name Crest
Short Name Crest
Description Calculates the crest factor of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Crest
(
Value NoP = 1,
);
Symbol
2.6.17.3.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose crest factor shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 627 / 866
NoP
Short Name NoP
Description determines number of points which shall be used for the crest factor calculation
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.17.3.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the crest factor calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 628 / 866
2.6.17.3.4 Examples
Analyzing Model
Crest 01 Online Calculates the crest factor of a generated sine wave.
Crest 02 Offline Calculates the crest factor of an offline signal.
Analyzing Script
Crest 01 Online Calculates the crest factor of a generated sine wave.
Crest 02 Offline Calculates the crest factor of an offline signal.
English
Release 2018-06 629 / 866
2.6.17.4 GetPrd() - GetPeriod()
2.6.17.4.1 General
Properties
Full Name GetPeriod
Short Name GetPrd
Description Calculates the period duration of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = GetPrd
(
Value NoPrd = 1,
);
Symbol
2.6.17.4.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose period shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 630 / 866
NoPrd
Full Name NumberOfPeriods
Short Name NoPrd
Description determines number of periods which shall be used for the calculation
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.17.4.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the period calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 631 / 866
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
2.6.17.4.4 Examples
Analyzing Model
GetPrd 01 Online Calculates the period of a generated sine wave.
GetPrd 02 Offline Calculates the period of an offline signal.
Analyzing Script
GetPrd 01 Online Calculates the period of a generated sine wave.
GetPrd 02 Offline Calculates the period of an offline signal.
English
Release 2018-06 632 / 866
2.6.17.5 H1D() - Histogram1D()
2.6.17.5.1 General
Properties
Full Name Histogram1D
Short Name H1D
Description Creates 1-dimensional histogram of the input data or values.
Parent Library Base
Function Prototype
Buffer1D Out0 = H1D
(
Value LowBrdX = 0,
Value UppBrdX = 1,
Value DimX = 1,
Value ClssMdX = “Inside”,
Value Update = 0.1,
);
Symbol
English
Release 2018-06 633 / 866
2.6.17.5.2 Inputs
InX
Full Name InputX
Short Name InX
Description data or values whose 1-dimensional histogram shall be created
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
LowBrdX
Short Name LowBrdX
Description data or value which shall be used as lower border of InputX for the histogram classification
Direction input
Class parameter
Default Value 0
Unit 1
Configurable 1
Remark none
UppBrdX
Short Name UppBrdX
Description data or value which shall be used as upper border of InputX for the histogram classification
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
English
Release 2018-06 634 / 866
DimX
Full Name DimensionX
Short Name DimX
Description data or value which shall be used as classes number of InputX for the histogram classification
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
ClssMdX
Full Name ClassificationModeX
Short Name ClssMdX
Description contains the mode of InputX for the histogram classification
Direction input
Class parameter
Default Value “Inside”
Unit n/a
Configurable 1
Remark none
Update
Full Name Update
Short Name Update
Description acquisition time for the release of the histogram
Direction input
Class parameter
Default Value 0.1
Unit s
Configurable 1
Remark none
English
Release 2018-06 635 / 866
Reset
Full Name Reset
Short Name Reset
Description resets the histogram calculation
Direction input
Class control
Default Value false
Unit 1
Configurable 1
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.17.5.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the 1-dimensional histogram of the input data or values
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 636 / 866
OutReady
Short Name OutReady
Description indicates whether the histogram data in Output0 is valid
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
2.6.17.5.4 Examples
Analyzing Model
H1D 01 Online Calculates the 1-dimensional histogram values of a generated signal.
H1D 02 Offline Calculates the 1-dimensional histogram values of an offline signal.
Analyzing Script
H1D 01 Online Calculates the 1-dimensional histogram values of a generated signal.
H1D 02 Offline Calculates the 1-dimensional histogram values of an offline signal.
English
Release 2018-06 637 / 866
2.6.17.6 H2D() – Histogram2D()
2.6.17.6.1 General
Properties
Full Name Histogram2D
Short Name H2D
Description Creates 2-dimensional histogram of the input data or values.
Parent Library Base
Function Prototype
Buffer2D Out0 = H2D
(
Value LowBrdX = 0,
Value UppBrdX = 1,
Value DimX = 1,
Value ClssMdX = “Inside”,
DataOrValue InZ = 0,
Value LowBrdZ = 0,
Value UppBrdZ = 1,
Value DimZ = 1,
Value ClssMdZ = “Inside”,
Value Update = 0.1,
);
Symbol
English
Release 2018-06 638 / 866
2.6.17.6.2 Inputs
InX
Full Name InputX
Short Name InX
Description data or values used as first input for the 2-dimensional histogram calculation
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
LowBrdX
Short Name LowBrdX
Description data or value which shall be used as lower border of InputX for the histogram classification
Direction input
Class parameter
Default Value 0
Unit 1
Configurable 1
Remark none
UppBrdX
Short Name UppBrdX
Description data or value which shall be used as upper border of InputX for the histogram classification
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
English
Release 2018-06 639 / 866
DimX
Full Name DimensionX
Short Name DimX
Description data or value which shall be used as classes number of InputX for the histogram classification
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
ClssMdX
Full Name ClassificationModeX
Short Name ClssMdX
Description contains the mode of InputX for the histogram classification
Direction input
Class parameter
Unit n/a
Configurable 1
Remark none
InZ
Full Name InputZ
Short Name InZ
Description data or values used as second input for the 2-dimensional histogram calculation
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 640 / 866
LowBrdZ
Full Name LowerBorderZ
Short Name LowBrdZ
Description data or value which shall be used as lower border of InputZ for the histogram classification
Direction input
Class parameter
Default Value 0
Unit 1
Configurable 1
Remark none
UppBrdZ
Full Name UpperBorderZ
Short Name UppBrdZ
Description data or value which shall be used as upper border of InputZ for the histogram classification
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
DimZ
Full Name DimensionZ
Short Name DimZ
Description data or value which shall be used as classes number of InputZ for the histogram classification
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
English
Release 2018-06 641 / 866
ClssMdZ
Full Name ClassificationModeZ
Short Name ClssMdZ
Description contains the mode of InputZ for the histogram classification
Direction input
Class parameter
Unit n/a
Configurable 1
Remark none
Update
Full Name Update
Short Name Update
Description acquisition time for the release of the histogram
Direction input
Class parameter
Default Value 0.1
Unit s
Configurable 1
Remark in case Update = 0 the histogram will be released each Cycle Time defined in the parent Analyz-
ing Model / Analyzing Script
Reset
Full Name Reset
Short Name Reset
Description resets the histogram calculation
Direction input
Class control
Default Value false
Unit 1
Configurable 1
English
Release 2018-06 642 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.17.6.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the 2-dimensional histogram of the input data or values
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Description indicates whether the histogram data in Output0 is valid
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 643 / 866
2.6.17.6.4 Examples
Analyzing Model
H2D 01 Online Calculates the 2-dimensional histogram values of generated signals.
H2D 02 Offline Calculates the 2-dimensional histogram values of offline signals.
Analyzing Script
H2D 01 Online Calculates the 2-dimensional histogram values of generated signals.
H2D 02 Offline Calculates the 2-dimensional histogram values of offline signals.
English
Release 2018-06 644 / 866
2.6.17.7 Kurtosis() - Kurtosis()
2.6.17.7.1 General
Properties
Full Name Kurtosis
Short Name Kurtosis
Description Calculates the kurtosis of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Kurtosis
(
Value NoP = 1,
);
Symbol
2.6.17.7.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose kurtosis shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 645 / 866
NoP
Short Name NoP
Description determines number of points which shall be used for the kurtosis calculation
Direction input
Class parameter
Default Value 2
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.17.7.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the kurtosis calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 646 / 866
2.6.17.7.4 Examples
Analyzing Model
Kurtosis 01 Online Calculates the kurtosis values of a generated signal.
Kurtosis 02 Offline Calculates the kurtosis values of an offline signal.
Analyzing Script
Kurtosis 01 Online Calculates the kurtosis values of a generated signal.
Kurtosis 02 Offline Calculates the kurtosis values of an offline signal.
English
Release 2018-06 647 / 866
2.6.17.8 Max() - Maximum()
2.6.17.8.1 General
Properties
Full Name Maximum
Short Name Max
Description Detects global maximum of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Max
(
);
Symbol
2.6.17.8.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose global maximum shall be detected
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 648 / 866
Reset
Full Name Reset
Short Name Reset
Description resets the global maximum detection
Direction input
Class control
Default Value false
Unit 1
Configurable 1
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.17.8.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the global maximum detection
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 649 / 866
2.6.17.8.4 Examples
Analyzing Model
Max 01 Online Calculates the global maximum value of a generated signal.
Max 02 Offline Calculates the global maximum value of an offline signal.
Analyzing Script
Max 01 Online Calculates the global maximum value of a generated signal.
Max 02 Offline Calculates the global maximum value of an offline signal.
English
Release 2018-06 650 / 866
2.6.17.9 MaxBffr() - MaximumBuffer()
2.6.17.9.1 General
Properties
Full Name MaximumBuffer
Short Name MaxBffr
Description Detects global maximum of the input buffer.
Parent Library Base
Function Prototype
DataOrValue Out0 = MaxBffr
(
Buffer1D In0 = 0,
);
Symbol
2.6.17.9.2 Inputs
In0
Full Name Input0
Short Name In0
Description buffer containing the values whose global maximum shall be detected
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 651 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.17.9.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the buffer global maximum detection
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
2.6.17.9.4 Examples
Analyzing Model
MaxBffr 01 Online Calculates the global maximum value of a buffered generated signal.
MaxBffr 02 Offline Calculates the global maximum value of a buffered offline signal.
Analyzing Script
MaxBffr 01 Online Calculates the global maximum value of a buffered generated signal.
MaxBffr 02 Offline Calculates the global maximum value of a buffered offline signal.
English
Release 2018-06 652 / 866
2.6.17.10 Min() - Minimum()
2.6.17.10.1 General
Properties
Full Name Minimum
Short Name Min
Description Detects global minimum of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Min
(
);
Symbol
2.6.17.10.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose global minimum shall be detected
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 653 / 866
Reset
Full Name Reset
Short Name Reset
Description resets the global minimum detection
Direction input
Class control
Default Value false
Unit 1
Configurable 1
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.17.10.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the global minimum detection
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 654 / 866
Analyzing Model
Min 01 Online Calculates the global minimum value of a generated signal.
Min 02 Offline Calculates the global minimum value of an offline signal.
Analyzing Script
Min 01 Online Calculates the global minimum value of a generated signal.
Min 02 Offline Calculates the global minimum value of an offline signal.
English
Release 2018-06 655 / 866
2.6.17.11 MinBffr() - MinimumBuffer()
2.6.17.11.1 General
Properties
Full Name MinimumBuffer
Short Name MinBffr
Description Detects global minimum of the input buffer.
Parent Library Base
Function Prototype
DataOrValue Out0 = MinBffr
(
Buffer1D In0 = 0,
);
Symbol
2.6.17.11.2 Inputs
In0
Full Name Input0
Short Name In0
Description buffer containing the values whose global minimum shall be detected
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 656 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.17.11.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the buffer global minimum detection
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
Analyzing Model
MinBffr 01 Online Calculates the global minimum value of a buffered generated signal.
MinBffr 02 Offline Calculates the global minimum value of a buffered offline signal.
Analyzing Script
MinBffr 01 Online Calculates the global minimum value of a buffered generated signal.
MinBffr 02 Offline Calculates the global minimum value of a buffered offline signal.
English
Release 2018-06 657 / 866
2.6.17.12 Range() - Range()
2.6.17.12.1 General
Properties
Full Name Range
Short Name Range
Description Calculates the global range of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Range
(
);
Symbol
2.6.17.12.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose global range shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 658 / 866
Reset
Full Name Reset
Short Name Reset
Description resets the global range calculation
Direction input
Class control
Default Value false
Unit 1
Configurable 1
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.17.12.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the global range calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 659 / 866
Analyzing Model
Range 01 Online Calculates the global range values of a generated sinus wave.
Range 02 Offline Calculates the global range values of an offline signal.
Analyzing Script
Range 01 Online Calculates the global range values of a generated sine wave.
Range 02 Offline Calculates the global range values of an offline signal.
English
Release 2018-06 660 / 866
2.6.17.13 RMS() - RootMeanSquare()
2.6.17.13.1 General
Properties
Full Name RootMeanSquare
Short Name RMS
Description Calculates the root mean square of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = RMS
(
Value NoP = 1,
);
Symbol
2.6.17.13.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose root mean square shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 661 / 866
NoP
Short Name NoP
Description determines number of points which shall be used for the root mean square calculation
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.17.13.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the root mean square calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 662 / 866
Analyzing Model
RMS 01 Online Calculates the root mean square values of a generated sine wave.
RMS 02 Offline Calculates the root mean square values of an offline signal.
Analyzing Script
RMS 01 Online Calculates the root mean square values of a generated sine wave.
RMS 02 Offline Calculates the root mean square values of an offline signal.
English
Release 2018-06 663 / 866
2.6.17.14 Skewness() - Skewness()
2.6.17.14.1 General
Properties
Full Name Skewness
Short Name Skewness
Description Calculates the skewness of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Skewness
(
Value NoP = 1,
);
Symbol
2.6.17.14.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose skewness shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 664 / 866
NoP
Short Name NoP
Description determines number of points which shall be used for the skewness calculation
Direction input
Class parameter
Default Value 2
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.17.14.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the skewness calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 665 / 866
Analyzing Model
Skewness 01 Online Calculates the skewness values of a generated signal.
Skewness 02 Offline Calculates the skewness values of an offline signal.
Analyzing Script
Skewness 01 Online Calculates the skewness values of a generated sine wave.
Skewness 02 Offline Calculates the skewness values of an offline signal.
English
Release 2018-06 666 / 866
2.6.17.15 StdDev() – StandardDeviation()
2.6.17.15.1 General
Properties
Full Name StandardDeviation
Short Name StdDev
Description Calculates the sample standard deviation of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = StdDev
(
Value NoP = 2,
);
Symbol
2.6.17.15.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose sample standard deviation shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 667 / 866
NoP
Short Name NoP
Description determines number of points which shall be used for the sample standard deviation calculation
Direction input
Class parameter
Default Value 2
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.17.15.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the sample standard deviation calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 668 / 866
Analyzing Model
StdDev 01 Online Calculates the sample standard deviation values of a generated signal.
StdDev 02 Offline Calculates the sample standard deviation values of an offline signal.
Analyzing Script
StdDev 01 Online Calculates the sample standard deviation values of a generated signal.
StdDev 02 Offline Calculates the sample standard deviation values of an offline signal.
English
Release 2018-06 669 / 866
2.6.17.16 StdDevN() – StandardDeviationN()
2.6.17.16.1 General
Properties
Full Name StandardDeviationN
Short Name StdDevN
Description Calculates the standard deviation of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = StdDevN
(
Value NoP = 1,
);
Symbol
2.6.17.16.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose standard deviation shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 670 / 866
NoP
Short Name NoP
Description determines number of points which shall be used for the standard deviation calculation
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.17.16.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the standard deviation calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 671 / 866
Analyzing Model
StdDevN 01 Online Calculates the standard deviation values of a generated signal.
StdDevN 02 Offline Calculates the standard deviation values of an offline signal.
Analyzing Script
StdDevN 01 Online Calculates the standard deviation values of a generated signal.
StdDevN 02 Offline Calculates the standard deviation values of an offline signal.
English
Release 2018-06 672 / 866
2.6.17.17 Vrnc() – Variance()
2.6.17.17.1 General
Properties
Full Name Variance
Short Name Vrnc
Description Calculates the empirical variance of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = Vrnc
(
Value NoP = 2,
);
Symbol
2.6.17.17.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose empirical variance shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 673 / 866
NoP
Short Name NoP
Description determines number of points which shall be used for the empirical variance calculation
Direction input
Class parameter
Default Value 2
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.17.17.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the empirical variance calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 674 / 866
Analyzing Model
Vrnc 01 Online Calculates the empirical variance values of a generated signal.
Vrnc 02 Offline Calculates the empirical variance values of an offline signal.
Analyzing Script
Vrnc 01 Online Calculates the empirical variance values of a generated signal.
Vrnc 02 Offline Calculates the empirical variance values of an offline signal.
English
Release 2018-06 675 / 866
2.6.17.18 VrncN() – VarianceN()
2.6.17.18.1 General
Properties
Full Name VarianceN
Short Name VrncN
Description Calculates the variance of the input data or values.
Parent Library Base
Function Prototype
DataOrValue Out0 = VrncN
(
Value NoP = 1,
);
Symbol
2.6.17.18.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values whose variance shall be calculated
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 676 / 866
NoP
Short Name NoP
Description determines number of points which shall be used for the variance calculation
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.17.18.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the result of the variance calculation
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 677 / 866
Analyzing Model
VrncN 01 Online Calculates the variance values of a generated signal.
VrncN 02 Offline Calculates the variance values of an offline signal.
Analyzing Script
VrncN 01 Online Calculates the variance values of a generated signal.
VrncN 02 Offline Calculates the variance values of an offline signal.
English
Release 2018-06 678 / 866
2.6.18 String
2.6.18.1 CatStr() - ConcatenateString()
2.6.18.1.1 General
Properties
Full Name ConcatenateString
Short Name CatStr
Description Concatenates the input strings.
Parent Library Base
Parent Category String
Function Prototype
DataOrValue Out0 = CatStr
(
);
Symbol
2.6.18.1.2 Inputs
In0 … In7
Description data or values which shall be concatenated
Direction input
Class data
Unit n/a
Configurable 1…8
Allowed manual Inputs string with 0 or more characters
argument
English
Release 2018-06 679 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.18.1.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the concatenated string
Direction output
Class data
Unit n/a
Configurable 1
Remark none
2.6.18.1.4 Examples
Analyzing Model
CatStr 01 Online Outputs a string which contains the current time in seconds.
CatStr 02 Offline Outputs a string which contains the value of the input data.
Analyzing Script
CatStr 01 Online Outputs a string which contains the current time in seconds.
CatStr 02 Offline Outputs a string which contains the value of the input data.
English
Release 2018-06 680 / 866
2.6.18.2 CpySubStr() - CopySubString()
2.6.18.2.1 General
Properties
Full Name CopySubString
Short Name CpySubStr
Description Copies the specified sub-string from the specified string.
Parent Library Base
Function Prototype
DataOrValue Out0 = CpySubStr
(
DataOrValue Str = “”,
DataOrValue StrtIdx = 0,
DataOrValue Lngth = 1,
);
Symbol
2.6.18.2.2 Inputs
Str
Full Name String
Short Name Str
Description string from which a sub-string shall be extracted
Direction input
Class data
Unit n/a
Configurable 1
Allowed manual Inputs string with at least 1 character
Remark in case the provided string is empty, Out0 is set to “”
English
Release 2018-06 681 / 866
StrtIdx
Full Name StartIndex
Short Name StrtIdx
Description index at which the to-be-copied sub-string starts
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Allowed manual Inputs 0 … length of the specified string -1
Remark in case the start index is after the end of the specified string, Out0 is set to “”
Lngth
Full Name Length
Short Name Lngth
Description length of the to-be-copied sub-string
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Allowed manual Inputs 1 … length of the specified string -StrtIdx
Remark in case the specified string ends before the specified length is reached, only the available charac-
ters are copied to Out0
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 682 / 866
2.6.18.2.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the copied sub-string
Direction output
Class data
Unit n/a
Configurable 1
Remark none
2.6.18.2.4 Examples
Analyzing Model
CpySubStr 01 Online Outputs a string which runs a countdown.
CpySubStr 02 Offline Outputs a string which contains only the digits of the input data which are before the decimal
dot.
Analyzing Script
CpySubStr 01 Online Outputs a string which runs a countdown.
CpySubStr 02 Offline Outputs a string which contains only the digits of the input data which are before the decimal
dot.
English
Release 2018-06 683 / 866
2.6.18.3 FndStr() - FindString()
2.6.18.3.1 General
Properties
Full Name FindString
Short Name FndStr
Description Returns the first occurrence of the specified sub-string within the specified string.
Parent Library Base
Function Prototype
DataOrValue Out0 = FndStr
(
DataOrValue Str = “”,
DataOrValue SubStr = “”,
DataOrValue StrtIdx = 0,
Value CsSnstv = true,
);
Symbol
2.6.18.3.2 Inputs
Str
Full Name String
Short Name Str
Description data or value with the string that shall be searched
Direction input
Class data
Unit n/a
Configurable 1
Remark in case the provided string is empty, Out0 is set to -1
English
Release 2018-06 684 / 866
SubStr
Full Name SubString
Short Name SubStr
Description data or value with the sub-string that shall be searched for
Direction input
Class data
Unit n/a
Configurable 1
Remark in case the provided string is empty, Out0 is set to -1
StrtIdx
Full Name StartIndex
Short Name StrtIdx
Description index within the to-be-searched string at which the search shall start
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Allowed manual Inputs 0 … length of the specified string -1
Remark in case the start index is after the end of the to-be-searched string, Out0 is set to -1
CsSnstv
Full Name CaseSensitive
Short Name CsSnstv
Description specifies whether the comparison shall be case-sensitive or not
Direction input
Class parameter
Default Value true
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 685 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.18.3.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the index within the to-be-searched string at which the specified sub-string starts
Direction output
Class data
Unit n/a
Configurable 1
Remark -1 is returned in case the specified sub-string has not been found within the to-be-searched string
2.6.18.3.4 Examples
Analyzing Model
FndStr 01 Online Outputs the index of the to-be-searched string at which the digit “3” occurs the first time.
FndStr 02 Offline Outputs the position of the decimal point of the input data.
Analyzing Script
FndStr 01 Online Outputs the index of the to-be-searched string at which the digit “3” occurs the first time.
FndStr 02 Offline Outputs the position of the decimal point of the input data.
English
Release 2018-06 686 / 866
2.6.18.4 FrmtStr() - FormatString()
2.6.18.4.1 General
Properties
Full Name FormatString
Short Name FrmtStr
Description Produces string using parameterized format text-string.
Parent Library Base
Function Prototype
DataOrValue Out0 = FrmtStr
(
Value Format = “”,
);
Symbol
2.6.18.4.2 Inputs
Format
Full Name Format
Short Name Format
Description template format for the outputted string
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string contained format which shall be used for the text-string parameterization
Remark none
English
Release 2018-06 687 / 866
In0 … In7
Description data or values used as parameters for Format pattern
Direction input
Class data
Unit n/a
Configurable 1…8
Allowed manual Inputs string contained parameters for the text-string parameterization
argument
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.18.4.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the formatted text-string
Direction output
Class data
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 688 / 866
2.6.18.4.4 Examples
Analyzing Model
FrmtStr 01 Online Outputs a string which contains the current time in seconds.
FrmtStr 02 Offline Outputs a string which contains the value of the input data.
Analyzing Script
FrmtStr 01 Online Outputs a string which contains the current time in seconds.
FrmtStr 02 Offline Outputs a string which contains the value of the input data.
English
Release 2018-06 689 / 866
2.6.18.5 GetStrLen() - GetStringLength()
2.6.18.5.1 General
Properties
Full Name GetStringLength
Short Name GetStrLen
Description Returns the length of the specified string.
Parent Library Base
Function Prototype
DataOrValue Out0 = GetStrLen
(
DataOrValue In0 = “”,
);
Symbol
2.6.18.5.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or value whose string length shall be returned
Direction input
Class data
Unit n/a
Configurable 1
Allowed manual Inputs string with 0 or more characters
Remark in case the provided string is empty, Out0 is set to 0
English
Release 2018-06 690 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.18.5.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the length of the specified string
Direction output
Class data
Unit n/a
Configurable 1
Remark 0
2.6.18.5.4 Examples
Analyzing Model
GetStrLen 01 Online Outputs the length of a random number.
GetStrLen 02 Offline Outputs the length of the number of the input data.
Analyzing Script
GetStrLen 01 Online Outputs the length of a random number.
GetStrLen 02 Offline Outputs the length of the number of the input data.
English
Release 2018-06 691 / 866
2.6.19 System
2.6.19.1 ExprtData() - ExportData()
2.6.19.1.1 General
Properties
Full Name ExportData
Short Name ExprtData
Description Exports the specified offline data to the file system.
Parent Library Base
Parent Category System
Function Prototype
DataOrValue Status = ExportData
(
Value DataName = “”,
Value ExprtPath = “”,
Value FlCrtnMd = “One Export File per offline Data”,
Value TSFrmt = “ns”,
Value DecPrcsn= “Automatic”,
Value ExprtMd = “Each Value”,
Value ExprtPrm = “Hysteresis = 0.000; Interval = 1000000000”,
Value TmIptMd = “None”,
Value MinTm = 1,
Value TmInt = 1,
Value MaxTm = 1,
Value DataCtgry = “”,
);
Symbol
N/A
2.6.19.1.2 Inputs
DataName
Full Name DataName
Short Name DataName
Description name of the offline data which shall be exported
Direction input
Class parameter
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 692 / 866
ExprtPath
Full Name ExportPath
Short Name ExprtPath
Description full symbolic path to the directory which shall receive the exported files
the format of the directory is “Location Name://[Directory/]”, e.g. “Example Offline Da-
ta://Rectangle”
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the symbolic path
Remark the specified symbolic location name must point to an offline data location of type “.csv”
FlCrtnMd
Full Name FileCreationMode
Short Name FlCrtnMd
Description specifies whether the export shall create one or multiple files
Direction input
Class parameter
Default Value “One Export File per offline Data”
Unit n/a
Configurable 1
Allowed manual Inputs “One Export File per offline Data”, “One Export File per Probe”
Remark One Export File per offline Data = all probes (= pairs of timestamp + value) of the offline data are
exported to a single file
One Export File per Probe = each probe of the offline data is exported to a separate file
TSFrmt
Full Name TimestampFormat
Short Name TSFrmt
Description format of the timestamps within the exported file
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs “ns”, “Date+Time+ns (GMT)”, “Data+Time+ns (Local Time)”
Remark none
English
Release 2018-06 693 / 866
DcmlPrcsn
Full Name DecimalPrecision
Short Name DcmlPrcsn
Description number of digits after the decimal separator within the exported file
Direction input
Class parameter
Default Value “Automatic”
Unit 1
Configurable 1
Allowed manual Inputs “Automatic”, “0”, “3”, “6”, “9”, “12”
Remark none
ExprtMd
Full Name ExportMode
Short Name ExprtMd
Description export mode which shall be used
Direction input
Class parameter
Default Value “Each Value”
Unit n/a
Configurable 1
Allowed manual Inputs “Each Value”, “Changes only”, “Changes and Interval”, “Interval only”
Remark Each Value = all values of the offline data are being exported
Changes only = a value from the offline data is exported only in case it differs more than the speci-
fied hysteresis to the last value which has been exported to the file
Changes and Interval = a value from the offline data is exported in case it differs more than the
specified hysteresis to the last value which has been exported to the file and the last known value
from the offline data is exported to the each defined time interval
Interval only = the last known value from the offline data is exported to the file each defined time
interval
ExprtPrm
Full Name ExportParameters
Short Name ExprtPrm
Description export parameters which shall be used
Direction input
Class parameter
Default Value “Hysteresis = 0.000; Interval = 1.000”
Unit n/a
Configurable 1
Allowed manual Inputs standard input behavior of export parameters edit boxes
Remark see the examples below for information about how to configure the available export parameters
English
Release 2018-06 694 / 866
TmInptMd
Full Name TimeInputMode
Short Name TmInptMd
Description specifies which time input mode shall be used
Direction input
Class parameter
Default Value “None”
Unit n/a
Configurable 1
Allowed manual Inputs “None”, “Minimum Time and Time Interval”, “Minimum Time and Maximum Time”, “Time Interval
and Maximum Time”
Remark None = the whole period of time of the specified offline data is exported
Minimum Time and Time Interval = the specified MinimumTime and TimeInterval parameters are
used in order to determine the period of time which shall be exported
Minimum Time and Maximum Time = the specified MinimumTime and MaximumTime parameters
are used in order to determine the period of time which shall be exported
Time Interval and Maximum Time = the specified TimeInterval and MaximumTime parameters are
used in order to determine the period of time which shall be exported
MinTm
Full Name MinimumTime
Short Name MinTm
Description specifies the point in time from which on the offline data values shall be exported
Direction input
Class data
Default Value 1
Unit s
Configurable 1
Remark this parameter is ignored in case TimeInputMode is “None” or “Time Interval and Maximum Time”
in case the offline data bases on absolute timestamps, a MinimumTime of 0 points to 1970-01-01
00:00:00 and MinimumTime is in local time
English
Release 2018-06 695 / 866
TmInt
Short Name TmInt
Description specifies the time interval which shall be exported
Direction input
Class data
Default Value 1
Unit s
Configurable 1
Remark this parameter is ignored in case TimeInputMode is “None” or “Minimum Time and Maximum
Time”
MaxTm
Full Name MaximumTime
Short Name MxTm
Description specifies the point in time until which the offline data values shall be exported
Direction input
Class data
Default Value 1
Unit s
Configurable 1
Remark this parameter is ignored in case TimeInputMode is “None” or “Minimum Time and Time Interval”
in case the offline data bases on absolute timestamps, a MaximumTime of 0 points to 1970-01-01
00:00:00 and MaximumTime is in local time
DataCtgry
Full Name DataCategory
Short Name DataCtgry
Description data category which shall be set for the exported data
Direction input
Class data
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the category which shall be set for the exported data
Remark a backslash (“\”) or slash (“/”) can be used in order to specify sub-categories
examples:
 Some Category
in case an empty string is passed as data category, the default category of each data is used for
the export
English
Release 2018-06 696 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.1.3 Outputs
Status
Full Name Status
Short Name Status
Description receives the status of the offline data export
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark = -1 in case no export file could be created
> 0 in case at least one export file has been created (the returned number matches the amount of
export files which have been created)
2.6.19.1.4 Examples
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function ExportData().
Analyzing Script
ExprtData 02 Offline Exports offline data with different settings.
English
Release 2018-06 697 / 866
2.6.19.2 GetCalcTm() - GetCalculationTime()
2.6.19.2.1 General
Properties
Full Name GetCalculationTime
Short Name GetCalcTm
Description Returns the current calculation time.
Parent Library Base
Function Prototype
DataOrValue CalcTm = GetCalcTm
(
);
Symbol
2.6.19.2.2 Inputs
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 698 / 866
2.6.19.2.3 Outputs
CalcTm
Full Name CalculationTime
Short Name CalcTm
Description receives the current calculation time of the parent Analyzing Model or Analyzing Script
Direction output
Class data
Default Value 0
Unit ns
Configurable 1
Remark in case the parent Analyzing Model/Analyzing Script outputs absolute timestamps, the calculation
time is in ns since 1970-01-01 00:00:00.000.000.000 GMT
in case the parent Analyzing Model/Analyzing Script outputs relative timestamps, the calculation
time is in ns since 00000 00:00:00.000.000.000
2.6.19.2.4 Examples
Analyzing Model
GetCalcTm 01 Online Determines the calculation time during an online data calculation.
GetCalcTm 02 Offline Determines the calculation time during an offline data calculation.
Analyzing Script
GetCalcTm 01 Online Determines the calculation time during an online data calculation.
GetCalcTm 02 Offline Determines the calculation time during an offline data calculation.
English
Release 2018-06 699 / 866
2.6.19.3 GetEvnt() - GetEvent()
2.6.19.3.1 General
Properties
Full Name GetEvent
Short Name GetEvnt
Description Returns one event of the specified data.
Parent Library Base
Function Prototype
Value EvntScp = GetEvnt
(
Value Idx = “-1”,
Value EvntTyp = NULL,
Value EvntTmStmp = NULL
);
Symbol
N/A
2.6.19.3.2 Inputs
Name
Full Name Name
Short Name Name
Description name of the online or offline data whose event shall be determined, e.g. “~’OnlineData_1”, “$’Of-
flineData_1’”, “OfflineData_1” or OfflineDataName
Direction input
Class parameter
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 700 / 866
Type
Full Name Type
Short Name Type
Direction input
Class parameter
Unit n/a
Configurable 1
Idx
Full Name Index
Short Name Idx
Description specifies which event information shall be returned
Direction input
Class parameter
Default Value -1
Unit 1
Configurable 1
Allowed manual Inputs -1 … max of Integer32
Remark in case -1 is provided as index, the information about the most recent (= newest) event of the data
is returned
in case the provided index is bigger than the number of events of the data, the information about
the most recent (= newest) event of the data is returned
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 701 / 866
2.6.19.3.3 Outputs
EvntScp
Full Name EventScope
Short Name EvntScp
Description receives the scope of the event
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark the following event scope values are defined:
 1 start
 2 stop
 3 singleton
2.6.19.3.4 Examples
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function GetEvent().
Analyzing Script
GetEvnt 02 Offline Returns information about all events of an offline data.
English
Release 2018-06 702 / 866
2.6.19.4 GetEvntCd() - GetEventCode()
2.6.19.4.1 General
Properties
Full Name GetEventCode
Short Name GetEvntCd
Description Reads the event code of a link or var.
Function Prototype
DataOrValue Out0 = GetEvntCd
(
);
Symbol
2.6.19.4.2 Inputs
In0
Full Name Input0
Short Name In0
Description link or var whose event code shall be determined
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Supported Data Types Boolean, Integer8, Integer16, Integer32, Integer64, Decimal32, Decimal64, String, 1-dimensional
buffer, 2-dimensional buffer, orbit, spectrum, spectrum envelope, 2-dimensional vector
Remark none
English
Release 2018-06 703 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.4.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the current event code of the specified link or var
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark the following event code values are defined:
 -2 unknown
 -1 not initialized
 0 value available period
 1 value available start
 2 value available stop
 3 value available singleton
 4 value not available
the status and event code of In0 is not relevant for Out0 – thus, Out0 delivers its value with a sta-
tus code of “value is valid” and an event code of “value available period” even in case the status
and/or event code of In0 are worse
English
Release 2018-06 704 / 866
2.6.19.4.4 Examples
Analyzing Model
GetEvntCd 01 Online This Analyzing Model provokes a division by zero in cyclic intervals and outputs the event
code of the affected data (“value not available” or “value available period”).
GetEvntCd 02 Offline This Analyzing Model provokes a division by zero in cyclic intervals and outputs the event
Analyzing Script
GetEvntCd 01 Online This Analyzing Model provokes a division by zero in cyclic intervals and outputs the event
GetEvntCd 02 Offline This Analyzing Model provokes a division by zero in cyclic intervals and outputs the event
English
Release 2018-06 705 / 866
2.6.19.5 GetHBT() - GetHeartBeatTime()
2.6.19.5.1 General
Properties
Full Name GetHeartBeatTime
Short Name GetHBT
Description Returns the current heart beat time.
Parent Library Base
Function Prototype
DataOrValue Text = GetHBT
(
DataOrValue* ns = NULL,
DataOrValue* s = NULL
);
Symbol
2.6.19.5.2 Inputs
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 706 / 866
2.6.19.5.3 Outputs
Text
Full Name Text
Short Name Text
Description receives the current heart beat time of the parent Analyzing Model or Analyzing Script as text
Direction output
Class data
Default Value 0
Unit ns
Configurable 1
Remark in case the parent Analyzing Model/Analyzing Script outputs absolute timestamps, the heart beat
in case the parent Analyzing Model/Analyzing Script outputs relative timestamps, the heart beat
ns
Full Name NanoSeconds
Short Name ns
Description receives the current heart beat time of the parent Analyzing Model or Analyzing Script in nano
seconds (since 1970-01-01 GMT or since 0)
Direction output
Class data
Default Value 0
Unit ns
Configurable 1
English
Release 2018-06 707 / 866
s
Full Name Seconds
Short Name s
Description receives the current heart beat time of the parent Analyzing Model or Analyzing Script in seconds
(since 1970-01-01 GMT or since 0)
Direction output
Class data
Default Value 0
Unit ns
Configurable 1
2.6.19.5.4 Examples
Analyzing Model
GetHBT 01 Online Determines the heart beat time during an online data calculation.
GetHBT 02 Offline Determines the heart beat time during an offline data calculation.
Analyzing Script
GetHBT 01 Online Determines the heart beat time during an online data calculation.
GetHBT 02 Offline Determines the heart beat time during an offline data calculation.
English
Release 2018-06 708 / 866
2.6.19.6 GetHBTDlt() - GetHeartBeatTimeDelta()
2.6.19.6.1 General
Properties
Full Name GetHeartBeatTimeDelta
Short Name GetHBTDlt
Description Returns the difference between the current heart beat time and the previous heart beat time.
Parent Library Base
Function Prototype
DataOrValue Text = GetHBTDlt
(
DataOrValue* ns = NULL,
DataOrValue* s = NULL
);
Symbol
2.6.19.6.2 Inputs
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 709 / 866
2.6.19.6.3 Outputs
Text
Full Name Text
Short Name Text
Description receives the difference between the current heart beat time and the previous heart beat time as
text
Direction output
Class data
Default Value 0
Unit ns
Configurable 1
Remark none
ns
Full Name NanoSeconds
Short Name ns
Description receives the difference between the current heart beat time and the previous heart beat time in
nano seconds
Direction output
Class data
Default Value 0
Unit ns
Configurable 1
Remark none
s
Full Name Seconds
Short Name s
Description receives the difference between the current heart beat time and the previous heart beat time in
seconds
Direction output
Class data
Default Value 0
Unit ns
Configurable 1
Remark none
English
Release 2018-06 710 / 866
2.6.19.6.4 Examples
Analyzing Model
GetHBTDlt 01 Online Determines the difference between two successive heart beat times during an online data
calculation.
GetHBTDlt 02 Offline Determines the difference between two successive heart beat times during an offline data
calculation.
Analyzing Script
GetHBTDlt 01 Online Determines the difference between two successive heart beat times during an online data
calculation.
GetHBTDlt 02 Offline Determines the difference between two successive heart beat times during an offline data
calculation.
English
Release 2018-06 711 / 866
2.6.19.7 GetLclDate() - GetLocalDate()
2.6.19.7.1 General
Properties
Full Name GetLocalDate
Short Name GetLclDate
Description Returns the date in local system time.
Parent Library Base
Function Prototype
DataOrValue Year = GetLclDate
(
DataOrValue* Month = NULL,
DataOrValue* Day = NULL,
DataOrValue* Hour = NULL,
DataOrValue* Minute = NULL,
DataOrValue* Second = NULL
);
Symbol
2.6.19.7.2 Inputs
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 712 / 866
2.6.19.7.3 Outputs
Year
Full Name Year
Short Name Year
Description receives the current year
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
Month
Full Name Month
Short Name Month
Description receives the current month
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
Day
Full Name Day
Short Name Day
Description receives the current day
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 713 / 866
Hour
Full Name Hour
Short Name Hour
Description receives the current hour
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
Minute
Full Name Minute
Short Name Minute
Description receives the current minute
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
Second
Full Name Second
Short Name Second
Description receives the current second
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 714 / 866
2.6.19.7.4 Examples
Analyzing Model
GetLclDate 01 Online Determines the current date and time.
Analyzing Script
GetLclDate 01 Online Determines the current date and time.
English
Release 2018-06 715 / 866
2.6.19.8 GetLctnPath() - GetLocationPath()
2.6.19.8.1 General
Properties
Full Name GetLocationPath
Short Name GetLctnPath
Description Shows the path to the specified location.
Parent Library Base
Function Prototype
DataOrValue Path = GetLctnPath
(
Value Lctn = “”,
);
Symbol
2.6.19.8.2 Inputs
Lctn
Full Name Location
Short Name Lctn
Description name of the location whose path shall be returned
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the symbolic name of the location whose absolute path shall be returned
Remark none
English
Release 2018-06 716 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.8.3 Outputs
Path
Full Name Path
Short Name Path
Description receives the absolute path of the specified location
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark an empty string is returned in case the specified location does not exist
2.6.19.8.4 Examples
Analyzing Model
GetLctnPath 01 Online Outputs the absolute path to the “Default Location” once each five seconds.
Analyzing Script
GetLctnPath 02 Offline Outputs the absolute path of the “Default Location” once.
English
Release 2018-06 717 / 866
2.6.19.9 GetLogStat() - GetSystemLogStatistics()
2.6.19.9.1 General
Properties
Full Name GetSystemLogStatistics
Short Name GetLogStat
Description Returns the current statistics about system log entries of the X-Tools Server.
Parent Library Base
Function Prototype
DataOrValue TtlEntrs = GetLogStat
(
DataOrValue* InfoEntrs = NULL,
DataOrValue* WrngEntrs = NULL,
DataOrValue* ErrEntrs = NULL,
DataOrValue* FtlEntrs = NULL,
DataOrValue* SysEntrs = NULL
);
Symbol
2.6.19.9.2 Inputs
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 718 / 866
2.6.19.9.3 Outputs
TtlEntrs
Full Name TotalEntries
Short Name TtlEntrs
Description receives the total number of entries which have been added to the system log since the startup of
the X-Tools Server
Direction output
Class data
Default Value 0
Unit s
Configurable 1
Remark none
InfoEntrs
Full Name InformationEntries
Short Name InfoEntrs
Description receives the number of entries of priority “Information” which have been added to the system log
since the startup of the X-Tools Server
Direction output
Class data
Default Value 0
Unit s
Configurable 1
Remark none
WrngEntrs
Full Name WarningEntries
Short Name WrngEntrs
Description receives the number of entries of priority “Warning” which have been added to the system log
since the startup of the X-Tools Server
Direction output
Class data
Default Value 0
Unit s
Configurable 1
Remark none
English
Release 2018-06 719 / 866
ErrEntrs
Full Name ErrorEntries
Short Name ErrEntrs
Description receives the number of entries of priority “Error” which have been added to the system log since
the startup of the X-Tools Server
Direction output
Class data
Default Value 0
Unit s
Configurable 1
Remark none
FtlEntrs
Full Name FatalEntries
Short Name FtlEntrs
Description receives the number of entries of priority “Fatal” which have been added to the system log since
Direction output
Class data
Default Value 0
Unit s
Configurable 1
Remark none
SysEntrs
Full Name SystemEntries
Short Name SysEntrs
Description receives the number of entries of priority “System” which have been added to the system log since
Direction output
Class data
Default Value 0
Unit s
Configurable 1
Remark none
English
Release 2018-06 720 / 866
2.6.19.9.4 Examples
Analyzing Model
GetLogStat 01 Online Returns the number of log entries since the startup of the X-Tools Server.
Analyzing Script
GetLogStat 01 Online Returns the number of log entries since the startup of the X-Tools Server.
English
Release 2018-06 721 / 866
2.6.19.10 GetNoE() - GetNumberOfEvents()
2.6.19.10.1 General
Properties
Full Name GetNumberOfEvents
Short Name GetNoE
Description Returns the number of events of the specified data.
Parent Library Base
Function Prototype
Value NoE = GetNoE
(
);
Symbol
N/A
2.6.19.10.2 Inputs
Name
Full Name Name
Short Name Name
Description name of the online or offline data whose number of events shall be determined, e.g.
“~’OnlineData_1”, “$’OfflineData_1’”, “OfflineData_1” or OfflineDataName
Direction input
Class parameter
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 722 / 866
Type
Full Name Type
Short Name Type
Direction input
Class parameter
Unit n/a
Configurable 1
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.10.3 Outputs
NoE
Full Name NumberOfEvents
Short Name NoE
Description receives the number of events of the offline data
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 723 / 866
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function GetNumberOfEvents().
Analyzing Script
GetNoE 02 Offline Determines the number of events of an offline data.
English
Release 2018-06 724 / 866
2.6.19.11 GetNoV() - GetNumberOfValues()
2.6.19.11.1 General
Properties
Full Name GetNumberOfValues
Short Name GetNoV
Description Returns the number of values of the specified offline data.
Parent Library Base
Function Prototype
Value NoV = GetNoV
(
);
Symbol
N/A
2.6.19.11.2 Inputs
Name
Full Name Name
Short Name Name
Description name of the offline data whose number of values shall be determined, e.g. “$’OfflineData_1’”,
“OfflineData_1” or OfflineDataName
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the data as offline data identifier, string or variable
Remark none
English
Release 2018-06 725 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.11.3 Outputs
NoV
Full Name NumberOfValues
Short Name NoV
Description receives the number of values of the offline data
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark the returned number of values is the number of values of the offline data which also can be seen
within the MDS Explorer
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function GetNumberOfValues().
Analyzing Script
GetNoV 02 Offline Determines the number of values of an offline data.
English
Release 2018-06 726 / 866
2.6.19.12 GetSrvStts() - GetServerStatus()
2.6.19.12.1 General
Properties
Full Name GetServerStatus
Short Name GetSrvStts
Description Reads the status of the X-Tools Server.
Parent Library Base
Function Prototype
DataOrValue Clnts = GetSrvStts
(
DataOrValue* IPFsRng = NULL,
DataOrValue* IPFsSpnd = NULL,
DataOrValue* DPFsRng = NULL,
DataOrValue* DPFsSpnd = NULL,
DataOrValue* MVFsRng = NULL,
DataOrValue* MVFsSpnd = NULL,
DataOrValue* AMFsRng = NULL,
DataOrValue* AMFsSpnd = NULL,
DataOrValue* ASFsRng = NULL,
DataOrValue* ASFsSpnd = NULL,
DataOrValue* SPFsRng = NULL,
DataOrValue* SPFsSpnd = NULL
);
Symbol
English
Release 2018-06 727 / 866
2.6.19.12.2 Inputs
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.12.3 Outputs
Clnts
Full Name Clients
Short Name Clnts
Description receives the number of currently connected clients
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
IPFsRng
Full Name IPFsRunning
Short Name IPFsRng
Description receives the number of Interface Profiles which are currently running
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 728 / 866
IPFsSpnd
Full Name IPFsSuspended
Short Name IPFsSpnd
Description receives the number of Interface Profiles which are currently suspended
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
DPFsRng
Full Name DPFsRunning
Short Name DPFsRng
Description receives the number of Device Profiles which are currently running
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
DPFsSpnd
Full Name DPFsSuspended
Short Name DPFsSpnd
Description receives the number of Device Profiles which are currently suspended
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 729 / 866
MVFsRng
Full Name MVFsRunning
Short Name MVFsRng
Description receives the number of Monitoring Views which are currently running
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
MVFsSpnd
Full Name MVFsSuspended
Short Name MVFsSpnd
Description receives the number of Monitoring Views which are currently suspended
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
AMFsRng
Full Name AMFsRunning
Short Name AMFsRng
Description receives the number of Analyzing Models which are currently running
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 730 / 866
AMFsSpnd
Full Name AMFsSuspended
Short Name AMFsSpnd
Description receives the number of Analyzing Models which are currently suspended
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
ASFsRng
Full Name ASFsRunning
Short Name ASFsRng
Description receives the number of Analyzing Scripts which are currently running
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
ASFsSpnd
Full Name ASFsSuspended
Short Name ASFsSpnd
Description receives the number of Analyzing Scripts which are currently suspended
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 731 / 866
SPFsRng
Full Name SPFsRunning
Short Name SPFsRng
Description receives the number of Storage Profiles which are currently running
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
SPFsSpnd
Full Name SPFsSuspended
Short Name SPFsSpnd
Description receives the number of Storage Profiles which are currently suspended
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
Analyzing Model
GetSrvStts 01 Online Determines the currently started and the currently suspended Configuration Files.
Analyzing Script
GetSrvStts 01 Online Determines the currently started and the currently suspended Configuration Files.
English
Release 2018-06 732 / 866
2.6.19.13 GetStpTm() - GetStopTime()
2.6.19.13.1 General
Properties
Full Name GetStopTime
Short Name GetStpTm
Description Returns the stop time of the specified offline data.
Parent Library Base
Function Prototype
DataOrValue StpTm = GetStpTm
(
);
Symbol
N/A
2.6.19.13.2 Inputs
Name
Full Name Name
Short Name Name
Description name of the offline data whose stop time shall be determined, e.g. “$’OfflineData_1’”, “OfflineDa-
ta_1” or OfflineDataName
Direction input
Class parameter
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 733 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.13.3 Outputs
StrtTm
Full Name StopTime
Short Name StpTm
Description receives the stop time of the offline data
Direction output
Class data
Default Value 0
Unit s
Configurable 1
Remark the returned stop time is the stop time of the offline data which also can be seen within the MDS
Explorer
in case the input data uses absolute timestamps, the stop time is in seconds since 1970-01-01
00:00:00 GMT
in case the input data uses relative timestamps, the stop time is in seconds since 0
the resolution of the returned value is in ms (the original stop time is rounded to three digits after
the comma)
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function GetStopTime().
Analyzing Script
GetStpTm 02 Offline Determines the stop time of an offline data.
English
Release 2018-06 734 / 866
2.6.19.14 GetStrtTm() - GetStartTime()
2.6.19.14.1 General
Properties
Full Name GetStartTime
Short Name GetStrtTm
Description Returns the start time of the specified offline data.
Parent Library Base
Function Prototype
DataOrValue StrtTm = GetStrtTm
(
);
Symbol
N/A
2.6.19.14.2 Inputs
Name
Full Name Name
Short Name Name
Description name of the offline data whose start time shall be determined, e.g. “$’OfflineData_1’”, “OfflineDa-
ta_1” or OfflineDataName
Direction input
Class parameter
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 735 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.14.3 Outputs
StrtTm
Full Name StartTime
Short Name StrtTm
Description receives the start time of the offline data
Direction output
Class data
Default Value 0
Unit s
Configurable 1
Remark the returned start time is the start time of the offline data which also can be seen within the MDS
Explorer
in case the input data uses absolute timestamps, the start time is in seconds since 1970-01-01
00:00:00 GMT
in case the input data uses relative timestamps, the start time is in seconds since 0
the resolution of the returned value is in ms (the original start time is rounded to three digits after
the comma)
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function GetStartTime().
Analyzing Script
GetStrtTm 02 Offline Determines the start time of an offline data.
English
Release 2018-06 736 / 866
2.6.19.15 GetSttsCd() - GetStatusCode()
2.6.19.15.1 General
Properties
Full Name GetStatusCode
Short Name GetSttsCd
Description Reads the status code of a link or var.
Function Prototype
DataOrValue Out0 = GetSttsCd
(
);
Symbol
2.6.19.15.2 Inputs
In0
Full Name Input0
Short Name In0
Description link or var whose status code shall be determined
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Supported Data Types Boolean, Integer8, Integer16, Integer32, Integer64, Decimal32, Decimal64, String, 1-dimensional
buffer, 2-dimensional buffer, orbit, spectrum, spectrum envelope, 2-dimensional vector
Remark none
English
Release 2018-06 737 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.15.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the current status code of the specified link or var
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark the following status code values are defined:
 -2 unknown
 0 value is valid
 1 overflow
 2 underflow
 3 loss of accuracy
 4 division by zero
 5 infinite result
 6 undefined result
 7 input out of range
 8 result not available
 9 input not available
 10 function specific error
 12 disabled
the status and event code of In0 is not relevant for Out0 – thus, Out0 delivers its value with a sta-
tus code of “value is valid” and an event code of “value available period” even in case the status
and/or event code of In0 are worse
English
Release 2018-06 738 / 866
Analyzing Model
GetSttsCd 01 Online This Analyzing Model provokes a division by zero in cyclic intervals and outputs the status
code of the affected data (“divison by zero” or “data is valid”).
GetSttsCd 02 Offline This Analyzing Model provokes a division by zero in cyclic intervals and outputs the status
Analyzing Script
GetSttsCd 01 Online This Analyzing Script provokes a division by zero in cyclic intervals and outputs the status
GetSttsCd 02 Offline This Analyzing Script provokes a division by zero in cyclic intervals and outputs the status

The example measurement tasks are part of the “Introduction” document and provide a chapter “Data Analysis
with Gaps” which shows in detail how to use the Analyzing Function GetSttsCd() for the detection and handling
of gaps within the to-be-processed offline data.
for the example about data anylsis with gaps are found within the “15” folders of their according explorer trees
English
Release 2018-06 739 / 866
2.6.19.16 GetTime() - GetTime()
2.6.19.16.1 General
Properties
Full Name GetTime
Short Name GetTime
Description Returns the total number of seconds which have elapsed since 1970-01-01.
Parent Library Base
Function Prototype
DataOrValue Out0 = GetTime
(
);
Symbol
2.6.19.16.2 Inputs
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 740 / 866
2.6.19.16.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the amount of seconds which have elapsed since 1970-01-01 for the GMT time zone
Direction output
Class data
Default Value 0
Unit s
Configurable 1
Remark the resolution of the returned value is in ms (three digits after the comma)
Analyzing Model
GetTime 01 Online Calculates the number of elapsed seconds for the current time.
Analyzing Script
GetTime 01 Online Calculates the number of elapsed seconds for the current time.
English
Release 2018-06 741 / 866
2.6.19.17 IsPrcsBsy() - IsProcessBusy()
2.6.19.17.1 General
Properties
Full Name IsProcessBusy
Short Name IsPrcsBsy
Description Checks whether the specified process is busy.
Parent Library Base
Function Prototype
DataOrValue Status = IsPrcsBsy
(
Value Process = “”,
);
Symbol
2.6.19.17.2 Inputs
Process
Full Name Process
Short Name Process
Description specifies the name of the process which shall be monitored
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the file name of a process
Remark the file extension (e.g. “.exe”) must be provided together with the actual file name
English
Release 2018-06 742 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.17.3 Outputs
Status
Full Name Status
Short Name Status
Description indicates whether the specified process is busy or not
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark Status = true in case the specified process is busy, otherwise Status = false
Analyzing Model
IsPrcsBsy 01 Online Monitors whether the X-Tools Client is busy or not.
Analyzing Script
IsPrcsBsy 01 Online Monitors whether the X-Tools Client is busy or not.
English
Release 2018-06 743 / 866
2.6.19.18 IsPrcsPrsnt() - IsProcessPresent()
2.6.19.18.1 General
Properties
Full Name IsProcessPresent
Short Name IsPrcsPrsnt
Description Checks whether the specified process is present.
Parent Library Base
Function Prototype
DataOrValue Status = IsPrcsPrsnt
(
Value Process = “”,
);
Symbol
2.6.19.18.2 Inputs
Process
Full Name Process
Short Name Process
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 744 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.18.3 Outputs
Status
Full Name Status
Short Name Status
Description indicates whether the specified process is present or not
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark Status = true in case the specified process is present, otherwise Status = false
Analyzing Model
IsPrcsPrsnt 01 Online Monitors whether the X-Tools Client is present or not.
Analyzing Script
IsPrcsPrsnt 01 Online Monitors whether the X-Tools Client is present or not.
English
Release 2018-06 745 / 866
2.6.19.19 LoadData() - LoadData()
2.6.19.19.1 General
Properties
Full Name LoadData
Short Name LoadData
Description Reads offline data of type “*.sdf.xts”, “*.csv” and “*.dat” from the file system.
Parent Library Base
Function Prototype
DataOrValue Status = LoadData
(
Value Path = “”,
Value DataName = “”,
Value AppndMd = “Append”,
Value LdngPrfl = “”,
Value LdngMd = “Default”,
Value LdngPrm = “Hysteresis = 0.000; Interval = 1000000000”,
Value TmIptMd = “Default”,
Value MinTm = 1,
Value TmInt = 1,
Value MaxTm = 1,
Value DataCtgry = “”,
Value DtNmPrfx = “”,
Value DtNmSffx = “”,
);
Symbol
N/A
English
Release 2018-06 746 / 866
2.6.19.19.2 Inputs
Path
Full Name Path
Short Name Path
Description full symbolic path to a root directory or to a Storage Profile or to an offline data file
the format of a root directory is “Location Name://[Directory/]”, e.g. “Example Offline Da-
ta://Rectangle”
the format of a Storage Profile is “Location Name://[Directory/]FileName.FileExtension”, e.g. “De-
fault Location://Test/Test Profile.spf.xts”
the format of an offline data file is “Location Name://[Directory/]FileName.FileExtension”, e.g. “Ex-
ample Offline Data://Rectangle\Data.sdf.xts”
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the symbolic path
Remark the value of Path is case insensitive
in case a root directory is specified, the Analyzing Function automatically searches for the speci-
fied offline data within the specified directory and all of its sub-directories
in case a Storage Profile is specified and the time input mode is “Load latest Files”, the system
checks whether it knows the latest stored files of this Storage Profile and loads the ones which
match the remaining filter criteria; in case there are no known latest stored files for this Storage
Profile the system determines the root storage location of the specified Storage Profile and per-
forms the rest of the loading operation in the same way as if the user would have provided a direc-
tory path
in case a Storage Profile is specified and the time input mode is not “Load latest Files”, the system
determines the root storage location of the specified Storage Profile and performs the rest of the
loading operation in the same way as if the user would have provided a directory path
DataName
Full Name DataName
Short Name DataName
Description name of the offline data which shall be read
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the data name
Remark the value of DataName is case insensitive
the value of DataName can be left empty - in this case, the Analyzing Function loads all of the
data which matches the rest of the specified filter criteria
English
Release 2018-06 747 / 866
AppndMd
Full Name AppendMode
Short Name AppndMd
Description append mode which shall be used when reading of values from the offline data files
Direction input
Class parameter
Default Value “Append”
Unit n/a
Configurable 1
Allowed manual Inputs “Append”, “Overwrite”
Remark Append = in case an offline data of the same name as the currently loaded one is present within
the MDS Explorer already, the values from the file are added to the existing offline data
Overwrite = an eventually present offline data of the same name as the currently loaded one is
removed from the MDS Explorer and afterwards the values from current offline data file are load-
ed
LdngPrfl
Full Name LoadingProfile
Short Name LdngPrfl
Description full path and name of the Loading Profile which shall be used, in format “Location
Name://[Directory/]Loading Profile Name.Extension”, e.g. “Example Location://ION AnalogInput
T001.lpf.xts”
when the name of the location is not provided (e.g. “://ION AnalogInput T001.lpf.xts”), the location
of the calling Analyzing Program is used
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name and its symbolic path
Remark the value of LoadingProfile is case insensitive
the value of LoadingProfile can be left empty
English
Release 2018-06 748 / 866
LdngMd
Full Name LoadingMode
Short Name LdngMd
Description loading mode which shall be used when reading of values from the offline data files
Direction input
Class parameter
Unit n/a
Configurable 1
Remark Default = the loading mode from the specified Loading Profile is being used; in case there is no
Loading Profile specified, all values of all offline data files are being loaded
Each Value = all values of all offline data files are being loaded
Changes only = a value from an offline data file is loaded only in case it differs more than the
specified hysteresis to the last value which has been written into the offline data buffer
Changes and Interval = a value from an offline data file is loaded in case it differs more than the
specified hysteresis to the last value which has been written into the offline data buffer and the last
known value from the offline data file is written into the offline data buffer each defined time inter-
val
Interval only = the last known value from the offline data file is written into the offline data buffer
each defined time interval
LdngPrm
Full Name LoadingParameters
Short Name LdngPrm
Description loading parameters which shall be used when reading of values from the offline data files
Direction input
Class parameter
Default Value “Hysteresis = 0.000; Interval = 1000000000”
Unit n/a
Configurable 1
Allowed manual Inputs standard input behavior of loading parameters edit boxes
Remark see the examples below for information about how to configure the available loading parameters
English
Release 2018-06 749 / 866
TmInptMd
Full Name TimeInputMode
Short Name TmInptMd
Description specifies which time input mode shall be used
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs “Default”, “Minimum Time and Time Interval”, “Minimum Time and Maximum Time”, “Time Interval
and Maximum Time”, “Load Latest Files”
Remark Default = the time input mode from the specified Loading Profile is being used; in case there is no
Loading Profile specified, all offline data files are being loaded from their beginning until their end
Minimum Time and Time Interval = the specified MinimumTime and TimeInterval parameters are
used in order to determine the period of data which shall be loaded
Minimum Time and Maximum Time = the specified MinimumTime and MaximumTime parameters
are used in order to determine the period of data which shall be loaded
Time Interval and Maximum Time = the specified TimeInterval and MaximumTime parameters are
used in order to determine the period of data which shall be loaded
Load latest Files = the Analyzing Function automatically loads the offline data file(s) from the last
finished file splitting; in case these offline data file(s) are loaded already, the Analyzing Function
does not perform any loading operation and exits
MinTm
Full Name MinimumTime
Short Name MinTm
Description specifies the point in time from which on the offline data values shall be loaded
Direction input
Class data
Default Value 1
Unit s
Configurable 1
Remark this parameter is ignored in case TimeInputMode is “Time Interval and Maximum Time” or “Load
latest Files”
in case the offline data bases on absolute timestamps, a MinimumTime of 0 points to 1970-01-01
00:00:00 and MinimumTime is in local time
English
Release 2018-06 750 / 866
TmInt
Short Name TmInt
Description specifies the time interval which shall be loaded
Direction input
Class data
Default Value 1
Unit s
Configurable 1
Remark this parameter is ignored in case TimeInputMode is “Minimum Time and Maximum Time” or “Load
latest Files”
MaxTm
Full Name MaximumTime
Short Name MaxTm
Description specifies the point in time until which the offline data values shall be loaded
Direction input
Class data
Default Value 1
Unit s
Configurable 1
Remark this parameter is ignored in case TimeInputMode is “Minimum Time and Time Interval” or “Load
latest Files”
in case the offline data bases on absolute timestamps, a MaximumTime of 0 points to 1970-01-01
00:00:00 and MaximumTime is in local time
DataCtgry
Full Name DataCategory
Short Name DataCtgry
Description data category under which the read data shall appear
Direction input
Class data
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the data category under which the read data shall appear
Remark a backslash (“\”) or slash (“/”) can be used in order to specify sub-categories
examples:
 Some Category
in case an empty string is passed as data category, the default category of each data is
read/taken from the file
English
Release 2018-06 751 / 866
DtNmPrfx
Full Name DataNamePrefix
Short Name DtNmPrfx
Description prefix which shall be added to the beginning of the names of all created offline data
Direction input
Class data
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the prefix which shall be added to the beginning of the names of all created
offline data
Remark the specified prefix is added to the name of the created offline data as it is reported by the loaded
offline data file
in case no prefix and no suffix is specified, the name of the created offline data is identical to the
name within the loaded offline data file(s)
DtNmSffx
Full Name DataNameSuffix
Short Name DtNmSffx
Description suffix which shall be added to the end of the names of all created offline data
Direction input
Class data
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the suffix which shall be added to the end of the names of all created offline
data
Remark the specified suffix is added to the name of the created offline data as it is reported by the loaded
offline data file
in case no prefix and no suffix is specified, the name of the created offline data is identical to the
name within the loaded offline data file(s)
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 752 / 866
2.6.19.19.3 Outputs
Status
Full Name Status
Short Name Status
Description receives the status of the offline data loading
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark = -1 in case no offline data could be loaded
= 1 in case offline data has been loaded
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function LoadData().
Analyzing Script
LoadData 20 Offline Shows a simple loading of offline data from a certain directory.
LoadData 21 Offline Shows how the different loading modes and loading parameters can be configured.

The example measurement tasks are part of the “Introduction” document and provide a chapter “Automatic
loading of Data” which shows in detail how to use the Analyzing Function LoadData() for the loading of offline
data and in combination with different use cases.
for the example of automatic loading of data are found within the “09” folders of their according explorer trees
English
Release 2018-06 753 / 866
2.6.19.20 MonCF() - MonitorConfigurationFile()
2.6.19.20.1 General
Properties
Full Name MonitorConfigurationFile
Short Name MonCF
Description Monitors the state of the specified Configuration File.
Parent Library Base
Function Prototype
DataOrValue Status = MonCF
(
Value State0 ... State3 = “All States”;
DataOrValue* Msg = NULL
);
Symbol
2.6.19.20.2 Inputs
FileName
Full Name FileName
Short Name FileName
Description full path and name of the Configuration File which shall be monitored, in format “Location
01.amf.xts”
Direction input
Class parameter
Unit n/a
Configurable 1
File (“*.dpf.xts”), Monitoring View (“*.mvf.xts”), Analyzing Model (“*.amf.xts”), Analyzing Script
(“*.asf.xts”) or Storage Profile File (“*.spf.xts”)
English
Release 2018-06 754 / 866
State0 … State3
Full Name State0 … State3
Short Name State0 … State3
Description specifies the states of the Configuration File which shall be monitored
Direction input
Class parameter
Default Value “All States”
Unit n/a
Configurable 1…4
Allowed manual Inputs “All States”, “Started”, “Stopped”, “Suspended”, “Paused”, “Triggering”
Remark in case the Configuration File is in a specified state already at the first call to MonCF(), MonCF()
creates a message with the current state immediately at its first execution
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 755 / 866
2.6.19.20.3 Outputs
Status
Full Name Status
Short Name Status
Description indicates whether a new message is available
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark Status = true in case one of the specified states has been reached, otherwise Status = false
Msg
Full Name Message
Short Name Msg
Description receives the message which indicates a Configuration File state
Direction output
Class data
Unit n/a
Configurable 1
Remark none
Analyzing Model
MonCF 01 Online Monitors a specified Configuration File for the started state.
Analyzing Script
MonCF 01 Online Monitors a specified Configuration File for the started state.
English
Release 2018-06 756 / 866
2.6.19.21 MonDev() - MonitorDevice()
2.6.19.21.1 General
Properties
Full Name MonitorDevice
Short Name MonDev
Description Monitors the state of the specified device.
Parent Library Base
Function Prototype
DataOrValue Status = MonDev
(
Value DevName = “”,
Value State = “All States”,
);
Symbol
2.6.19.21.2 Inputs
DevName
Full Name DeviceName
Short Name DevName
Description name of the device which shall be monitored
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the device name
Remark The value of DeviceName is case sensitive.
English
Release 2018-06 757 / 866
State
Full Name State
Short Name State
Description specifies the state of the device which shall be monitored
Direction input
Class parameter
Default Value “All States”
Unit n/a
Configurable 1
Allowed manual Inputs “All States”, “Attached”, “Detached”
Remark In case the device is in a specified state already at the first call to MonDev(), MonDev() creates a
message with the current state immediately at its first execution.
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.21.3 Outputs
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark Status = true in case one of the specified states has been reached, otherwise Status = false
English
Release 2018-06 758 / 866
Msg
Full Name Message
Short Name Msg
Description receives the message which indicates a device state
Direction output
Class data
Unit 1
Configurable 1
Remark none
Analyzing Model
MonDev 01 Online Monitors a specified simulation device for the attached state.
Analyzing Script
MonDev 01 Online Monitors a specified simulation device for the attached state.
English
Release 2018-06 759 / 866
2.6.19.22 MonDisk() - MonitorDisk()
2.6.19.22.1 General
Properties
Full Name MonitorDisk
Short Name MonDisk
Description Monitors the usage of the specified disk.
Parent Library Base
Function Prototype
DataOrValue Out0 = MonDisk
(
Value Disk = “C:”,
Value MonType = “Free Space”,
Value AlrmBrd = 1000,
Value AlrmInt = 3600,
DataOrValue* Status = NULL,
);
Symbol
2.6.19.22.2 Inputs
Disk
Full Name Disk
Short Name Disk
Description specifies the name of the disk which shall be monitored
Direction input
Class parameter
Default Value “C:”
Unit n/a
Configurable 1
Allowed manual Inputs string which contains a valid disk partition in format “XXX:”
Remark The value of Disk is case insensitive.
English
Release 2018-06 760 / 866
MonType
Full Name MonitoringType
Short Name MonType
Description specifies the property of the disk which shall be monitored
Direction input
Class parameter
Default Value “Free Space”
Unit n/a
Configurable 1
Allowed manual Inputs “Free Space”, “Used Space”
Remark none
AlrmBrd
Full Name AlarmBorder
Short Name AlrmBrd
Description specifies the border which will generate the message in case it is exceeded
Direction input
Class parameter
Default Value 1000
Unit MByte
Configurable 1
Remark in case MonitoringType = “Free Space” alarm message will be produced if detected free space
drops below than specified AlarmBorder, in case MonitoringType = “Used Space” alarm message
will be produced if detected used space rises higher than specified AlarmBorder, in case Alarm-
Border <= 0 alarming is disabled
AlrmInt
Full Name AlarmInterval
Short Name AlrmInt
Description specifies the shortest interval at which the alarm message can be created
Direction input
Class parameter
Default Value 3600
Unit s
Configurable 1
Remark a value of 0 disables the alarm interval
in this case the alarm message is not being repeated automatically and the next alarm message is
created only in case the violation of the alarm border ended and the alarm border becomes violat-
ed again
English
Release 2018-06 761 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.22.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the current value of the monitored property of the disk
Direction output
Class data
Default Value 0
Unit MByte
Configurable 1
Remark none
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark Status = true in case the specified alarm constraint has been broken, otherwise Status = false
English
Release 2018-06 762 / 866
Msg
Full Name Message
Short Name Msg
Description receives the message which indicates an exceeded border
Direction output
Class data
Unit 1
Configurable 1
Remark none
Analyzing Model
MonDisk 01 Online Monitors a specified disk partition for using of the free space.
Analyzing Script
MonDisk 01 Online Monitors a specified disk partition for using of the free space setting.
English
Release 2018-06 763 / 866
2.6.19.23 MonFrBlck() - MonitorFreeBlock()
2.6.19.23.1 General
Properties
Full Name MonitorFreeBlock
Short Name MonFrBlck
Description Monitors the free memory block of the specified process.
Parent Library Base
Function Prototype
DataOrValue MaxFreBlck = MonFrBlck
(
Value Process = “X-Tools Server.exe”,
Value AlrmDur = 5,
DataOrValue* NoR = NULL,
DataOrValue* PrcssngTm = NULL,
);
Symbol
English
Release 2018-06 764 / 866
2.6.19.23.2 Inputs
Process
Full Name Process
Short Name Process
Direction input
Class parameter
Default Value “X-Tools Server.exe”
Unit n/a
Configurable 1
AlrmBrd
Short Name AlrmBrd
Description specifies the border which will generate the message in case it is undercut
Direction input
Class parameter
Default Value 100
Unit MByte
Configurable 1
Allowed manual Inputs 0.5 … max of Decimal64
Remark the alarm message is produced in case the maximal free block of the specified process drops
below the specified AlarmBorder, in case the AlarmBorder <= 0 alarming is disabled
AlrmDur
Full Name AlarmDuration
Short Name AlrmDur
Description specifies the minimal duration for which the border must be undercut
Direction input
Class parameter
Default Value 5
Unit s
Configurable 1
Remark none
English
Release 2018-06 765 / 866
AlrmInt
Short Name AlrmInt
Direction input
Class parameter
Default Value 3600
Unit s
Configurable 1
ed again
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.23.3 Outputs
MaxFreBlck
Full Name MaximalFreeBlock
Short Name MaxFreBlck
Description receives the maximal size of a block of memory which can be allocated by the specified process
Direction output
Class data
Default Value 0
Unit MBytes
Configurable 1
Remark none
English
Release 2018-06 766 / 866
NoR
Full Name NumberOfRegions
Short Name NoR
Description receives the number of memory regions which are present at the moment
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
PrcssngTm
Full Name ProcessingTime
Short Name PrcssngTm
Description receives the amount of time which was needed for the scan of the memory
Direction output
Class data
Default Value 0
Unit s
Configurable 1
Remark none
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
English
Release 2018-06 767 / 866
Msg
Full Name Message
Short Name Msg
Description receives the message which indicates an undercut border
Direction output
Class data
Unit 1
Configurable 1
Remark none
Analyzing Model
MonFrBlck 01 Online Monitors the free memory block of the X-Tools Server.
Analyzing Script
MonFrBlck 01 Online Monitors the free memory block of the X-Tools Client.
English
Release 2018-06 768 / 866
2.6.19.24 MonIM() – MonitorInternalMemory()
2.6.19.24.1 General
Properties
Full Name MonitorInternalMemory
Short Name MonIM
Description Monitors the memory usage through the specified module of the X-Tools Server.
Parent Library Base
Function Prototype
DataOrValue UsdMem = MonIM
(
Value MemTp = “Online Data”,
Value AlrmDur = 5,
);
Symbol
2.6.19.24.2 Inputs
MemTp
Full Name MemoryType
Short Name MemTp
Description specifies the type of the internal memory which shall be monitored
Direction input
Class parameter
Default Value “Online Data”
Unit n/a
Configurable 1
Allowed manual Inputs “Online Data”, “Offline Data”, “Scalar Data”, “Interface Profiles”, “Device Profiles”, “Monitoring
Views”, “Analyzing Models”, “Analyzing Scripts”, “Storage Profiles”, “Log Entries”
Remark none
English
Release 2018-06 769 / 866
AlrmBrd
Short Name AlrmBrd
Direction input
Class parameter
Default Value 100
Unit MBytes
Configurable 1
Allowed manual Inputs 0.001 … max of Decimal64
Remark the alarm message is produced in case the detected memory usage through the specified module
rises higher than the specified AlarmBorder, in case the AlarmBorder <= 0 alarming is disabled
AlrmDur
Short Name AlrmDur
Description specifies the minimal duration for which the border must be exceeded
Direction input
Class parameter
Default Value 5
Unit s
Configurable 1
Remark none
AlrmInt
Short Name AlrmInt
Direction input
Class parameter
Default Value 3600
Unit s
Configurable 1
ed again
English
Release 2018-06 770 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.24.3 Outputs
UsdMem
Full Name UsedMemory
Short Name UsdMem
Description receives the current memory usage through the specified module
Direction output
Class data
Default Value 0
Unit MBytes
Configurable 1
Remark none
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
English
Release 2018-06 771 / 866
Msg
Full Name Message
Short Name Msg
Direction output
Class data
Unit 1
Configurable 1
Remark none
Analyzing Model
MonIM 01 Online Monitors the memory usage of the different modules of the X-Tools Server.
Analyzing Script
MonIM 01 Online Monitors the memory usage of the different modules of the X-Tools Server.
English
Release 2018-06 772 / 866
2.6.19.25 MonLog() - MonitorSystemLog()
2.6.19.25.1 General
Properties
Full Name MonitorSystemLog
Short Name MonLog
Description Extracts the entries of the system log which match the specified source modules, phrases and
priorities.
Parent Library Base
Function Prototype
DataOrValue Status = MonLog
(
Value Module = “All”,
Value Phrase0 ... Phrase7 = “”;
Value MinPrio = “Warning”,
);
Symbol
2.6.19.25.2 Inputs
Module
Full Name Module
Short Name Module
Description specifies from which source modules an entry to the system log must be created
Direction input
Class parameter
Default Value “All”
Unit n/a
Configurable 1
Allowed manual Inputs “All”, “ANE”, “DME”, “MTE”, “STE”, “ANE+DME+STE”, “DME+STE”, “Other”
Remark none
English
Release 2018-06 773 / 866
Phrase0 … Phrase7
Full Name Phrase0 … Phrase7
Short Name Phrase0 … Phrase7
Description specifies which phrases must be present within an entry to the system log
Direction input
Class parameter
Unit n/a
Configurable 1…8
Allowed manual Inputs string which contains a phrase for the monitoring
Remark spelling of the Filter0 … Filter7 is case insensitive, in case of the empty string all system log en-
tries will be monitored
MinPrio
Full Name MinimumPriority
Short Name MinPrio
Description specifies the minimum priority of an entry to the system log
Direction input
Class parameter
Default Value “Warning”
Unit n/a
Configurable 1
Allowed manual Inputs “User”, “Information”, “Normal”, “Warning”, “Error”, “Fatal”
Remark none
English
Release 2018-06 774 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.25.3 Outputs
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark Status = true in case a matching entry to the system log has been detected, otherwise Status =
false
Msg
Full Name Message
Short Name Msg
Description receives a message which contains the matching entries of the system log
Direction output
Class data
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 775 / 866
Analyzing Model
MonLog 01 Online Monitors a phrase in the system log for all modules.
Analyzing Script
MonLog 01 Online Monitors a phrase in the system log for all modules.
English
Release 2018-06 776 / 866
2.6.19.26 MonPC() - MonitorPerformanceCounter()
2.6.19.26.1 General
Properties
Full Name MonitorPerformanceCounter
Short Name MonPC
Description Monitors the specified performance counter.
Parent Library Base
Function Prototype
DataOrValue CntrVl = MonPC
(
Value CntrPth = “”,
Value AlrmBrd = 0,
Value AlrmDur = 5,
);
Symbol
2.6.19.26.2 Inputs
CntrPth
Full Name CounterPath
Short Name CntrPth
Description specifies the path to the counter which shall be monitored
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the path to the counter which shall be monitored
Remark example: \Process(X-Tools Server)\% Processor Time
English
Release 2018-06 777 / 866
AlrmBrd
Short Name AlrmBrd
Direction input
Class parameter
Default Value 0
Unit
Configurable 1
Remark the alarm message is produced in case the detected counter value rises higher than the specified
AlarmBorder, in case the AlarmBorder <= 0 alarming is disabled
AlrmDur
Short Name AlrmDur
Direction input
Class parameter
Default Value 5
Unit s
Configurable 1
Remark none
AlrmInt
Short Name AlrmInt
Direction input
Class parameter
Default Value 3600
Unit s
Configurable 1
ed again
English
Release 2018-06 778 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.26.3 Outputs
CntrVl
Full Name CounterValue
Short Name CntrVl
Description receives the current value of the specified counter
Direction output
Class data
Default Value 0
Unit
Configurable 1
Remark the unit depends to the unit of the chosen counter
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
English
Release 2018-06 779 / 866
Msg
Full Name Message
Short Name Msg
Direction output
Class data
Unit 1
Configurable 1
Remark none
Analyzing Model
MonPC 01 Online Monitors the processor time of the X-Tools Server.
Analyzing Script
MonPC 01 Online Monitors the elapsed time of the X-Tools Server.
English
Release 2018-06 780 / 866
2.6.19.27 MonPM() - MonitorProcessMemory()
2.6.19.27.1 General
Properties
Full Name MonitorProcessMemory
Short Name MonPM
Description Monitors the memory usage through the specified process.
Parent Library Base
Function Prototype
DataOrValue MemUsg = MonPM
(
Value AlrmBrd = 80,
Value AlrmDur = 5,
DataOrValue* WrkStSz = NULL,
DataOrValue* CmmtChrg = NULL,
);
Symbol
2.6.19.27.2 Inputs
Process
Full Name Process
Short Name Process
Direction input
Class parameter
Unit n/a
Configurable 1
English
Release 2018-06 781 / 866
AlrmBrd
Short Name AlrmBrd
Direction input
Class parameter
Default Value 80
Unit %
Configurable 1
Remark the alarm message is produced in case the detected memory usage through the specified process
AlrmDur
Short Name AlrmDur
Direction input
Class parameter
Default Value 5
Unit s
Configurable 1
Remark none
AlrmInt
Short Name AlrmInt
Direction input
Class parameter
Default Value 3600
Unit s
Configurable 1
ed again
English
Release 2018-06 782 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.27.3 Outputs
MemUsg
Full Name MemoryUsage
Short Name MemUsg
Description receives the current memory usage through the specified process
Direction output
Class data
Default Value 0
Unit %
Configurable 1
Remark MemoryUsage = CommitCharge / TotalPageFile * 100.0
WrkStSz
Full Name WorkingSetSize
Short Name WrkStSt
Description receives the current working set size of the specified process
Direction output
Class data
Default Value 0
Unit Mbytes
Configurable 1
Remark the current working set size specifies the number of bytes of the current commit charge which are
present within the physical memory of the computer at the moment
English
Release 2018-06 783 / 866
CmmtChrg
Full Name CommitCharge
Short Name CmmtChrg
Description receives the current commit charge of the specified process
Direction output
Class data
Default Value 0
Unit Mbytes
Configurable 1
Remark the current commit charge specifies the total number of bytes which are allocated for the process
at the moment
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Msg
Full Name Message
Short Name Msg
Direction output
Class data
Unit 1
Configurable 1
Remark none
English
Release 2018-06 784 / 866
Analyzing Model
MonPM 01 Online Monitors the memory usage of the X-Tools Server.
Analyzing Script
MonPM 01 Online Monitors the memory usage of the X-Tools Server.
English
Release 2018-06 785 / 866
2.6.19.28 MonPT() - MonitorProcessTimes()
2.6.19.28.1 General
Properties
Full Name MonitorProcessTimes
Short Name MonPT
Description Monitors the CPU usage through the specified process.
Parent Library Base
Function Prototype
DataOrValue CPUUsg = MonPT
(
Value AlrmBrd = 80,
Value AlrmDur = 5,
DataOrValue* TtlTm = NULL,
DataOrValue* UsrTm = NULL,
DataOrValue* KrnlTm = NULL,
);
Symbol
English
Release 2018-06 786 / 866
2.6.19.28.2 Inputs
Process
Full Name Process
Short Name Process
Direction input
Class parameter
Unit n/a
Configurable 1
AlrmBrd
Short Name AlrmBrd
Direction input
Class parameter
Default Value 80
Unit %
Configurable 1
Remark the alarm message is produced in case the detected memory usage through the specified process
AlrmDur
Short Name AlrmDur
Direction input
Class parameter
Default Value 5
Unit s
Configurable 1
Remark none
English
Release 2018-06 787 / 866
AlrmInt
Short Name AlrmInt
Direction input
Class parameter
Default Value 3600
Unit s
Configurable 1
ed again
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.28.3 Outputs
CPUUsg
Full Name CPUUsage
Short Name CPUUsg
Description receives the current CPU usage through the specified process
Direction output
Class data
Default Value 0
Unit %
Configurable 1
Remark none
English
Release 2018-06 788 / 866
TtlTm
Full Name TotalTime
Short Name TtlTm
Description receives the total time which has been spent by the specified process
Direction output
Class data
Default Value 0
Unit s
Configurable 1
Remark none
UsrTm
Full Name UserTime
Short Name UsrTm
Description receives the user time which has been spent by the specified process
Direction output
Class data
Default Value 0
Unit s
Configurable 1
Remark none
KrnlTm
Full Name KernelTime
Short Name KrnlTm
Description receives the kernel time which has been spent by the specified process
Direction output
Class data
Default Value 0
Unit s
Configurable 1
Remark none
English
Release 2018-06 789 / 866
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Msg
Full Name Message
Short Name Msg
Direction output
Class data
Unit 1
Configurable 1
Remark none
Analyzing Model
MonPT 01 Online Monitors the CPU usage of the X-Tools Server.
Analyzing Script
MonPT 01 Online Monitors the CPU usage of the X-Tools Server.
English
Release 2018-06 790 / 866
2.6.19.29 MonSM() - MonitorSystemMemory()
2.6.19.29.1 General
Properties
Full Name MonitorSystemMemory
Short Name MonSM
Description Monitors the memory usage through the whole system.
Parent Library Base
Function Prototype
DataOrValue MemUsg = MonSM
(
Value AlrmBrd = 80,
Value AlrmDur = 5,
DataOrValue* TtlPhys = NULL,
DataOrValue* AvlPhys = NULL,
DataOrValue* TtlPF = NULL,
DataOrValue* AvlPF = NULL,
);
Symbol
English
Release 2018-06 791 / 866
2.6.19.29.2 Inputs
AlrmBrd
Short Name AlrmBrd
Direction input
Class parameter
Default Value 80
Unit %
Configurable 1
Remark the alarm message is produced in case the detected memory usage through the whole system
AlrmDur
Short Name AlrmDur
Direction input
Class parameter
Default Value 5
Unit s
Configurable 1
Remark none
AlrmInt
Short Name AlrmInt
Direction input
Class parameter
Default Value 3600
Unit s
Configurable 1
ed again
English
Release 2018-06 792 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.29.3 Outputs
MemUsg
Full Name MemoryUsage
Short Name MemUsg
Description receives the current memory usage through the whole system
Direction output
Class data
Default Value 0
Unit %
Configurable 1
Remark none
TtlPhys
Full Name TotalPhysical
Short Name TtlPhys
Description receives the amount of installed, physical memory
Direction output
Class data
Default Value 0
Unit Mbytes
Configurable 1
Remark none
English
Release 2018-06 793 / 866
AvlPhys
Full Name AvailablePhysical
Short Name AvlPhys
Description receives the amount of physical memory which is currently available
Direction output
Class data
Default Value 0
Unit Mbytes
Configurable 1
Remark none
TtlPF
Full Name TotalPageFile
Short Name TtlPF
Description receives the current committed memory limit
Direction output
Class data
Default Value 0
Unit Mbytes
Configurable 1
Remark none
AvlPF
Full Name AvailablePageFile
Short Name AvlPF
Description receives the maximum, additional amount of memory which can be committed within the system
Direction output
Class data
Default Value 0
Unit Mbytes
Configurable 1
Remark none
English
Release 2018-06 794 / 866
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Msg
Full Name Message
Short Name Msg
Direction output
Class data
Unit 1
Configurable 1
Remark none
Analyzing Model
MonSM 01 Online Monitors the memory usage through the whole system.
Analyzing Script
MonSM 01 Online Monitors the memory usage through the whole system.
English
Release 2018-06 795 / 866
2.6.19.30 MonST() - MonitorSystemTimes()
2.6.19.30.1 General
Properties
Full Name MonitorSystemTimes
Short Name MonST
Description Monitors the CPU usage through the whole system.
Parent Library Base
Function Prototype
DataOrValue CPUUsg = MonST
(
Value AlrmBrd = 80,
Value AlrmDur = 5,
DataOrValue* TtlTm = NULL,
DataOrValue* UsrTm = NULL,
DataOrValue* KrnlTm = NULL,
DataOrValue* IdlTm = NULL,
);
Symbol
English
Release 2018-06 796 / 866
2.6.19.30.2 Inputs
AlrmBrd
Short Name AlrmBrd
Direction input
Class parameter
Default Value 80
Unit %
Configurable 1
Remark the alarm message is produced in case the detected memory usage through the whole system
AlrmDur
Short Name AlrmDur
Direction input
Class parameter
Default Value 5
Unit s
Configurable 1
Remark none
AlrmInt
Short Name AlrmInt
Direction input
Class parameter
Default Value 3600
Unit s
Configurable 1
ed again
English
Release 2018-06 797 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.30.3 Outputs
CPUUsg
Full Name CPUUsage
Short Name CPUUsg
Description receives the current CPU usage through the whole system
Direction output
Class data
Default Value 0
Unit %
Configurable 1
Remark none
TtlTm
Full Name TotalTime
Short Name TtlTm
Description receives the total time which has been spent by the whole system
Direction output
Class data
Default Value 0
Unit s
Configurable 1
Remark none
English
Release 2018-06 798 / 866
UsrTm
Full Name UserTime
Short Name UsrTm
Description receives the user time which has been spent by the whole system
Direction output
Class data
Default Value 0
Unit s
Configurable 1
Remark none
KrnlTm
Full Name KernelTime
Short Name KrnlTm
Description receives the kernel time which has been spent by the whole system
Direction output
Class data
Default Value 0
Unit s
Configurable 1
Remark the kernel time also includes the idle time
IdlTm
Full Name IdleTime
Short Name IdlTm
Description receives the idle time which has been spent by the whole system
Direction output
Class data
Default Value 0
Unit s
Configurable 1
Remark none
English
Release 2018-06 799 / 866
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Msg
Full Name Message
Short Name Msg
Direction output
Class data
Unit 1
Configurable 1
Remark none
Analyzing Model
MonST 01 Online Monitors the CPU usage through the whole system.
Analyzing Script
MonST 01 Online Monitors the CPU usage through the whole system.
English
Release 2018-06 800 / 866
2.6.19.31 NTPOffset() - NTPOffset()
2.6.19.31.1 General
Properties
Full Name NTPOffset
Short Name NTPOffset
Description Returns the time offset between the local system and the specified NTP server.
Parent Library Base
Function Prototype
DataOrValue Offset = NTPOffset
(
Value NTPSrv = “”,
Value AlrmBrd = 5,
Value AlrmDur = 0,
);
Symbol
2.6.19.31.2 Inputs
NTPSrv
Full Name NTPServer
Short Name NTPSrv
Description NTP server which shall be used as time reference
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the file name of a NTP server
Remark none
English
Release 2018-06 801 / 866
AlrmBrd
Short Name AlrmBrd
Direction input
Class parameter
Default Value 5
Unit s
Configurable 1
Remark the alarm message is produced in case the detected time difference is higher than the specified
AlarmBorder, in case the AlarmBorder <= 0 alarming is disabled
AlrmDur
Short Name AlrmDur
Direction input
Class parameter
Default Value 5
Unit s
Configurable 1
Remark none
AlrmInt
Short Name AlrmInt
Direction input
Class parameter
Default Value 3600
Unit s
Configurable 1
ed again
English
Release 2018-06 802 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.31.3 Outputs
Offset
Full Name Offset
Short Name Offset
Description receives the time difference between the local system and the specified NTP server
Direction output
Class data
Default Value 0
Unit s
Configurable 1
Remark none
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value false
Unit 1
Configurable 1
English
Release 2018-06 803 / 866
Msg
Full Name Message
Short Name Msg
Direction output
Class data
Unit 1
Configurable 1
Remark none
Analyzing Model
NTPOffset 01 Online Determines the time difference between the local system and time.windows.com.
Analyzing Script
NTPOffset 01 Online Determines the time difference between the local system and time.windows.com.
English
Release 2018-06 804 / 866
2.6.19.32 RdStrFrmFl() - ReadStringFromFile()
2.6.19.32.1 General
Properties
Full Name ReadStringFromFile
Short Name RdStrFrmFl
Description Reads a string from a file.
Parent Library Base
Function Prototype
DataOrValue Out0 = RdStrFrmFl
(
Value File = “”,
Value Key = “”,
);
Symbol
2.6.19.32.2 Inputs
File
Full Name File
Short Name File
Description specifies the path to the file, e.g. "C:\Temp\Default.ini"
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the file from which the string shall be read
Remark the file must not be empty
English
Release 2018-06 805 / 866
Key
Full Name Key
Short Name Key
Description specifies the key of the string which shall be read from the file
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the key within the file from which the string shall be read
Remark the key must not be empty
Name
Full Name Name
Short Name Name
Description specifies the name of the string which shall be read from the file
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the string which shall be read
Remark the name must not be empty
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 806 / 866
2.6.19.32.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the string which has been read from the file
Direction output
Class data
Unit n/a
Configurable 1
Remark an empty string is returned in case the specified name is present within the file but does not have
any string assigned to it
Analyzing Model
RdStrFrmFl 01 Online This Analyzing Model reads a string from a file and uses the read string for its online data
calculation.
The Analyzing Model “WrtStrToFl 01” can be started so that the to-be-read value from the
file is constantly updated.
Analyzing Script
RdStrFrmFl 01 Online This Analyzing Script reads a string from a file and uses the read string for its online data
calculation.
The Analyzing Script “WrtStrToFl 01” can be started so that the to-be-read value from the
file is constantly updated.

The example measurement tasks are part of the “Introduction” document and provide a chapter “Massive se-
quential processing with Scalar Data” which shows in detail how to use the Analyzing Function ReadString-
FromFile() for the reading of a string from a file.
for the example about massive sequential processing of scalar data are found within the “22” folders of their
according explorer trees within the X-Tools Client (e.g. “Measurement Tasks://Analyzing Script Files\22” within
the ANS Explorer).
English
Release 2018-06 807 / 866
2.6.19.33 RdVlFrmFl() - ReadValueFromFile()
2.6.19.33.1 General
Properties
Full Name ReadValueFromFile
Short Name RdVlFrmFl
Description Reads a value from a file.
Parent Library Base
Function Prototype
DataOrValue Out0 = RdVlFrmFl
(
Value Key = “”,
);
Symbol
2.6.19.33.2 Inputs
File
Full Name File
Short Name File
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the file from which the value shall be read
English
Release 2018-06 808 / 866
Key
Full Name Key
Short Name Key
Description specifies the key of the value which shall be read from the file
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the key within the file from which the value shall be read
Name
Full Name Name
Short Name Name
Description specifies the name of the value which shall be read from the file
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the value which shall be read
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 809 / 866
2.6.19.33.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the value which has been read from the file
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark 0 is returned in case the specified name is present within the file but does not have any value
assigned to it
Analyzing Model
RdVlFrmFl 01 Online This Analyzing Model reads a value from a file and uses the read value for its online data
calculation.
The Analyzing Model “WrtVlToFl 01” can be started so that the to-be-read value from the file
is constantly updated.
Analyzing Script
RdVlFrmFl 01 Online This Analyzing Script reads a value from a file and uses the read value for its online data
calculation.
The Analyzing Script “WrtVlToFl 01” can be started so that the to-be-read value from the file
is constantly updated.

quential processing with Scalar Data” which shows in detail how to use the Analyzing Function ReadValue-
FromFile() for the reading of a value from a file.
the ANS Explorer).
English
Release 2018-06 810 / 866
2.6.19.34 RemCnt() - RemanentCounter()
2.6.19.34.1 General
Properties
Full Name RemanentCounter
Short Name RemCnt
Description Maintains a remanent counter within an AMF/ASF-specific backup (.ini) file.
Parent Library Base
Function Prototype
DataOrValue Out0 = RemCnt
(
DataOrValue RstVl = 0,
DataOrValue IncrmtVl = 1,
DataOrValue Rst = false,
DataOrValue Incrmt = false,
);
Symbol
2.6.19.34.2 Inputs
Name
Full Name Name
Short Name Name
Description specifies the name of the remanent counter as it is found within the backup (.ini) file
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the remanent counter
Remark none
English
Release 2018-06 811 / 866
RstVl
Full Name ResetValue
Short Name RstVl
Description specifies the value to which the remanent counter shall be set in case the “Reset” input is “true”
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
IncrmtVl
Full Name IncrementValue
Short Name IncrmtVl
Description specifies the value by which the remanent counter shall be increased in case the “Increment” input
is “true”
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
Rst
Full Name Reset
Short Name Rst
Description in case “Reset” is true, the current counter value is set to the value of “ResetValue”
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark in case both “Reset” and “Increment” are true, the current counter value is set to the value of “Re-
setValue”
English
Release 2018-06 812 / 866
Incrmt
Full Name Increment
Short Name Incrmt
Description in case “Increment” is true, the current counter value is increased by the value of “IncrementValue”
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.34.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the current value of the specified counter
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 813 / 866
Analyzing Model
RemCnt 01 Online This Analyzing Model shows an increasing counter which is reset from time to time and
another one which is never reset.
RemCnt 02 Offline This Analyzing Model shows an increasing counter which is reset from time to time and
another one which is never reset.
Analyzing Script
RemCnt 01 Online This Analyzing Script shows an increasing counter which is reset from time to time and an-
other one which is never reset.
RemCnt 02 Offline This Analyzing Script shows an increasing counter which is reset from time to time and an-
other one which is never reset.
English
Release 2018-06 814 / 866
2.6.19.35 RmvEvnts() - RemoveEvents()
2.6.19.35.1 General
Properties
Full Name RemoveEvents
Short Name RmvEvnts
Description Removes all intermediate events from the specified input data.
Parent Library Base
Function Prototype
DataOrValue Status = RmvEvnts
(
);
Symbol
N/A
2.6.19.35.2 Inputs
InData
Full Name InputData
Short Name InData
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the data from the system
Remark the input data must be an offline data
English
Release 2018-06 815 / 866
OutData
Short Name OutData
Direction input
Class parameter
Unit n/a
Configurable 1
Remark the output data is an offline data
in case an empty string is passed for this input, RmvEvnts() overwrites the input data (= removes
the intermediate events from the input data) and no new output data is created
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.35.3 Outputs
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark = -1 in case an error has occurred
>= 0 in case the output data has been created, the status returns the number of events which
have been removed
English
Release 2018-06 816 / 866
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function RmvEvnts().
Analyzing Script
RmvEvnts 02 Offline This Analyzing Script loads offline data which contains gaps and creates a new offline data
without gaps afterwards.
English
Release 2018-06 817 / 866
2.6.19.36 SetEvntCd() - SetEventCode()
2.6.19.36.1 General
Properties
Full Name SetEventCode
Short Name SetEvntCd
Description Outputs a value with the specified event code.
Function Prototype
DataOrValue Out0 = SetEvntCd
(
DataOrValue EvntGenMod = 0,
DataOrValue* EvntCd = NULL,
);
Symbol
2.6.19.36.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values which shall be forwarded to Out0
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark the value from In0 is forwarded to Out0 without a further processing
the status and event codes of In0 are not relevant for Out0
English
Release 2018-06 818 / 866
EvntGenMod
Full Name EventGenerationMode
Short Name EvntGenMod
Description event code which shall be output
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Allowed manual Inputs min … max of Integer32 or “Random” in order to let SetEventCode() set a random status in each
cycle
Remark the following event code values are defined:
 -2 unknown
 0 value available period
 1 value available start
 2 value available stop
 3 value available singleton
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 819 / 866
2.6.19.36.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the specified event code as status code
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
EvntCd
Full Name EventCode
Short Name EvntCd
Description receives the specified event code as value
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
Analyzing Model
SetEvntCd 01 Online This Analyzing Model creates one output data with a random event code and another output
data with a constant event code.
Analyzing Script
SetEvntCd 01 Online This Analyzing Script creates one output data with a random event code and another output
data with a constant event code.
English
Release 2018-06 820 / 866
2.6.19.37 SetSttsCd() - SetStatusCode()
2.6.19.37.1 General
Properties
Full Name SetStatusCode
Short Name SetSttsCd
Description Outputs a value with the specified status code.
Function Prototype
DataOrValue Out0 = SetSttsCd
(
DataOrValue StatGenMod = 0,
DataOrValue* SttsCd = NULL,
);
Symbol
2.6.19.37.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values which shall be forwarded to Out0
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark the value from In0 is forwarded to Out0 without a further processing
the status and event codes of In0 are not relevant for Out0
English
Release 2018-06 821 / 866
StatGenMod
Full Name StatusGenerationMode
Short Name StatGenMod
Description status code which shall be output
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Allowed manual Inputs min … max of Integer32 or “Random” in order to let SetStatusCode() set a random status in each
cycle
Remark the following status code values are defined:
 -2 unknown
 0 value is valid
 1 overflow
 2 underflow
 3 loss of accuracy
 4 division by zero
 5 infinite result
 6 undefined result
 7 input out of range
 8 result not available
 9 input not available
 10 function specific error
 12 disabled
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 822 / 866
2.6.19.37.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the specified status code as status code
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
SttsCd
Full Name StatusCode
Short Name SttsCd
Description receives the specified status code as value
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
Analyzing Model
SetSttsCd 01 Online This Analyzing Model creates one output data with a random status code and another out-
put data with a constant status code.
Analyzing Script
SetSttsCd 01 Online This Analyzing Script creates one output data with a random status code and another output
data with a constant status code.
English
Release 2018-06 823 / 866
2.6.19.38 ShllExe() - ShellExecute()
2.6.19.38.1 General
Properties
Full Name ShellExecute
Short Name ShllExe
Description Calls a shell command
Parent Library Base
Function Prototype
DataOrValue Status = ShllExe
(
Value Oprtn = “open”,
Value Dir = “”,
Value Prmtrs = “”,
Value ShwMd = “show”,
);
Symbol
2.6.19.38.2 Inputs
Oprtn
Full Name Operation
Short Name Oprtn
Description specifies the operation which shall be performed
Direction input
Class parameter
Default Value “open”
Unit n/a
Configurable 1
Allowed manual Inputs “edit”, “explore”, “find”, “open”, “print”, “null”
Remark none
English
Release 2018-06 824 / 866
File
Full Name File
Short Name File
Description file on which the operation shall be applied
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs file name with absolute or relative path information
Remark this parameter can be left empty
in case the directory is provided as relative path, the file must be an absolute path
Dir
Full Name Directory
Short Name Dir
Description working directory which shall be used for the action
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs absolute or relative path information
in case the file is provided as relative path, the directory must be provided as absolute path
Prmtrs
Full Name Parameters
Short Name Prmtrs
Description in case an application shall be started, this parameter can contain the command line arguments
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs command line arguments in the format which are requested by the to-be-started application
English
Release 2018-06 825 / 866
ShwMd
Full Name ShowMode
Short Name ShwMd
Description specifies how the to-be-started application shall be displayed
Direction input
Class parameter
Default Value “show”
Unit n/a
Configurable 1
Allowed manual Inputs “show”, “maximize”, “restore”, “minimize”, “normal”, “hide”, “no activate”
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.38.3 Outputs
Status
Full Name Status
Short Name Status
Description provides the return value of the ShellExecute() function of Windows
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 826 / 866
Analyzing Model
ShllExe 01 Online This Analyzing Model starts one instance of the Windows calculator each 15 seconds.
Analyzing Script
ShllExe 01 Online This Analyzing Script starts one instance of the Windows calculator each 15 seconds
English
Release 2018-06 827 / 866
2.6.19.39 ShowLocation() - ShowLctn()
2.6.19.39.1 General
Properties
Full Name ShowLocation
Short Name ShowLctn
Description Shows the name of the parent location of the Analyzing Model or Analyzing Script.
Parent Library Base
Function Prototype
DataOrValue Lctn = ShowLctn
(
);
Symbol
2.6.19.39.2 Inputs
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 828 / 866
2.6.19.39.3 Outputs
Path
Full Name Location
Short Name Lctn
Description receives the symbolic name of the location of the parent Analyzing Model or Analyzing Script
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark none
Analyzing Model
ShowLctn 01 Online Outputs the symbolic name of the parent location once each 15 seconds.
Analyzing Script
ShowLctn 02 Offline Outputs the symbolic name of the parent location once.
English
Release 2018-06 829 / 866
2.6.19.40 ShowPath() - ShowPath()
2.6.19.40.1 General
Properties
Full Name ShowPath
Short Name ShowPath
Description Shows the path to the parent Analyzing Model or Analyzing Script.
Parent Library Base
Function Prototype
DataOrValue Path = ShowPath
(
Value PthTp = “Absolute Path”,
);
Symbol
2.6.19.40.2 Inputs
PthTp
Full Name PathType
Short Name PthTp
Description type of path which shall be returned
Direction input
Class parameter
Default Value “Absolute Path”
Unit n/a
Configurable 1
Allowed manual Inputs “Absolute Path”, “Absolute Path + File Name”, “Symbolic Path”, “Symbolic Path + File Name”
Remark none
English
Release 2018-06 830 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.40.3 Outputs
Path
Full Name Path
Short Name Path
Description receives the path of the parent Analyzing Model or Analyzing Script in the chosen format (absolute
or symbolic path)
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark none
Analyzing Model
ShowPath 01 Online Outputs the absolute path of the parent Analyzing Model once per minute.
Analyzing Script
ShowPath 02 Offline Outputs the symbolic path of the parent Analyzing Script once.
English
Release 2018-06 831 / 866
2.6.19.41 Sleep() - Sleep()
2.6.19.41.1 General
Properties
Full Name Sleep
Short Name Sleep
Description Pauses the execution of the parent Analyzing Program for the specified amount of time.
Parent Library Base
Function Prototype
DataOrValue Status = Sleep
(
DataOrValue SlpTm = 1,
);
Symbol
N/A
2.6.19.41.2 Inputs
SlpTm
Full Name SleepTime
Short Name SlpTm
Description amount of time for which the execution of the parent Analyzing Program shall be paused
Direction input
Class data
Default Value 1
Unit s
Configurable 1
Remark none
English
Release 2018-06 832 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.41.3 Outputs
Status
Full Name Status
Short Name Status
Direction output
Class data
Default Value 0
Unit s
Configurable 1
Remark Status = true in case the execution has been paused for the specified amount of time
Status = false in case Sleep() was interrupted (e.g. because the parent Analyzing Program has
been stopped)
Analyzing Model
The usage within Analyzing Models is not supported by the Analyzing Function Sleep().
Analyzing Script
Sleep 02 Offline Sleeps for different amounts of time.
English
Release 2018-06 833 / 866
2.6.19.42 SndEmail() - SendEmail()
2.6.19.42.1 General
Properties
Full Name SendEmail
Short Name SndEmail
Description Builds emails from text messages and sends to the specified address afterwards.
Parent Library Base
Function Prototype
DataOrValue Status = SndEmail
(
DataOrValue Msg0 ... Msg7 = “”;
Value Subject = “”,
Value Recipient = “”,
Value Sender = “”,
Value Host = “”,
Value Auth = true,
Value User = “”,
Value Pass = “”,
Value MinMsgN = 1,
DataOrValue* Email = NULL
);
Symbol
English
Release 2018-06 834 / 866
2.6.19.42.2 Inputs
Msg0 … Msg7
Full Name Message0 … Message7
Short Name Msg0 … Msg7
Description messages which shall be sent to the specified email address
Direction input
Class data
Unit n/a
Configurable 1…8
Allowed manual Inputs string which contains a message for the sending
Remark empty messages are not treated as messages and are not sent
Subject
Full Name Subject
Short Name Subject
Description identifies email address of the recipient
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the subject which shall be used when the email is being sent
Remark in case the subject is left empty, the Email Subject setting from the global options is being used for
the sending of the email
English
Release 2018-06 835 / 866
Recipient
Full Name RecipientAddress
Short Name Recipient
Description identifies email address of the recipient
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains a valid email address in format “xxx@yyy.zzz”
Remark In case the recipient is left empty, the “Sender”, “Host”, “Auth”, “User” and “Pass” inputs are ig-
nored and the email notification settings from the global options are being used for the sending of
the email.
Sender
Full Name SenderAddress
Short Name Sender
Description identifies email address of the sender
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains a valid email address in format “xxx@yyy.zzz”
Remark none
Host
Full Name MailServerHostName
Short Name Host
Description specifies email gateway address
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains a valid host name of the email server
Remark none
English
Release 2018-06 836 / 866
Auth
Full Name Authentication
Short Name Auth
Description indicates whether the user authentication at the email server shall be performed
Direction input
Class parameter
Default Value true
Unit 1
Configurable 1
Remark none
User
Full Name UserName
Short Name User
Description specifies user name for the user authentication at the email server
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains a valid user name for the user authentication
Remark none
Pass
Full Name Password
Short Name Pass
Description specifies password for the user authentication at the email server
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains a valid password for the user authentication
Remark none
English
Release 2018-06 837 / 866
MinMsgN
Full Name MinimumMessageNumber
Short Name MinMsgN
Description determines how many of the messages shall be collected for the email sending
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark if the internal calculation is disabled, the already received messages are discarded and the filling
of the internal message stack is restarted when the internal calculation is enabled again
2.6.19.42.3 Outputs
Status
Full Name Status
Short Name Status
Description indicates whether a new email has been sent
Direction output
Class data
Default Value false
Unit 1
Configurable 1
Remark Status = true in case a new email has been sent, otherwise Status = false
English
Release 2018-06 838 / 866
Email
Full Name Email
Short Name Email
Description receives the content of sent email
Direction output
Class data
Unit n/a
Configurable 1
Remark none
The Example Location does not provide ready Analyzing Models or Analyzing Scripts which use the Analyzing
Function SendEmail() because the necessary information about the email server (IP, port, username and
password) can be different for each PC/network.
English
Release 2018-06 839 / 866
2.6.19.43 TstEyFrmFl() - TestEntryFromFile()
2.6.19.43.1 General
Properties
Full Name TestEntryFromFile
Short Name TstEyFrmFl
Description Tests whether an entry is present within a file.
Parent Library Base
Function Prototype
DataOrValue Stts = TstEyFrmFl
(
Value Key = “”,
);
Symbol
2.6.19.43.2 Inputs
File
Full Name File
Short Name File
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the file from which the entry shall be checked
English
Release 2018-06 840 / 866
Key
Full Name Key
Short Name Key
Description specifies the key of the value which shall be read from the file
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the key within the file from which the entry shall be checked
Name
Full Name Name
Short Name Name
Description specifies the name of the value which shall be read from the file
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the entry which shall be checked
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
English
Release 2018-06 841 / 866
2.6.19.43.3 Outputs
Stts
Full Name Status
Short Name Stts
Description receives information about whether the specified entry is available
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark = 0 in case the to-be-tested entry is present and provides a value
= 1 in case the to-be-tested entry is present but does not provide a value
= 2 in case the specified file, key or name could not be accessed
= 3 in case the specified path could not be accessed
= 5 in case the access to the specified file is denied
= -1 in case any other error has occurred
Analyzing Model
TstEyFrmFl 01 Online This Analyzing Model checks whether a certain entry is present within a file.
The Analyzing Model “WrtVlToFl 01” can be started so that the to-be-checked value from
the file becomes present.
Analyzing Script
TstEyFrmFl 01 Online This Analyzing Script checks whether a certain entry is present within a file.
The Analyzing Script “WrtVlToFl 01” can be started so that the to-be-checked value from the
file becomes present.
English
Release 2018-06 842 / 866
2.6.19.44 WrtStrToFl() - WriteStringToFile()
2.6.19.44.1 General
Properties
Full Name WriteStringToFile
Short Name WrtStrToFl
Description Writes a string to a file.
Parent Library Base
Function Prototype
DataOrValue Out0 = WrtStrToFl
(
Value Key = “”,
DataOrValue String = “0”,
);
Symbol
2.6.19.44.2 Inputs
File
Full Name File
Short Name File
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the file to which the string shall be written
English
Release 2018-06 843 / 866
Key
Full Name Key
Short Name Key
Description specifies the key of the string which shall be written to the file
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the key within the file to which the string shall be written
Name
Full Name Name
Short Name Name
Description specifies the name of the string which shall be written to the file
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the string which shall be written
Value
Full Name Value
Short Name Value
Description specifies the string which shall be written to the file
Direction input
Class data
Unit n/a
Configurable 1
Allowed manual Inputs string which shall be written
Remark none
English
Release 2018-06 844 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.44.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the string which has been written to the file
Direction output
Class data
Unit n/a
Configurable 1
Remark none
Analyzing Model
WrtStrToFl 01 Online This Analyzing Model writes a string to a file.
The Analyzing Model “RdStrFrmFl 01” can be used in order to read back the written string.
Analyzing Script
WrtStrToFl 01 Online This Analyzing Script writes a string to a file.
The Analyzing Script “RdStrFrmFl 01” can be used in order to read back the written string.
English
Release 2018-06 845 / 866

quential processing with Scalar Data” which shows in detail how to use the Analyzing Function Writ-
eStringToFile() for the writing of a string to a file.
the ANS Explorer).
English
Release 2018-06 846 / 866
2.6.19.45 WrtVlToFl() - WriteValueToFile()
2.6.19.45.1 General
Properties
Full Name WriteValueToFile
Short Name WrtVlToFl
Description Writes a value to a file.
Parent Library Base
Function Prototype
DataOrValue Out0 = WrtVlToFl
(
Value Key = “”,
);
Symbol
2.6.19.45.2 Inputs
File
Full Name File
Short Name File
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the file to which the value shall be written
English
Release 2018-06 847 / 866
Key
Full Name Key
Short Name Key
Description specifies the key of the value which shall be written to the file
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the key within the file to which the value shall be written
Name
Full Name Name
Short Name Name
Description specifies the name of the value which shall be written to the file
Direction input
Class parameter
Unit n/a
Configurable 1
Allowed manual Inputs string which contains the name of the value which shall be written
Value
Full Name Value
Short Name Value
Description specifies the value which shall be written to the file
Direction input
Class data
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 848 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.19.45.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the value which has been written to the file
Direction output
Class data
Unit n/a
Configurable 1
Remark none
Analyzing Model
WrtVlToFl 01 Online This Analyzing Model writes a value to a file.
The Analyzing Model “RdVlFrmFl 01” can be used in order to read back the written value.
Analyzing Script
WrtVlToFl 01 Online This Analyzing Script writes a value to a file.
The Analyzing Script “RdVlFrmFl 01” can be used in order to read back the written value.
English
Release 2018-06 849 / 866

quential processing with Scalar Data” which shows in detail how to use the Analyzing Function WriteValue-
ToFile() for the writing of a value to a file.
the ANS Explorer).
English
Release 2018-06 850 / 866
2.6.20 Time
2.6.20.1 Bffr() - Buffer()
2.6.20.1.1 General
Properties
Full Name Buffer
Short Name Bffr
Description Creates 1-dimensional buffer with defined size contained input data or values.
Parent Library Base
Parent Category Time
Function Prototype
Buffer1D Out0 = Bffr
(
Value NoP = 1024,
Value Lap = 0,
);
Symbol
2.6.20.1.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values which shall be stored in the buffer
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 851 / 866
NoP
Short Name NoP
Description determines number of points containing in the buffer
Direction input
Class parameter
Default Value 1024
Unit 1
Configurable 1
Remark none
Lap
Full Name Overlap
Short Name Lap
Description defines the overlapping length of the input data or values
Direction input
Class parameter
Default Value 0
Unit 1
Configurable 1
Allowed manual Inputs 0 … 1)
Remark in case Overlap = 0 no overlapping will be occurred
Reset
Full Name Reset
Short Name Reset
Description resets the buffer filling
Direction input
Class control
Default Value false
Unit 1
Configurable 1
English
Release 2018-06 852 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark if the internal calculation is disabled, the already received input buffer is discarded and the filling of
the internal buffer is restarted when the internal calculation is enabled again
2.6.20.1.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the 1-dimensional buffer with the input data or values
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
OutReady
Short Name OutReady
Direction output
Class control
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 853 / 866
2.6.20.1.4 Examples
Analyzing Model
Bffr 01 Online Creates a 1-dimensional buffer of a generated sine wave.
Bffr 02 Offline Creates a 1-dimensional buffer of an offline signal.
Analyzing Script
Bffr 01 Online Creates a 1-dimensional buffer of a generated sine wave.
Bffr 02 Offline Creates a 1-dimensional buffer of an offline signal.
English
Release 2018-06 854 / 866
2.6.20.2 Dly() - Delay()
2.6.20.2.1 General
Properties
Full Name Delay
Short Name Dly
Description Delays input signal.
Parent Library Base
Function Prototype
DataOrValue Out0 = Dly
(
Value Dly = 1,
);
Symbol
2.6.20.2.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values which shall be delayed
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 855 / 866
Dly
Full Name Delay
Short Name Dly
Description delay time for the input data or values
Direction input
Class parameter
Default Value 1
Unit s
Configurable 1
Allowed manual Inputs 2-52 … max of Decimal64
Remark none
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.20.2.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the delayed input data or values
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 856 / 866
2.6.20.2.4 Examples
Analyzing Model
Dly 01 Online Delays a generated sine wave by 1 second.
Dly 02 Offline Delays an offline signal by 2 seconds.
Analyzing Script
Dly 01 Online Delays a generated sine wave by 1.34 seconds.
Dly 02 Offline Delays an offline signal by 2 seconds.
English
Release 2018-06 857 / 866
2.6.20.3 GetBffrM() - GetBufferMember()
2.6.20.3.1 General
Properties
Full Name GetBufferMember
Short Name GetBffrM
Description Gets indicated member of the input buffer.
Parent Library Base
Function Prototype
DataOrValue Out0 = GetBffrM
(
Buffer1D In0 = 0,
Value Idx = 0,
);
Symbol
2.6.20.3.2 Inputs
In0
Full Name Input0
Short Name In0
Description buffer whose indicated member shall be provided to the output
Direction input
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
English
Release 2018-06 858 / 866
Idx
Full Name Index
Short Name Idx
Description indicates the sequence number of the buffer member which shall be provided to the output
Direction input
Class parameter
Default Value 0
Unit 1
Configurable 1
Allowed manual Inputs -1 … max of Integer32
Remark indexation of the buffer member begins from 0
in case -1 is provided as value, the value from the highest present index is returned
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.20.3.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the indicated member of the input buffer
Direction output
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 859 / 866
2.6.20.3.4 Examples
Analyzing Model
GetBffrM 01 Online Returns a value from a buffered online signal.
GetBffrM 02 Offline Returns a value from a buffered offline signal.
Analyzing Script
GetBffrM 01 Online Returns a value from a buffered online signal.
GetBffrM 02 Offline Returns a value from a buffered offline signal.
English
Release 2018-06 860 / 866
2.6.20.4 Rsmpl() - Resample()
2.6.20.4.1 General
Properties
Full Name Resample
Short Name Rsmpl
Description Re-samples input data or values with specified number of points.
Parent Library Base
Function Prototype
Buffer1D Out0 = Rsmpl
(
DataOrValue Prd = 0,
Value NoPrd = 1,
Value NoP = 1024,
);
Symbol
2.6.20.4.2 Inputs
In0
Full Name Input0
Short Name In0
Description data or values which shall be used for the re-sampling
Direction input
Class data
Default Value 0
Unit 1
Configurable 1
Remark none
English
Release 2018-06 861 / 866
Prd
Full Name Period
Short Name Prd
Description period duration of the fundamental oscillation of the input data or values
Direction input
Class data
Default Value 0
Unit s
Configurable 1
Remark none
NoPrd
Full Name NumberOfPeriods
Short Name NoPrd
Description determines number of periods which shall be used for the re-sampling
Direction input
Class parameter
Default Value 1
Unit 1
Configurable 1
Remark none
NoP
Short Name NoP
Description determines number of points for the re-sampled data or values
Direction input
Class parameter
Default Value 1024
Unit 1
Configurable 1
Allowed manual Inputs 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536
Remark none
English
Release 2018-06 862 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.20.4.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the buffer with the re-sampled data or values
Direction output
Class data
Default Value 0
Unit n/a
Configurable 1
Remark none
2.6.20.4.4 Examples
Analyzing Model
Rsmpl 01 Online Calculates a buffer data with re-sampled input online signal.
Rsmpl 02 Offline Calculates a buffer data with re-sampled input offline signal.
Analyzing Script
Rsmpl 01 Online Calculates a buffer data with re-sampled input online signal.
Rsmpl 02 Offline Calculates a buffer data with re-sampled input offline signal.
English
Release 2018-06 863 / 866
2.6.20.5 Stopper() - Stopper()
2.6.20.5.1 General
Properties
Full Name Stopper
Short Name Stopper
Description Calculates duration of a binary signal.
Parent Library Base
Function Prototype
DataOrValue Out0 = Stopper
(
);
Symbol
2.6.20.5.2 Inputs
In0
Full Name Input0
Short Name In0
Description binary data or values whose duration shall be calculated
Direction input
Class data
Default Value false
Unit 1
Configurable 1
Remark none
English
Release 2018-06 864 / 866
EN
Full Name Enable
Short Name EN
Direction input
Class control
Default Value true
Unit 1
Configurable 1
Remark none
2.6.20.5.3 Outputs
Out0
Full Name Output0
Short Name Out0
Description receives the calculated duration of the input data or values
Direction output
Class data
Default Value 0
Unit s
Configurable 1
Remark none
2.6.20.5.4 Examples
Analyzing Model
Stopper 01 Online Stop clock of a generated signal.
Stopper 02 Offline Stop clock of an offline signal.
Analyzing Script
Stopper 01 Online Stop clock of a generated signal.
Stopper 02 Offline Stop clock of an offline signal.
English
Release 2018-06 865 / 866
3 Contact Information
Should you have any questions concerning the software application, please refer to the Industry Sector Tech-
nical Support.
Department
Siemens AG
Industry Sector
Phone
+49 (0) 911 895 7222 (Monday to Friday, 09:00 am to 05:00 pm CET/CEST)
Fax
+49 (0) 911 895 7223
Internet
https://support.industry.siemens.com/
Thank you for using one of the above mentioned contacts to ensure your inquiry is registered and can be pro-
cessed.
English
Release 2018-06 866 / 866

CMS X-Tools All Editions User Manual - 06 - Analyzing System - en

Enviado por

Dados do documento

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

CMS X-Tools All Editions User Manual - 06 - Analyzing System - en

Enviado por

Direitos autorais:

Formatos disponíveis

CMS X-Tools - User Manual - 06 - Analyzing System CMS

2.2.5.2 Analyzing Function Properties Table ................................................................................. 49

2.4 Analyzing Script Editors ............................................................................................................... 75

2.5.3 UFE Standard T001 .............................................................................................................. 112

2.6.2.4.1 General ....................................................................................................................... 135

2.6.2.12.3 Outputs ....................................................................................................................... 153

2.6.2.21 Mod() - Modulo() .............................................................................................................. 175

2.6.2.29.2 Inputs .......................................................................................................................... 193

2.6.5.2.1 General ....................................................................................................................... 223

2.6.5.10.3 Outputs ....................................................................................................................... 247

2.6.6.4.4 Examples .................................................................................................................... 274

2.6.7.1.4 Examples .................................................................................................................... 303

2.6.8.8 IIRBPCH1() – IIRBandPassFilterChebyshev1() .............................................................. 332

2.6.8.16.2 Inputs .......................................................................................................................... 360

2.6.10.4.3 Outputs ....................................................................................................................... 390

2.6.11.2 NAND() - NAND()............................................................................................................. 423

2.6.13.1 Cnt() - Count() .................................................................................................................. 446

2.6.15.2 OutB1D() - OutputBuffer1D() ........................................................................................... 476

2.6.16.1 AppBhann() - ApplyBartlettHann() ................................................................................... 532

2.6.16.9.2 Inputs .......................................................................................................................... 556

2.6.16.18 MonSpmEnv2() – MonitorSpectrumEnvelope2() ............................................................. 599

2.6.17.3.1 General ....................................................................................................................... 627

2.6.17.11.3 Outputs ....................................................................................................................... 657

2.6.18.1.4 Examples .................................................................................................................... 680

2.6.19.5 GetHBT() - GetHeartBeatTime() ...................................................................................... 706

2.6.19.13.2 Inputs .......................................................................................................................... 733

2.6.19.21.4 Examples .................................................................................................................... 759

2.6.19.30.1 General ....................................................................................................................... 796

2.6.19.38.3 Outputs ....................................................................................................................... 826

2.6.20.1.4 Examples .................................................................................................................... 854

Figure 1: Example of an Analyzing System ........................................................................................................ 36

1.1 Purpose of this Document

1.2 Validity of this Document

This document is valid for the following software:

The following notations are used within this document:

2.1 Analyzing System

Figure 1: Example of an Analyzing System

2.1.2 Menu Bar

The following functionality is available via the View menu:

The following functionality is available via the Window menu:

The following functionality is available via the Sub-Windows menu:

2.2 Analyzing System Explorer

Figure 2: Example of an ANS Explorer

2.2.2 Menu Bar

The following functionality is available via the Edit menu:

The following functionality is available via the Run menu:

The following functionality is available via the View menu:

The following functionality is available via the Window menu:

2.2.3 ANS Explorer Tree

2.2.3.2 Main Branch

2.2.3.3 Editors Branch

2.2.3.4 Analyzing Model Editors Branch

2.2.3.5 Analyzing Model Editor Branch

2.2.3.6 Analyzing Script Editors Branch

2.2.3.7 Analyzing Script Editor Branch

2.2.3.8 User Function Editors Branch

2.2.3.9 User Function Editor Branch

2.2.3.10 Servers Branch

2.2.3.11 Server Branch

2.2.3.12 Files Branch

2.2.3.13 File Location Branch

2.2.3.14 Analyzing Model Files Branch

The following specific context menu items are provided: