Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                

CTA Remote Interface Manual

Download as pdf or txt
Download as pdf or txt
You are on page 1of 217

CT Analyzer

Remote Control Software Programming Manual


CT Analyzer Remote Control Programming Manual

Manual Version: ENU 1039 06 01


This manual refers to version 4.50 of the CT Analyzer firmware and the CT Analyzer PC Toolset
software.
© OMICRON electronics GmbH 2016. All rights reserved.
This manual is a publication of OMICRON electronics GmbH.
All rights including translation reserved. Reproduction of any kind, for example, photocopying,
microfilming, optical character recognition and/or storage in electronic data processing systems,
requires the explicit consent of OMICRON. Reprinting, wholly or in part, is not permitted.
The product information, specifications, and technical data embodied in this manual represent the
technical status at the time of writing and are subject to change without prior notice.
We have done our best to ensure that the information given in this manual is useful, accurate and entirely
reliable. However, OMICRON does not assume responsibility for any inaccuracies which may be
present.
The user is responsible for every application that makes use of an OMICRON product.
OMICRON translates this manual from the source language English into a number of other languages.
Any translation of this manual is done for local requirements, and in the event of a dispute between the
English and a non-English version, the English version of this manual shall govern.

2 OMICRON
Contents

Contents
1 Designated use................................................................................................ 11
2 Installing the CTA Remote Control Software ................................................ 12
2.1 System requirements .........................................................................................................12
2.2 Installing the software ........................................................................................................12

3 Connecting the CT Analyzer to the PC .......................................................... 13


3.1 Connecting the CT Analyzer via a serial interface .............................................................13
3.2 Connecting the CT Analyzer via USB ................................................................................14
3.3 Connecting the CT Analyzer and the CT SB2 ...................................................................14

4 Description ...................................................................................................... 15
4.1 What is the CTA Remote Control Software? .....................................................................15
4.2 Overview of data communication and interfaces provided by the software ......................15
4.3 Overview of connection states and state transitions..........................................................18
4.4 Log file ................................................................................................................................18

5 Operation ......................................................................................................... 19
5.1 Possible programming languages......................................................................................19
5.2 The most important Visual Basic statements .....................................................................19
5.3 Working in the Visual Basic editor .....................................................................................22
5.3.1 Starting the Visual Basic editor .............................................................................22
5.3.2 Including the CTA Remote Type Library ..............................................................22
5.3.3 Window areas of the Visual Basic editor ..............................................................24
5.3.4 Inserting, renaming and deleting modules ...........................................................25
5.3.5 Working in the Visual Basic code window ............................................................26
5.3.6 Loading an existing Visual Basic program............................................................28
5.4 Creating an application program step by step ...................................................................29
5.4.1 Assumptions for the descriptions given in this section .........................................29
5.4.2 Creating the program code ...................................................................................29

6 Description of interfaces and functions ........................................................ 31


6.1 Overview of interfaces and functions / properties ..............................................................31
6.2 Description of the syntax given for the functions and properties .......................................34
6.2.1 Syntax of functions ...............................................................................................34
6.2.2 Syntax of properties ..............................................................................................35
6.3 ICTA (administrative tasks) ...............................................................................................36
6.3.1 Overview of functions and properties ...................................................................36
6.3.2 Description of functions ........................................................................................37
6.3.2.1 SerialConnect ........................................................................................37
6.3.2.2 USBConnect..........................................................................................38
6.3.2.3 Disconnect .............................................................................................38

OMICRON 3
CTA Remote Control Programming Manual

6.3.2.4 UpgradeFirmware................................................................................. 39
6.3.2.5 UpgradeText......................................................................................... 39
6.3.2.6 UpgradeLicenses ................................................................................. 40
6.3.2.7 Advise ................................................................................................... 40
6.3.2.8 Unadvise .............................................................................................. 42
6.3.3 Description of properties ...................................................................................... 43
6.3.3.1 eStatus ................................................................................................. 43
6.3.3.2 bstrFirmwareVersion ............................................................................ 43
6.3.3.3 bstrHardwareVersion............................................................................ 44
6.3.3.4 bstrSoftwareVersion ............................................................................. 44
6.3.3.5 bstrSerialNumber ................................................................................. 44
6.3.3.6 Info........................................................................................................ 45
6.3.3.7 USBDevices ......................................................................................... 45
6.3.3.8 HasLicense ........................................................................................... 46
6.3.3.9 MissingLicenses ................................................................................... 46
6.3.3.10 AvailableLicenses ................................................................................. 47
6.3.3.11 NotAvailableLicenses ........................................................................... 48
6.3.3.12 AddLicenses ......................................................................................... 48
6.3.3.13 Test....................................................................................................... 48
6.3.3.14 Settings ................................................................................................ 49
6.3.3.15 Results ................................................................................................. 49
6.3.3.16 LiveResults ........................................................................................... 49
6.3.3.17 FileTransfer .......................................................................................... 50
6.3.3.18 Directory ............................................................................................... 50
6.3.3.19 Calculate .............................................................................................. 50
6.3.3.20 Quick .................................................................................................... 50
6.4 ICTAInfo (device information) ........................................................................................ 51
6.4.1 Overview of functions and properties .................................................................. 51
6.4.2 Description of functions ....................................................................................... 52
6.4.2.1 Clear ..................................................................................................... 52
6.4.3 Description of properties ...................................................................................... 52
6.4.3.1 eClass .................................................................................................. 52
6.4.3.2 nNumber ............................................................................................... 52
6.4.3.3 nLocation .............................................................................................. 53
6.4.3.4 bstrDescription ..................................................................................... 53
6.4.3.5 nMeasurementInfo ............................................................................... 53
6.5 ICTASettings (specifying test settings) ........................................................................ 55
6.5.1 Overview of functions .......................................................................................... 55
6.5.2 Description of functions ....................................................................................... 56
6.5.2.1 LocalLoadSettings ................................................................................ 56
6.5.2.2 LocalSaveSettings................................................................................ 56
6.5.2.3 ClearSettings ........................................................................................ 57
6.5.2.4 GetValue .............................................................................................. 57
6.5.2.5 SetValue ............................................................................................... 58

4 OMICRON
Contents

6.6 ICTARemoteTest (test execution on the CT Analyzer) ...................................................59


6.6.1 Overview of functions ...........................................................................................59
6.6.2 Description of functions ........................................................................................59
6.6.2.1 RemoteLoadReport ...............................................................................59
6.6.2.2 RemoteSaveReport ...............................................................................60
6.6.2.3 Activate ..................................................................................................60
6.6.2.4 Deactivate .............................................................................................62
6.6.2.5 LoadRefExcitationCurve .......................................................................63
6.6.2.6 LockDevice ............................................................................................63
6.6.2.7 UnlockDevice ........................................................................................63
6.7 ICTAFileTransfer (file exchange) ................................................................................64
6.7.1 Overview of functions ...........................................................................................64
6.7.2 Description of functions ........................................................................................64
6.7.2.1 CopyToCTA...........................................................................................64
6.7.2.2 CopyFromCTA ......................................................................................65
6.8 ICTARemoteDirectory (file management on the CT Analyzer) ....................................66
6.8.1 Overview of functions ...........................................................................................66
6.8.2 Description of functions ........................................................................................66
6.8.2.1 QueryFileItems ......................................................................................66
6.8.2.2 FileMove ................................................................................................68
6.8.2.3 FileRename ...........................................................................................68
6.8.2.4 FileCopy ................................................................................................68
6.8.2.5 FileRemove ...........................................................................................69
6.8.2.6 DirectoryCreate .....................................................................................69
6.8.2.7 DirectoryRemove...................................................................................69
6.8.2.8 FormatDisk ............................................................................................69
6.9 ICTAResults (reading test results from a test report) .....................................................71
6.9.1 Overview of functions ...........................................................................................71
6.9.2 Description of functions ........................................................................................72
6.9.2.1 LocalLoadReport ...................................................................................72
6.9.2.2 GetValue ...............................................................................................72
6.9.2.3 GetIndexedValue...................................................................................73
6.9.2.4 GetIndexedValues .................................................................................74
6.9.2.5 GetCompositeError ...............................................................................75
6.9.2.6 GetPhaseDeviation ...............................................................................76
6.9.2.7 GetRatioDeviation .................................................................................77
6.9.2.8 GetMaxPrimaryCurrent .........................................................................78
6.9.2.9 GetISec .................................................................................................79
6.9.2.10 GetErrorDescription...............................................................................79
6.9.2.11 SetValue ................................................................................................80
6.9.2.12 LocalSaveReport ...................................................................................81
6.9.2.13 IsReportSecure .....................................................................................81
6.9.2.14 GetAssessInfo .......................................................................................81

OMICRON 5
CTA Remote Control Programming Manual

6.10 ICTALiveResults (reading test results directly from the CT Analyzer) ........................ 83
6.10.1 Overview of functions .......................................................................................... 83
6.10.2 Description of functions ....................................................................................... 84
6.10.2.1 GetLiveValue ........................................................................................ 84
6.10.2.2 GetLiveIndexedValue ........................................................................... 84
6.10.2.3 GetLiveIndexedValues ......................................................................... 85
6.10.2.4 GetLiveErrorDescription ....................................................................... 86
6.11 ICTACalc (enhanced calculation of results) .................................................................... 87
6.11.1 Overview of functions .......................................................................................... 87
6.11.2 Description of functions ....................................................................................... 89
6.11.2.1 EvalCompositeError ............................................................................. 89
6.11.2.2 EvalPhaseDeviation ............................................................................. 90
6.11.2.3 EvalRatioDeviation ............................................................................... 91
6.11.2.4 EvalSecondaryCurrent ......................................................................... 92
6.11.2.5 EvalMaxPrimaryCurrent ....................................................................... 93
6.11.2.6 EvalExcitationCurrentRms ................................................................... 94
6.11.2.7 EvalExcitationCurrentPeak .................................................................. 95
6.11.2.8 EvalCoreVoltage .................................................................................. 96
6.11.2.9 EvalExcitationCurrentRmsAtVcore ...................................................... 97
6.11.2.10 EvalExcitationCurrentRmsAtVTerm ..................................................... 98
6.11.2.11 EvalExcitationCurrentPeakAtVcore ...................................................... 99
6.11.2.12 EvalVTermAtExcitationCurrentRms ................................................... 100
6.11.2.13 EvalVCoreAtExcitationCurrentRms.................................................... 101
6.11.2.14 EvalVCoreAtExcitationCurrentPeak ................................................... 102
6.11.2.15 AL_MaxPrimaryCurrent ...................................................................... 103
6.11.2.16 AL_MaxImpedance ............................................................................ 104
6.11.2.17 AL_ImpedanceAtPrimaryCurrent ....................................................... 105
6.11.2.18 AL_PrimaryCurrentAtImpedance ....................................................... 106
6.11.2.19 AL_PrimaryCurrentAtNomBurden ...................................................... 107
6.11.2.20 AL_PrimaryCurrentAtOprBurden ....................................................... 108
6.12 ICTAQuick (Quick measurement device) ..................................................................... 109
6.12.1 Overview of functions ........................................................................................ 110
6.12.2 Description of functions ..................................................................................... 110
6.12.2.1 SetSetting ........................................................................................... 110
6.12.2.2 GetSetting .......................................................................................... 111
6.12.2.3 GetResult ........................................................................................... 111
6.12.2.4 GetV1Results ..................................................................................... 112
6.12.2.5 GetV2Results ..................................................................................... 112
6.12.2.6 GetI1Results ....................................................................................... 113
6.12.2.7 GetCalculatedResults......................................................................... 114
6.12.2.8 StartMeasurement .............................................................................. 115
6.12.2.9 StopMeasurement .............................................................................. 115
6.12.2.10 Status ................................................................................................. 116
6.12.3 Example ............................................................................................................. 117

6 OMICRON
Contents

7 Enumeration types, test settings and test results ..................................... 118


7.1 Overview of types.............................................................................................................118
7.2 Enumeration types ...........................................................................................................119
7.2.1 TCTAAssessment ...............................................................................................119
7.2.2 TCTACard ...........................................................................................................119
7.2.3 TCTAClass .........................................................................................................120
7.2.4 TCTACoreType...................................................................................................121
7.2.5 TCTACompensation ...........................................................................................122
7.2.6 TCTAInfoClass ...................................................................................................122
7.2.7 TCTAKtdCalculation ...........................................................................................123
7.2.8 TCTALicense ......................................................................................................123
7.2.9 TCTAResultTestStatus .......................................................................................124
7.2.10 TCTASequence ..................................................................................................124
7.2.11 TCTAStandard ....................................................................................................125
7.2.12 TCTAStatus ........................................................................................................125
7.2.13 TCTATempUnit ...................................................................................................125
7.2.14 TCTAMeasInfo....................................................................................................126
7.2.15 TCTAQualifier .....................................................................................................127
7.2.16 TCTAChecksResult ............................................................................................127
7.2.17 TCTABurdenType ...............................................................................................127
7.2.18 TCTATPSpecMtd................................................................................................128
7.2.19 TCTAAssessRule ...............................................................................................128
7.3 Test settings .....................................................................................................................129
7.3.1 TCTASettingValue ..............................................................................................129
7.4 Test results.......................................................................................................................140
7.4.1 TCTAResultValue ...............................................................................................140
7.4.2 TCTAResultIndexedValue ..................................................................................173
7.4.3 TCTAAssessParameter ......................................................................................181
7.4.4 TCTAAssessInfo .................................................................................................184
7.5.1 TCTAQuickOutMode ..........................................................................................186
7.5.2 TCTAQuickRangeMode .....................................................................................186
7.5.3 TCTAQuickRangeV1 ..........................................................................................186
7.5.4 TCTAQuickRangeV2 ..........................................................................................187
7.5.5 TCTAQuickRangeI1............................................................................................187
7.5.6 TCTAQuickFilterMode ........................................................................................188
7.5.7 TCTAQuickMeasType ........................................................................................188
7.5.8 TCTAQuickSetting ..............................................................................................190
7.5.9 TCTAQuickResult ...............................................................................................193
7.5.10 TCTAQuickStatus ...............................................................................................197

8 Multi-ratio support ........................................................................................ 198


8.1 Prepare a multi-ratio measurement .................................................................................198
8.1.1 Recalculations ....................................................................................................199

OMICRON 7
CTA Remote Control Programming Manual

8.1.2 Enumeration types ............................................................................................. 199

9 Application examples ................................................................................... 204


9.1 Available application examples ....................................................................................... 204

10 Error handling ............................................................................................... 205


10.1 Overview of error communication mechanisms .............................................................. 205
10.1.1 Result code (HRESULT).................................................................................... 205
10.1.2 Device Information ............................................................................................. 206
10.1.3 Error Object ....................................................................................................... 206
10.1.4 Logfile ................................................................................................................ 206
10.2 Unstructured exception handling in Visual Basic ............................................................ 207
10.2.1 Basics ................................................................................................................ 207
10.2.2 On Error GoTo Line ........................................................................................... 207
10.2.3 On Error Resume Next ...................................................................................... 208
10.2.4 On Error GoTo 0 ................................................................................................ 209
10.2.5 On Error GoTo -1 ............................................................................................... 209
10.2.6 An example ........................................................................................................ 209

11 Warning messages of the CTA Remote Control Software ........................ 211


12 Error and warning messages of the CT Analyzer ...................................... 215
Support .......................................................................................................... 216

8 OMICRON
Preface

Preface
The CTA Remote Control Software is used to remote control CT Analyzer test
sets via PC. It does not offer a graphical user interface and can be operated
using all common programming languages. The purpose of this manual is to
familiarize programmers and users with the CTA Remote Control Software and
its programming.
In addition to this programming manual, the CT Analyzer User Manual has to
be observed. The CT Analyzer User Manual always has to be available at the
site where the CT Analyzer is used.
Programming of remote control programs and testing with the CT Analyzer
should only be carried out by authorized and qualified personnel. Although it is
not absolutely necessary, it is recommended and useful that persons entrusted
with the programming of remote control programs have fundamental
programming knowledge.
Due to reasons of clarity, all explanations regarding programming and all
programming examples given in this manual refer to the programming
language Visual Basic.

Conventions
The names of interfaces, functions, properties, (enumeration) types and
variables/parameters of the CTA Remote Control Software are written in
Courier font.
Interfaces are prefixed by the identifier "I", e.g. ICTASettings.
Enumeration types are prefixed by the identifier "T", e.g. TCTAStatus.
Program code is written in Courier Bold font.
Whenever a given path refers to the file system of the PC, it is written in the
common form, using the drive letter and backslash characters, e.g.
D:\CT Analyzer\CTATests\MyTests\.
Whenever a path refers to the file system of the CT Analyzer (i.e. the Compact
Flash card), it is written using forward slashes, e.g.
A:/Tests/MyTests/Manufacturer1/. Only two drive letters are allowed
by the CT Analyzer: A is the Compact Flash card, B is the internal RAM. When
no drive letter is specified, drive A is taken by default.

Glossary of symbols
Note
Indicates notes with special meaning, i.e., additional important
information.

OMICRON 9
CTA Remote Control Programming Manual

Safety instructions
Before operating the CT Analyzer, carefully read the CT Analyzer
User Manual and the safety instructions given there. It is not
recommended to use (or even switch on) the CT Analyzer without
understanding the information given in the CT Analyzer User Manual.
If some points of the safety instructions are unclear, please contact
OMICRON electronics.
Before starting a test on the CT Analyzer via PC remote control, make sure
that the CT Analyzer is in a technically sound condition and that no other
persons are working on the site where the CT Analyzer is used.
Prior to actual testing procedures, you should test your programs used to
control the CT Analyzer in detail and verify the results in order to guarantee
the reliability of the obtained results.
Observe the following when running tests:
• Prevent the presence of other persons in the potentially dangerous area
around the test object.
• If necessary, perform appropriate additional safety precautions according to
the relevant standard, for example, by defining a high-voltage area around
the test object and securing this area against unauthorized access by using
a barrier chain and warning sign.
• Apply an appropriate warning sign to warn other persons that the test set is
switched on and operated remote-controlled.
• Start the test only if all safety precautions were taken and if you are
absolutely sure that no other person is present in the potentially dangerous
area around the test object.

10 OMICRON
Designated use

1 Designated use
The CTA Remote Control Software is intended to control CT Analyzer test sets
via PC for the purpose of remote control and/or to automate test procedures
performed using the CT Analyzer.
It may only be used together with CT Analyzer test sets.
Any other use of the CTA Remote Control Software but the one mentioned
above is considered as improper use, and will not only invalidate all customer
warranty claims but also exempt the manufacturer from its liability to recourse.

OMICRON 11
CTA Remote Control Programming Manual

2 Installing the CTA Remote Control


Software
2.1 System requirements
To run the CTA Remote Control Software, your PC must meet the following
minimum requirements:
• PC with 1 serial interface or 1 USB interface (USB 1.1 or 2.0).
• Operating System Windows 2000/XP/Vista/Windows 7.
• Programming environment of the desired programming language installed
(e.g. Visual Basic (VB), Visual Basic for Applications (VBA), C, C++, C#,
VB.Net, etc.).
®
• The Visual Basic editor of Microsoft Excel is required to run the example
programs given in this manual (these example programs are included on
the CTA Remote Control Software CD-ROM).

2.2 Installing the software


To install the CTA Remote Control Software, insert the delivered CTAnalyzer
PC Toolset CD-ROM into your CD-ROM drive and follow the instructions on
the screen.

12 OMICRON
Connecting the CT Analyzer to the PC

3 Connecting the CT Analyzer to the


PC
3.1 Connecting the CT Analyzer via a serial
interface
1. Connect one side of the null modem cable included in the scope of delivery
to the remote control interface of the CT Analyzer.
2. Connect the other side of the null modem cable to the serial port of your
PC.
Note If the CT Analyzer is connected to a serial port of your PC, you
have to specify the port number in your program.

Figure 1 CT Analyzer connected to PC via serial interface

OMICRON 13
CTA Remote Control Programming Manual

3.2 Connecting the CT Analyzer via USB


Note Although it is generally possible to connect more than one
CT Analyzer test sets to a PC via USB (e.g. using an USB hub), the
CTA Remote Control Software can control only one CT Analyzer test
set simultaneously.
If several CT Analyzer test sets are connected to the PC via USB,
you have to specify the serial number of the CT Analyzer test set you
want to access in your program.

1. Connect the USB-RS232 adapter included in the scope of delivery to one


side of the USB cable and then connect the other side of the USB cable to
the USB port of your PC.
2. Connect one side of the null modem cable included in the scope of delivery
to the remote control interface of the CT Analyzer and the other side to the
USB-RS232 adapter.

Figure 2 CT Analyzer connected to PC via USB

3.3 Connecting the CT Analyzer and the CT SB2


For connecting the CT Analyzer and the CT SB2 with the PC please refer to
the CT SB2 User Manual.

14 OMICRON
Description

4 Description
4.1 What is the CTA Remote Control Software?
The CTA Remote Control Software is a remote component installed on the
PC. It works as a Common Object Model (COM) server and provides a
number of access interfaces to the CT Analyzer with numerous functions to
control the CT Analyzer.
The CTA Remote Control Software itself does not offer a graphical user
interface. It can be operated using all common programming languages, e.g.
Visual Basic (VB), Visual Basic for Applications (VBA), .NET (C#), C++, etc.
By means of application programs, it is possible to remote control a connected
CT Analyzer test set completely and/or to automate test procedures performed
using the CT Analyzer.

4.2 Overview of data communication and


interfaces provided by the software
Figure 3 shows an overview of the data communication and the interfaces
provided by the CTA Remote Control Software (CTA remote component). The
figure is explained in the subsequent legend.

OMICRON 15
CTA Remote Control Programming Manual

Figure 3 Data communication and interfaces

The CTA Remote Control Software can be accessed by one or more


customer applications in order to control a CT Analyzer test set
connected to the PC. However, parallel access of several application
programs to one CT Analyzer is restricted by the CT Analyzer test set.
Concurrent control of several CT Analyzer test sets is not possible. The
CTA Remote Control Software is able to control only one CT Analyzer

16 OMICRON
Description

test set simultaneously. Access to another CT Analyzer test set possibly


connected to the USB port at the same time is only possible after
disconnecting from the previously accessed test set (see functions
SerialConnect / USBConnect and Disconnect on page 37).
The CTA Remote Control Software provides several access interfaces
providing the following functionality:
ICTA interface: Administrative tasks, see page 36.
Functions: e.g. establishing a connection to the CT Analyzer,
reading the operating state or the serial number of the CT Analyzer,
initiating a firmware update, etc.
ICTAInfo interface: Reading device information (hints, warning or
error conditions) from the CT Analyzer and clearing the information
on the CT Analyzer, see page 51.
ICTALiveResults interface: Reading test results directly from the
CT Analyzer, see page 83.
In contrast to the ICTAResults interface, it is not necessary to save a
test report on the CT Analyzer and to transfer the report file to the
PC before reading the values. The values are read directly from the
CT Analyzer memory.
ICTARemoteTest interface: Test execution, see page 59.
Functions: e.g. directing the CT Analyzer to load a test definition file
from the Compact Flash card, activating the test, saving the test
report to the Compact Flash card, etc.
ICTARemoteDirectory interface: File management on the Compact
Flash card, see page 66.
Functions: e.g. querying file directories, renaming or deleting files,
creating or removing directories, etc.
ICTASettings interface: Specification of test definitions, see page 55.
Functions: e.g. loading a test settings file from the local harddisk,
saving a changed test settings file to the local harddisk, etc.
ICTAResults interface: Reading test results from test reports, see
page 71.
Functions: e.g. loading a test report file from the local harddisk,
reading individual result values, etc.
ICTAFileTransfer interface: File exchange, see page 64.
Functions: e.g. copying a file from the local harddisk to the Compact
Flash card of the CT Analyzer or vice versa.
ICTAQuick interface: Quick measurement access

OMICRON 17
CTA Remote Control Programming Manual

4.3 Overview of connection states and state


transitions
The connection state can be read using the eStatus property of the ICTA
interface (see page 36). The available states are described below (see also
enumeration type TCTAStatus on page 125).
CTA_STAT_NOT_CONNECTED
Initial status after the instantiation of the CTA remote component and status
after applying the Disconnect function.
CTA_STAT_READY
CT Analyzer is sucessfully connected and the device is not in a warning or an
error state. The CT Analyzer is ready for operation. This status is also entered,
when a performed test has successfully completed.
CTA_STAT_ACTIVATED
Status after starting the test using the Activate function.
CTA_STAT_PAUSED
The CT Analyzer is activated but the test is paused because rewiring of the
test object is required to continue the test.
CTA_STAT_WAIT_FOR_ACKNOWLEDGE
The CT Analyzer is connected and waiting for an acknowledgement of a
message (an error or warning). This is when a test has stopped with a failure
or has been aborted using the Deactivate function.

4.4 Log file


During operation, the CTA remote component writes a log file for the purpose
of error diagnosis. The log file is stored in the installation folder of the CTA
Remote Control Software, which is by default C:\Program
Files\OMICRON\CT Analyzer PC Toolset\CTARemote.exe.log. It
can be useful for debugging purposes.

18 OMICRON
Operation

5 Operation
5.1 Possible programming languages
The CTA Remote Control Software can be operated using the following
programming languages:
• Visual Basic (VB)
®
• Visual Basic for Applications (VBA, included e.g. in Microsoft Excel ,
® ®
WORD , Access , etc.)
• .NET (C#, VB.Net)
• C++
• Borland Delphi
• Any other programming language supporting COM (Common Objects
Model).

Note Due to reasons of clarity, the explanations regarding programming


and the programming examples given in this manual refer to the
®
programming language Visual Basic included in Microsoft Excel .

5.2 The most important Visual Basic statements


This section gives some fundamental information about the most important
and most frequently used Visual Basic statements.
For more detailed information and information about the full scope of the
programming language Visual Basic, please refer to the Visual Basic online
help system, the standard literature about Visual Basic or visit Microsoft's
MSDN library in the internet:
http://msdn2.microsoft.com/en-us/library/sh9ywfdk.aspx
Comments and remarks
Comments and remarks within the code are written with a preceding
apostrophe '.
Debug.Print
The Debug.Print statement is used to display information or results in the
Immediate window of the Visual Basic editor.
Dim
The Dim declaration is used to declare variables and objects.
Do...Loop
The Do...Loop statement is used to repeat a set of statements an
indeterminate number of times. The execution of the statements is repeated
while a Boolean condition is true or until the condition becomes true.

OMICRON 19
CTA Remote Control Programming Manual

Exit
The Exit statement is used to exit a code block or procedure. This statement
transfers control immediately to the statement following the procedure call or
the block definition.
For...Next
For...Next structures are used to repeat statements a specified number of
times. For this purpose, it is necessary to use a counting variable the value of
which is increased or decreased with each execution of the For...Next
structure. If the specified number of executions is reached, the code following
the Next statement is executed.
For Each...Next
The For Each...Next statement repeats a block of statements for each
element of a collection or array.
Function - End Function
The Function statement declares the name, parameters, and code that
define a Function procedure. The procedure starts with a Function
statement and ends with an End Function statement.
GoTo
The GoTo statement is used to unconditionally branch to a specified code line
within a procedure.
If...Then...Else - End If
If...Then structures are used to make the execution of statements
conditional upon whether a specific condition is fulfilled. Using the additional
instruction Else, it is possible to specify what to do if the condition is not
fulfilled.
If...Then...Else structures have to be terminated with an End If
statement.
On Error
The On Error statement is used to specify what to do in case of an error.
For example, it could be used together with the GoTo statement to specify that
the program execution should continue at a specified code line in case of an
error.
Without an On Error statement, any run-time error that occurs is fatal: an
error message is displayed, and program execution stops.
Select...Case
The Select...Case statement executes one of several groups of
statements, depending on the value of an expression.
Set
The Set statement is used to assign an object reference to a variable or a
property. E.g. Set rt = cta assigns an object reference between the
variable rt and the object cta.

20 OMICRON
Operation

Stop
The Stop statement interrupts the execution of a program. This statement is
similar to setting a breakpoint in the code. The Stop statement interrupts
execution, but unlike End, it does not close any files or clear any variables.
Sub - End Sub
The Sub statement declares the name, parameters, and code that define a
Sub procedure. The procedure starts with a Sub statement and ends with an
End Sub statement.
While...Wend (or While...End While)
While...Wend structures are used to execute a statement or a series of
statements as long as a given condition is fulfilled (true). If the condition is no
longer fulfilled, the code following the Wend statement is executed.
With...End With
Using the With...End With statement you can perform a series of
statements on a specified object without requalifying the name of the object.
I.e., using this statement you can specify an object or a user-defined type once
and then use it for a series of statements.
With...End With statements can accelerate the execution of procedures
and reduce repetitive typing. A code structure starting with With has to be
terminated with an End With statement.

OMICRON 21
CTA Remote Control Programming Manual

5.3 Working in the Visual Basic editor


Working with the Visual Basic editor is described using the Visual Basic editor
®
of Microsoft Excel . However, you could also use any other Visual Basic editor
®
(e.g. of Microsoft WORD ) as an alternative.

5.3.1 Starting the Visual Basic editor


®
Start Microsoft Excel and then select Tools | Macros | Visual Basic Editor
®
from the Excel menu or press <Alt> + <F11> on the keyboard to open the
Visual Basic editor window.

Figure 4 Visual Basic editor window

5.3.2 Including the CTA Remote Type Library


The CTA Remote Type Library enables the access to the CTA remote
component of the CTA Remote Control Software. The CTA Remote Type
Library has to be included as follows in order to announce that this component
is used, i.e. to make the interfaces and functions provided by the CTA Remote
Type Library available.
1. In the Visual Basic editor window, select Tools | References.

Figure 5 Visual Basic editor window

2. The dialog "References - VBAProject" appears. In the "Available


References" list, scroll to the entry "CTARemote x.x Type Library" and click
on the checkbox in front of this entry to check it (refer to Figure 6).

22 OMICRON
Operation

Figure 6 "References - VBAProject" dialog, entry "CTARemote Type


Library" checked

3. Click OK. You'll return to the main window of the Visual Basic editor.
4. All interfaces and functions provided by the CTA Remote Type Library are
now available for programming and can be selected from the Object
browser.

OMICRON 23
CTA Remote Control Programming Manual

5.3.3 Window areas of the Visual Basic editor


Figure 7 shows the most important window areas of the Visual Basic editor.
You can show or hide individual windows using the options in the View menu.
This section gives only brief descriptions of the window areas. For detailed
information, please refer to the Visual Basic online help system.

Project explorer Code window

Properties
window

Immediate window

Figure 7 Most important window areas in the Visual Basic editor

Project explorer
The project explorer shows the projects and all elements contained in the
projects in a hierarchical tree structure. E.g. after inserting a new module, a
new element with the default name (e.g. "Module1") is displayed as an
element of the Modules folder.
Properties window
The Properties window shows the properties of the element highlighted in the
project explorer. In this window you can change the properties, e.g. give a
module a new name.
Code window
The code window contains the program code. Refer to section 5.3.5 on page
26.
Immediate window
The Immediate window can be used to display information resulting from
instructions. Refer to section 5.3.5 on page 26.

24 OMICRON
Operation

5.3.4 Inserting, renaming and deleting modules

Inserting a new module


To insert a new module in the Visual Basic editor, select Insert | Module from
the menu. A new module is inserted in the project explorer on the left and a
new code window is opened (refer to Figure 8).

Renaming a module
To rename a module, click on the corresponding module entry in the project
explorer to highlight it. The module name is then displayed in the "Name" field
of the Properties window. Click in the "Name" field and enter the new name.

Figure 8 Project explorer and properties window after inserting a new


module

Deleting a module
To delete a module, click on the corresponding module entry in the project
explorer and select File | Remove modulename.

OMICRON 25
CTA Remote Control Programming Manual

5.3.5 Working in the Visual Basic code window


This section can only give some fundamental information for working in the
Visual Basic editor. Since this is only a very small excerpt of the extensive
functionality of the Visual Basic editor, please refer to the Visual Basic online
help system for detailed information.

Writing program code


Note If not already done, include the CTA Remote Type Library (refer to
section 5.3.2 on page 22) before writing program code.

Click in the code window to position the cursor to the desired location and
enter the desired program code.
Refer to chapter 6 for descriptions of the functions provided by the CTA
Remote Control Software and code examples or chapter 9 for application
examples.
The code window of the Visual Basic editor provides the following functions in
addition to the "normal" text editor functions:
• The standard behavior of the code window (e.g. step/indent width of the tab
key, drag&drop usage) can be specified by selecting Tools | Options.
• For better clarity of the code representation, different colors are used:
Commands, instructions, data types, etc. are displayed in blue. Comments
(following an apostrophe character) are displayed in green. Incomplete
code elements or elements with syntax errors are displayed in red.
• An IntelliSense function is available for the automatic completion of code
elements known by the Visual Basic editor.
E.g. when writing a Debug.Print instruction, a corresponding selection
box appears after typing Debug. or when writing the declaration Dim cta
As New CTARemoteLib.CTA, a corresponding selection box appears
after typing Dim cta As New :

Use the arrow keys on your keyboard to select the desired entry from the
selection box and press the <Tab> key to insert it into your code.
Note You can open the IntelliSense selection box at any time by
selecting List Properties/Methods from the context menu of the
code window.

26 OMICRON
Operation

• An object browser is available containing all available objects, interfaces,


functions or methods and properties. Refer to the following subsection.

Using the object browser


To open the object browser, select View | Object Browser from the menu,
press the <F2> key or click on the object browser icon on the toolbar.

Figure 9 Object browser displaying elements of the CTA Remote Type


Library

In the upper left list box, select the entry CTARemoteLib to display all available
elements of the CTA Remote Type Library.
The "Classes" area on the left then lists all interfaces and types included in the
CTA Remote Type Library. If you click on an entry in the "Classes" list, the
"Elements of" area on the right displays all elements available for this interface
or type (functions and properties in case of a selected interface or parameters,
setting variables or values in case of a selected type).
The information area on the bottom displays the code syntax and information
about the element selected in one of the lists mentioned above.
To enter an element of the object browser into your program code, click on the
respective entry to highlight it. Select Copy from the context menu or click on
the copy button and paste it at the desired position in the code window.

Using the Immediate window


Using the Debug.Print statement you can display information in the
Immediate window. For example you could display the status during program
execution using the instruction Debug.Print cta.eStatus or display the
content of the variable xyz using the instruction Debug.Print xyz.

OMICRON 27
CTA Remote Control Programming Manual

5.3.6 Loading an existing Visual Basic program


Note The example programs delivered with the CTA Remote Control
Software were created using the Visual Basic Editor of Microsoft
®
Excel . Thus, the examples are stored in Excel files with the file
extension .xls.
®
1. If not already done, open Microsoft Excel .
2. Select File | Open from the menu. Then, select the desired file in the Open
dialog and click on OK to open the file.
3. A safety warning appears on the screen, notifying you that the file contains
macros. Click on Activate Macros to continue opening.

Figure 10 Safety Warning: File contains macros


®
4. The Microsoft Excel window is displayed with an empty Excel sheet.
Select Tools | Macros | Visual Basic editor from the menu or press <Alt>
+ <F11> on the keyboard.
5. The Visual Basic editor window appears showing the program code in the
code window.
6. Execute the program.

28 OMICRON
Operation

5.4 Creating an application program step by step


This section explains the creation of a new Visual Basic application program
step by step using a small example.
Detailed descriptions of the available interfaces and functions can be found in
chapter 6 on page 31.

5.4.1 Assumptions for the descriptions given in this


section
The following descriptions assume the following:
• A Visual Basic editor is installed on your PC.
• The CTA Remote Control Software is installed on your PC (see section 2.2
on page 12).
• The CT Analyzer is connected to the PC via USB (see section 3.2 on page
14).
• The CT Analyzer test set is switched on and ready for a new default test
using the guesser function.

5.4.2 Creating the program code

Task
In our small example program explained below we want to
• start a new default test on the CT Analyzer and
• read the CT ratio and the ratio deviation determined during the test directly
from the CT Analyzer and
• display the results in the Immediate window of the Visual Basic editor.

Program creation
Start the Visual Basic editor (refer to section 5.3.1 on page 22).
If necessary, include the CTA Remote Type Library (refer to section 5.3.2 on
page 22).
Insert a new module (refer to section 5.3.4 on page 25).
Click into the code area of the code window and proceed as follows to create
the program (refer to the code example given in Figure 11):
1. First of all, it is necessary to instantiate the CTA remote component. The
object is cta.
Dim cta As New CTARemoteLib.CTA

2. Declare a new procedure using the Sub statement. In our example we are
using the name MyCode. After pressing the <Enter> key, the End Sub
statement (which is required to close the procedure) is automatically
inserted. Enter your further code between the Sub and the End Sub
statements.
Sub MyCode()

OMICRON 29
CTA Remote Control Programming Manual

3. Connect the CTA remote component to the CT Analyzer test set connected
via USB:
cta.USBConnect

4. Start the test using the Activate function of the ICTARemoteTest


interface.
cta.Test.Activate

5. Now, we have to wait until the test results are available, i.e. until the test is
finished. In our example we are using the eStatus property of the ICTA
interface to read the status in a While-Wend loop. The loop is executed as
long as the test is running (during this time, the status is
CTA_STAT_ACTIVATED. After the test is finished, the status returns to
CTA_STAT_READY. The condition given in the While-Wend loop is no
longer fulfilled and program execution continues with the code after Wend.
While cta.eStatus = CTA_STAT_ACTIVATED
Wend

6. Read the results using the GetLiveValue function of the


ICTALiveResults interface and output them to the Immediate window
using the Debug.Print statement.
Debug.Print cta.LiveResults.GetLiveValue(RV_RATIO_DISPL_STRING)
Debug.Print cta.LiveResults.GetLiveValue(RV_RATIO_DEVIATION_PERC)

This will display the results in the Immediate window e.g. like:
200:5.0056
0.112
7. Disconnect from the CT Analyzer.
cta.Disconnect

8. The End Sub statement was inserted automatically before with the
declaration of the Sub procedure (see step 2).
End Sub

Dim cta As New CTARemoteLib.cta

Sub MyCode()

cta.USBConnect
cta.Test.Activate

While cta.eStatus = CTA_STAT_ACTIVATED


Wend

Debug.Print cta.LiveResults.GetLiveValue(RV_RATIO_DISPL_STRING)
Debug.Print cta.LiveResults.GetLiveValue(RV_RATIO_DEVIATION_PERC)

cta.Disconnect

End Sub

Figure 11 Example program code

30 OMICRON
Description of interfaces and functions

6 Description of interfaces and


functions
This chapter describes the interfaces and functions provided by the CTA
Remote Control Software. In Visual Basic, the interfaces and functions are
available in the Object browser.
The identifiers for the interfaces, types, properties and parameters follow some
naming conventions. They are prefixed by one or several lower case
characters, indicating the identifier type as follows:
Name Prefix Type
nXXX Value of a 4 byte integer number type.
bXXX Value of the type BOOLEAN (values: TRUE or FALSE).
bstrXXX Value of the type BSTR. A binary or basic string which is a
pointer to a wide character string used by automation data
functions.
eXXX Value of an enumeration type.
pXXX Value which is a pointer to a type indicated by the following
name prefix (e.g. “pn” means: pointer to a number).
IXXX Interface type.
TXXX Enumeration type.

6.1 Overview of interfaces and functions /


properties
6.3 ICTA (administrative tasks) ....................................................................36
6.3.2.1 SerialConnect .........................................................................37
6.3.2.2 USBConnect ...........................................................................38
6.3.2.3 Disconnect ..............................................................................38
6.3.2.4 UpgradeFirmware ...................................................................39
6.3.2.5 UpgradeText ...........................................................................39
6.3.2.6 UpgradeLicenses ....................................................................40
6.3.2.7 Advise .....................................................................................40
6.3.2.8 Unadvise .................................................................................42
6.3.3.1 eStatus ....................................................................................43
6.3.3.2 bstrFirmwareVersion ...............................................................43
6.3.3.3 bstrHardwareVersion ..............................................................44
6.3.3.4 bstrSoftwareVersion................................................................44
6.3.3.5 bstrSerialNumber ....................................................................44
6.3.3.6 Info ..........................................................................................45
6.3.3.7 USBDevices ............................................................................45
6.3.3.8 HasLicense .............................................................................46
6.3.3.9 MissingLicenses......................................................................46

OMICRON 31
CTA Remote Control Programming Manual

6.3.3.10 AvailableLicenses .................................................................. 47


6.3.3.11 NotAvailableLicenses............................................................. 48
6.3.3.12 AddLicenses .......................................................................... 48
6.3.3.13 Test ........................................................................................ 48
6.3.3.14 Settings .................................................................................. 49
6.3.3.15 Results ................................................................................... 49
6.3.3.16 LiveResults ............................................................................ 49
6.3.3.17 FileTransfer ............................................................................ 50
6.3.3.18 Directory ................................................................................. 50
6.3.3.19 Calculate ................................................................................ 50
6.3.3.20 Quick ...................................................................................... 50
6.4 ICTAInfo (device information) ............................................................ 51
6.4.2.1 Clear....................................................................................... 52
6.4.3.1 eClass .................................................................................... 52
6.4.3.2 nNumber ................................................................................ 52
6.4.3.3 nLocation ............................................................................... 53
6.4.3.4 bstrDescription ....................................................................... 53
6.4.3.5 nMeasurementInfo ................................................................. 53
6.5 ICTASettings (specifying test settings) ............................................. 55
6.5.2.1 LocalLoadSettings ................................................................. 56
6.5.2.2 LocalSaveSettings ................................................................. 56
6.5.2.3 ClearSettings ......................................................................... 57
6.5.2.4 GetValue ................................................................................ 57
6.5.2.5 SetValue ................................................................................ 58
6.6 ICTARemoteTest (test execution on the CT Analyzer) ...................... 59
6.6.2.1 RemoteLoadReport................................................................ 59
6.6.2.2 RemoteSaveReport ............................................................... 60
6.6.2.3 Activate .................................................................................. 60
6.6.2.4 Deactivate .............................................................................. 62
6.6.2.5 LoadRefExcitationCurve ........................................................ 63
6.6.2.6 LockDevice ............................................................................ 63
6.6.2.7 UnlockDevice ......................................................................... 63
6.7 ICTAFileTransfer (file exchange) ................................................... 64
6.7.2.1 CopyToCTA ........................................................................... 64
6.7.2.2 CopyFromCTA ....................................................................... 65
6.8 ICTARemoteDirectory (file management on the CT Analyzer) ....... 66
6.8.2.1 QueryFileItems....................................................................... 66
6.8.2.2 FileMove ................................................................................ 68
6.8.2.3 FileRename............................................................................ 68
6.8.2.4 FileCopy ................................................................................. 68
6.8.2.5 FileRemove ............................................................................ 69
6.8.2.6 DirectoryCreate ...................................................................... 69
6.8.2.7 DirectoryRemove ................................................................... 69
6.8.2.8 FormatDisk ............................................................................. 69

32 OMICRON
Description of interfaces and functions

6.9 ICTAResults (reading test results from a test report) .........................71


6.9.2.1 LocalLoadReport.....................................................................72
6.9.2.2 GetValue .................................................................................72
6.9.2.3 GetIndexedValue ....................................................................73
6.9.2.4 GetIndexedValues ..................................................................74
6.9.2.5 GetCompositeError .................................................................75
6.9.2.6 GetPhaseDeviation .................................................................76
6.9.2.7 GetRatioDeviation ...................................................................77
6.9.2.8 GetMaxPrimaryCurrent ...........................................................78
6.9.2.9 GetISec ...................................................................................79
6.9.2.10 GetErrorDescription ................................................................79
6.9.2.11 SetValue .................................................................................80
6.9.2.12 LocalSaveReport ....................................................................81
6.9.2.13 IsReportSecure .......................................................................81
6.9.2.14 GetAssessInfo.........................................................................81
6.10 ICTALiveResults (reading test results directly from the CTA) ..........83
6.10.2.1 GetLiveValue ..........................................................................84
6.10.2.2 GetLiveIndexedValue .............................................................84
6.10.2.3 GetLiveIndexedValues ............................................................85
6.10.2.4 GetLiveErrorDescription .........................................................86
6.11 ICTACalc (enhanced calculation of results) .........................................87
6.11.2.1 EvalCompositeError ................................................................89
6.11.2.2 EvalPhaseDeviation ................................................................90
6.11.2.3 EvalRatioDeviation..................................................................91
6.11.2.4 EvalSecondaryCurrent ............................................................92
6.11.2.5 EvalMaxPrimaryCurrent ..........................................................93
6.11.2.6 EvalExcitationCurrentRms ......................................................94
6.11.2.7 EvalExcitationCurrentPeak .....................................................95
6.11.2.8 EvalCoreVoltage .....................................................................96
6.11.2.9 EvalExcitationCurrentRmsAtVcore .........................................97
6.11.2.10 EvalExcitationCurrentRmsAtVTerm........................................98
6.11.2.11 EvalExcitationCurrentPeakAtVcore ........................................99
6.11.2.12 EvalVTermAtExcitationCurrentRms......................................100
6.11.2.13 EvalVCoreAtExcitationCurrentRms ......................................101
6.11.2.14 EvalVCoreAtExcitationCurrentPeak .....................................102
6.11.2.15 AL_MaxPrimaryCurrent ........................................................103
6.11.2.16 AL_MaxImpedance ...............................................................104
6.11.2.17 AL_ImpedanceAtPrimaryCurrent ..........................................105
6.11.2.18 AL_PrimaryCurrentAtImpedance ..........................................106
6.11.2.19 AL_PrimaryCurrentAtNomBurden ........................................107
6.11.2.20 AL_PrimaryCurrentAtOprBurden ..........................................108
6.12 ICTAQuick (Quick measurement device) ...........................................109
6.12.2.1 SetSetting .............................................................................110
6.12.2.2 GetSetting .............................................................................111
6.12.2.3 GetResult ..............................................................................111

OMICRON 33
CTA Remote Control Programming Manual

6.12.2.4 GetV1Results ....................................................................... 112


6.12.2.5 GetV2Results ....................................................................... 112
6.12.2.6 GetI1Results ........................................................................ 113
6.12.2.7 GetCalculatedResults .......................................................... 114
6.12.2.8 StartMeasurement ............................................................... 115
6.12.2.9 StopMeasurement................................................................ 115
6.12.2.10 Status ................................................................................... 116

6.2 Description of the syntax given for the


functions and properties
Since programming is possible using many different programming languages,
the syntax of the functions and properties given in this chapter is represented
in a neutral form as explained below.

6.2.1 Syntax of functions


The syntax of functions is given as follows:
Function FunctionName([direction]Datatype Parametername)
or
Function FunctionName([direction]Datatype
Parametername):Datatype
Explanation:
Function Points out that it is a function.
FunctionName Name identifier of the function, e.g.
LocalLoadSettings.
() The parameters and information about the parameters are
enclosed in round brackets.
[direction] Specifies the direction of value transfer:
in (input for the CTA remote component) or
out (output of the CTA remote component)
Datatype Specifies the data type of the parameter, e.g. String.
Parametername Identifier of the parameter (e.g. LocalPath). The content
this parameter stands for is described under "Parameters"
(in case of LocalPath: full path on the PC).
:Datatype Optional. If functions return a value, its type is given after a
final colon. Otherwise it’s left blank.
If the function requires more than one parameter, the parameters are
separated by a comma, e.g.
([direction]Datatype Param1, [direction]Datatype Param2).
If a parameter is optional, the data type and the parameter name are enclosed
in square brackets, e.g. ([direction][Datatype Parameter1]).

34 OMICRON
Description of interfaces and functions

6.2.2 Syntax of properties


The syntax of properties is given as follows:
Property PropertyName : Datatype [read-only]
Explanation:
Property Points out that it is a property.
PropertyName Name identifier of the property, e.g. eStatus.
: Separator between name and type used in this syntax
representation.
Datatype Specifies the data type (e.g. Long, String or type
specified in the library, e.g. TCTAStatus).
[read-only] Optional. Specifies that the value is read-only.

OMICRON 35
CTA Remote Control Programming Manual

6.3 ICTA (administrative tasks)


In order to use the functions of the ICTA interface, the CTA remote component
has to be instantiated in the program, e.g. using the declaration
Dim cta As New CTARemoteLib.CTA

6.3.1 Overview of functions and properties


Functions Brief description
SerialConnect Establishes the connection to the CT Analyzer test
set connected to the serial interface.
USBConnect Establishes the connection to the CT Analyzer test
set connected via USB.
Requires the serial number of the CT Analyzer, if
more than one test set is connected via USB.
Disconnect Terminates the connection to the CT Analyzer.
UpgradeFirmware Upgrading the CT Analyzer firmware.
UpgradeText Upgrading the language texts on the CT Analyzer.
UpgradeLicenses Upgrading the licenses on the CT Analyzer.
AddLicenses Used to perform an upgrade of the licenses on the
CT Analyzer.
Advise Registration for event notification from the
CT Analyzer, used for asynchronous handling of error
and status messages.
Unadvise Deregistration of event notifications.

Properties Brief description


eStatus Device status.
bstrFirmwareVersion Firmware version of the CT Analyzer.
bstrHardwareVersion Hardware version of the CT Analyzer.
bstrSoftwareVersion Version of the CTA Remote Control Software.
bstrSerialNumber Serial number of the CT Analyzer.
Info A record containing device information.
USBDevices Accesses the list of serial numbers of all CT Analyzer
test sets connected via USB.
HasLicense Used to query whether certain licenses are available
on the CT Analyzer.
MissingLicenses Returns an array of license-values which are missing
to start a measurement on the CT Analyzer.
AvailableLicenses Reads a list of actual available licenses.
NotAvailableLicenses Reads a list of not available licenses.
Settings Access to the ICTASettings interface for querying and
defining the test settings.

36 OMICRON
Description of interfaces and functions

Properties Brief description


Results Access to the ICTAResults interface for querying test
results.
LiveResults Access to the ICTALiveResults interface.
FileTransfer Access to the ICTAFileTransfer interface.
Directory Access to the ICTARemoteDirectory interface.
Calculate Access to the ICTACalc interface
Quick Access to the ICTAQuick interface

6.3.2 Description of functions

6.3.2.1 SerialConnect
Scope ICTA
Syntax Function SerialConnect([in]long nSCCline)
Description Establishes a connection between the CTA remote
component and the CT Analyzer test set connected to a
serial interface of the PC.
If the connection is established successfully, the
connection status changes from
CTA_STAT_NOT_CONNECTED to CTA_STAT_READY or
CTA_STAT_WAIT_FOR_ACKNOWLEDGE (refer to property eStatus
on page 43) and the CT Analyzer display shows a
corresponding connection symbol.
Parameters nSCCLine
Number of serial interface (1 for COM1, etc.).
Example in VB Dim cta as New CTARemoteLib.CTA
cta.SerialConnect 1
Connects to the CT Analyzer at serial port 1.
Example in C++ ICTAPtr cta(CLSID_CTA);
cta->SerialConnect(1);

OMICRON 37
CTA Remote Control Programming Manual

6.3.2.2 USBConnect
Scope ICTA
Syntax Function USBConnect([in,optional]string
bstrDeviceName)
Description Establishes a connection between the CTA remote
component and a CT Analyzer test set connected to the
PC via USB.
When the connection is established successfully, the
connection status changes from
CTA_STAT_NOT_CONNECTED to CTA_STAT_READY or
CTA_STAT_WAIT_FOR_ACKNOWLEDGE (refer to property
eStatus on page 43) and the CT Analyzer display shows a
corresponding connection symbol.
Parameters bstrDeviceName
Optional Parameter.
Six character serial number of the CT Analyzer test set
according to the nameplate.
Note:
If only one CT Analyzer test set is connected via USB, no
parameter is required. If several test sets are connected
via USB, you have to specify the serial number of the
CT Analyzer to be accessed.
Read the serial number from the nameplate of the
CT Analyzer or retrieve it by means of the USBDevices
property.
Example in VB cta.USBConnect
Connects to the CT Analyzer connected via USB. No
parameter is necessary, if only one CT Analyzer is
connected.
cta.USBConnect "AI153T"
Connects to test set AI153T (if more than one CT Analyzer
is connected via USB).
Example in C++ HRESULT hr = cta->USBConnect(_bstr_t(L”AI153T”));
if (SUCCEEDED(hr)) { … }
6.3.2.3 Disconnect
Scope ICTA
Syntax Function Disconnect()
Description Terminates the connection to the CT Analyzer. After the
connection is terminated, the connection status changes to
CTA_STAT_NOT_CONNECTED (refer to property eStatus on
page 43) ) and the connection symbol disappears from the
CT Analyzer display.
Example in VB cta.Disconnect

Example in C++ cta->Disconnect();

38 OMICRON
Description of interfaces and functions

6.3.2.4 UpgradeFirmware
Scope ICTA
Syntax Function UpgradeFirmware([in]string
bstrFile)
Description Used to perform an upgrade of the firmware on the
CT Analyzer.
Copies the firmware file from the specified path on the PC
to the Compact Flash card of the CT Analyzer and then
automatically performs the firmware upgrade on the
CT Analyzer.
Blocks the further program execution until the firmware
update process is finished. This can take several minutes.
The file is transferred to a temporary location and is
renamed when the transmission has successfully
completed. However, for reasons of security, do not
disconnect the cable between CT Analyzer and PC or
switch off the CT Analyzer during this process.
Parameters pbstrFile
Full path to the file CTAnalyzer.bin on the PC.
Example in VB cta.UpgradeFirmware "D:\CTA\Firmware\CTAnalyzer.bin"

Example in C++ cta-


>UpgradeFirmware(_bstr_t(L”D:\CTA\Firmware\CTAnalyzer.
bin”));
6.3.2.5 UpgradeText
Scope ICTA
Syntax Function UpgradeText([in]string bstrFile)
Description Used to perform an upgrade of the language text on the
CT Analyzer.
Copies the firmware file from the specified path on the PC
to the Compact Flash card of the CT Analyzer and then
automatically upgrades the language text on the device.
Blocks the further program execution until the firmware
update process is finished. This can take some minutes.
The file is transferred to a temporary location and is
renamed when the transmission has successfully
completed. However, for reasons of security, do not
disconnect the cable between CT Analyzer and PC or
switch off the CT Analyzer during this process.
Parameters pbstrFile
Full path to the language text file on the PC.
Example in VB cta.UpgradeFirmware
"D:\CTA\Firmware\CTUser_V1_04_FRA.bin"
Example in C++ cta-
>UpgradeFirmware(_bstr_t(L”D:\CTA\Firmware\CTUser_V1_0
4_FRA.bin”));

OMICRON 39
CTA Remote Control Programming Manual

6.3.2.6 UpgradeLicenses
Scope ICTA
Syntax Function UpgradeLicenses([in]string
bstrFile)
Description Used to perform an upgrade of the licenses on the
CT Analyzer.
Copies the license file from the specified path on the PC to
the Compact Flash card of the CT Analyzer and then
automatically upgrades the licenses on the device.
Blocks the further program execution until the license
update process is finished.
Handle with care!
All existing licenses on the CT Analyzer will be overwritten.
Parameters bstrFile
Full path to the license file on the PC.
Example in VB cta.UpgradeLicenses "D:\CTA\LicenseBB170U.lic"

Example in C++ cta-


>UpgradeLicenses(bstr_t(L”D:\CTA\LicenseBB170U.lic”));

6.3.2.7 Advise
Scope ICTA
Syntax Function Advise([in]ICTAEvents
objCallback): long
Description Used to register for asynchronous event notification.
Whenever changes in the device status (see eStatus on
page 43) occur or new information is available, the
CT Analyzer reports them by calling the appropriate
functions in the callback object.
Only one object can be registered at the same time. The
caller of Advise() has to implement the ICTAEvents
interface (this interface is not separately described).
The returned value needs to be passed when calling
Unadvise().
Hint: It is difficult to use this feature with VB6 or VBA (used
in Excel), because these programming languages are not
designed for asynchronous operation. Therefore, it is
recommended to do without this function when using these
programming languages.
Using synchronous mechanisms instead, it is possible to
solve any task without exploiting this feature and without
any drawback for the system (refer to chapter Error
handling on page 205).
Parameters objCallback
An object of type ICTAEvents. The interface has to be
implemented by the calling application.

40 OMICRON
Description of interfaces and functions

Return value A cookie is returned which identifies the advising


application. This cookie has to be passed to a successive
call to Unadvise().
Example in VB No example is given here.
Example in C++ Refer to the following code:

// include CTARemote support


#include <atlbase.h>
#include <CTARemote.h>
#include <CTARemote_i.c>
// implementation of ICTAEvents callback interface
CComModule _Module;

class CCTACallback :
public
ComObjectRootEx<CComMultiThreadModelNoCS>,
public ICTAEvents
{
public:
DECLARE_AGGREGATABLE(CCTACallback)
DECLARE_PROTECT_FINAL_CONSTRUCT()

BEGIN_COM_MAP(CCTACallback)
COM_INTERFACE_ENTRY(ICTAEvents)
END_COM_MAP()
// ICTAEvents
public:
STDMETHODIMP OnStatusNotification(ICTA* pCTA, TCTAStatus eStat, long nInfo = 0)
{
switch (eStat) {
case CTA_STAT_NOT_CONNECTED: // TODO: add implementation
_tprintf(_T("\t <disconnected>\n"));
break;

case CTA_STAT_READY: // TODO: add implementation


_tprintf(_T("\t <ready>\n"));
break;

case CTA_STAT_WAIT_FOR_ACKNOWLEDGE: // TODO: add implementation


_tprintf(_T("\t <wait for ack>\n"));
break;

case CTA_STAT_ACTIVATED: // TODO: add implementation


_tprintf(_T("\t <activated>\n"));
break;

case CTA_STAT_PAUSED: // TODO: add implementation


_tprintf(_T("\t <paused>\n"));
_tprintf(_T("\t please rewire the connectors and <press any key>"), nInfo);
_gettchar();
// pCTA->Activate is automatically called when the pause notification handler
returns S_OK
break;

default:
_tprintf(_T("\t <unknown CTA notification: %d>\n"), eStat);
}//endswitch
return S_OK;

OMICRON 41
CTA Remote Control Programming Manual

}// OnCTANotification
STDMETHODIMP OnInfoNotifiation(ICTA* pCTA, TCTAInfoClass eErrorClass, long nErrorCode,
long nErrorLocation, BSTR bstrErrorDescription)
{
_tprintf(_T("\t * %s: number %d, location %d: %s\n"), GetErrorClassString(eErrorClass),
nErrorCode, nErrorLocation, bstrErrorDescription);
return S_OK;
}// OnCTAError
};// CCTACallback

...

// create a callback object


CComObject<CCTACallback>* pEventSink = 0;
hr = pEventSink->CreateInstance(&pEventSink);
// advise the callback object
long nSinkCookie;
hr = pCTA->Advise(pEventSink, &nSinkCookie);

6.3.2.8 Unadvise
Scope ICTA
Syntax Function Unadvise([in]long nCookie)
Description Deregisters the asynchronous event sink. The cookie
retrieved from the previous call to Advise() has to be
passed.
Parameters nCookie
The cookie returned from the previous call of Advise().
Example in VB No example is given here. See description for Advise()
above.
Example in C++ cta->Unadvise(nSinkCookie);

42 OMICRON
Description of interfaces and functions

6.3.3 Description of properties


6.3.3.1 eStatus
Scope ICTA
Syntax Property eStatus : TCTAStatus [read-only]
Description This function is used to query the device status. The
possible states are:
• CTA_STAT_NOT_CONNECTED
• CTA_STAT_READY
• CTA_STAT_ACTIVATED
• CTA_STAT_WAIT_FOR_ACKNOWLEDGE
• CTA_STAT_PAUSED
Return value Current device status (element of the type TCTAStatus,
see page 125).
Example in VB Debug.Print cta.eStatus
Displays the current status in the Immediate window of the
Visual Basic editor.
Dim s As TCTAStatus
s = cta.eStatus
If s = CTA_STAT_READY Then

The instructions following Then are only executed if the
connection status is CTA_STAT_READY.
Example in C++ TCTAStatus eStatus;
if (SUCCEEDED(cta->get_eStatus(&eStatus)) && eStatus
== CTA_STAT_READY) {

}

6.3.3.2 bstrFirmwareVersion
Scope ICTA
Syntax Property bstrFirmwareVersion : string
[read-only]
Description Used to query the firmware version of the CT Analyzer.
Return value Firmware version number.
This string has the following format: "m.n"
m is the major and n the minor version number
Example in VB Dim strVer As string
strVer = cta.bstrFirmwareVersion
Debug.Print strVer
Displays the firmware version in the Immediate window of
the Visual Basic editor.
Example in C++ printf(L"FWVersion %s", cta->bstrFirmwareVersion);

OMICRON 43
CTA Remote Control Programming Manual

6.3.3.3 bstrHardwareVersion
Scope ICTA
Syntax Property bstrHardwareVersion : string
[read-only]
Description Used to query the hardware version of the CT Analyzer.
Return value String containing the hardware version number in the
following format: "aa/bb/cc/dd/ee".
Each part indicates the version of an internal device part.
Example in VB Debug.Print cta.bstrHardwareVersion

Example in C++ printf(L"HWVersion %s", cta->bstrHardwareVersion);

6.3.3.4 bstrSoftwareVersion
Scope ICTA
Syntax Property bstrSoftwareVersion : string
[read-only]
Description Used to query the software version of the CTA Remote
Control Software.
Return value Software version number.
Example in VB Debug.Print cta.bstrSoftwareVersion

Example in C++ printf(L"SWVersion %s", cta->bstrSoftwareVersion);

6.3.3.5 bstrSerialNumber
Scope ICTA
Syntax Property bstrSerialNumber : string [read-
only]
Description Used to query the serial number of the CT Analyzer.
Return value Serial number of the CT Analyzer.
Example in VB Dim sernum As String
sernum = cta.bstrSerialNumber
Debug.Print sernum
Displays the serial number in the Immediate window of the
Visual Basic editor.
Example in C++ printf(L"Serial %s", cta->bstrSerialNumber);

44 OMICRON
Description of interfaces and functions

6.3.3.6 Info
Scope ICTA
Syntax Property Info : ICTAInfo [read-only]
Description Used to access device messages through the ICTAInfo
interface. A message can be an operating error, a warning
or a hint.
Return value Access to the ICTAInfo interface (page 51).
Example in VB If cta.Info.eClass = CTA_INFO_CLS_ERROR Then
msgbox cta.Info.bstrDescription
End If
cta.Info.Clear
Example in C++ if (cta->Info->eClass == CTA_INFO_CLS_ERROR) {
_tprintf(_T("uuhps: %s"), cta->Info->bstrDescription);
}
cta->Info->Clear();

6.3.3.7 USBDevices
Scope ICTA
Syntax Property USBDevices : IUSBDevices [read-
only]
Description Used to access the list of serial numbers of all CT Analyzer
test sets connected via USB. This function returns the
IUSBDevices interface (this interface is not described
separately but the example below should suffice).
If more than one device is connected via USB, the serial
number of the desired device is passed to the
USBConnect() function. Otherwise, the first device found
on the USB bus is used.
Return value Access to the IUSBDevices interface.
Example in VB cta.USBDevices.Refresh
For i = 0 To cta.USBDevices.Count - 1
Debug.Print "CTA Device: "
cta.USBDevices.Item2(i).bstrSerialNumber
Next
Explanation of the example:
With each execution of the For-Next loop, the serial
number of one CT Analyzer connected via USB is
displayed in the Immediate window of the Visual Basic
editor (e.g. "CTA Device: AI153T"). The value i is
increased by 1 with each execution until all CT Analyzer
test sets detected on the USB bus are listed. After this, the
program code following Next is executed.

OMICRON 45
CTA Remote Control Programming Manual

Example in C++ _tprintf(_T("enumerating USB devices...\n"));


_HR(pCTA->USBDevices->Refresh());
for (int i = 0; i < pCTA->USBDevices->Count; ++i) {
_tprintf(_T("'%s'\n"), BSTR(pCTA->USBDevices-
>Item2[i]->bstrSerialNumber));
}

6.3.3.8 HasLicense
Scope ICTA
Syntax Function HasLicense([in] TCTALicense eLic):
BOOL
Description Used to query whether a certain functionality or feature is
licensed on the CT Analyzer. The CT Analyzer must be
connected.
Parameters eLic
License to be queried (element of TCTALicense, see page
123.
Return value True, if license exists. Otherwise False is returned.
If the CT Analyzer is not connected, an error is returned.
Example in VB If cta.HasLicense(CTA_LIC_RATIO_CARD) Then
' enable ratio card
cta.Settings.SetValue SV_CARD_RATIO, True
End If
Example in C++ BOOL bLicensed = cta->HasLicense(CTA_LIC_RATIO_CARD);
if (bLicensed) {
cta->Settings->SetValue(SV_CARD_RATIO, TRUE);
}

6.3.3.9 MissingLicenses
Scope ICTA
Syntax Function MissingLicenses(): Variant
Description Reads a list of missing licenses.
These licenses prevent a start of a certain measurement
on the CT Analyzer.
Apply this Command just before an
"ICTARemoteTest.Activate" Command, to consider if you
can start a measurement.
Parameters
Return value List of license ID's.
See enum TCTALicense.

46 OMICRON
Description of interfaces and functions

Example in VB Dim v As Variant


v = MissingLicenses
Debug.Print "Number of licenses ="; UBound(v) –
IBound(v)
If UBound(v) <> -1 Then
For i = 0 To UBound(v)
Debug.Print "L ["; i; "]"; v(i)
Next i
End If

6.3.3.10 AvailableLicenses
Scope ICTA
Syntax Function AvailableLicenses(): Variant
Description Reads a list of actual available licenses.
These licenses are enabled on the CT Analyzer.
Parameters
Return value List of license ID's.
See enum TCTALicense.
Example in VB Dim v As Variant
v = AvailableLicenses
Debug.Print "Number of licenses ="; UBound(v) –
IBound(v)
If UBound(v) <> -1 Then
For i = 0 To UBound(v)
Debug.Print "L ["; i; "]"; v(i)
Next i
End If

OMICRON 47
CTA Remote Control Programming Manual

6.3.3.11 NotAvailableLicenses
Scope ICTA
Syntax Function NotAvailableLicenses(): Variant
Description Reads a list of not available licenses.
Parameters
Return value List of license ID's.
See enum TCTALicense.
Example in VB Dim v As Variant
v = NotAvailableLicenses
Debug.Print "Number of licenses ="; UBound(v) –
IBound(v)
If UBound(v) <> -1 Then
For i = 0 To UBound(v)
Debug.Print "L ["; i; "]"; v(i)
Next i
End If

6.3.3.12 AddLicenses
Scope ICTA
Syntax Function AddLicenses([in]string bstrFile)
Description Used to perform an upgrade of the licenses on the
CT Analyzer.
Copies the license file from the specified path on the PC to
the Compact Flash card of the CT Analyzer and then
automatically upgrades the licenses on the device.
Blocks the further program execution until the license
update process is finished.
Unlike UpgradeLicensis() this function keeps the existing
licenses on the CT Analyzer and adds only the new
licenses.
Parameters bstrFile
Full path to the license file on the PC.
Example in VB cta.AddLicenses "D:\CTA\License.lic"

Example in C++ cta->AddLicenses(bstr_t(L”D:\CTA\License.lic”));

6.3.3.13 Test
Scope ICTA
Syntax Property Test : ICTARemoteTest [read-only]
Return value Access to the ICTARemoteTest interface (page 59).
Example in VB cta.Test.Activate

Example in C++ cta->Test->Activate();

48 OMICRON
Description of interfaces and functions

6.3.3.14 Settings
Scope ICTA
Syntax Property Settings : ICTASettings [read-
only]
Return value Access to the ICTASettings interface (page 55).
Example in VB cta.Settings.LocalLoadSettings "mysettings.xml"
cta.Settings.SetValue SV_SER_NR, "1234567"
cta.Settings.LocalSaveSettings "mysettings.xml"
Example in C++ #import <CTARemote.tlb> no_namespace named_guids
ICTAPtr cta(CLSID_CTA);
cta->Settings-
>LocalLoadSettings(_bstr_t(L"mysettings.xml"));
cta->Settings->SetValue(SV_SER_NR,
_variant_t(L"1234567"));
cta->Settings-
>LocalSaveSettings(_bstr_t(L"mysettings.xml"));

6.3.3.15 Results
Scope ICTA
Syntax Property Results : ICTAResults [read-only]
Return value Access to the ICTAResults interface (page 71).
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport "myreport.xml"
Debug.Print
cta.Results.GetValue(RV_GENERAL_XML_FILE_VERSION)
Example in C++ #import <CTARemote.tlb> no_namespace named_guids
ICTAPtr cta(CLSID_CTA);
cta->Results-
>LocalLoadReport(_bstr_t(L"myreport.xml"));
_tprintf(_T("%s"), cta->Results-
>GetValue(RV_GENERAL_XML_FILE_VERSION));

6.3.3.16 LiveResults
Scope ICTA
Syntax Property LiveResults : ICTALiveResults
[read-only]
Return value Access to the ICTALiveResults interface (page 83).
Example in VB Dim cta as new CTA
Debug.Print
cta.Results.GetValue(RV_OBJECT_CT_MANUFACTURER)
Example in C++ ICTAPtr cta(CLSID_CTA);
_tprintf(_T("%s"), cta->Results-
>GetValue(RV_OBJECT_CT_MANUFACTURER));

OMICRON 49
CTA Remote Control Programming Manual

6.3.3.17 FileTransfer
Scope ICTA
Syntax Property FileTransfer : ICTAFileTransfer
[read-only]
Return value Access to the ICTAFileTransfer interface (page 64).
Example in VB cta.FileTransfer.CopyToCTA "localfile.xml",
"remotefile.xml"
Example in C++ cta->FileTransfer-
>CopyToCTA(_bstr_t(L"localfile.xml"),
_bstr_t(L"remotefile.xml"));

6.3.3.18 Directory
Scope ICTA
Syntax Property Directory : ICTARemoteDirectory
[read-only]
Return value Access to the ICTARemoteDirectory interface (page 66).
Example in VB cta.Directory.FileRename "ctafileold.xml",
"ctafilenew.xml"
Example in C++ cta->Directory.FileRename(_bstr_t(L"ctafileold.xml"),
_bstr_t(L"ctafilenew.xml"));

6.3.3.19 Calculate
Scope ICTA
Syntax Property Calculate : ICTACalc [read-only]
Return value Access to the ICTACalc interface (page 87).
Example in VB Dim cta as new CTA
Dim status As TCTAQualifier
Dim dbResult As Double
dbResult = cta.Calculat.EvalCompositeError (1000, 15,
1, status)
Debug.Print dbResult
Example in C++ #import <CTARemote.tlb> no_namespace named_guids
ICTAPtr cta(CLSID_CTA);
TCTAQualifier status;
double result = cta->Calculate-
>EvalCompositeError(1000, 15, 1, &status);
printf("%f", result);

6.3.3.20 Quick
Scope ICTA
Syntax Property Quick : ICTAQuick [read-only]
Return value Access to the ICTAQuick interface (page 109).
Example in VB cta.Quick.StartMeasurement

50 OMICRON
Description of interfaces and functions

6.4 ICTAInfo (device information)


The ICTAInfo interface is accessed through the ICTA::Info property.
Whenever a hint, a warning or an error condition occurs, the information is
stored in this object. Fault conditions of higher severity overwrite conditions of
a lower severity. The information needs to be cleared explicitly using the
Clear() function.
In case of warnings and errors, the Error object is set and, if no statement like
On Error Resume Next
is used, the Visual Basic runtime system is halted.

6.4.1 Overview of functions and properties


Function Brief description
Clear Clears the device information. eClass, nNumber,
nLocation and bstrDescription is reset, unless
another device information is pending.

Property Brief description


eClass Information class: error, warning, tooltip, hint or none.
nNumber Information number.
nLocation Information location.
bstrDescription Verbose information about the information number.
nMeasurementInfo Details about the internal device operation.

OMICRON 51
CTA Remote Control Programming Manual

6.4.2 Description of functions

6.4.2.1 Clear
Scope ICTAInfo
Syntax Function Clear()
Description Resets the device information.
Parameters none
Example in VB cta.Info.Clear

Example in C++ cta->Info->Clear();

6.4.3 Description of properties

6.4.3.1 eClass
Scope ICTAInfo
Syntax Property eClass : TCTAInfoClass
Description Returns the error class. If no error or information is
available, CTA_INFO_CLS_NONE is returned.
Return value Error class (element of TCTAInfoClass, see page 122).
Example in VB Debug.Print cta.Info.eClass

Example in C++ printf("%d", cta->Info->eClass);

6.4.3.2 nNumber
Scope ICTAInfo
Syntax Property nNumber : integer
Description Returns the error/information number.
Return value Error/information number (refer to the CT Analyzer User
Manual). With this number the error description can be
found in the User Manual.
Example in VB Debug.Print cta.Info.nNumber

Example in C++ printf("%d", cta->Info->nNumber);

52 OMICRON
Description of interfaces and functions

6.4.3.3 nLocation
Scope ICTAInfo
Syntax Property nLocation : integer
Description Provides further details about the error condition. This
information is important for OMICRON to determine the
exact reason of the error.
Return value Location number. Location in the software where the error
was detected. Necessary to determine the exact cause of
error. This value is necessary for OMICRON Support to
exactly determine where the error was generated in the
software.
Example in VB Debug.Print cta.Info.nLocation

Example in C++ printf("%d", cta->Info->nLocation);

6.4.3.4 bstrDescription
Scope ICTAInfo
Syntax Property bstrDescription : string
Description A verbose description of the error condition. Only available
in English.
Return value Returns the descriptive string.
Example in VB Debug.Print cta.Info.bstrDescription

Example in C++ printf("%s", cta->Info->bstrDescription);

6.4.3.5 nMeasurementInfo
Scope ICTAInfo
Syntax Property nMeasurementInfo :
TCTAMeasurementInfo
Description This property provides detailed information about the
current CT Analyzer operation. This information can be
queried at any time (not only in context with an error
condition) to see what the device is currently doing.

OMICRON 53
CTA Remote Control Programming Manual

Return value Integer value with the following meaning:


Name Value Meaning
(range)
MI_NO_MEAS 0 No measurement routine is currently
active.
MI_AC_TEST 5 An AC test is running.
MI_AUTO_CAL 6 An auto calibration is in progress.
MI_WIRING_BUR 7 Device is waiting for wiring check
prior to burden test.
MI_WIRING_CT 8 Device is waiting for wiring check
prior to resistance test.
MI_MEAS_DEMAG 10 Demagnetization process is running.
MI_MEAS_BUR 20 - 29 nMEasurementInfo
>= MI_MEAS_BUR and
< MI_MEAS_RES indicates that the
CT Analyzer is currently measuring
the burden.
MI_MEAS_RES 30 - 39 nMEasurementInfo
>= MI_MEAS_RES and
< MI_MEAS_EXC indicates that the
CT Analyzer is currently measuring
the winding resistance.
MI_MEAS_EXC 40 - 69 nMEasurementInfo
>= MI_MEAS_EXC and <
MI_MEAS_RAT indicates that the
CT Analyzer is currently measuring
the excitation characteristics.
MI_MEAS_RAT 70 - 79 nMEasurementInfo
>= MI_MEAS_RAT and
< MI_MEAS_RESERVED indicates
that the CT Analyzer is currently
measuring the ratio.
MI_MEAS_ >= 80 nMEasurementInfo
RESERVED >= MI_MEAS_RESERVED is
reserved for future use.

Example in VB Debug.Print cta.Info.nMeasurementInfo

Example in C++ printf("%d", cta->Info->nMeasurementInfo);

54 OMICRON
Description of interfaces and functions

6.5 ICTASettings (specifying test settings)


The ICTASettings interface is accessed through the ICTA::Settings
property.
Test settings files (test definitions) and test report files are of the same file
structure and have the same file extension (.XML). The difference is that
settings files do not contain any test results and therefore have a much smaller
file size. Using ICTARemoteTest::RemoteLoadReport(), the CT Analyzer is
able to load both file types, settings files and report files.
Similarly, the difference between the functions LocalSaveSettings() and
LocalLoadSettings() is that the former is only able to save settings files while
the latter is able to load settings files and report files. However, when loading
report files using LocalLoadSettings(), the results contained in the report
files are lost.
Please note that the internal handling of setting values differs from the
handling of the result values. In fact, they are kept in distinct memory areas
without any interrelation. For example, it is possible to load and manipulate the
settings of one file and at the same time load the results of another file.
Note All functions in ICTASettings can be executed offline, without a
CT Analyzer test set connected.

6.5.1 Overview of functions


Function Brief description
LocalLoadSettings Load a settings file or a report file from a local drive on
the PC.
LocalSaveSettings Save a settings file (test definitions) to a local drive on the
PC.
ClearSettings Reset all setting values to the default values.
GetValue Read the value of a particular test setting.
SetValue Set the value of a particular test setting.

OMICRON 55
CTA Remote Control Programming Manual

6.5.2 Description of functions

6.5.2.1 LocalLoadSettings
Scope ICTASettings
Syntax Function LocalLoadSettings([in]string
LocalPath)
Description Loads a settings file (test definition) from a local drive on
the PC.
After this, the individual settings can be queried using the
GetValue() function, changed using SetValue() and
stored again using LocalSaveSettings().
Using this function, it is possible to load settings files and
test report files, since both file types share the same file
structure and format (XML). The difference is that test
report files contain test results in addition to the test
settings.
When loading a test report file using this function, all test
results contained in this file are discarded, and will be lost
when calling LocalSaveSettings().
Parameters LocalPath (full path to the settings file on the PC)
Example in VB Dim sett As ICTASettings
set sett = cta.Settings
sett.LocalLoadSettings "D:\CTA_Test\settings1.xml"
Example in C++ cta->Settings->LocalLoadSettings
(_bstr_t(L"D:\CTA_Test\settings1.xml"));

6.5.2.2 LocalSaveSettings
Scope ICTASettings
Syntax Function LocalSaveSettings([in]string
LocalPath)
Description Saves a settings file (test definition, file extension .XML) to
a local drive on the PC.
Parameters LocalPath (full path on the PC and file name)
Example in VB cta.Settings.LocalSaveSettings
"D:\CTA_Test\settings2.xml"
Example in C++ cta->Settings->LocalLoadSettings
(_bstr_t(L"D:\CTA_Test\settings2.xml"));

56 OMICRON
Description of interfaces and functions

6.5.2.3 ClearSettings
Scope ICTASettings
Syntax Function ClearSettings()
Description This function is used to reset all settings to the default
values.
Example in VB Dim sett As ICTASettings
set sett = cta.Settings
sett.LocalLoadSettings "D:\CTA_Test\settings1.xml"
sett.ClearSettings
Example in C++ cta->Settings->LocalLoadSettings
(_bstr_t(L"D:\CTA_Test\settings1.xml"));
cta->Settings->ClearSettings();

6.5.2.4 GetValue
Scope ICTASettings
Syntax Function GetValue([in]TCTASettingValue id):
Variant
Description Reads the value of a particular test setting.
Parameters id
(ID of the setting value to be read (element of
TCTASettingValue, see page 129))
Return value Setting value of the test parameter.
Data type: Variant.
Example in VB cta.Settings.LocalLoadSettings
"D:\CTA_Test\settings1.xml"
Debug.Print cta.Settings.GetValue(SV_ALF)
Example in C++ cta->Settings->LocalLoadSettings(_bstr_t(L"
D:\CTA_Test\settings1.xml "));
_variant_t v = cta->Settings->GetValue(SV_ALF);
_tprintf(_T("%d"), cta->Settings->GetValue(SV_ALF));

OMICRON 57
CTA Remote Control Programming Manual

6.5.2.5 SetValue
Scope ICTASettings
Syntax Function SetValue([in]TCTASettingValue
paramid, [in]Variant value) : Variant
Description Used to set the value of a particular test setting.
The specified value may be reduced or corrected
automatically, if it exceeds the allowed value range. In this
case, the corrected value is returned. The same value
would be returned when using the function GetValue()
subsequently.
Parameters paramid
(test parameter, the value of which you want to set
(element of TCTASettingValue, see page 129))
value
(new value of the test setting; since a Variant type is
requested, values of any type can be passed)
Return Parameter:
The return parameter should be the same as [in]Variant
value but may be reduced or corrected automatically, if it
exceeds the allowed value range. In this case, the
corrected value is returned. The same value would be
returned when using the function GetValue()
subsequently.

Example in VB Dim sett As ICTASettings


set sett = cta.Settings
If sett.SetValue(SV_IAL, v) <> v Then
Debug.Print "value " & v & " has been rounded"
End If
Example in C++ _variant_t vin = 3.4;
_variant_t vout;
vout = cta->Settings->SetValue(SV_IAL, vin);
if (vin != vout) {
printf("rounded");
}

58 OMICRON
Description of interfaces and functions

6.6 ICTARemoteTest (test execution on the


CT Analyzer)
The ICTARemoteTest interface is accessed through the ICTA::Test property.
All functions of this interface require a previous connection establishment to
the CT Analyzer.

6.6.1 Overview of functions


Function Brief description
RemoteLoadReport Loads a test report or a test settings file on the
CT Analyzer.
RemoteSaveReport Saves the current test report on the CT Analyzer.
Activate Activates the test.
Deactivate Aborts the test.
LoadRefExcitationCurve Loads a reference curve for the excitation test.
LockDevice Locks the keyboard of the CT Analyzer, except the
"I/O" key.
UnlockDevice Unlocks the keyboard of the CT Analyzer.

6.6.2 Description of functions


6.6.2.1 RemoteLoadReport
Scope ICTARemoteTest
Syntax Function RemoteLoadReport([in]string
RemotePath)
Description Loads a specified test report or test settings file on the
CT Analyzer (from the Compact Flash card or the internal
RAM disk).
Hint: Always use the RAM disk to avoid that the limit of
possible write cycles of the Compact Flash card is
reached.
Parameters RemotePath (full path of the file)
Example in VB cta.Test.RemoteLoadReport "b:/Tests/test1.xml"

Example in C++ cta->Test-


>RemoteLoadReport(_bstr_t(L"b:/Tests/test1.xml"));

OMICRON 59
CTA Remote Control Programming Manual

6.6.2.2 RemoteSaveReport
Scope ICTARemoteTest
Syntax Function RemoteSaveReport([in]string
RemotePath)
Description Saves the current test report on the CT Analyzer (to the
Compact Flash card or the internal RAM disk).
Hint: Always use the RAM disk to avoid that the limit of
possible write cycles of the Compact Flash card is
reached.
Parameters RemotePath (full path on the CT Analyzer and file name)
Example in VB cta.Test.RemoteSaveReport "b:/Tests/test2.xml"

Example in C++ cta->Test-


>RemoteSaveReport(_bstr_t(L"b:/Tests/test2.xml"));

6.6.2.3 Activate
Scope ICTARemoteTest
Syntax Function Activate()
Description Activates a test. Unlike the other functions, Activate()
does not wait until its execution is completed. Control is
immediately returned to the caller while the CT Analyzer
performs the test procedure concurrently.
Activating the test is only possible, if the device status (to
be queried by the ICTA::eStatus property) is
CTA_STAT_READY. If the device status is
CTA_STAT_WAIT_FOR_ACKNOWLEDGE, a message is still
pending and needs to be acknowledged using
ICTA::Info.Clear().
After the test activation, the device status changes to
CTA_STAT_ACTIVATED. This status is kept until one of the
following occurs:
1. The test completed successfully. The device status
changes to CTA_STAT_READY.
2. The test failed or was aborted. In this case, the
device status changes to
CTA_STAT_WAIT_FOR_ACKNOWLEDGE.
3. The test is still active but the execution is paused,
since rewiring of the test object is required. This is
the case if you have to measure the burden and
the winding resistance in one test procedure.
Then, the device status changes to
CTA_STAT_PAUSED. After rewiring is finished,
Activate() has to be called again to continue.
After this, the device status returns to
CTA_STAT_ACTIVATED (see the example below
for a proper implementation).

60 OMICRON
Description of interfaces and functions

Example (VB) 'start test


cta.Test.Activate
' loop while test is running
While cta.eStatus >= CTA_STAT_ACTIVATED
'check if rewiring is needed
If cta.eStatus = CTA_STAT_PAUSED Then
' block until rewired…
MsgBox "Change wiring and click OK"
'wiring change finished, continue test
rt.Activate
End If
Wend
'query and display error status
If cta.eStatus = CTA_STAT_WAIT_FOR_ACKNOWLEDGE Then
Debug.Print cta.Info.bstrDescription
If cta.Info.eClass = CTA_INFO_CLS_ERROR Then
MsgBox "ERROR"
Exit
End If
' acknowledge any notification
cta.Info.Clear
End If
Explanation of the example:
The test is started using cta.Test.Activate. The
While-Wend loop is executed as long as the test is
running (status not CTA_STAT_ACTIVATED).
If the CT Analyzer requests rewiring, the status changes to
CTA_STAT_PAUSED. In this case, the If-Then instruction
is fulfilled and a message box containing the text "Change
wiring and click OK" appears. While the message box is
displayed, program execution is blocked. After you have
changed the wiring and clicked on OK, the
cta.Test.Activate instruction in the next line is
executed and the test continues (status returns to
CTA_STAT_ACTIVATED).
When the test is finished or aborted, a status of
CTA_STAT_WAIT_FOR_ACKNOWLEDGE indicates that
something unexpected has happened during the test. A
description of the problem is displayed and, if this is an
error, another message box appears and the execution is
terminated. Otherwise, the message is acknowledged by
cta.Info.Clear().
See also chapter Error handling on page 205.

OMICRON 61
CTA Remote Control Programming Manual

Example in C++ // start test


ICTAPtr cta(CLSID_CTA);
cta->Test->Activate();
// loop while test is running
while (cta->eStatus >= CTA_STAT_ACTIVATED) {
//check for rewiring
if (cta->eStatus == CTA_STAT_PAUSED) {
//let rewire…
_tprintf(_T("do rewire and press
<return>\n"));
getchar();
cta->Test->Activate();
}
}
// query for errors
if (cta->eStatus == CTA_STAT_WAIT_FOR_ACKNOWLEDGE) {
_tprintf(_T("msg: %s"), cta->Info-
>bstrDescription);
if (cta->Info->eClass == CTA_INFO_CLS_ERROR) {
_tprintf(_T("ERROR"));
getchar();
return;
}
// acknowledge any notification
cta->Info->Clear();
}

6.6.2.4 Deactivate
Scope ICTARemoteTest
Syntax Function Deactivate()
Description Aborts a running test.
The Deactivate function can take several minutes,
depending on whether demagnetization of the test object is
required or not. In contrast to Activate(), the
Deactivate() function does not return before the action
is completed.
Example in VB cta.Test.Deactivate

Example in C++ cta->Test->Deactivate();

62 OMICRON
Description of interfaces and functions

6.6.2.5 LoadRefExcitationCurve
Scope ICTARemoteTest
Syntax Function LoadRefExcitationCurve([in]string
RemotePath)
Description Loads an excitation curve of a previous test as a
reference curve. This is used to compare the current
results with a previous test.
LoadRefExcitationCurve() must not be called until
the test is completed.
The test report file containing the reference curve has to
be available on the Compact Flash card or the internal
RAM disk.
Parameters RemotePath (full path to a report file)
Example in VB cta.Test.LoadRefExcitationCurve "/Tests/test1.xml"

Example in C++ cta->Test-


>LoadRefExcitationCurve(_bstr_t(L"/Tests/test1.xml"));

6.6.2.6 LockDevice
Scope ICTARemoteTest
Syntax Function LockDevice()
Description Locks the keyboard of the CT Analyzer. This prevents e.g.
unauthorized changes of settings as long as the device is
under remote control.
All keys except the "I/O" key are locked, so that a manual
abortion of a running test is still possible.
Use the UnlockDevice function to unlock the keyboard
again.
Example in VB cta.Test.LockDevice

Example in C++ cta->Test->LockDevice();

6.6.2.7 UnlockDevice
Scope ICTARemoteTest
Syntax Function UnlockDevice()
Description Unlocks the keyboard of the CT Analyzer.
Example in VB cta.Test.UnlockDevice

Example in C++ cta->Test->UnlockDevice();

OMICRON 63
CTA Remote Control Programming Manual

6.7 ICTAFileTransfer (file exchange)


The ICTAFileTransfer interface is accessed through the
ICTA::FileTransfer property.
All functions of this interface require a previous connection establishment to
the CT Analyzer.

6.7.1 Overview of functions


Function Brief description
CopyToCTA Copy file from PC to CT Analyzer.
CopyFromCTA Copy file from CT Analyzer to PC.

6.7.2 Description of functions

6.7.2.1 CopyToCTA
Scope ICTAFileTransfer
Syntax Function CopyToCTA([in]string LocalPath,
[in]string RemotePath)
Description Copies a file from a local drive on the PC to the Compact
Flash card or the internal RAM disk of the CT Analyzer.
The file transfer can take some seconds.
Hint: Always use the RAM disk to avoid that the limit of
possible write cycles of the Compact Flash card is
reached.
Parameters LocalPath
(full local PC path of the file to be copied)
RemotePath
(full remote path of the file on the target device)
Example in VB cta.FileTransfer.CopyToCTA
"D:\CTA_Tests\settings1.xml", "b:/Tests/test1.xml"
Example in C++ cta->FileTransfer-
>CopyToCTA(_bstr_t(L"D:\CTA_Tests\settings1.xml"),
_bstr_t(L"b:/Tests/test1.xml"));

64 OMICRON
Description of interfaces and functions

6.7.2.2 CopyFromCTA
Scope ICTAFileTransfer
Syntax Function CopyFromCTA([in]string RemotePath,
[in]string LocalPath)
Description Copies a file from the Compact Flash card or the internal
RAM disk of the CT Analyzer to a local drive on the PC.
The file transfer can take some seconds.
Parameters RemotePath
(full remote path of the file on the target device)
LocalPath
(full local PC path of the file to be copied)
Example in VB cta.FileTransfer.CopyFromCTA "b:/Tests/test1.xml",
"D:\CTA_Tests\test1.xml"
Example in C++ cta->FileTransfer-
>CopyFromCTA(_bstr_t(L"b:/Tests/test1.xml"),
_bstr_t(L"D:\CTA_Tests\settings1.xml"));

OMICRON 65
CTA Remote Control Programming Manual

6.8 ICTARemoteDirectory (file management on


the CT Analyzer)
The ICTARemoteDirectory interface is accessed through the
ICTA::Directory property. All functions of this interface require a previous
connection establishment to the CT Analyzer.

6.8.1 Overview of functions


Function Brief description
QueryFileItems Queries for subfolders and files contained in a
specific folder on the CT Analyzer.
FileMove Moves a file on the CT Analyzer.
FileRename Renames a file on the CT Analyzer.
FileCopy Copies a file on the CT Analyzer.
FileRemove Deletes a file on the CT Analyzer.
DirectoryCreate Creates a new folder on the CT Analyzer.
DirectoryRemove Deletes an empty folder on the CT Analyzer.
FormatDisk Formats the Compact Flash card. All data stored on
the Compact Flash card will be lost.

6.8.2 Description of functions


6.8.2.1 QueryFileItems
Scope ICTARemoteDirectory
Syntax Function QueryFileItems([in]string
bstrRemoteDirectoryPath, [out]ICTAFileItems
Directories, [out]ICTAFileItems Files)
Description Used to query for subfolders and files contained in the
folder RemoteDirectoryPath on the CT Analyzer. The path
of the root folder is "/".
Note:
This function returns
• a list of file names stored in the queried folder and
• a list of subfolder names in the queried folder.
The file names and the folder names are the item names
without the full path.
Parameters bstrRemoteDirectoryPath
Path to the folder to be queried.
Return value Directories (list of contained folders9
Files (list of contained files)

66 OMICRON
Description of interfaces and functions

Example in VB 'instantiate the CTA remote component


Dim cta As New CTARemoteLib.CTA
'connect to CT Analyzer
cta.USBConnect
'instantiate ICTARemoteDirectory interface
Dim rd As ICTARemoteDirectory
'Assign object reference
Set rd = cta
'declaration of variables di and fi as elements of
'ICTAFileItems
Dim di As ICTAFileItems
Dim fi As ICTAFileItems
'call function QueryFileItems for the root directory
'output parameters are di and fi
Call rd.QueryFileItems("/", di, fi)
'declaration of variable I as type integer
Dim i As Integer
'list contained directories in the Immediate window
For i = 0 To di.Count - 1
Debug.Print "dir: " & di.Item2(i).bstrName & ","
& di.Item2(i).dateDateTime & ","
& di.Item2(i).nSize
Next
'list contained files in the Immediate window
For i = 0 To fi.Count - 1
Debug.Print "file: " & fi.Item2(i).bstrName & ","
& fi.Item2(i).dateDateTime & ","
& fi.Item2(i).nSize
Next
Explanation of the example:
With each execution of the first For-Next loop, the name
of one contained folder is displayed (e.g. "dir: Test,
11.11.2004 19:21:18, 27200").
The second For-Next loop works exactly as the first
For-Next loop but lists files instead of folders.
Example in C++ ICTAFileItemsPtr di, fi;
cta->Directory->QueryFileItems(_bstr_t(L"/"), &di,
&fi);
for (int i = 0; i < di->Count – 1; ++i) {
_tprintf(_T("dir: %s"), di->Item2[i]-
>bstrName);
}
// ...

OMICRON 67
CTA Remote Control Programming Manual

6.8.2.2 FileMove
Scope ICTARemoteDirectory
Syntax Function FileMove([in]string
bstrRemoteFileOld, [in]string
bstrRemoteFileNew)
Description Using this function, you can move a file stored on the
CT Analyzer.
Parameters bstrRemoteFileOld (full path of the file to be moved)
bstrRemoteFileNew (new full path)
Example in VB cta.Directory.FileMove "A:/Tests1/test1.xml",
"A:/Tests2/test1.xml"
Example in C++ cta->Directory-
>FileMove(_bstr_t(L"A:/Tests1/test1.xml"),
_bstr_t(L"A:/Tests2/test1.xml"));

6.8.2.3 FileRename
Scope ICTARemoteDirectory
Syntax Function FileRename([in]string
bstrRemoteFileOld, [in]string
bstrRemoteFileNew)
Description Using this function, you can rename a file stored on the
CT Analyzer.
Parameters bstrRemoteFileOld (full path of the file to be renamed)
bstrRemoteFileNew (new full path)
Example in VB cta.Directory.FileRename "A:/Tests/test1.xml",
"A;/Tests/test1renamed.xml"
Example in C++ cta->Directory->FileRename(_bstr_t(L"A:/Tests/
test1.xml"), _bstr_t(L"A:/Tests/test1renamed.xml"));

6.8.2.4 FileCopy
Scope ICTARemoteDirectory
Syntax Function FileCopy([in]string
bstrRemoteFileOld, [in]string
bstrRemoteFileNew)
Description Using this function, you can copy a file stored on the
CT Analyzer.
Parameters bstrRemoteFileOld (full path of the file to be renamed)
bstrRemoteFileNew (new full path)
Example in VB cta.Directory.FileCopy "A:/Tests1/test1.xml",
"A:/Tests2/test1.xml"
Example in C++ cta->Directory-
>FileCopy(_bstr_t(L"A:/Tests1/test1.xml"),
_bstr_t(L"A:/Tests2/test1.xml"));

68 OMICRON
Description of interfaces and functions

6.8.2.5 FileRemove
Scope ICTARemoteDirectory
Syntax Function FileRemove([in]string
bstrRemoteFile)
Description Deletes a file on the CT Analyzer.
Parameters bstrRemoteFile (full path of the file to be deleted)
Example in VB cta.Directory.FileRemove "/Tests/test1.xml"

Example in C++ cta->Directory->FileRemove(_bstr_t(L"/Tests/


test1.xml"));

6.8.2.6 DirectoryCreate
Scope ICTARemoteDirectory
Syntax Function DirectoryCreate([in]string
bstrRemoteDir)
Description Using this function, you can create a new folder on the
CT Analyzer.
Parameters bstrRemoteDir (full path of the new folder)
Example in VB cta.Directory.DirectoryCreate "/Tests/MyNewTests"

Example in C++ cta->Directory->DirectoryCreate(_bstr_t(L"/Tests/


MyNewTests"));

6.8.2.7 DirectoryRemove
Scope ICTARemoteDirectory
Syntax Function DirectoryRemove([in]string
bstrRemoteDir)
Description Deletes a folder on the CT Analyzer.
Only empty folders can be deleted. If you try to delete a
folder containing files or subfolders, an error message is
displayed.
Parameters bstrRemoteDir (full path of the folder to be deleted)
Example in VB cta.Directory.DirectoryRemove "/Tests/MyTests"

Example in C++ cta->Directory->DirectoryRemove(_bstr_t(L"/Tests/


MyTests"));

6.8.2.8 FormatDisk
Scope ICTARemoteDirectory
Syntax Function FormatDisk()
Description Formats the Compact Flash card inserted in the
CT Analyzer.
Warning:
All data stored on the Compact Flash card will be lost.
Example in VB cta.Directory.FormatDisk

OMICRON 69
CTA Remote Control Programming Manual

Example in C++ cta->Directory->FormatDisk();

70 OMICRON
Description of interfaces and functions

6.9 ICTAResults (reading test results from a


test report)
The ICTAResults interface is accessed through the ICTA::Results property.
Using the functions of the ICTAResults interface, you can read the result
values previously saved in a test report. In contrast to the functions of the
ICTALiveResults interface (which allows direct access to values on the
CT Analyzer, see page 83), it is necessary to save a test report on the
CT Analyzer and to transfer the test report file to the PC before reading the
values.
The values in ICTAResults are not coupled to the values in ICTASettings.
Therefore, it is possible to treat the results of one file while changing the
settings of another file. Consequently, when you load the same file with
ICTAResults and ICTASettings, changing the setting values has no effect
on the available results.
Note All functions in ICTAResults can be executed offline, without a
CT Analyzer test set connected.

6.9.1 Overview of functions


Function Brief description
LocalLoadReport Load a test report file from a local PC drive.
GetValue Read a particular result value.
GetIndexedValue Read a single value of a particular result curve (e.g.
the excitation curve). A result curve is an array of
result values.
GetIndexedValues Read all values of a particular result curve at once. A
result curve is an array of result values.
GetCompositeError Composite error according to IEC60044-1. Refer to
CT Analyzer User Manual, section "Calculation of
Instrument Security Factor (FS)".
GetPhaseDeviation Phase deviation according to direct measurement
method.
GetRatioDeviation Current ratio deviation according direct measurement
method.
GetMaxPrimaryCurrent Maximum primary current that can be entered to
calculate the ratio error.
GetISec Secondary current for a specified primary current on a
specified burden.
GetErrorDescription Get a verbose description for an error number
retrieved by GetValue(RV_GENERAL_ERROR_NR).
SetValue Write a particular result value.
LocalSaveReport Save a test report file to a local PC drive.
IsReportSecure Check if the checksum of the loaded report is valid.

OMICRON 71
CTA Remote Control Programming Manual

GetAssessInfo Read detailed assessment information

6.9.2 Description of functions

6.9.2.1 LocalLoadReport
Scope ICTAResults
Syntax Function LocalLoadReport([in]string
LocalPath)
Description Loads a test report file (XML file) from a local drive on the
PC for further processing using the functions GetValue,
GetIndexedValue and GetIndexedValues.
Note: Test report files and test settings files (test
definitions) are of the same file structure and have the
same file extension (.XML). Setting files, however, do not
contain test results and therefore loading a settings file
using this function will fail.
Parameters LocalPath
(full path and file name of the report file to be loaded)
Example in VB cta.results.LocalLoadReport "D:\CTA_Test\test1.xml"

Example in C++ cta->Results-


>LocalLoadReport(_bstr_t(L"D:\CTA_Test\test1.xml"));

6.9.2.2 GetValue
Scope ICTAResults
Syntax Function GetValue([in]TCTAResultValue id) :
Variant
Description Reads a particular result value. See TCTAResultValue on
page 140 for the available result values.
Parameters id
ID of the value you want to query, see TCTAResultValue
(page 140).
Return value The result value (type: Variant).
A Variant is able to hold values of any data type. So, the
returned value can be a float, an enumeration type, an
integer or a string.
For the actual data types of the requested ID, please refer
to TCTAResultValue (page 140).
Example in VB cta.Results.LocalLoadReport "D:\CTA_Test\test1.xml"
Debug.Print cta.Results.GetValue
(RV_OBJECT_CT_MANUFACTURER)
Example in C++ cta->Results-
>LocalLoadReport(_bstr_t(L"D:\CTA_Test\test1.xml"));
_tprintf(_T("%s"), (_bstr_t)(cta->Results-
>GetValue(RV_OBJECT_CT_MANUFACTURER));

72 OMICRON
Description of interfaces and functions

6.9.2.3 GetIndexedValue
Scope ICTAResults
Syntax Function
GetIndexedValue([in]TCTAResultIndexedValue
id, [in]integer idx) : Variant
Description Reads a single value of a particular result value list (e.g.
the excitation curve).
If a particular test result is not a single value but consists of
a list of values instead (e.g. an excitation curve, a table,
etc.), all values in this list have an index number assigned.
Please refer to TCTAResultIndexedValue (page 173) for
the available value lists.
Note: If you access an index number which is not
available, an error is thrown. When iterating through the
list, this can be used to terminate the iteration.
Parameters id
ID of the value list you want to query, see
TCTAResultIndexedValue (page 173).
idx
Index number of the particular result you want to query.
Return value The result value (type: Variant).
A Variant is able to hold values of any data type. So, the
returned value can be a float, an enumeration type, an
integer or a string.
For the actual data types of the requested ID, please refer
to TCTAResultIndexedValue (page 173).
Example 1 (VB) cta.Results.LocalLoadReport "D:\CTA_Test\test1.xml"
cta.Results.GetIndexedValue(RV_RATIO_CURVE_EMF_V, 9)
Queries the 9th value of the results list for
RV_RATIO_CURVE_EMF_V.
Example 2 (VB) cta.Results.LocalLoadReport "D:\CTA_Test\test1.xml"
(query number of
existing values) Dim i As Integer
i = 0
On Error GoTo finish
While True
Debug.Print
cta.Results.GetIndexedValue(RV_RATIO_CURVE_EMF_V, i)
i = i + 1
Wend
finish: Debug.Print "Number of values:"; i
Explanation of the example:
The code shown in this example prints all values of the
RV_RATIO_CURVE_EMF_V value list (curve).
All values are successively read until the end of the list is
exceeded. Since an invalid index is requested then, an
error is thrown. Due to the preceding declaration On
Error Goto finish, the program execution then jumps
to the label named "finish".

OMICRON 73
CTA Remote Control Programming Manual

Example in C++ int i = 0;


CComVariant v;
while (SUCCEEDED(cta->Results-
>raw_GetIndexedValue(RV_RATIO_CURVE_EMF_V, i, &v))) {
_tprintf(_T(L"%f"), v.fltVal);
}
// number of values is i

6.9.2.4 GetIndexedValues
Scope ICTAResults
Syntax Function
GetIndexedValues([in]TCTAResultIndexedValue
id) : Variant
Description Reads all values of a particular result values list at once.
Most of the value lists are measurement curves with the
values representing the individual points.
Please refer to TCTAResultIndexedValue on page 173 for
a summary of all available lists.
Using this function you can read the complete list of values
(e.g. all values of the excitation curve) at once.
Parameters id
(ID of the value list you want to query, see
TCTAResultIndexedValue (page 173))
Return value List of result values. The list is delivered as a value array
packed into a Variant type. How to access the individual
values is shown in the example below.

74 OMICRON
Description of interfaces and functions

Example in VB cta.Results.LocalLoadReport "D:\CTA_Test\test1.xml"

Dim v As Variant
v = cta.Results.GetIndexedValues(RV_RATIO_CURVE_EMF_V)

Debug.Print "Number of values = "; UBound(v) - LBound(v)


If UBound(v) <> -1 Then
For i = 0 To UBound(v)
Debug.Print "V ["; i; "]"; v(i)
Next i
End If
Explanation of the example:
The code shown in this example first determines the
number of values available in the results list of the
parameter RV_RATIO_CURVE_EMF_V by subtracting the
lowest index number (LBound – "lower bound") from the
highest one (UBound – "upper bound"). Then, the values
are printed one after the other. The elements are accessed
by v(i). The check UBound(v) <> -1 is successful, if
values are available in the list.

6.9.2.5 GetCompositeError
Scope ICTAResults
Syntax Function GetCompositeError([in]float
fIPrim, [in]float fBurden, [in]fCosPhi) :
float
Description This function returns the composite error according to the
IEC 60044-1 direct measurement method for the specified
primary current, burden and CosPhi. The composite error
can only be calculated up to a maximum primary current
(see GetMaxPrimaryCurrent on page 78).
LocalLoadReport has to be called before using this
function.
Parameters fIPrim (primary current)
fBurden (operating burden)
fCosPhi (cosine of phase angle)
All values are passed as of type float.
Return value The calculated composite error for the current report and
the parameters passed.

OMICRON 75
CTA Remote Control Programming Manual

Example in VB Dim cta as new CTA


cta.Results.LocalLoadReport “C:\my report.xml”
Dim isec, burden, cosphi As Single
isec = 1.0
burden = 33.3
cosphi = 0.5
Debug.Print cta.Results.GetCompositeError(isec,
burden, cosphi)
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
float fCompErr = cta->Results->GetCompositeError(1.0,
33.3, 0.5);

6.9.2.6 GetPhaseDeviation
Scope ICTAResults
Syntax Function GetPhaseDeviation([in]float
fIPrim, [in]float fBurden, [in]fCosPhi) :
float
Description This function returns the phase deviation in degrees of the
secondary current for the specified primary current, burden
and CosPhi. The phase deviation can only be calculated
up to a maximum primary current (see
GetMaxPrimaryCurrent on page 78).
LocalLoadReport has to be called before using this
function.
Parameters fIPrim (primary current)
fBurden (operating burden)
fCosPhi (cosine of phase angle)
All values are passed as of type float.
Return value The calculated phase deviation for the current report and
the parameters passed.
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim isec, burden, cosphi As Single
isec = 1.0
burden = 33.3
cosphi = 0.5
Debug.Print cta.Results.GetPhaseDeviation(isec,
burden, cosphi)
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
float fCompErr = cta->Results->GetPhaseDeviation(1.0,
33.3, 0.5);

76 OMICRON
Description of interfaces and functions

6.9.2.7 GetRatioDeviation
Scope ICTAResults
Syntax Function GetRatioDeviation([in]float
fIPrim, [in]float fBurden, [in]fCosPhi) :
float
Description This function returns the current ratio deviation for the
specified primary current, burden and CosPhi. The current
ratio deviation can only be calculated up to a maximum
primary current (see GetMaxPrimaryCurrent on page 78).
LocalLoadReport has to be called before using this
function.
Parameters fIPrim (primary current)
fBurden (operating burden)
fCosPhi (cosine of phase angle)
All values are passed as of type float.
Return value The calculated ratio deviation for the current report and the
parameters passed.
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim isec, burden, cosphi As Single
isec = 1.0
burden = 33.3
cosphi = 0.5
Debug.Print cta.Results.GetRatioDeviation(isec,
burden, cosphi)
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
float fCompErr = cta->Results->GetRatioDeviation(1.0,
33.3, 0.5);

OMICRON 77
CTA Remote Control Programming Manual

6.9.2.8 GetMaxPrimaryCurrent
Scope ICTAResults
Syntax Function GetMaxPrimaryCurrent([in]float
fBurden, [in]fCosPhi) : float
Description Delivers that maximum value for the primary current, the
software can deliver valid results for GetCompositeError,
GetPhaseDeviation and GetRatioDeviation. The device
can only calculate this parameters in that range of the CT
where a excitation curve could be measured.
LocalLoadReport has to be called before using this
function.
Parameters fBurden (operating burden
fCosPhi (cosine of phase angle)
All values are passed as of type float.
Return value The calculated maximum primary current for the current
report and the parameters passed. LocalLoadReport has
to be called before.
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim isec, burden, cosphi As Single
isec = 1.0
burden = 33.3
cosphi = 0.5
Debug.Print cta.Results.GetMaxPrimaryCurrent(isec,
burden, cosphi)
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
float fCompErr = cta->Results-> GetMaxPrimaryCurrent
(1.0, 33.3, 0.5);

78 OMICRON
Description of interfaces and functions

6.9.2.9 GetISec
Scope ICTAResults
Syntax Function GetISec([in]float fIPrim,
[in]float fBurden, [in]fCosPhi) : float
Description This function returns the secondary current for the
specified primary current, burden and CosPhi. The
secondary current can only be calculated up to a maximum
primary current (see GetMaxPrimaryCurrent on page 78).
LocalLoadReport has to be called before using this
function.
Parameters fIPrim (primary current)
fBurden (operating burden)
fCosPhi (cosine of phase angle)
All values are passed as of type float.
Return value The calculated secondary current for the current report and
the parameters passed. LocalLoadReport has to be called
before.
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim isec, burden, cosphi As Single
isec = 1.0
burden = 33.3
cosphi = 0.5
Debug.Print cta.Results.GetISec(isec, burden, cosphi)
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
float fCompErr = cta->Results->GetISec(1.0, 33.3,
0.5);

6.9.2.10 GetErrorDescription
Scope ICTAResults
Syntax Function GetErrorDescription([in]long
nErrorNumber) : String
Description Get a verbose description of the error number. The number
might have been read by
GetValue(RV_GENERAL_ERROR_NR)
Parameters nErrorNumber (CT Analyzer error number)
Return value descriptive string
Example in VB Debug.Print
cta.Results.GetErrorDescription(cta.Results.GetValue(R
V_GENERAL_ERROR_NR))
Example in C++ variant_t varErrNumber = cta->Results-
>GetValue(RV_GENERAL_ERROR_NR);
_bstr_t bstrErrDescr = cta->Results-
>GetErrorDescription(varErrNumber);

OMICRON 79
CTA Remote Control Programming Manual

6.9.2.11 SetValue
Scope ICTAResults
Syntax Function SetValue([in]TCTAResultValue
paramid, [in]Variant value) : Variant
Description Used to set the value of a particular test result.
The same value would be returned when using the function
GetValue() subsequently.
Parameters paramid
(result parameter, the value of which you want to set
(element of TCTAResultValue, see page 140))
The following parameters are possible:
RV_OBJECT_LOC_COMPANY
RV_OBJECT_LOC_COUNTRY
RV_OBJECT_LOC_STATION
RV_OBJECT_LOC_FEEDER
RV_OBJECT_LOC_PHASE
RV_OBJECT_LOC_IECID
RV_OBJECT_OBJ_CT_TAP
RV_OBJECT_OBJ_OPTION1
RV_OBJECT_OBJ_MANUF
RV_OBJECT_OBJ_CT_TYPE
RV_OBJECT_OBJ_CT_SER_NR
RV_OBJECT_OBJ_CT_CORE_NR
RV_COMMENT_TEXT

value
(new value of the result setting; since a Variant type is
requested, values of any type can be passed)
Example in VB Dim result As ICTAResults
set result = cta.Results
result.SetValue(RV_OBJECT_LOC_COMPANY, v)
Example in C++ _variant_t vin = "Company";
_variant_t vout;
vout = cta->Results->SetValue(RV_OBJECT_LOC_COMPANY,
vin);

80 OMICRON
Description of interfaces and functions

6.9.2.12 LocalSaveReport
Scope ICTAResults
Syntax Function LocalSaveReport([in]string
LocalPath)
Description Saves a report to a local drive on the PC.
Parameters LocalPath (full path on the PC and file name)
Example in VB cta.Results.LocalSaveReport "D:\CTA_Test\report2.xml"

Example in C++ cta->Results->LocalLoadReport


(_bstr_t(L"D:\CTA_Test\report2.xml"));

6.9.2.13 IsReportSecure
Scope ICTAResults
Syntax Property IsReportSecure : TCTAChecksResult
Description Checks if the checksum of the actual loaded report is valid
(see also TCTAChecksResult on page 127).

6.9.2.14 GetAssessInfo
Scope ICTAResults
Syntax Function
GetAssessInfo([in]TCTAAssessParameter
ParamId, [in]TCTAAssessInfo InfoId) :
Variant
Description Reads detailed assessment information, depending on the
parameters param_id and info_id.
Parameters ParamId
ID of the assessment value you want to query, see
TCTAAssesParameter.
InfoId
ID of the particular value for the provided assessment
(ParamId) you want to query, see TCTAAssesInfo.
Return value The result value (type: Variant).
A Variant is able to hold values of any data type. So, the
returned value can be a float, an enumeration type, an
integer or a string.
For the actual data types of the requested ID, please refer
to TCTAAssessInfo.
Note Calls with ParamId
ASS_PARAM_UNSPECIFIED,
ASS_PARAM_CLASS,
ASS_PARAM_RATIO_ERR,
ASS_PARAM_RCF,
ASS_PARAM_PHASE_ERR,
return no result.
They are not supported and will throw an error.

OMICRON 81
CTA Remote Control Programming Manual

Example in VB cta.Results.LocalLoadReport "D:\CTA_Test\test1.xml"


Debug.Print cta.Results.GetAssessInfo ASS_PARAM_ALF
ASS_INFO_MEASURED_VAL
Example in C++ cta->Results-
>LocalLoadReport(_bstr_t(L"D:\CTA_Test\test1.xml"));
_tprintf(_T("%f"), (double)(cta->Results-
>GetAssessInfo(ASS_PARAM_ALF, ASS_INFO_MEASURED_VAL));

82 OMICRON
Description of interfaces and functions

6.10 ICTALiveResults (reading test results


directly from the CT Analyzer)
The ICTALiveResults interface is accessed through the ICTA::LiveResults
property.
Using the functions of the ICTALiveResults interface, you can read result
values directly on the CT Analyzer, as soon as the CT Analyzer software has
calculated them. In contrast to the functions of the ICTAResults interface, it is
not necessary to save a test report on the CT Analyzer and to transfer the test
report file to the PC before reading the values. The values are read directly
from the CT Analyzer software.
The functions of this interface are useful to query individual values during the
test, e.g. for calibration purposes. For such an application, you could stop the
test, if the value is not within the tolerance, adjust the calibration and then
repeat the test. As soon as the value is within the tolerance range, you can
automatically have a test report created for documentation.
Using the functions of the ICTALiveResults interface is not recommended
to read all test results. In this case, the functions of the ICTAResults interface
are more suitable.

6.10.1 Overview of functions


Function Brief description
GetLiveValue Read a particular result value directly on the
CT Analyzer.
GetLiveIndexedValue Read a single value of a particular result curve (e.g.
the excitation curve) directly on the CT Analyzer. A
result curve is an array of result values.
GetLiveIndexedValues Read all values of a particular result curve at once
directly on the CT Analyzer. A result curve is an
array of result values.
GetLiveErrorDescription Get a verbose description for an error number
retrieved by GetValue(RV_GENERAL_ERROR_NR)

OMICRON 83
CTA Remote Control Programming Manual

6.10.2 Description of functions

6.10.2.1 GetLiveValue
Scope ICTALiveResults
Syntax Function GetLiveValue([in]TCTAResultValue
id) : Variant
Description Reads a particular result value directly on the CT Analyzer.
See TCTAResultValue on page 140 for the available result
values.
Parameters id
(ID of the value you want to query, see TCTAResultValue
(page 140))
Return The result value (type: Variant).
A Variant is able to hold values of any data type. So, the
returned value can be a float, an enumeration type, an
integer or a string.
For the actual data types of the requested ID, please refer
to TCTAResultValue (page 140).
Example in VB Debug.Print cta.LiveResults.GetLiveValue
(RV_BURDEN_AUTO_ASSESS)
Example in C++ bool bAssessBurden = (bool)(cta->LiveResults->
GetLiveValue(RV_BURDEN_AUTO_ASSESS));

6.10.2.2 GetLiveIndexedValue
Scope ICTALiveResults
Syntax Function GetLiveIndexedValue(
[in]TCTAResultIndexedValue id, [in]integer
idx) : Variant
Description Reads a single value of a particular result value list (e.g.
the excitation curve) directly on the CT Analyzer.
If a particular test result is not a single value but consists of
a list of values instead (e.g. an excitation curve, a table,
etc.), all values in this list have an index number assigned.
Please refer to TCTAResultIndexedValue (page 173) for
the available value lists.
Note: If you access an index number which is not
available, an error is thrown. When iterating through the
list, this can be used to terminate the iteration.
Parameters id
(ID of the value list you want to query, see
TCTAResultIndexedValue (page 173))
idx
(index number of the result you want to query)

84 OMICRON
Description of interfaces and functions

Return The result value (type: Variant).


A Variant is able to hold values of any data type. So, the
returned value can be a float, an enumeration type, an
integer or a string.
For the actual data types of the requested ID, please refer
to TCTAResultIndexedValue (page 173).
Example 1 (VB) cta.LiveResults.GetLiveIndexedValue
(RV_RATIO_CURVE_EMF_V, 9)
Query the 9th value of the results list for
RV_RATIO_CURVE_EMF_V.
Example 2 (VB) Dim i As Integer
(query number of i = 0
existing values) On Error GoTo finish
While True
Debug.Print
cta.LiveResults.GetLiveIndexedValue(RV_RATIO_CURVE_EMF
_V, i)
i = i + 1
Wend
finish: Debug.Print "Number of values:"; i
Explanation of the example:
The code shown in this example prints all values of the
RV_RATIO_CURVE_EMF_V value list (curve).
All values are successively read until the end of the list is
exceeded. Since an invalid index is requested then, an
error is thrown. Due to the preceding declaration On
Error Goto finish, the program execution then jumps
to the label named "finish".

6.10.2.3 GetLiveIndexedValues
Scope ICTALiveResults
Syntax Function
GetLiveIndexedValues([in]TCTAResultIndexedV
alue id) : Variant
Description Reads all values of a particular result values list on the
CT Analyzer at once. Most of the value lists are
measurement curves with the values representing the
individual points.
Please refer to TCTAResultIndexedValue on page 173 for
a summary of all available lists.
Using this function you can read the complete list of values
(e.g. all values of the excitation curve) at once.
Parameters id
(ID of the value list you want to query, see
TCTAResultIndexedValue (page 173))

OMICRON 85
CTA Remote Control Programming Manual

Return List of result values. The list is delivered as a value array


packed into a Variant type. How to access the individual
values is shown in the example below.
Example in VB Dim v As Variant
v = cta.LiveResults.GetLiveIndexedValues(RV_RATIO_
CURVE_EMF_V)

Debug.Print "Number of values = "; UBound(v) - LBound(v)


If UBound(v) <> -1 Then
For i = 0 To UBound(v)
Debug.Print "V ["; i; "]"; v(i)
Next i
End If
Explanation of the example:
The code shown in this example first determines the
number of values available in the results list of the
parameter RV_RATIO_CURVE_EMF_V by subtracting the
lowest index number (LBound – "lower bound") from the
highest one (UBound – "upper bound"). Then, the values
are printed one after the other. The elements are accessed
by v(i). The check UBound(v) <> -1 is successful, if
values are available in the list.

6.10.2.4 GetLiveErrorDescription
Scope ICTAResults
Syntax Function GetLiveErrorDescription([in]long
nErrorNumber) : String
Description Get a verbose description of the error number. The number
might have been read using
GetValue(RV_GENERAL_ERROR_NR)
Parameters nErrorNumber (CT Analyzer error number)
Return value descriptive string
Example in VB Debug.Print
cta.Results.GetLiveErrorDescription(cta.Results.
GetValue(RV_GENERAL_ERROR_NR))
Example in C++ variant_t varErrNumber = cta->Results->
GetValue(RV_GENERAL_ERROR_NR);
_bstr_t bstrErrDescr = cta->Results->
GetLiveErrorDescription(varErrNumber);

86 OMICRON
Description of interfaces and functions

6.11 ICTACalc (enhanced calculation of results)


The ICTACalc interface is accessed through the ICTA::Calculate
property.
Using the functions of the ICTACalc interface, you can calculate some
parameters in the same way as they are calculated in the CT Analyzer.
The functions of this interface are useful to obtain further information about a
successful measurement included in the protocol, or to perform a recalculation
of specific results with different input parameters (burden, primary current,
etc.).
Before using these functions, a valid measurement must be available.

6.11.1 Overview of functions


Function Brief description
EvalCompositeError Composite error according to IEC 60044-1. Refer
to section "Calculation of Instrument Security
Factor (FS)" in the CT Analyzer User Manual.
Identical with
ICTAResults::GetCompositeError but
accessible through this interface.
EvalPhaseDeviation Phase deviation according to direct
measurement method.
Identical with
ICTAResults::GetPhaseDeviation but
accessible through this interface.
EvalRatioDeviation Current ratio deviation according to direct
measurement method.
Identical with
ICTAResults::GetRatioDeviation but
accessible through this interface.
EvalSecondaryCurrent Secondary current for a specified primary current
at a specified burden.
Identical with ICTAResults::GetIsec but
accessible through this interface.
EvalMaxPrimaryCurrent Maximum primary current that can be entered to
calculate the ratio error.
Identical with
ICTAResults::GetMaxPrimaryCurrent but
accessible through this interface.
EvalExcitationCurrentRms Excitation current rms value for a specified
primary current at a specified burden.
EvalExcitationCurrentPeak Excitation current peak value for a specified
primary current at a specified burden (according
to IEC 60044-6).
EvalCoreVoltage Core voltage for a specified primary current at a
specified burden.
EvalExcitationCurrent Excitation current rms value at a specified core

OMICRON 87
CTA Remote Control Programming Manual

RmsAtVcore voltage.
EvalExcitationCurrent Excitation current rms value at a specified
RmsAtVTerm terminal voltage.
EvalExcitationCurrent Excitation current peak value at a specified core
PeakAtVcore voltage.
EvalVTermAtExcitation Terminal voltage at a specified excitation current
CurrentRms rms value.
EvalVCoreAtExcitation Core voltage at a specified excitation current rms
CurrentRms value.
EvalVCoreAtExcitation Core voltage at a specified excitation current
CurrentPeak peak value.
AL_MaxPrimaryCurrent AL-Error graph.
Max. primary current for a specified error (and at
burden impedance = 0 ohms).
AL_MaxImpedance AL-Error graph.
Max. impedance for a specified error (and at
nominal primary current).
AL_Impedance AL-Error graph.
AtPrimaryCurrent lmpedance for a specified error and a specified
primary current at a specified CosPhi.
AL_PrimaryCurrent AL-Error graph.
AtImpedance Primary current for a specified error and a
specified impedance and CosPhi.
AL_PrimaryCurrent AL-Error graph.
AtNomBurden Primary current at nominal burden.
(Error value and burden are taken from the
actually loaded measurement).
AL_PrimaryCurrent AL-Error graph.
AtOprBurden Primary current at operating burden.
(Error value and burden are taken from the
actually loaded measurement)

88 OMICRON
Description of interfaces and functions

6.11.2 Description of functions

6.11.2.1 EvalCompositeError
Scope ICTACalc
Syntax Function EvalCompositeError([in]float
fIprim, [in]float fBurden, [in]float
fCosPhi, [out]enum TCTAQualifier* peStatus)
: float
Description This function returns the composite error according to the
IEC 60044-1 direct measurement method for the specified
primary current, burden and CosPhi. The composite error
can only be calculated up to a maximum primary current
(see GetMaxPrimaryCurrent on page 78). If the primary
current exceeds this value, the composite error is limited,
and the value of *peStatus returns QV_BOUNDED ( = 1).
LocalLoadReport has to be called before using this
function.
Parameters float fIPrim (primary current)
float fBurden (operating burden)
float fCosPhi (cosine of phase angle)
enum TCTAQualifier* peStatus
(address to a status value)
Return value The composite error calculated for the currently loaded
report and for the parameter values passed with this
function call.
The status value *peStatus contains the qualifier:
QV_INVALID = -1,
QV_VALID = 0,
QV_BOUNDED = +1
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim status As TCTAQualifier
result = cta.Calculate.EvalCompositeError(2000.0, 2.5,
1.0, status)
if status = QV_VALID then
Debug.Print result
end if
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
enum TCTAQualifier status;
float fCompErr = cta->Calculate-
>EvalCompositeError(2000.0, 2.5, 1.0, &status);

OMICRON 89
CTA Remote Control Programming Manual

6.11.2.2 EvalPhaseDeviation
Scope ICTACalc
Syntax Function EvalPhaseDeviation([in]float
fIprim, [in]float fBurden, [in]float
fCosPhi, [out]enum TCTAQualifier* peStatus)
: float
Description This function returns the phase deviation in degrees of the
secondary current for the specified primary current, burden
and CosPhi. The phase deviation can only be calculated
up to a maximum primary current (see
GetMaxPrimaryCurrent on page 78). If the primary current
exceeds this value, the phase deviation is limited, and the
value of *peStatus returns QV_BOUNDED ( = 1).
LocalLoadReport has to be called before using this
function.
Parameters float fIPrim (primary current)
float fBurden (operating burden)
float fCosPhi (cosine of phase angle)
enum TCTAQualifier* peStatus
(address to a status value)
Return value The phase deviation calculated for the currently loaded
report and for the parameter values passed with this
function call.
The status value *peStatus contains the qualifier:
QV_INVALID = -1,
QV_VALID = 0,
QV_BOUNDED = +1
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim status As TCTAQualifier
result = cta.Calculate.EvalPhaseDeviation(2000.0, 2.5,
1.0, status)
if status = QV_VALID then
Debug.Print result
end if
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
enum TCTAQualifier status;
float fPhaseDeviation = cta->Calculate-
>EvalPhaseDeviation(2000.0, 2.5, 1.0, &status);

90 OMICRON
Description of interfaces and functions

6.11.2.3 EvalRatioDeviation
Scope ICTACalc
Syntax Function EvalRatioDeviation([in]float
fIPrim, [in]float fBurden, [in]float
fCosPhi, [out]enum TCTAQualifier* peStatus)
: float
Description This function returns the current ratio deviation for the
specified primary current, burden and CosPhi. The current
ratio deviation can only be calculated up to a maximum
primary current (see GetMaxPrimaryCurrent on page 78).
If the primary current exceeds this value, the ratio deviation
is limited, and the value of *peStatus returns
QV_BOUNDED ( = 1).
LocalLoadReport has to be called before using this
function.
Parameters float fIPrim (primary current)
float fBurden (operating burden)
float fCosPhi (cosine of phase angle)
enum TCTAQualifier* peStatus
(address to a status value)
Return value The ratio deviation calculated for the currently loaded
report and for the parameter values passed with this
function call.
The status value *peStatus contains the qualifier:
QV_INVALID = -1,
QV_VALID = 0,
QV_BOUNDED = +1
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim status As TCTAQualifier
result = cta.Calculate.EvalRatioDeviation(2000.0, 2.5,
1.0, status)
if status = QV_VALID then
Debug.Print result
end if
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
enum TCTAQualifier status;
float fRatioDeviation = cta->Calculate-
>EvalRatioDeviation(2000.0, 2.5, 1.0, &status);

OMICRON 91
CTA Remote Control Programming Manual

6.11.2.4 EvalSecondaryCurrent
Scope ICTACalc
Syntax Function EvalSecondaryCurrent([in]float
fIPrim, [in]float fBurden, [in]float
fCosPhi, [out]enum TCTAQualifier* peStatus)
: float
Description This function returns the secondary current for the
specified primary current, burden and CosPhi. The
secondary current can only be calculated up to a maximum
primary current (see GetMaxPrimaryCurrent on page 78).
If the primary current exceeds this value, the secondary
current is limited, and the value of *peStatus returns
QV_BOUNDED ( = 1).
LocalLoadReport has to be called before using this
function.
Parameters float fIPrim (primary current)
float fBurden (operating burden)
float fCosPhi (cosine of phase angle)
enum TCTAQualifier* peStatus
(address to a status value)
Return value The secondary current calculated for the currently loaded
report and for the parameter values passed with this
function call.
The status value *peStatus contains the qualifier:
QV_INVALID = -1,
QV_VALID = 0,
QV_BOUNDED = +1
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim status As TCTAQualifier
result = cta.Calculate.EvalSecondaryCurrent(2000.0,
2.5, 1.0, status)
if status = QV_VALID then
Debug.Print result
end if
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
enum TCTAQualifier status;
float fSecondaryCurrent = cta->Calculate-
>EvalSecondaryCurrent(2000.0, 2.5, 1.0, &status);

92 OMICRON
Description of interfaces and functions

6.11.2.5 EvalMaxPrimaryCurrent
Scope ICTACalc
Syntax Function EvalMaxPrimaryCurrent([in]float
fBurden, [in]float fCosPhi, [out]enum
TCTAQualifier* peStatus) : float
Description Delivers that maximum value of the primary current, the
software can deliver valid results for GetCompositeError,
GetPhaseDeviation and GetRatioDeviation. The device
can only calculate this parameter for that operating range
of the CT that allows a measurement of the excitation
curve.
LocalLoadReport has to be called before using this
function.
Parameters float fBurden (operating burden)
float fCosPhi (cosine of phase angle)
enum TCTAQualifier* peStatus
(address to a status value)
Return value The maximum primary current calculated for the currently
loaded report and for the parameter values passed with
this function call.
The status value *peStatus always contains
QV_VALID = 0
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim status As TCTAQualifier
Debug.Print cta.Calculate.EvalMaxPrimaryCurrent(2.5,
1.0, status)
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
enum TCTAQualifier status;
float fMaxCurrent = cta->Calculate-
>EvalMaxPrimaryCurrent (2.5, 1.0, &status);

OMICRON 93
CTA Remote Control Programming Manual

6.11.2.6 EvalExcitationCurrentRms
Scope ICTACalc
Syntax Function EvalExcitationCurrentRms([in]float
fIPrim, [in]float fBurden, [in]float
fCosPhi, [out]enum TCTAQualifier* peStatus)
: float
Description This function returns the excitation current rms value for a
specified primary current at a specified burden and cosPhi.
The excitation current can only be calculated up to a
maximum primary current (see GetMaxPrimaryCurrent on
page 78). If the primary current exceeds this value, the
excitation current is limited, and the value of *peStatus
returns QV_BOUNDED ( = 1).
LocalLoadReport has to be called before using this
function.
Parameters float fIPrim (primary current)
float fBurden (operating burden)
float fCosPhi (cosine of phase angle)
enum TCTAQualifier* peStatus
(address to a status value)
Return value The excitation current calculated for the currently loaded
report and for the parameter values passed with this
function call.
The status value *peStatus contains the qualifier:
QV_INVALID = -1,
QV_VALID = 0,
QV_BOUNDED = +1
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim status As TCTAQualifier
result = cta.Calculate.EvalExcitationCurrentRms
(2000.0, 2.5, 1.0, status)
if status = QV_VALID then
Debug.Print result
end if
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
enum TCTAQualifier status;
float fMaxCurrent = cta->Calculate-
>EvalExcitationCurrentRms (2.5, 1.0, &status);

94 OMICRON
Description of interfaces and functions

6.11.2.7 EvalExcitationCurrentPeak
Scope ICTACalc
Syntax Function
EvalExcitationCurrentPeak([in]float fIPrim,
[in]float fBurden, [in]float fCosPhi,
[out]enum TCTAQualifier* peStatus) : float
Description This function returns the excitation current peak value for a
specified primary current at a specified burden and cosPhi.
The excitation current can only be calculated up to a
maximum primary current (see GetMaxPrimaryCurrent on
page 78). If the primary current exceeds this value, the
excitation current is limited, and the value of *peStatus
returns QV_BOUNDED ( = 1).
LocalLoadReport has to be called before using this
function.
Parameters float fIPrim (primary current)
float fBurden (operating burden)
float fCosPhi (cosine of phase angle)
enum TCTAQualifier* peStatus
(address to a status value)
Return value The excitation current calculated for the currently loaded
report and for the parameter values passed with this
function call.
The status value *peStatus contains the qualifier:
QV_INVALID = -1,
QV_VALID = 0,
QV_BOUNDED = +1
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim status As TCTAQualifier
result = cta.Calculate.EvalExcitationCurrentPeak
(2000.0, 2.5, 1.0, status)
if status = QV_VALID then
Debug.Print result
end if
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
enum TCTAQualifier status;
float fMaxCurrent = cta->Calculate-
>EvalExcitationCurrentPeak (2.5, 1.0, &status);

OMICRON 95
CTA Remote Control Programming Manual

6.11.2.8 EvalCoreVoltage
Scope ICTACalc
Syntax Function EvalCoreVoltage([in]float fIPrim,
[in]float fBurden, [in]float fCosPhi,
[out]enum TCTAQualifier* peStatus) : float
Description This function returns the core voltage for a specified
primary current at a specified burden and cosPhi.
The core voltage can only be calculated up to a maximum
primary current (see GetMaxPrimaryCurrent on page 78).
If the primary current exceeds this value, the core voltage
is limited, and the value of *peStatus returns
QV_BOUNDED ( = 1).
LocalLoadReport has to be called before using this
function.
Parameters float fIPrim (primary current)
float fBurden (operating burden)
float fCosPhi (cosine of phase angle)
enum TCTAQualifier* peStatus
(address to a status value)
Return value The core voltage calculated for the currently loaded report
and for the parameter values passed with this function call.
The status value *peStatus contains the qualifier:
QV_INVALID = -1,
QV_VALID = 0,
QV_BOUNDED = +1
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim status As TCTAQualifier
result = cta.Calculate.EvalCoreVoltage(2000.0, 2.5,
1.0, status)
if status = QV_VALID then
Debug.Print result
end if
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
enum TCTAQualifier status;
float fMaxCurrent = cta->Calculate->EvalCoreVoltage
(2.5, 1.0, &status);

96 OMICRON
Description of interfaces and functions

6.11.2.9 EvalExcitationCurrentRmsAtVcore
Scope ICTACalc
Syntax Function
EvalExcitationCurrentRmsAtVcore([in]float
fVcore, [out]enum TCTAQualifier* peStatus)
: float
Description This function returns the excitation current rms value for
the specified core voltage. If the specified core voltage
exceeds the maximum core voltage listed in the excitation
table, the excitation current is limited, and the value of
*peStatus returns QV_BOUNDED ( = 1).
LocalLoadReport has to be called before using this
function.
Parameters float fVcore (core voltage)
enum TCTAQualifier* peStatus
(address to a status value)
Return value The excitation current calculated for the currently loaded
report and for the parameter values passed with this
function call.
The status value *peStatus contains the qualifier:
QV_INVALID = -1,
QV_VALID = 0,
QV_BOUNDED = +1
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim status As TCTAQualifier
result = cta.Calculate.EvalExcitationCurrentRmsAtVcore
(50.0, status)
if status = QV_VALID then
Debug.Print result
end if
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
enum TCTAQualifier status;
float fMaxCurrent = cta->Calculate-
>EvalExcitationCurrentRmsAtVcore (50.0, &status);

OMICRON 97
CTA Remote Control Programming Manual

6.11.2.10 EvalExcitationCurrentRmsAtVTerm
Scope ICTACalc
Syntax Function
EvalExcitationCurrentRmsAtVTerm([in]float
fVTerm, [out]enum TCTAQualifier* peStatus)
: float
Description This function returns the excitation current rms value for
the specified terminal voltage. If the specified terminal
voltage exceeds the maximum terminal voltage listed in the
excitation table, the excitation current is limited, and the
value of *peStatus returns QV_BOUNDED ( = 1).
LocalLoadReport has to be called before using this
function.
Parameters float fVTerm (terminal voltage)
enum TCTAQualifier* peStatus
(address to a status value)
Return value The excitation current calculated for the currently loaded
report and for the parameter values passed with this
function call.
The status value *peStatus contains the qualifier:
QV_INVALID = -1,
QV_VALID = 0,
QV_BOUNDED = +1
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim status As TCTAQualifier
result = cta.Calculate.EvalExcitationCurrentRmsAtVTerm
(50.0, status)
if status = QV_VALID then
Debug.Print result
end if
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
enum TCTAQualifier status;
float fMaxCurrent = cta->Calculate-
>EvalExcitationCurrentRmsAtVTerm (50.0, &status);

98 OMICRON
Description of interfaces and functions

6.11.2.11 EvalExcitationCurrentPeakAtVcore
Scope ICTACalc
Syntax Function
EvalExcitationCurrentPeakAtVcore([in]float
fVcore, [out]enum TCTAQualifier* peStatus)
: float
Description This function returns the excitation current peak value for
the specified core voltage. If the specified core voltage
exceeds the maximum core voltage listed in the excitation
table, the excitation current is limited, and the value of
*peStatus returns QV_BOUNDED ( = 1).
LocalLoadReport has to be called before using this
function.
Parameters float fVcore (core voltage)
enum TCTAQualifier* peStatus
(address to a status value)
Return value The excitation current calculated for the currently loaded
report and for the parameter values passed with this
function call.
The status value *peStatus contains the qualifier:
QV_INVALID = -1,
QV_VALID = 0,
QV_BOUNDED = +1
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim status As TCTAQualifier
result =
cta.Calculate.EvalExcitationCurrentPeakAtVcore(50.0,
status)
if status = QV_VALID then
Debug.Print result
end if
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
enum TCTAQualifier status;
float fMaxCurrent = cta->Calculate-
>EvalExcitationCurrentPeakAtVcore (50.0, &status);

OMICRON 99
CTA Remote Control Programming Manual

6.11.2.12 EvalVTermAtExcitationCurrentRms
Scope ICTACalc
Syntax Function EvalVTermAtExcitationCurrentRms
([in]float fCurrent, [out]enum
TCTAQualifier* peStatus) : float
Description This function returns the terminal voltage for the specified
excitation current rms value. If the specified excitation
current exceeds the maximum excitation current listed in
the excitation table, the terminal voltage is limited, and the
value of *peStatus returns QV_BOUNDED ( = 1).
LocalLoadReport has to be called before using this
function.
Parameters float fCurrent (rms excitation current)
enum TCTAQualifier* peStatus
(address to a status value)
Return value The terminal voltage calculated for the currently loaded
report and for the parameter values passed with this
function call.
The status value *peStatus contains the qualifier:
QV_INVALID = -1,
QV_VALID = 0,
QV_BOUNDED = +1
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim status As TCTAQualifier
result = cta.Calculate.EvalVTermAtExcitationCurrentRms
(50.0, status)
if status = QV_VALID then
Debug.Print result
end if
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
enum TCTAQualifier status;
float fMaxCurrent = cta->Calculate-
>EvalVTermAtExcitationCurrentRms (50.0, &status);

100 OMICRON
Description of interfaces and functions

6.11.2.13 EvalVCoreAtExcitationCurrentRms
Scope ICTACalc
Syntax Function EvalVCoreAtExcitationCurrentRms
([in]float fCurrent, [out]enum
TCTAQualifier* peStatus) : float
Description This function returns the core voltage for the specified
excitation current rms value. If the specified excitation
current exceeds the maximum excitation current listed in
the excitation table, the core voltage is limited, and the
value of *peStatus returns QV_BOUNDED ( = 1).
LocalLoadReport has to be called before using this
function.
Parameters float fCurrent (rms excitation current)
enum TCTAQualifier* peStatus
(address to a status value)
Return value The core voltage calculated for the currently loaded report
and for the parameter values passed with this function call.
The status value *peStatus contains the qualifier:
QV_INVALID = -1,
QV_VALID = 0,
QV_BOUNDED = +1
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim status As TCTAQualifier
result = cta.Calculate.EvalVCoreAtExcitationCurrentRms
(50.0, status)
if status = QV_VALID then
Debug.Print result
end if
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
enum TCTAQualifier status;
float fMaxCurrent = cta->Calculate-
>EvalVCoreAtExcitationCurrentRms (50.0, &status);

OMICRON 101
CTA Remote Control Programming Manual

6.11.2.14 EvalVCoreAtExcitationCurrentPeak
Scope ICTACalc
Syntax Function EvalVCoreAtExcitationCurrentPeak
([in]float fCurrent, [out]enum
TCTAQualifier* peStatus) : float
Description This function returns the core voltage for the specified
excitation current peak value. If the specified excitation
current exceeds the maximum excitation current listed in
the excitation table, the core voltage is limited, and the
value of *peStatus returns QV_BOUNDED ( = 1).
LocalLoadReport has to be called before using this
function.
Parameters float fCurrent (peak excitation current)
enum TCTAQualifier* peStatus
(address to a status value)
Return value The core voltage calculated for the currently loaded report
and for the parameter values passed with this function call.
The status value *peStatus contains the qualifier:
QV_INVALID = -1,
QV_VALID = 0,
QV_BOUNDED = +1
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim status As TCTAQualifier
result =
cta.Calculate.EvalVCoreAtExcitationCurrentPeak(50.0,
status)
if status = QV_VALID then
Debug.Print result
end if
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
enum TCTAQualifier status;
float fMaxCurrent = cta->Calculate-
>EvalVCoreAtExcitationCurrentPeak (50.0, &status);

102 OMICRON
Description of interfaces and functions

6.11.2.15 AL_MaxPrimaryCurrent
Scope ICTACalc
Syntax Function AL_MaxPrimaryCurrent([in]float
fError, [out]enum TCTAQualifier* peStatus)
: float
Description This function returns the max. primary current for a
specified ratio error and at burden impedance = 0 ohms.
Used to build the AL-Error graph.
LocalLoadReport has to be called before using this
function.
Parameters float fError (ratio error)
enum TCTAQualifier* peStatus
(address to a status value)
Return value The max. primary current calculated for the currently
loaded report and for the parameter values passed with
this function call.
The status value *peStatus contains the qualifier:
QV_INVALID = -1,
QV_VALID = 0,
QV_BOUNDED = +1
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim status As TCTAQualifier
result = cta.Calculate.AL_MaxPrimaryCurrent(10.0,
status)
if status = QV_VALID then
Debug.Print result
end if
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
enum TCTAQualifier status;
float fMaxCurrent = cta->Calculate-
>AL_MaxPrimaryCurrent (10.0, &status);

OMICRON 103
CTA Remote Control Programming Manual

6.11.2.16 AL_MaxImpedance
Scope ICTACalc
Syntax Function AL_MaxImpedance([in]float fError,
[in]float fCosPhi, [out]enum TCTAQualifier*
peStatus) : float
Description This function returns the max. burden impedance for a
specified ratio error and cosPhi at nominal primary current.
Used to build the AL-Error graph.
LocalLoadReport has to be called before using this
function.
Parameters float fError (ratio error)
float fCosPhi (cosine of phase angle)
enum TCTAQualifier* peStatus
(address to a status value)
Return value The max. burden impedance calculated for the currently
loaded report and for the parameter values passed with
this function call.
The status value *peStatus contains the qualifier:
QV_INVALID = -1,
QV_VALID = 0,
QV_BOUNDED = +1
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim status As TCTAQualifier
result = cta.Calculate.AL_MaxImpedance(10.0, 1.0,
status)
if status = QV_VALID then
Debug.Print result
end if
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
enum TCTAQualifier status;
float fMaxCurrent = cta->Calculate->AL_MaxImpedance
(10.0, 1.0, &status);

104 OMICRON
Description of interfaces and functions

6.11.2.17 AL_ImpedanceAtPrimaryCurrent
Scope ICTACalc
Syntax Function AL_ImpedanceAtPrimaryCurrent
([in]float fError, [in]float fIprim,
[in]float fCosPhi, [out]enum TCTAQualifier*
peStatus) : float
Description This function returns the burden impedance for a specified
error, primary current and cosPhi.
Used to build the AL-Error graph.
LocalLoadReport has to be called before using this
function.
Parameters float fError (ratio error)
float fIprim (primary current)
float fCosPhi (cosine of phase angle)
enum TCTAQualifier* peStatus
(address to a status value)
Return value The burden impedance calculated for the currently loaded
report and for the parameter values passed with this
function call.
The status value *peStatus contains the qualifier:
QV_INVALID = -1,
QV_VALID = 0,
QV_BOUNDED = +1
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim status As TCTAQualifier
result = cta.Calculate.AL_ImpedanceAtPrimaryCurrent
(10.0, 2000.0, 1.0, status)
if status = QV_VALID then
Debug.Print result
end if
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
enum TCTAQualifier status;
float fMaxCurrent = cta->Calculate-
>AL_ImpedanceAtPrimaryCurrent (10.0, 2000.0, 1.0,
&status);

OMICRON 105
CTA Remote Control Programming Manual

6.11.2.18 AL_PrimaryCurrentAtImpedance
Scope ICTACalc
Syntax Function AL_PrimaryCurrentAtImpedance
([in]float fError, [in]float fImpedance,
[in]float fCosPhi, [out]enum TCTAQualifier*
peStatus) : float
Description This function returns the primary current for a specified
error and a specified burden impedance and a specified
cosPhi.
Used to build the AL-Error graph.
LocalLoadReport has to be called before using this
function.
Parameters float fError (ratio error)
float fImpedance (burden impedance)
float fCosPhi (cosine of phase angle)
enum TCTAQualifier* peStatus
(address to a status value)
Return value The primary current calculated for the currently loaded
report and for the parameter values passed with this
function call.
The status value *peStatus contains the qualifier:
QV_INVALID = -1,
QV_VALID = 0,
QV_BOUNDED = +1
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim status As TCTAQualifier
result = cta.Calculate.AL_PrimaryCurrentAtImpedance
(10.0, 2.5, 1.0, status) (ratio error of 10 %?!)
if status = QV_VALID then
Debug.Print result
end if
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
enum TCTAQualifier status;
float fMaxCurrent = cta->Calculate-
>AL_PrimaryCurrentAtImpedance (10.0, 2.5, 1.0,
&status);

106 OMICRON
Description of interfaces and functions

6.11.2.19 AL_PrimaryCurrentAtNomBurden
Scope ICTACalc
Syntax Function AL_PrimaryCurrentAtNomBurden
([out]enum TCTAQualifier* peStatus) : float
Description This function returns the primary current at nominal
burden. (Error value, burden and cosPhi are taken from the
actually loaded measurement.)
Used to build the AL-Error graph.
LocalLoadReport has to be called before using this
function.
Parameters enum TCTAQualifier* peStatus
(address to a status value)
Return value The primary current calculated for the currently loaded
report and for the parameter values passed with this
function call.
The status value *peStatus contains the qualifier:
QV_INVALID = -1,
QV_VALID = 0,
QV_BOUNDED = +1
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim status As TCTAQualifier
result = cta.Calculate.AL_PrimaryCurrentAtNomBurden
(status)
if status = QV_VALID then
Debug.Print result
end if
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
enum TCTAQualifier status;
float fMaxCurrent = cta->Calculate-
>AL_PrimaryCurrentAtNomBurden (&status);

OMICRON 107
CTA Remote Control Programming Manual

6.11.2.20 AL_PrimaryCurrentAtOprBurden
Scope ICTACalc
Syntax Function AL_PrimaryCurrentAtOprBurden
([out] enum TCTAQualifier* peStatus) :
float
Description This function returns the primary current at operating
burden. (Error value, burden and cosPhi are taken from the
actually loaded measurement.)
Used to build the AL-Error Graph.
LocalLoadReport has to be called before using this
function.
Parameters enum TCTAQualifier* peStatus
(address to a status value)
Return value The primary current calculated for the currently loaded
report and for the parameter values passed with this
function call.
The status value *peStatus contains the qualifier:
QV_INVALID = -1,
QV_VALID = 0,
QV_BOUNDED = +1
Example in VB Dim cta as new CTA
cta.Results.LocalLoadReport “C:\my report.xml”
Dim status As TCTAQualifier
result = cta.Calculate.AL_PrimaryCurrentAtOprBurden
(status)
if status = QV_VALID then
Debug.Print result
end if
Example in C++ ICTAPtr pCTA(CLSID_CTA);
cta->Results->LocalLoadReport(_bstr_t(L"C:\my
report.xml"));
enum TCTAQualifier status;
float fMaxCurrent = cta->Calculate-
>AL_PrimaryCurrentAtOprBurden (&status);

108 OMICRON
Description of interfaces and functions

6.12 ICTAQuick (Quick measurement device)


The ICTAQuick interface is accessed through the ICTA::Quick property.
Using the functions of the ICTAQuick interface, you can use the CT Analyzer
as a signal generator and a general multimeter.
The power amplifier of the CT Analyzer can be adjusted to output a sinus or
DC signal in voltage or current mode.
The measurement input SEC can be adjusted to measure general input
signals.
For ratio measurement on CTs and VTs the ratio between input SEC and input
PRIM is calculated.
To simplify the configuration for some typical measurements on a CT or VT,
some predefined setting parameters are available.
In addition to the direct measurement of values from the terminals I-OUT, V-
SEC and V-PRIM some derived values are calculated and may be read out:
N … Ratio (V-SEC rms / V-PRIM rms)
Z … Impedance (V-SEC rms / I-OUT rms)
Phase … between V-SEC and I-OUT
Rs … Real part of the Impedance in the serial equivalent circuit
Rp … Real part of the Impedance in the parallel equivalent circuit
Xs … Imaginary part of the Impedance in the serial equivalent circuit
Xp … Imaginary part of the Impedance in the parallel equivalent circuit
Ls … Inductivity in the serial equivalent circuit
Lp … Inductivity in the parallel equivalent circuit
Cs … Capacity in the serial equivalent circuit
Cp … Capacity in the parallel equivalent circuit

Before using these functions, a valid connection to a CT Analyzer must


be available.

OMICRON 109
CTA Remote Control Programming Manual

6.12.1 Overview of functions


Function Brief description
SetSetting Set the value of a particular Quick test
parameter.
GetSetting Read the value of a particular Quick test
parameter.
GetResult Read the value of a particular Quick test
measurement result.
GetV1Results Read all voltage values of the SEC
measurement input at once.
GetV2Results Read all voltage values of the PRIM
measurement input at once.
GetI1Results Read all current values flowing out of the
OUTPUT terminal at once.
GetCalculatedResults Read all calculated values at once.
Calculated values means some important terms
for CTs and VTs, derived from real measurement
data (R, L, X, Z, …).
StartMeasurement Starts a Quick measurement.
StopMeasurement Stops a running Quick measurement.
Status Obtain the Quick measurement status.

6.12.2 Description of functions

6.12.2.1 SetSetting
Scope ICTAQuick
Syntax Function SetSetting ([in]TCTAQuickSetting
eData, [in]VARIANT vData) : VARIANT
Description Used to set the value of a particular quick test setting.
The specified value may be corrected automatically, if it
exceeds the allowed value range. The same value would
be returned when using the function GetSetting()
subsequently.
Parameters eData
(test parameter, the value of which you want to set
(element of TCTAQuickSetting, see page 190)).
Return value The return value should be the same as the in-parameter
vData but may be corrected automatically, if it exceeds
the allowed value range.
Example in VB See Example on page 117.

110 OMICRON
Description of interfaces and functions

6.12.2.2 GetSetting
Scope ICTAQuick
Syntax Function GetSetting ([in]TCTAQuickSetting
eData) : VARIANT
Description Reads the value of a particular quick test setting.
Parameters eData
(ID of the setting value to be read (element of
TCTAQuickSetting, see page 190))
Return value Setting value of the test parameter.
Example in VB See Example on page 117.

6.12.2.3 GetResult
Scope ICTAQuick
Syntax Function GetResult ([in]TCTAQuickResult
eData) : VARIANT
Description Reads a particular result value.
Parameters eData
(ID of the result value to be read (element of
TCTAQuickResult, see page 193))
Return value The result value (type: Variant).
A Variant is able to hold values of any data type. So the
returned value can be a float, an enumeration type or an
integer value.
For the actual data types of the requested ID, please refer
to TCTAQuickResult, see page 193.
Example in VB See Example on page 117.

OMICRON 111
CTA Remote Control Programming Manual

6.12.2.4 GetV1Results
Scope ICTAQuick
Syntax Function GetV1Results () : VARIANT
Description Reads all values of the SEC measurement channel at
once.
Using this function you can read the complete list of
available measurement values.
Parameters
Return value List of result values. This list is delivered as a value array
packed into a Variant type:
array[0] … V1 Range as integer
array[1] … V1 RMS value (volts) as float
array[2] … V1 AC value (volts) as float
array[3] … V1 DC value (volts) as float
array[4] … V1 frequency (Hz) as float
array[5] … V1 phase (degrees) as float
array[6] … V1 peak value + (volts) as float
array[7] … V1 peak value – (volts) as float
Example in VB See Example on page 117.

6.12.2.5 GetV2Results
Scope ICTAQuick
Syntax Function GetV2Results () : VARIANT
Description Reads all values of the PRIM measurement channel at
once.
Using this function you can read the complete list of
available measurement values.
Parameters
Return value List of result values. This list is delivered as a value array
packed into a Variant type:
array[0] … V2 Range as integer
array[1] … V2 RMS value (volts) as float
array[2] … V2 AC value (volts) as float
array[3] … V2 DC value (volts) as float
array[4] … V2 frequency (Hz) as float
array[5] … V2 phase (degrees) as float
array[6] … V2 peak value + (volts) as float
array[7] … V2 peak value – (volts) as float
Example in VB See Example on page 117.

112 OMICRON
Description of interfaces and functions

6.12.2.6 GetI1Results
Scope ICTAQuick
Syntax Function GetI1Results () : VARIANT
Description Reads all values of the OUTPUT measurement channel at
once.
Using this function you can read the complete list of
available measurement values.
Parameters
Return value List of result values. This list is delivered as a value array
packed into a Variant type:
array[0] … I1 Range as integer
array[1] … I1 RMS value (ampere) as float
array[2] … I1 AC value (ampere) as float
array[3] … I1 DC value (ampere) as float
array[4] … I1 frequency (Hz) as float
array[5] … I1 phase (degrees) as float
array[6] … I1 peak value + (ampere) as float
array[7] … I1 peak value – (ampere) as float
Example in VB See Example on page 117.

OMICRON 113
CTA Remote Control Programming Manual

6.12.2.7 GetCalculatedResults
Scope ICTAQuick
Syntax Function GetCalculatedResults () : VARIANT
Description Reads all values of the calculated results at once.
Calculated results are some specific values for CTs and
VTs derived from the values of the measurement channels.
Using this function you can read the complete list of
available calculated results.
Parameters
Return value List of result values. This list is delivered as a value array
packed into a Variant type:
array[0] … N = Ratio (V1rms/V2rms) as float
array[1] … Z = Impedance (V1rms/I1rms) as float
array[2] … Phase between V1 and I1 as float
array[3] … Rs = Real part of the Impedance in the
serial equivalent circuit as float
array[4] … Rp = Real part of the Impedance in the
parallel equivalent circuit as float
array[5] … Xs = Imaginary part of the Impedance in the
serial equivalent circuit as float
array[6] … Xp = Imaginary part of the Impedance in the
parallel equivalent circuit as float
array[7] … Ls = Inductivity in the serial equivalent
circuit as float
array[8] … Lp = Inductivity in the parallel equivalent
circuit as float
array[9] … Cs = Capacity in the serial equivalent
circuit as float
array[10] …Cp = Capacity in the parallel equivalent
circuit as float
Example in VB See Example on page 117.

114 OMICRON
Description of interfaces and functions

6.12.2.8 StartMeasurement
Scope ICTAQuick
Syntax Function StartMeasurement ()
Activates a quick test.
Control is immediately returned to the caller while the CT
Analyzer performs the test prodedure concurrently.
After the test activation, the quick status is
QST_NO_RESULTS.
This status is kept until one of the following occurs:
1. New measurement values are available on the CT
Analyzer. The status is changed to
QST_NEW_RESULTS.
2. A current overload occurs during the last
measurement cycle. The status is changed to
QST_CURRENT_OVL.
3. A power overload occurs during the last
measurement cycle. The status is changed to
QST_POWER_OVL.
4. The user aborts the measurement by pressing the
I/O-key or ESC-key on the CT Analyzer. The
status is changed to QST_USER_ABORT.
5. The connection between PC and CT Analyzer is
lost. The status is changed to QST_CONN_LOST.

After reading the status, the status is changed back to


QST_NO_RESULTS.
Parameters
Return value
Example in VB See Example on page 117.

6.12.2.9 StopMeasurement
Scope ICTAQuick
Syntax Function StopMeasurement ()
Description Aborts a running quick test.
Parameters
Return value
Example in VB See Example on page 117.

OMICRON 115
CTA Remote Control Programming Manual

6.12.2.10 Status
Scope ICTAQuick
Syntax Property Status : TCTAQuickStatus
Description This function is used to query the quick status.
The possible states are:
• QST_NO_RESULTS
• QST_NEW_RESULTS
• QST_USER_ABORT
• QST_CURRENT_OVL
• QST_POWER_OVL
• QST_CONN_LOST
Return value Current Quick measurement status (element of
TCTAQuickStatus, see page 197).
Example in VB See Example on page 117.

116 OMICRON
Description of interfaces and functions

6.12.3 Example

Dim CTAnalyzer As New CTARemoteLib.CTA


Dim MwArray
Dim Status
Dim Value

' start a Quick measurement, read measured and calculated values, stop measurement
Sub Main()
CTAnalyzer.USBConnect
If CTAnalyzer.eStatus <> CTA_STAT_NOT_CONNECTED Then
Value = CTAnalyzer.Quick.SetSetting(QSV_MEAS_TYPE, QMT_ADVANCED)
CTAnalyzer.Quick.StartMeasurement

' read measurement values


Status = CTAnalyzer.Quick.Status
While Status <> QST_USER_ABORT
If Status = QST_NEW_RESULTS Then
Value = CTAnalyzer.Quick.GetResult(QRV_MEAS_TYPE)
Debug.Print Value
MwArray = CTAnalyzer.Quick.GetV1Results
Debug.Print "V1 ="; MwArray(0); MwArray(1); MwArray(2); MwArray(3);
MwArray(4); MwArray(5); MwArray(6); MwArray(7)
MwArray = CTAnalyzer.Quick.GetV2Results
Debug.Print "V2 ="; MwArray(0); MwArray(1); MwArray(2); MwArray(3);
MwArray(4); MwArray(5); MwArray(6); MwArray(7)
MwArray = CTAnalyzer.Quick.GetI1Results
Debug.Print "I1 ="; MwArray(0); MwArray(1); MwArray(2); MwArray(3);
MwArray(4); MwArray(5); MwArray(6); MwArray(7)
MwArray = CTAnalyzer.Quick.GetCalculatedResults
Debug.Print "CR ="; MwArray(0); MwArray(1); MwArray(2); MwArray(3);
MwArray(4); MwArray(5); MwArray(6); MwArray(7);
MwArray(8); MwArray(9); MwArray(10)
End If
Status = CTAnalyzer.Quick.Status
Wend
CTAnalyzer.Quick.StopMeasurement
End If
CTAnalyzer.Disconnect
Set CTAnalyzer = Nothing
End Sub

OMICRON 117
CTA Remote Control Programming Manual

7 Enumeration types, test settings


and test results
7.1 Overview of types
7.2 Enumeration types .............................................................................. 119
7.2.1 TCTAAssessment ................................................................ 119
7.2.2 TCTACard ............................................................................ 119
7.2.3 TCTAClass ........................................................................... 120
7.2.4 TCTACoreType .................................................................... 121
7.2.5 TCTACompensation ............................................................ 122
7.2.6 TCTAInfoClass ..................................................................... 122
7.2.7 TCTAKtdCalculation ............................................................ 123
7.2.8 TCTALicense ....................................................................... 123
7.2.9 TCTAResultTestStatus ........................................................ 124
7.2.10 TCTASequence ................................................................... 124
7.2.11 TCTAStandard ..................................................................... 125
7.2.12 TCTAStatus ......................................................................... 125
7.2.13 TCTATempUnit .................................................................... 125
7.2.14 TCTAMeasInfo ..................................................................... 126
7.2.15 TCTAQualifier ...................................................................... 127
7.2.16 TCTAChecksResult ............................................................. 127
7.2.17 TCTABurdenType ................................................................ 127
7.2.18 TCTATPSpecMtd ................................................................. 128
7.2.19 TCTAAssessRule................................................................. 128
7.3 Test settings ........................................................................................ 129
7.3.1 TCTASettingValue ............................................................... 129
7.4 Test results .......................................................................................... 140
7.4.1 TCTAResultValue ................................................................ 140
7.4.2 TCTAResultIndexedValue ................................................... 173
7.4.3 TCTAAssessParameter ....................................................... 181
7.4.4 TCTAAssessInfo .................................................................. 184
7.5.1 TCTAQuickOutMode............................................................ 186
7.5.2 TCTAQuickRangeMode ....................................................... 186
7.5.3 TCTAQuickRangeV1 ........................................................... 186
7.5.4 TCTAQuickRangeV2 ........................................................... 187
7.5.5 TCTAQuickRangeI1 ............................................................. 187
7.5.6 TCTAQuickFilterMode ......................................................... 188
7.5.7 TCTAQuickMeasType.......................................................... 188
7.5.8 TCTAQuickSetting ............................................................... 190
7.5.9 TCTAQuickResult ................................................................ 193
7.5.10 TCTAQuickStatus ................................................................ 197

118 OMICRON
Enumeration types, test settings and test results

7.2 Enumeration types


7.2.1 TCTAAssessment
The elements of the type TCTAAssessment specify the possible values for
the assessment of a parameter (see Assessment card of the CT Analyzer).
The elements are used by the RV_ASSESSMENT_ parameters of the type
TCTAResultValue, refer to page 140.
Element Description
ASS_FAILED Results do not comply with the requirements.
ASS_NOT_ASSESSED No assessment possible.
ASS_OK The results measured for this parameter comply
with the requirements defined by the selected
standard and the parameters of the CT-Object
card.

7.2.2 TCTACard
The elements of the type TCTACard specify whether a test card is used in a
test or not (see Select Cards page of the CT Analyzer). The elements are used
by the SV_CARD_ parameters of the type TCTASettingValue, refer to page
129.

Element Description
CARD_DISABLE The corresponding card is not included in the test.
CARD_ENABLE The corresponding card is included in the test.

OMICRON 119
CTA Remote Control Programming Manual

7.2.3 TCTAClass
The elements of the type TCTAClass specify the accuracy class of the CT
(see CT-Object card and Assessment card of the CT Analyzer). The elements
are used by the parameter SV_CLASS of the type TCTASettingValue (refer to
page 129) and the parameter RV_OBJECT_CT_CLASS of the type
TCTAResultValue, refer to page 140.
Element Description
CLS_0_15 Class 0.15 according to IEEE C57.13.
CLS_0_15S Class 0.15S according to IEEE C57.13.
CLS_0_15N Class 0.15N according to IEEE C57.13
CLS_0_3 Class 0.3 according to IEEE C57.13.
ClS_0_3S Class 0.3S according to IEEE C57.13
CLS_0_6 Class 0.6 according to IEEE C57.13.
CLS_1_2 Class 1.2 according to IEEE C57.13.
CLS_2_4 Class 2.4 according to IEEE C57.13
CLS_4_8 Class 4.8 according to IEEE C57.13
CLS_C Class C according to IEEE C57.13.
CLS_K Class K according to IEEE C57.13.
CLS_T Class T according to IEEE C57.13.
CLS_X Class X according to IEEE C57.13.
CLS_0_1 Class 0.1 according to standard IEC 60044-1.
CLS_0_2 Class 0.2 according to standard IEC 60044-1.
CLS_0_2S Class 0.2S according to standard IEC 60044-1.
CLS_0_5 Class 0.5 according to standard IEC 60044-1.
CLS_0_5S Class 0.5S according to standard IEC 60044-1.
CLS_1 Class 1.0 according to standard IEC 60044-1.
CLS_3 Class 3 according to standard IEC 60044-1.
CLS_5 Class 5 according to standard IEC 60044-1.
CLS_2P Class 2P according to standard IEC 60044-1.
CLS_3P Class 3P according to standard IEC 60044-1.
CLS_4P Class 4P according to standard IEC 60044-1.
CLS_5P Class 5P according to standard IEC 60044-1.
CLS_6P Class 6P according to standard IEC 60044-1.
CLS_10P Class 10P according to standard IEC 60044-1.
CLS_2PR Class 2PR according to standard IEC 60044-1.
CLS_3PR Class 3PR according to standard IEC 60044-1.
CLS_4PR Class 4PR according to standard IEC 60044-1.
CLS_5PR Class 5PR according to standard IEC 60044-1.

120 OMICRON
Enumeration types, test settings and test results

CLS_6PR Class 6PR according to standard IEC 60044-1.


CLS_10PR Class 10PR according to standard IEC 60044-1.
CLS-PX Class PX according to standard IEC 60044-1
CLS_PXR Class PXR according to standard IEC 60044-1.
CLS_TPS Class TPS according to standard IEC 60044-6.
CLS_TPX Class TPX according to standard IEC 60044-6.
CLS_TPY Class TPY according to standard IEC 60044-6.
CLS_TPZ Class TPY according to standard IEC 60044-6.
UNKNOWN_CLASS Class not specified, to be determined using the
guesser function (test settings) or class could not be
determined during the test (test results).

7.2.4 TCTACoreType
The elements of the type TCTACoreType specify the core type of the CT (see
CT-Object card of the CT Analyzer). The elements are used by the parameter
SV_CT_CORE_P_M of the type TCTASettingValue (page 129) and the
parameter RV_OBJECT_CT_CORE_P_M of the type TCTAResultValue (page
140.

Element Description
CORE_M Measurement CT.
CORE_P Protection CT.
UNKNOWN_CORE Core type not specified, to be determined using
the guesser function (test settings) or
core type could not be determined during the
test (test results).

OMICRON 121
CTA Remote Control Programming Manual

7.2.5 TCTACompensation
The elements of the type TCTACompensation specify the factor the ratio
measurement is corrected. This factor allows measuring the ratio of a CT
inside a delta winding transformer. Choose DELTACOMP_2div3 if input PRIM
is connected to that two terminals of the transformer winding the CT is in
series. Choose DELTACOMP_1div3 if the PRIM input is connected to that
transformer terminals no CT is in series.
Element Description
DELTACOMP_1 Ratio measurement, not corrected.
DELTACOMP_2div3 Ratio measurement corrected by factor 2/3.
This correction allows the measurement of a CT
in a delta transformer (see CT Analyzer User
Manual, section "Measurement at a Delta
Winding Transformer").
DELTACOMP_1div3 Ratio measurement corrected by factor 1/3.
This correction allows the measurement of a CT
in a delta transformer (see CT-Analyzer User
Manual, section "Measurement at a Delta
Winding Transformer").

7.2.6 TCTAInfoClass
The elements of the type TCTAInfoClass specify the class (severity) of
occurring error messages or information messages. It can be queried using
the ICTA::Info property (refer to page 51).
Element Description
CTA_INFO_CLS_ERROR An error occurred during test operation. Errors
are critical events that lead to a test abortion. In
case of an error, the device either has a
hardware problem or can no longer be used
until the error is solved.
CTA_INFO_CLS_WARNING An operation warning. The device is still under
the control of the software but had a problem
during measurement or can not execute the
expected function.
CTA_INFO_CLS_TOOLTIP A tooltip comes up. Information of this kind are
not exposed to the remote component, but are
kept for compatibility with the CT Analyzer's way
of categorizing the messages.
CTA_INFO_CLS_HINT An informational hint is displayed on the
CT Analyzer, everything still works as expected.
CTA_INFO_CLS_NONE No error or information pending.

122 OMICRON
Enumeration types, test settings and test results

7.2.7 TCTAKtdCalculation
The elements of the type TCTAKtdCalculation specify whether the Ktd is
calculated with consideration of the remanence (KTDCALC_OMIC) or according
to IEC 60044-6 without consideration of the CT remanence (KTDCALC_NORM).

Element Description
KTDCALC_NORM Calculation of the Ktd (transient dimensioning
factor) according to the formulas defined in
IEC 60044-6. See CT Analyzer Users Manual,
chapter "Ktd calculation").
KTDCALC_OMIC Calculation of the Ktd according to the formulas
in IEC 60044-6 and with consideration of the
remanence of the CT. See CT-Analyzer Users
Manual, chapter "Ktd calculation").

7.2.8 TCTALicense
The elements of the type TCTALicense represent operations or features of
the CT Analyzer that require a license. Use the ICTA::HasLicense function to
query whether a certain license is present (refer to page 46).

Element Description
CTA_LIC_CLASS_GUESS Class guessing feature.
CTA_LIC_BURDEN_GUESS Burden guessing feature.
CTA_LIC_SIMULATION Simulation calculations feature.
CTA_LIC_IEC_60044_6 Test acc. to standard IEC 60044-6.
CTA_LIC_IEEE_C57_13 Test acc. to standard IEEE C57.13.
CTA_LIC_BURDEN_CARD Burden testing feature.
CTA_LIC_RATIO_TABLE Ratio measurement table feature.
CTA_LIC_RATIO_CARD Ratio testing feature.
CTA_LIC_ASSESSMENT_CARD Assessment information feature.
CTA_LIC_REMOTE_CONTROL Remote control feature enabled.
CTA_LIC_REFERENCE_CURVE Reference curve feature.
CTA_LIC_15kV_KNEE Allows testing of knee points of up to 15 kV
(instead of 4 kV max. knee point voltage).
CTA_LIC_ALL_LANG Device can be used with all languages.
CTA_LIC_QUICK_CARD Quick testing feature.
CTA_LIC_VT_TEST_CARD VT testing feature.
CTA_LIC_AL_GRAPH AL-Error graph feature.
CTA_LIC_IEC_60044_1 Test acc. to standard IEC 60044-1.
CTA_LIC_ENH_IEC1 Test enhanced IEC 60044-1 classes.
CTA_LIC_ENH_ANSI Test enhanced IEEE C57.13 classes.
CTA_LIC_PRIM_RESISTANCE Allows testing of primary resistance.

OMICRON 123
CTA Remote Control Programming Manual

_CARD
CTA_LIC_REMANENCE_CARD Allows testing of residual magnetism.
CTA_LIC_SWITCHB_SINGLE_ Allows testing of single-ratio CTs with a
RATIO connected switchbox.
CTA_LIC_SWITCHB_MULTI_R Allows testing of multi-ratio CTs with a
ATIO connected switchbox.
CTA_LIC_ALL_CORES Allows testing of protection and metering
CTs.
CTA_LIC_ALL_FREQUENCIES Allows testing with all frequencies.
CTA_LIC_ONLY_60Hz Allows testing only with 60Hz.
CTA_LIC_ONLY_P_CORES Allows testing only relaying CTs.
CTA_LIC_ONLY_M_CORES Allows testing only measurement CTs.

7.2.9 TCTAResultTestStatus
The elements of the type TCTAResultTestStatus specify the status of the
test, i.e. whether the test has been finished successfully or not. The elements
are used by the ..._TEST_STATUS parameters of the type
TCTAResultValue, refer to page 140.
Element Description
STAT_ABORT Test aborted, test results are not valid.
STAT_NA Test status cannot be determined, test results are
not valid.
STAT_NOK Test not OK, test results are not valid.
STAT_OK Test OK, test results are valid.

7.2.10 TCTASequence
The elements of the type TCTASequence specify the duty cycle according to
IEC 60044-6. The elements are used by the parameter SV_SEQ of the type
TCTASettingValue (page 129) and the parameter RV_OBJECT_SEQ of the
type TCTAResultValue (page 140).

Element Description
SEQ_C_O Single energization acc. to IEC 60044-6.
SEQ_C_O_C_O Double energization acc. to IEC 60044-6.

124 OMICRON
Enumeration types, test settings and test results

7.2.11 TCTAStandard
The elements of the type TCTAStandard specify the possible test standards
(see CT-Object card of the CT Analyzer) according to which the test can be
performed. The elements are used by the parameter SV_STD of the type
TCTASettingValue (page 129) and the parameter RV_OBJECT_STD of the
type TCTAResultValue (page 140).
Element Description
STD_60044_1 Standard IEC 60044-1.
STD_60044_6 Standard IEC 60044-6.
STD_ANSI_30 Standard IEEE C57.13 (30°).
STD_ANSI_45 Standard IEEE C57.13 (45°).

7.2.12 TCTAStatus
The elements of the type TCTAStatus specify the possible states of the CTA
remote component. The status is returned by the ICTA::eStatus property.
(refer to page 43).

Element Description
CTA_STAT_NOT_ No connection to the CT Analyzer established.
CONNECTED
CTA_STAT_READY The CT Analyzer is connected and ready for
operation.
CTA_STAT_WAIT_FOR_ The CT Analyzer is connected and waiting for the
ACKNOWLEDGE acknowledgement of an error or information. This
can be done using the Clear() function of the
ICTA::Info property.
CTA_STAT_ACTIVATED The CT Analyzer is activated and test is running.
CTA_STAT_PAUSED The CT Analyzer is activated, but the test is
paused since the test procedure requires the
rewiring of the test object in order to continue the
test.

7.2.13 TCTATempUnit
The elements of the type TCTATempUnit specify the temperature unit (see
Units page (default test settings) of the CT Analyzer). The elements are used
by the parameter SV_RESISTANCE_TEMP_UNIT of the type
TCTASettingValue (page 129) and the parameters
RV_RESISTANCE_TEMP_UNIT.

Element Description
TEMPUNIT_C Temperature unit "Celsius".
TEMPUNIT_F Temperature unit "Fahrenheit".

OMICRON 125
CTA Remote Control Programming Manual

7.2.14 TCTAMeasInfo
The elements of the type TCTAMeasInfo specify the actual state of a running
measurement. The meas info is returned by the ICTA::nMeasurementInfo
property.
Element Description
MI_NO_MEAS No measurement is running
MI_AC_TEST State during inhouse calibration cycles
MI_AUTO_CAL State during auto calibration
MI_WIRING_BUR State while the message "Check wiring before
burden test! Press <?> for connection diagram."
appears on the CT Analyzer display.
MI_WIRING_CT State while the message
"Check wiring before CT-test!
Press <?> for connection diagram."
appears on the CT Analyzer display.
MI_WIRING_RES_REM State while the message
"Check wiring before residual magnetism test!
Press <?> for connection diagram."
appears on the CT Analyzer display.
MI_MEAS_DEMAG State during demagnetization cycle.
MI_WIRING_PRI_RES State while the message "Check wiring before
primary winding resistance test! Press <?> for
connection diagram." appears on the CT Analyzer
display.
MI_START_DELAY State during start delay.
MI_MEAS_BUR State during burden measurement.
MI_MEAS_RES_REM State during residual magnetism measurement.
MI_MEAS_PRI_RES State during primary resistance measurement.
MI_MEAS_REV_POL_ State during reverse polarity detection.
DETECT
MI_MEAS_RES State during secondary resistance measurement.
MI_MEAS_EXC State during excitation curve measurement.
MI_MEAS_RAT State during current ratio measurement.
MI_MEAS_MAGNET State during demagnetisation cycle.
MI_MEAS_TAP_WIND_ State during tap winding ratio measurement.
RATIO
MI_MR_MEAS_RES State during multi-ratio resistance measurement.
MI_MR_MEAS_RAT State during multi-ratio ratio measurement.
MI_QUICK_REMOTE State during remote quick measurement.

126 OMICRON
Enumeration types, test settings and test results

7.2.15 TCTAQualifier
The elements of the type TCTAQualifier specify the return parameter of all
functions of the ICTACalc::… interface.
Element Description
QV_INVALID The calculation of the desired function failed.
QV_VALID The calculationof the desired function was
successful.
QV_BOUNDED The calculationof the desired function failed.
All calculation functions are based on some
values out of the excitation table.
For this case, the desired values are out of range
of the excitation table.

7.2.16 TCTAChecksResult
The elements of the type TCTAChecksResult specify the return parameter
from the function ICTAResults::IsReportSecure.
Element Description
CHKS_NOT_AVAIL No Node <Checksum> was found in the report
file.
CHKS_VALID Checksum was valid.
CHKS_INVALID Checksum was invalid.
The report file may be manipulated.

7.2.17 TCTABurdenType
The elements of the type TCTABurdenType specify the burden designation
for the standard IEEE C57.13.
Element Description
UNKNOWN_BURDEN_TYPE Guesser value "?"
BRD_TYPE_B16 Impedance = 16.0Ω, 400.0 VA at 5A, CosPhi 0.5
BRD_TYPE_B8 Impedance = 8.0Ω, 200.0 VA at 5A, CosPhi 0.5
BRD_TYPE_B4 Impedance = 4.0Ω, 100.0VA at 5A, CosPhi 0.5
BRD_TYPE_B2 Impedance = 2.0Ω, 50.0VA at 5A, CosPhi 0.5
BRD_TYPE_B1 Impedance = 1.0Ω, 25.0VA at 5A, CosPhi 0.5
BRD_TYPE_B18 Impedance = 1.8Ω, 45.0VA at 5A, CosPhi 0.9
BRD_TYPE_B09 Impedance = 0.9Ω, 22.5VA at 5A, CosPhi 0.9
BRD_TYPE_B05 Impedance = 0.5Ω, 12.5VA at 5A, CosPhi 0.9
BRD_TYPE_B02 Impedance = 0.2Ω, 5.0VA at 5A, CosPhi 0.9
BRD_TYPE_B01 Impedance = 0.1Ω, 2.5VA at 5A, CosPhi 0.9

OMICRON 127
CTA Remote Control Programming Manual

BRD_TYPE_E02 Impedance = 0.2Ω, 5.0VA at 5A, CosPhi 1.0


BRD_TYPE_E004 Impedance = 0.04Ω, 1.0VA at 5A, CosPhi 1.0

7.2.18 TCTATPSpecMtd
The elements of the type TCTATPSpecMtd specify the specification method
for the Ktd-value.

Defined for TP-CT’s and Standard 61869-2.

Element Description
SPEC_STD Specification according to standard 60044-6.
Ktd is calculated with the duty cycle, t1, tfr usw.
SPEC_ALT Alternate Specification.
Ktd is a setting-value.

7.2.19 TCTAAssessRule
The elements of the type TCTAAssesRule specify the rules which are
assigned to an assessment operation.
Element Description
ASS_RULE_VAL_LE_ Measured value less or equal than rated value.
RATED
ASS_RULE_VAL_GE_ Measured value greater or equal than rated value.
RATED
ASS_RULE_VAL_ Measured value within rated range.
WITHIN_RATED_RANGE

128 OMICRON
Enumeration types, test settings and test results

7.3 Test settings


The test settings are elements of the type TCTASettingValue.

7.3.1 TCTASettingValue
The elements of the type TCTASettingValue specify the setting parameters
(test settings) of the CT Analyzer.
Note The CTA remote component automatically limits the adjusted values to
their valid ranges.
Use the value -1 for parameters you want to have determined during
the test using the guesser function of the CT Analyzer. The value -1
corresponds to the question mark "?" displayed on the CT Analyzer.

Element (parameter) Type and description


SV_ALF Type: double
Possible values: 1 - 300
Accuracy limiting factor the CT is rated for. Before
defining this parameter, the standard (SV_STD),
the CT type (SV_CT_TYPE) and the class
(SV_CLASS) have to be defined first.
This parameter is part of the parameter Class on
the CT-Object card.
SV_OP_BURDEN Type: double
Possible values: 0 - 300
Value of the used operating burden (parameter
Burden on the CT-Object card).
SV_OP_BURDEN_ Type: double
COSPHI Possible values: 0 - 1
cosϕ of the used operating burden (parameter
Cosϕ on the CT-Object card).
SV_BURDEN_I_TEST Type: double
Possible values: 0.1 - 5
Test current used to measure the external burden
(parameter I-test on the Resistance card). If no
value is defined for this parameter, I-sn is used
instead.
SV_CARD_ASSESSMENT Type: enum TCTACard (page 120).
Enable/disable the Assessment card for the test.
SV_CARD_BURDEN Type: enum TCTACard (page 120).
Enable/disable the Burden card for the test.
SV_CARD_COMMENT Type: enum TCTACard (page 120).
Enable/disable the Comment card for the test.
SV_CARD_EXCITATION Type: enum TCTACard (page 120).
Enable/disable the Excitation card for the test.
SV_CARD_RATIO Type: enum TCTACard (page 120).
Enable/disable the Ratio card for the test.

OMICRON 129
CTA Remote Control Programming Manual

SV_CARD_RESISTANCE Type: enum TCTACard (page 120).


Enable/disable the Resistance card for the test.
SV_CLASS Type: enum TCTAClass (page 120).
Accuracy class of the CT. Before defining this
parameter, the standard (SV_STD) and the CT type
(SV_CT_TYPE) have to be defined first.
SV_CLASS_MULTIPLIER Type: double
Possible values: 0.25 - 1
Increases the assessment level for the ratio test.
E.g. a class multiplier of 0.5 means that the
maximum accepted tolerance for the ratio error is
only half the standard tolerance (standard error *
SV_CLASS_MULTIPLIER).
SV_COMMENT_TEXT Type: string
Possible values: 4095 characters max.
Comment to describe the test (content of the
Comment card).
SV_CORE_NR Type: string
identical to Possible values: 40 characters max.
SV_OBJ_CORE_NR Number of the core tested. Part of the CT-Object
definition.
SV_CT_CORE_P_M Type: enum TCTACoreType (page 121).
Definition of the CT core type: CORE_P for
protection CT, CORE_M for measurement CT or
Unknown_CORE to use the guesser function of the
CT Analyzer. Before defining this parameter, the
standard (SV_STD) has to be defined first.
SV_CT_TYPE Type: string
Possible values: 40 characters max.
Type of the CT (parameter Type on the CT-Object
card). Part of the CT-Object definition.
SV_DELTA_ Type: enum TCTACompensation (page 122).
COMPENSATION Possible values: Ratio 1, Ratio 2/3 Ratio 1/3
Allows that the measured ratio is corrected by the
error that would one get if a CT inside a delta
winding transformer is measured.
SV_FS Type: double
Possible values: 1 - 30
Instrument security factor the CT is rated for.
Before defining this parameter, the standard
(SV_STD), the CT type (SV_CT_TYPE) and the
class (SV_CLASS) have to be defined first.
This parameter is part of the parameter Class on
the CT-Object card.
SV_I_PN Type: double
Possible values: 1 - 99000
Rated primary current (parameter I-pn on the CT-
Object card).

130 OMICRON
Enumeration types, test settings and test results

SV_I_SN Type: double


Possible values: 0.001 - 10
Rated secondary current (parameter I-sn on the
CT-Object card). Before defining this parameter,
the standard (SV_STD), the CT type
(SV_CT_TYPE) and the class (SV_CLASS) have to
be defined first.
SV_IAL Type: double
Possible values: 0 - 30
Accuracy limiting secondary excitation current
(parameter Ial or Ie on the extended parameter
page of the CT-Object card). Before defining this
parameter, the standard (SV_STD), the CT type
(SV_CT_TYPE) and the class (SV_CLASS) have to
be defined first.
SV_IE Type: double
Possible values: 0 - 30
Accuracy limiting secondary excitation current acc.
to IEC 60044-1 class PX (parameter Ie on the
extended parameter page of the CT-Object card).
Before defining this parameter, the standard
(SV_STD), the CT type (SV_CT_TYPE) and the
class (SV_CLASS) have to be defined first.
SV_IDENT Type: string
Possible values: 40 characters max.
Test identification (to identify the location of the
CT).
If the parameter is read from a new report, the
location information SV_LOCATION limited to 40
characters is delivered. This parameter should not
be used in new software versions.
If this parameter is read from an old report that has
no location information, the content of the ident
string is delivered.
Note:
See also SV_LOCATION on page 136.
SV_K Type: double
Possible values: 0 - 1572
Dimensioning factor according to IEC 60044-6
class TPS (parameter K on the extended parameter
page of the CT-Object card).
The parameter K overwrites the parameter Tp
according to the formula
K −1
Tp = and vice versa.
ω
Before defining this parameter, the standard
(SV_STD) and the class (SV_CLASS) have to be
defined first.

OMICRON 131
CTA Remote Control Programming Manual

SV_KSSC Type: double


Possible values: 1 - 300
Rated symmetrical short-circuit current factor acc.
to IEC 60044-6 (parameter Kssc on the extended
parameter page of the CT-Object card). Before
defining this parameter, the standard (SV_STD)
and the class (SV_CLASS) have to be defined first.
SV_KTD Type: double
Possible values: 1 - 2043
Rated transient dimensioning factor according to
IEC 60044-6 (parameter Ktd on the extended
parameter page of the CT-Object card). Before
defining this parameter, the standard (SV_STD)
and the class (SV_CLASS) have to be defined first.
SV_KTD_CALCULATION Type: enum TCTAKtdCalculation (page 123)
The transient dimensioning factor according to
IEC 60044-6 can be calculated exactly as defined
in the standard or with consideration of the CT
remanence.
SV_KX Type: double
Possible values: 1 - 300
Dimensioning factor acc. to IEC 60044-1 class PX
(parameter Kx on the extended parameter page of
the CT-Object card). Before defining this
parameter, the standard (SV_STD) and the class
(SV_CLASS) have to be defined first.
SV_MANUF Type: string
Possible values: 40 characters max.
CT manufacturer (parameter Manuf. on the CT-
Object card).
SV_NOM_FREQ Type: double
Possible values: 16 - 400
Rated frequency of the CT (parameter f on the CT-
Object card).
SV_NOM_BURDEN Type: double
Possible values: 0 - 300
Nominal burden of the CT as defined on the name
plate, used to calculate the behavior of the CT at
the nominal burden.
For the nominal burden, no definition of the cosϕ is
allowed. The cosϕ is defined automatically
according to the selected standard instead. Refer to
the table "cosϕ depending on the selected nominal
burden and standard" at the end of this table.
SV_RCT Type: double
Possible values: 0 - 3000
Secondary winding resistance (parameter Rct on
the extended parameter page of the CT-Object
card).

132 OMICRON
Enumeration types, test settings and test results

SV_RESISTANCE_TEMP_ Type: enum TCTATempUnit (page 125).


UNIT Unit of the entered temperature (Celsius of
Fahrenheit). On the CT Analyzer, the temperature
unit can only be defined in the default test settings.
SV_RESISTANCE_TMEAS Type: double
Possible values: -150 to +150
Winding temperature of the CT during
measurement (parameter T-meas on the
Resistance card).
SV_RESISTANCE_TREF Type: double
Possible values: -150 to +150
Reference temperature, i.e. the temperature the CT
is specified for (parameter T-ref on the Resistance
card).
SV_RF Type: double
Possible values: 1 - 4
Thermal current rating factor. Before defining this
parameter, the standard (SV_STD), the CT type
(SV_CT_TYPE) and the class (SV_CLASS) have to
be defined first.
This parameter is part of the parameter Class on
the CT-Object card.
SV_SEQ Type: enum TCTASequence (page 124).
Duty cycle acc. to IEC 60044-6 (parameter Seq on
the extended parameter page of the CT-Object
card). Before defining this parameter, the standard
(SV_STD), the CT type (SV_CT_TYPE) and the
class (SV_CLASS) have to be defined first.
SV_SER_NR Type: string.
Possible values: 40 characters max.
Serial number of the CT as stated on the name
plate of the CT. Part of the CT-Object definition.
SV_STD Type: enum TCTAStandard (page 125).
Standard according to which the test is to be
performed.
Defining the standard is mandatory for every test.
SV_T1 Type: double
Possible values: 0 - 5
Duration of the first current flow according to
IEC 60044-6 (parameter t1 on the extended
parameter page of the CT-Object card). Before
defining this parameter, the standard (SV_STD),
the CT type (SV_CT_TYPE), the Class
(SV_CLASS) and the duty cycle (SV_SEQ) have to
be defined first.

OMICRON 133
CTA Remote Control Programming Manual

SV_T2 Type: double


Possible values: 0 - 5
Duration of the second current flow according to
IEC 60044-6 (parameter t2 on the extended
parameter page of the CT-Object card). Before
defining this parameter, the standard (SV_STD),
the CT type (SV_CT_TYPE), the Class
(SV_CLASS) and the duty cycle (SV_SEQ) have to
be defined first.
SV_TAL1 Type: double
Possible values: 0 - 5, but max. t1
Permissible time to accuracy limit for first
energizing period of the duty cycle according to
IEC 60044-6 (parameter t-al1 on the extended
parameter page of the CT-Object card). Before
defining this parameter, the standard (SV_STD),
the CT type (SV_CT_TYPE), the Class
(SV_CLASS), the duty cycle (SV_SEQ) and the
duration (SV_T1) have to be defined first.
SV_TAL2 Type: double
Possible values: 0 - 5, but max. t2
Permissible time to accuracy limit for second
energizing period of the duty cycle according to
IEC 60044-6 (parameter t-al2 on the extended
parameter page of the CT-Object card). Before
defining this parameter, the standard (SV_STD),
the CT type (SV_CT_TYPE), the Class
(SV_CLASS), the duty cycle (SV_SEQ) and the
duration (SV_T2) have to be defined first.
SV_TFR Type: double
Possible values: 0 - 5
Dead time between first opening and reclosure
according to IEC 60044-6 (parameter tfr on the
extended parameter page of the CT-Object card).
Before defining this parameter, the standard
(SV_STD), the CT type (SV_CT_TYPE), the Class
(SV_CLASS) and the duty cycle (SV_SEQ) have to
be defined first.
SV_TP Type: double
Possible values: 0 - 5
Primary time constant according to IEC 60044-6
(parameter Tp on the extended parameter page of
the CT-Object card). If the class TPS is used, the
parameter can be overwritten by the K factor (see
SV_K for details). Before defining this parameter,
the standard (SV_STD), the CT type
(SV_CT_TYPE) and the class (SV_CLASS) have to
be defined first.

134 OMICRON
Enumeration types, test settings and test results

SV_TS Type: double


Possible values: 0 - 100
Secondary loop time constant (parameter Ts on the
extended parameter page of the CT-Object card).
Before defining this parameter, the standard
(SV_STD), the CT type (SV_CT_TYPE) and the
class (SV_CLASS) have to be defined first.
SV_VAL Type: double
Possible values: 0.1 - 20000
Rated equivalent excitation limiting secondary
voltage according to IEC 60044-6 (parameter V-al
on the extended parameter page of the CT-Object
card). Before defining this parameter, the standard
(SV_STD), the CT type (SV_CT_TYPE) and the
class (SV_CLASS) have to be defined first.
SV_EK Type: double
Possible values: 0.1 - 20000
Rated equivalent excitation limiting secondary
voltage according to IEC 60044-1 class PX
(parameter Ek on the extended parameter page of
the CT-Object card). Before defining this
parameter, the standard (SV_STD), the CT type
(SV_CT_TYPE) and the class (SV_CLASS) have to
be defined first.
SV_VB Type: double
Possible values: 0 - 20000
Rated secondary terminal voltage according to
IEEE C57.13. Before defining this parameter, the
standard (SV_STD), the CT type (SV_CT_TYPE)
and the class (SV_CLASS) have to be defined first.
This parameter is part of the parameter Class on
the CT-Object card.

OMICRON 135
CTA Remote Control Programming Manual

Additional settings since version 3.0

Element (parameter) Type and description


SV_LOCATION Type: string
Possible values: 255 characters max.
Test identification (to identify the location of the
CT).
Note:
GetValue(SV_LOCATION) delivers a string
consisting of
SV_LOC_COMPANY
SV_LOC_COUNTRY
SV_LOC_STATION
SV_LOC_FEEDER
SV_LOC_PHASE
SV_LOC_IEC_ID
The strings are separated by a "\" character.
If the parameter is read from an old report that
contains a parameter "ident" instead of the
location parameters, the ident string is delivered.
SetValue(SV_LOCATION)has no effect.
Use instead:
SV_LOC_COMPANY
SV_LOC_COUNTRY
SV_LOC_STATION
SV_LOC_FEEDER
SV_LOC_PHASE
SV_LOC_IEC_ID
SV_LOC_COMPANY Type: string
Possible values: 40 characters max.
Company where the CT is installed.
If the parameter is read from an old report that
contains a parameter "ident" instead of the
location parameters, the ident string is delivered.
SV_LOC_COUNTRY Type: string
Possible values: 40 characters max.
Country where the CT is installed.
SV_LOC_STATION Type: string
Possible values: 40 characters max.
Station name where the CT is installed.
SV_LOC_FEEDER Type: string
Possible values: 40 characters max.
Feeder or bay where the CT is installed.
SV_LOC_PHASE Type: string
Possible values: 40 characters max.
Phase the CT is connected to.

136 OMICRON
Enumeration types, test settings and test results

SV_LOC_IEC_ID Type: string


Possible values: 40 characters max.
IEC ID number of the CT.
SV_OBJECT Type: string
Possible values: 255 characters max.
Object identification (to identify the CT).
Note:
GetValue(SV_OBJECT) reads a string
consisting of
SV_OBJ_MANUF
SV_OBJ_CT_TYPE
SV_OBJ_SER_NR
SV_OBJ_CORE_NR
SV_OBJ_TAP
SV_OBJ_OPTION1
The strings are separated by a "\" character.
SetValue(SV_OBJECT)has no effect.
Use instead:
SV_OBJ_MANUF
SV_OBJ_CT_TYPE
SV_OBJ_SER_NR
SV_OBJ_CORE_NR
SV_OBJ_TAP
SV_OBJ_OPTION1
SV_OBJ_MANUF Identical to (SV_MANUF).
SV_OBJ_CT_TYPE Identical to (SV_CT_TYPE).
SV_OBJ_SER_NR Identical to (SV_SER_NR).
SV_OBJ_CORE_NR Identical to (SV_CORE_NR).
SV_OBJ_TAP Type: string
Possible values: 40 characters max.
Description of taps, the tested winding is
connected to (e.g. "1S1-1S3).
(Improvement of the CT-Object identification.)
SV_OBJ_OPTION1 Type: string
Possible values: 40 characters max.
Optional definition (improvement of the CT-Object
identification).
SV_EXT Type: double
Possible values: 120 - 400
Rated extended primary current represented as
percentage of the rated primary current.
Before defining this parameter, the standard
(SV_STD), the CT type (SV_CT_TYPE) and the
class (SV_CLASS) have to be defined first.
This parameter extends the class definition for
standard IEC 60044-1 and measuring current
transformers on the CT-Object card.

OMICRON 137
CTA Remote Control Programming Manual

SV_IE1 Type: double


Possible values: 30μA – 30A
The default value is the value entered for SV_IE.
Rated secondary excitation current at the
excitation voltage defined in parameter SV_E1.
On the device, this parameter is defined in
parameter Ie1 on the CT-Object card.
Together with SV_E1, this is a second setpoint for
assessments for class PX and TPS CTs.
Depending on the standard, the rms or the peak
current has to be defined (peak current for
standard IEC 60044-6 (TPS), rms current for
standard IEC 60044-1 (PX)).
Before defining this parameter, the standard
(SV_STD), the CT type (SV_CT_TYPE) and the
class (SV_CLASS) have to be defined.
SV_E1 Type: double
Possible values: 0.1 V – 20000 V
The default value is the value entered for
parameter SV_EK or SV_VAL.
Rated e.m.f. voltage on specified voltage
according to IEC 60044-1 (parameter E1 on the
the CT-Object card).
Before defining this parameter, the standard
(SV_STD), the CT type (SV_CT_TYPE) and the
class (SV_CLASS) have to be defined first.
The parameters SV_E1 and SV_IE1 define a
second point on the excitation graph that is
assessed by the device for class PX and TPS
CTs. The device compares whether the current at
voltage SV_E1 is lower than the current defined in
parameter SV_IE1.
SV_AL_ERROR_GRAPH_ Type: TCTACard
ENABLE
Enable/disable the AL error graph for the test.
SV_CARD_PRIM_ Type: TCTACard
RESISTANCE
Enable/disable the primary resistance test.
SV_CARD_RES_REMANENCE Type: TCTACard
Enable/disable the residual magnetism test.
SV_RPRIM Type: double
Possible values: 0.0001 – 3000.0 ohms
Primary resistance.
SV_RE20 Type: int
Possible values: 1 - 20
Ratio error @ 20 * Isn [%]
SV_NOM_BURDEN_COSPHI Type: double
Possible values: 0.0 – 1.0
cosϕ of the used nominal burden (see table
below)

138 OMICRON
Enumeration types, test settings and test results

SV_CLASS_ASSESS_AT Type: Boolean


Possible values: 0, 1
Defines the accuracy class for C57.13.
If the accuracy class given is specific only to that
burden it is assigned, e.g. 0.3 @ B-0.5, then the
aqccuracy class is not guaranteed for other
burdens.
SV_BURDEN_TYPE_NOM_ Type: enum TCTABurdenType
BURDEN Burden designation for nominal burden
SV_BURDEN_TYPE_OPR_ Type: enum TCTABurdenType
BURDEN Burden designation for used operational burden
SV_EXT_VA Type: Boolean
Possible values: 0, 1
Extended VA for Standard IEC 61869-2
SV_TP_SPEC_MTD Type: enum TCTATPSpecMtd
Defines the Ktd specification method standard
61869-2 and TP-CTs.
SV_DESIGN Type: string
Possible values: 16 characters max.
String representation of the burden designation
for
Standard IEEE C57.13.
Examples: “B0.1 – B1.8”, “B0.5”, “E0.04”
SV_NOM_BURDEN_LOW Type: double
Possible values: 0 – 500
For standard IEEE C57.13 and M-core types, the
low range value of the nominal burden.
Example: Burdenrange “B0.1 – B1.8”
B1.8 defines the upper nominal burden
B0.1 defines the lower nominal burden
SV_BURDEN_TYPE_LOW Type: enum TCTABurdenType
For standard C57.13 and M-core types, the low
range value of the burden designation

cosϕ depending on the selected nominal burden and standard


Nominal Selected standard
burden 60044-1 60044-1 60044-6 IEEE IEEE
[VA] C57.13 C57.13
P M P M
< 5.0 1.0 1.0 1.0 0.5 0.9
>= 5.0 0.8 0.8 1.0 0.5 0.9

OMICRON 139
CTA Remote Control Programming Manual

7.4 Test results


The test results are elements of the types TCTAResultValue or
TCTAResultIndexedValue, depending on whether the result is a single value
or a list (array) of values.

7.4.1 TCTAResultValue
The type TCTAResultValue contains the test result parameters the result of
which is a single value.
Element (parameter) Description
RV_ASSESSMENT_CARD_EN Type: bool
Assessment card activated or deactivated.
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
BURDEN This value can only be assessed manually,
no automatic assessment available at the
moment.
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
ALF Assessment result for ALF (accuracy
limiting factor) according to the IEC 60044-1
direct measurement method. For details
about the assessment, please refer to the
CT Analyzer User Manual.
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
ALFI Assessment result for accuracy limiting
factor (ALF) calculated according to the
IEC 60044-1 indirect method. For details
about the assessment, please refer to the
CT Analyzer User Manual
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
EK Assessment result for accuracy limiting
voltage according to IEC 60044-1class PX.
For details about the assessment, please
refer to the CT Analyzer User Manual
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
FS Assessment result for instrument security
factor (FS) according to the IEC 60044-1
direct measurement method. For details
about the assessment, please refer to the
CT Analyzer User Manual.
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
FSI Assessment result for instrument security
factor (FS) calculated according to the
IEC 60044-1 indirect method. For details
about the assessment, please refer to the
CT Analyzer User Manual.

140 OMICRON
Enumeration types, test settings and test results

RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).


CLASS Assessment for the class. Depending on the
selected standard and class, different
parameters are assessed (see CT Analyzer
User Manual, chapter "Assessment Card"
for detailed information).
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
RCT Assessment, if the resistance entered in the
object page is > than the resistance
measured.
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
KR Assessment result for Kr. For details about
the assessment, please refer to the
CT Analyzer User Manual.
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
KSSC Assessment result for Kssc. For details
about the assessment, please refer to the
CT Analyzer User Manual.
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
KxKSSC Assessment for the product of the
symmetrical short-circuit overcurrent factor
and dimensioning parameter according to
IEC 60044-6 class TPS. Refer to
CT Analyzer User Manual, chapter
"Assessment Card".
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
KTDxKSSC Assessment for the product of the
symmetrical short-circuit overcurrent factor
and transient dimensioning factor according
to IEC 60044-6 class TPX, TPY, TPZ. Refer
to CT Analyzer User Manual, chapter
"Assessment Card".
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
TS Assessment result for Ts. For details about
the assessment, please refer to the
CT Analyzer User Manual.
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
VB Assessment result for Vb. For details about
the assessment, please refer to the
CT Analyzer User Manual.
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
IAL Assessment result for Ial (accuracy limiting
current) according to IEC 60044-6 class
TPS). For details about the assessment,
please refer to the CT Analyzer User
Manual.

OMICRON 141
CTA Remote Control Programming Manual

RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).


IE Assessment result for Ie (accuracy limiting
current) according to IEC 60044-1 class
PX). For details about the assessment,
please refer to the CT Analyzer User
Manual.
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
VAL Assessment result for accuracy limiting
voltage (Val) according to IEC 60044-6
class TPS). For details about the
assessment, please refer to the
CT Analyzer User Manual.
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
EPSILON_PEAK_AC Assessment result for accuracy limiting
Epsilon_peak ac according to IEC 60044-6
class TPZ). For details about the
assessment, please refer to the
CT Analyzer User Manual.

142 OMICRON
Enumeration types, test settings and test results

RV_ASSESSMENT_MANUAL_ Type: enum TCTAAssessment (page 119).


ASSESS_BURDEN Shows the status of the manual assessment
RV_ASSESSMENT_MANUAL_ entered by the user for the respective
ASSESS_ALF parameter on the Assessment card.
RV_ASSESSMENT_MANUAL_ This assessment is fully independent from
ASSESS_ALFI the automatic assessment of the
RV_ASSESSMENT_MANUAL_ CT Analyzer.
ASSESS_EK
RV_ASSESSMENT_MANUAL_
ASSESS_FS
RV_ASSESSMENT_MANUAL_
ASSESS_FSI
RV_ASSESSMENT_MANUAL_
ASSESS_CLASS
RV_ASSESSMENT_MANUAL_
ASSESS_IAL
RV_ASSESSMENT_MANUAL_
ASSESS_RCT
RV_ASSESSMENT_MANUAL_
ASSESS_KR
RV_ASSESSMENT_MANUAL_
ASSESS_KSSC
RV_ASSESSMENT_MANUAL_
ASSESS_KxKSSC
RV_ASSESSMENT_MANUAL_
ASSESS_KTDxKSSC
RV_ASSESSMENT_MANUAL_
ASSESS_TS
RV_ASSESSMENT_MANUAL_
ASSESS_VB
RV_ASSESSMENT_MANUAL_
ASSESS_IAL
RV_ASSESSMENT_MANUAL_
ASSESS_IE
RV_ASSESSMENT_MANUAL_
ASSESS_VAL
RV_ASSESSMENT_MANUAL_
ASSESS_EPSILON_PEAK_AC
RV_BURDEN_CARD_EN Type: bool
Burden card activated or deactivated.
RV_BURDEN_COSPHI Type: double
Cosϕ of the measured external burden.
RV_BURDEN_ERROR_LOC Type: integer
Location in the software where the error
was detected. Necessary to determine the
exact cause of error.

OMICRON 143
CTA Remote Control Programming Manual

RV_BURDEN_ERROR_NR Type: integer


For each error number, a detailed
description is available in the CT Analyzer
User Manual, explaining the error cause
and possible solutions.
RV_BURDEN_ERROR_PRIOR Type: integer
Indicates the severity of an error. See
chapter "Appendix: Error priority classes".
RV_BURDEN_IMEAS_I Type: double
Current measured during the burden test.
RV_BURDEN_IMEAS_PH Type: double
Phase angle between voltage and current
during burden measurement.
RV_BURDEN_IMPEDANCE Type: double
Impedance of the burden.
RV_BURDEN_ITEST Type: double
Test current selected for burden
measurement (not the current measured
during the test).
RV_BURDEN_OVL Type: bool
Indicates whether an overload occurred
during the test.
RV_BURDEN_TEST_STATUS Type: enum TCTAResultTestStatus (page
124).
Shows the status of the burden test.
RV_BURDEN_VA Type: double
Measured external burden.
2
Burden = Isn * Z
RV_BURDEN_VMEAS_PH Type: double
Always zero.
RV_BURDEN_VMEAS_V Type: double
Voltage measured at the burden during the
test.
RV_COMMENT_CARD_EN Type: bool
Comment card activated or deactivated.
RV_COMMENT_TEXT Type: string
Text contained in the comment card.
RV_DEBUG_NUMBER Type: integer
Number of debug variables in the protocol.
This value is a device internal variable and
not relevant for the user.
RV_EXCITATION_BURDEN_ALF Type: double
Accuracy limiting factor (ALF) according to
IEC 60044-1 direct measurement method at
operating burden (parameter Burden on the
CT-Object card). For the calculation, please
refer to the CT Analyzer User Manual.

144 OMICRON
Enumeration types, test settings and test results

RV_EXCITATION_BURDEN_ALF_Q Type: string (value ">" or empty)


Qualifier for ALF at operating burden. ALF is
prefixed by the ">" sign, if the CT Analyzer
is not able to measure up to the accuracy
limit.
RV_EXCITATION_BURDEN_ALFI Type: double
Accuracy limiting factor (ALF) according to
IEC 60044-1 indirect measurement method
at operating burden (parameter Burden on
the CT-Object card). For the calculation,
please refer to the CT Analyzer User
Manual.
RV_EXCITATION_BURDEN_ALFI_Q Type: string (value ">" or empty)
Qualifier for ALFI at operating burden. ALFI
is prefixed by the ">" sign, if the
CT Analyzer is not able to measure up to
the accuracy limit.
RV_EXCITATION_BURDEN_EK Type: double
Accuracy limiting voltage (Val) according to
IEC 60044-1 class PX. For the calculation,
please refer to the CT Analyzer User
Manual.
RV_EXCITATION_BURDEN_EMAX Type: double
Maximum emf voltage at operating burden.
Emax = K dt _ meas ⋅ K ssc ⋅ ( I sn ⋅ ( RCT + Rb ) 2 + X b2 )
This parameter allows the determination of
the working point on the excitation curve
that would be reached with the entered
settings on the measured CT.
RV_EXCITATION_BURDEN_EPS_ Type: double
PEAK Peak instantaneous error (ε^) at operating
burden according to IEC 60044-6 class
TPX, TPY.
RV_EXCITATION_BURDEN_EPS_ Type: string (value ">" or empty)
PEAK_Q ε^ is prefixed by the ">" sign, if the
CT Analyzer is not able to measure up to
the accuracy limit with operation burden.
RV_EXCITATION_BURDEN_EPS_ Type: double
PEAK_AC Peak instantaneous alternate error (ε^) at
operating burden according to IEC 60044-6
class TPX, TPY.
RV_EXCITATION_BURDEN_EPS_ Type: string (value ">" or empty)
PEAK_AC_Q ε^ is prefixed by the ">" sign, if the
CT Analyzer is not able to measure up to
the accuracy limit with operation burden.
RV_EXCITATION_BURDEN_FC Type: double
Factor of construction. Not yet supported by
the CT Analyzer.

OMICRON 145
CTA Remote Control Programming Manual

RV_EXCITATION_BURDEN_FS Type: double


Instrument security factor (FS) according to
IEC 60044-1 direct measurement method at
operating burden (parameter Burden on the
CT-Object card). For the calculation, please
refer to the CT Analyzer User Manual.
RV_EXCITATION_BURDEN_FS_Q Type: string (value ">" or empty)
Qualifier for FS at operating burden. FS is
prefixed by the ">" sign, if the CT Analyzer
is not able to measure up to the accuracy
limit.
RV_EXCITATION_BURDEN_FSI Type: double
Instrument security factor (FS) according to
IEC 60044-1 indirect measurement method
at operating burden (parameter Burden on
the CT-Object card). For the calculation,
please refer to the CT Analyzer User
Manual.
RV_EXCITATION_BURDEN_FSI_Q Type: string (value ">" or empty)
Qualifier for FSI at nominal burden. FSI is
prefixed by the ">" sign, if the CT Analyzer
is not able to measure up to the accuracy
limit.
RV_EXCITATION_BURDEN_IAL Type: double
Accuracy limiting current (Ial) according to
IEC 60044-6 class TPS.
RV_EXCITATION_BURDEN_IE Type: double
Accuracy limiting voltage (Ie) according to
IEC 60044-1 class PX.
RV_EXCITATION_BURDEN_KSSC Type: double
Rated symmetrical short-circuit current
factor at operating burden. See CT Analyzer
User Manual for the calculation method.
RV_EXCITATION_BURDEN_KSSC_Q Type: string (value ">" or empty)
Kssc is prefixed by the ">" sign, if the
CT Analyzer is not able to measure up to
the accuracy limit.
RV_EXCITATION_BURDEN_KTD Type: double
Transient dimensioning factor according to
IEC 60044-6 at operating burden. Two
calculation methods are offered (see
SV_KTD_CALCULATION on page 132).
See also the CT Analyzer User Manual,
chapter "Ktd calculation".
RV_EXCITATION_BURDEN_KX Type: double
Dimensioning factor according to
IEC 60044-1 class PX.

146 OMICRON
Enumeration types, test settings and test results

RV_EXCITATION_BURDEN_KX_Q Type: string (value ">" or empty)


Qualifier for KX at nominal burden. KX is
prefixed by the ">" sign, if the CT Analyzer
is not able to measure up to the accuracy
limit.
RV_EXCITATION_BURDEN_TS Type: double
Secondary time constant at operating
burden. For the calculation method, please
refer to the CT Analyzer User Manual.
RV_EXCITATION_BURDEN_VAL Type: double
Accuracy limiting voltage according to
IEC 60044-6 class TPS.
RV_EXCITATION_BURDEN_VB Type: double
Terminal voltage at operating burden
according to IEEE C57.13.
RV_EXCITATION_BURDEN_VB_Q Type: string (value ">" or empty)
VB is prefixed by the ">" sign, if the
CT Analyzer is not able to measure up to
the secondary terminal voltage for a 10%
ratio error.
RV_EXCITATION_CARD_EN Type: bool
Excitation card activated or deactivated.
RV_EXCITATION_CURVE_ Type: integer
NUMBER_POINTS Number of measurement points available
for the excitation curve.
RV_EXCITATION_EDDYRES Type: double
Determined eddy resistance.
RV_EXCITATION_ERROR_LOC Type: integer
Location in the software where the error
was detected. Necessary to determine the
exact cause of error.
RV_EXCITATION_ERROR_NR Type: integer
For each error number, a detailed
description is available in the CT Analyzer
User Manual, explaining the error cause
and possible solutions.
RV_EXCITATION_ERROR_PRIOR Type: integer
Indicates the severity of an error. See
chapter "Appendix: Error priority classes".
RV_EXCITATION_KNEEPOINT_ Type: double
ANSI30_I Knee point current acc. to IEEE C57.13
(30°).
-1 is returned, if no knee point exists.
RV_EXCITATION_KNEEPOINT_ Type: double
ANSI30_V Knee point voltage acc. to IEEE C57.13
(30°).
-1 is returned, if no knee point exists.

OMICRON 147
CTA Remote Control Programming Manual

RV_EXCITATION_KNEEPOINT_ Type: double


ANSI45_I Knee point current acc. to IEEE C57.13
(45°)
-1 is returned, if no knee point exists.
RV_EXCITATION_KNEEPOINT_ Type: double
ANSI45_V Knee point voltage acc. to IEEE C57.13
(45°).
-1 is returned, if no knee point exists.
RV_EXCITATION_KNEEPOINT_ Type: double
IEC_44_1_I Returns the highest knee point current acc.
to IEC 60044-1.
-1 is returned, if no knee point exists.
RV_EXCITATION_KNEEPOINT_2_ Type: double
IEC_44_1_I Returns the knee point current acc. to
IEC 60044-1 of the lowest knee point found,
if a second knee point exists.
-1 is returned, if no second knee point
exists.
RV_EXCITATION_KNEEPOINT_ Type: double
IEC_44_1_V Returns the highest knee point voltage acc.
to IEC 60044-1.
-1 is returned, if no knee point exists.
RV_EXCITATION_KNEEPOINT_2_ Type: double
IEC_44_1_V Returns the knee point voltage acc. to
IEC 60044-1 of the lowest knee point found,
if a second knee point exists.
-1 is returned, if no second knee point
exists.
RV_EXCITATION_KNEEPOINT_ Type: double
IEC_44_6_I Returns the highest knee point current acc.
to IEC 60044-6.
-1 is returned, if no knee point exists.
RV_EXCITATION_KNEEPOINT_2_ Type: double
IEC_44_6_I Returns the knee point current acc. to
IEC 60044-6 of the lowest knee point found,
if a second knee point exists.
-1 is returned, if no second knee point
exists.
RV_EXCITATION_KNEEPOINT_ Type: double
IEC_44_6_V Returns the highest knee point voltage acc.
to IEC 60044-6.
-1 is returned, if no knee point exists.
RV_EXCITATION_KNEEPOINT_2_ Type: double
IEC_44_6_V Returns the knee point voltage acc. to
IEC 60044-6 of the lowest knee point found,
if a second knee point exists.
-1 is returned, if no second knee point
exists.

148 OMICRON
Enumeration types, test settings and test results

RV_EXCITATION_KR Type: double


Remanence factor.
RV_EXCITATION_KTD_ Type: enum TCTAKtdCalculation (page
CALCULATION 123)
RV_OBJECT_KTD_CALCULATION It is possible to select whether the
calculation of the Ktd is done according to
IEC 60044-6 (remanence not considered) or
according to OMICRON (remanence
considered).
RV_EXCITATION_LS Type: double
Saturated inductance. Refer to the
CT Analyzer User Manual.
RV_EXCITATION_LU Type: double
Non-saturated inductance. Refer to the
CT Analyzer User Manual.
RV_EXCITATION_OVL Type: bool
Indicates whether an overload occurred
during the excitation test. An overload
occurs, if the knee point cannot be reached
or if the CT Analyzer had problems to
measure all necessary points.
RV_EXCITATION_REFCURVE_ Type: bool
EXIST Indicates whether a reference curve has
been loaded.
RV_EXCITATION_REFCURVE_ Type: double
KNEEPOINT_ANSI30_I Knee point current acc. to IEEE C57.13
(30°) of the reference curve.
RV_EXCITATION_REFCURVE_ Type: double
KNEEPOINT_ANSI30_V Knee point voltage acc. to IEEE C57.13
(30°) of the reference curve.
RV_EXCITATION_REFCURVE_ Type: double
KNEEPOINT_ANSI45_I Knee point current acc. to IEEE C57.13
(45°) of the reference curve.
RV_EXCITATION_REFCURVE_ Type: double
KNEEPOINT_ANSI45_V Knee point voltage acc. to IEEE C57.13
(45°) of the reference curve.
RV_EXCITATION_REFCURVE_ Type: double
KNEEPOINT_IEC_44_1_I Knee point current acc. to IEC 60044-1 of
the reference curve.
RV_EXCITATION_REFCURVE_ Type: double
KNEEPOINT_2_IEC_44_1_I Returns the knee point current acc. to
IEC 60044-1 of the lowest knee point found,
if a second knee point exists.
-1 is returned, if no second knee point
exists.
RV_EXCITATION_REFCURVE_ Type: double
KNEEPOINT_IEC_44_1_V Knee point voltage acc. to IEC 60044-1 of
the reference curve.

OMICRON 149
CTA Remote Control Programming Manual

RV_EXCITATION_REFCURVE_ Type: double


KNEEPOINT_2_IEC_44_1_V Returns the knee point voltage acc. to
IEC 60044-1 of the lowest knee point found,
if a second knee point exists.
-1 is returned, if no second knee point
exists.
RV_EXCITATION_REFCURVE_ Type: double
KNEEPOINT_IEC_44_6_I Knee point current acc. to IEC 60044-6 of
the reference curve.
RV_EXCITATION_REFCURVE_ Type: double
KNEEPOINT_2_IEC_44_6_I Returns the knee point current acc. to
IEC 60044-6 of the lowest knee point found,
if a second knee point exists.
-1 is returned, if no second knee point
exists.
RV_EXCITATION_REFCURVE_ Type: double
KNEEPOINT_IEC_44_6_V Knee point voltage acc. to IEC 60044-6 of
the reference curve.
RV_EXCITATION_REFCURVE_ Type: double
KNEEPOINT_2_IEC_44_6_V Returns the knee point voltage acc. to
IEC 60044-6 of the lowest knee point found,
if a second knee point exists.
-1 is returned, if no second knee point
exists.
RV_EXCITATION_REFCURVE_ Type: integer
NUMBER_POINTS Number of measurement points available
for the excitation curve of the reference file.
RV_EXCITATION_TEST_STATUS Type: enum TCTAResultTestStatus (page
124).
Shows the status of the excitation test.
RV_EXCITATION_VA_ALF Type: double
Calculated accuracy limiting factor (ALF)
according to IEC 60044-1 direct
measurement method at nominal burden
(parameter VA on the CT-Object card).
RV_EXCITATION_VA_ALF_Q Type: string (value ">" or empty)
Qualifier for ALF at nominal burden. ALF is
prefixed by the ">" sign, if the CT Analyzer
is not able to measure up to the accuracy
limit.
RV_EXCITATION_VA_ALFI Type: double
Accuracy limiting factor (ALF) according to
IEC 60044-1 indirect measurement method
at nominal burden (parameter VA on the
CT-Object card). For the calculation
method, please refer to the CT Analyzer
User Manual.

150 OMICRON
Enumeration types, test settings and test results

RV_EXCITATION_VA_ALFI_Q Type: string (value ">" or empty)


Qualifier for ALFI at nominal burden. ALFI is
prefixed by the ">" sign, if the CT Analyzer
is not able to measure up to the accuracy
limit.
RV_EXCITATION_VA_EK Type: double
Accuracy limiting voltage (Val) according to
IEC 60044-1 class PX. For the calculation
method, please refer to the CT Analyzer
User Manual.
RV_EXCITATION_VA_EMAX Type: double
Maximum emf voltage at nominal burden.
Emax = K dt _ meas ⋅ K ssc ⋅ ( I sn ⋅ ( RCT + Rb ) 2 + X b2 )
This parameter allows the determination of
the working point on the excitation curve
that would be reached with the entered
settings on the measured CT.
RV_EXCITATION_VA_EPS_PEAK Type: double
Peak instantaneous error (ε^) at nominal
burden according to IEC 60044-6 class
TPX, TPY.
RV_EXCITATION_VA_EPS_PEAK_Q Type: string (value ">" or empty)
ε^ is prefixed by the ">" sign, if the
CT Analyzer is not able to measure up to
the accuracy limit with nominal burden.
RV_EXCITATION_VA_EPS_PEAK_ Type: double
AC Peak instantaneous alternate error (ε^ ac)
at nominal burden according to IEC 60044-6
class TPX, TPY, TPZ.
RV_EXCITATION_VA_EPS_PEAK_ Type: string (value ">" or empty)
AC_Q ε^ is prefixed by the ">" sign, if the
CT Analyzer is not able to measure up to
the accuracy limit with nominal burden.
RV_EXCITATION_VA_FC Type: double
Not supported by the CT Analyzer.
RV_EXCITATION_VA_FS Type: double
Instrument security factor (FS) according to
IEC 60044-1 direct measurement method at
nominal burden (parameter VA on the CT-
Object card). For the calculation method,
please refer to the CT Analyzer User
Manual.
RV_EXCITATION_VA_FS_Q Type: string (value ">" or empty)
Qualifier for FS at nominal burden. FS is
prefixed by the ">" sign, if the CT Analyzer
is not able to measure up to the actual
instrument security current.

OMICRON 151
CTA Remote Control Programming Manual

RV_EXCITATION_VA_FSI Type: double


Instrument security factor (FS) according to
IEC 60044-1 indirect measurement method
at nominal burden (parameter VA on the
CT-Object card). For the calculation
method, please refer to the CT Analyzer
User Manual.
RV_EXCITATION_VA_FSI_Q Type: string (value ">" or empty)
Qualifier for FSI at nominal burden. FSI is
prefixed by the ">" sign, if the CT Analyzer
is not able to measure up to the actual
instrument security current.
RV_EXCITATION_VA_IAL Type: double
Accuracy limiting current (Ial) according to
IEC 60044-6 class TPS.
RV_EXCITATION_VA_IE Type: double
Accuracy limiting voltage (Ie) according to
IEC 60044-1 class PX.
RV_EXCITATION_VA_KSSC Type: double
Rated symmetrical short-circuit current
factor at nominal burden. For the calculation
method, please refer to the CT Analyzer
User Manual.
RV_EXCITATION_VA_KSSC_Q Type: string (value ">" or empty)
Kssc is prefixed by the ">" sign, if the
CT Analyzer is not able to measure up to
the actual short circuit current factor.
RV_EXCITATION_VA_KTD Type: double
Transient dimensioning factor according to
IEC 60044-6 at nominal burden. Two
calculation methods are offered (see
SV_KTD_CALCULATION on page 132).
Refer also to the CT Analyzer User Manual
chapter Ktd calculation.
RV_EXCITATION_VA_KX Type: double
Dimensioning factor according to
IEC 60044-1 class PX.
RV_EXCITATION_VA_KX_Q Type: string (value ">" or empty)
Kx is prefixed by the ">" sign, if the
CT Analyzer is not able to measure up to
the actual short circuit current factor.
RV_EXCITATION_VA_TS Type: double
Secondary time constant at nominal burden.
RV_EXCITATION_VA_VAL Type: double
Accuracy limiting voltage according to
IEC 60044-6 class TPS.
RV_EXCITATION_VA_VB Type: double
Terminal voltage at nominal burden
according to IEEE C57.13.

152 OMICRON
Enumeration types, test settings and test results

RV_EXCITATION_VA_VB_Q Type: string (value ">" or empty)


VB is prefixed by the ">" sign, if the
CT Analyzer is not able to measure up to
the secondary terminal voltage for a 10%
ratio error.
RV_GENERAL_DEVICE_CATEGORY Type: string
Returns “CT Analyzer”.
RV_GENERAL_DEVICE_SERIAL_ Type: string
NUMBER Serial number of the CT Analyzer.
RV_GENERAL_DEVICE_TYPE Type: string
Returns “CT Analyzer”.
RV_GENERAL_ERROR_LOC Type: integer
Location in the software where the error
was detected. Necessary to determine the
exact cause of error.
RV_GENERAL_ERROR_NR Type: integer
For each error number, a detailed
description is available in the CT Analyzer
User Manual, explaining the error cause
and possible solutions.
RV_GENERAL_ERROR_PRIOR Type: integer
Indicates the severity of an error. See
chapter "Appendix: Error priority classes".
RV_GENERAL_FILETYPE Type: string
Possible values: "Results", "Settings"
Indicates whether a file is a "Results" file or
a "Settings" file.
RV_GENERAL_HARDWARE_ Type: string
VERSION e.g: 01/00/07/05/00/10/01
Indicates the versions of the different
Hardware components of the CT Analyzer.
RV_GENERAL_SOFTWARE_ Type: string
VERSION e.g. "2.00 ALPHA 6 ( 06-11-22 13:35)"
Software version of the CT Analyzer.
RV_GENERAL_TEST_STATUS Type: enum TCTAResultTestStatus (page
124).
Shows the test status of the full test.
RV_GENERAL_TIME Type: string
Date and time (CT Analyzer time) when the
test was performed (live value returns the
actual time on the CT Analyzer).
(Format: DD-MM-YYYY, hh:mm:ss).
RV_GENERAL_XML_FILE_NAME Type: string
XML file name (live value returns an empty
string).
RV_GENERAL_XML_FILE_ Type: string
VERSION XML file version (live value returns an
empty string).

OMICRON 153
CTA Remote Control Programming Manual

RV_GENERAL_XML_LANGUAGE Type: string


Language of the XML file (live value returns
an empty string).
RV_OBJECT_ALF Type: double
Defined Accuracy Limiting Factor at nominal
burden the CT is defined for (second
parameter for Class on the CT-Object card).
The value returned is either the value
defined by the user or the value determined
by the guesser function.
Question mark is returned with the value -1.
RV_OBJECT_CT_CLASS Type: enum TCTAClass (page 120).
Values: e.g. 0.1, 5P, PX, 0.3, TPS, TPX…
Defined accuracy class of the CT
(parameter Class on the CT-Object card)
without accuracy limiting factor (ALF) or
instrument security factor (FS).
RV_OBJECT_CT_CLASS_ Type: double
MULTIPLIER Returns the class multiplier as defined on
the ratio card (see also
SV_CLASS_MULTIPLIER on page 130).
RV_OBJECT_CT_CLASS_STRING Type: string
For internal use only!
RV_OBJECT_CT_CLASSGUESS Type: bool
Indicates whether the class and the class
string were determined by the guesser
function or defined by the user.
RV_OBJECT_CT_CORE_NR Type: string (40 characters max.).
Text specified in the "Core:" field on the
Object settings menu.
Improvement of the CT object definition.
RV_OBJECT_CT_COREGUESS Type: bool
Value: 1 = guessed
Indicates whether the core type (P/M) was
determined by the guesser function or
defined by the user.
RV_OBJECT_CT_CORE_P_M Type: enum TCTACoreType (page 121).
Core type of the CT (parameter P/M on the
CT-Object card). The core type can be
defined by the user or determined by the
guesser function (see
RV_OBJECT_CT_COREGUESS above).
RV_OBJECT_CT_MANUFACTURER Type: string (40 characters max.).
Text specified in the parameter "Manufact:"
on the Object settings menu.
Improvement of the CT object definition.
RV_OBJECT_CT_NOM_FREQ Type: double
Rated frequency of the CT (parameter f on
the CT-Object card).

154 OMICRON
Enumeration types, test settings and test results

RV_OBJECT_CT_SERIAL_NR Type: string (40 characters max.).


Text specified in the parameter "SerialNo:"
on the Object settings menu.
Improvement of the CT object definition.
RV_OBJECT_CT_TYPE Type: string (40 characters max.).
Text specified in the parameter "SerialNo:"
on the Object settings menu.
Improvement of the CT object definition.
RV_OBJECT_EK Type: double
Defined accuracy limiting voltage in the
Object page. This parameter can be defined
by the user or determined by the guesser
function.
RV_OBJECT_EK_GUESS Type: bool
Value: 1 = guessed
Indicates whether the accuracy limiting
voltage (Ek) was determined by the guesser
function or defined by the user.
RV_OBJECT_FS Type: double
Defined Instrument security factor at
nominal burden the CT is defined for
(second parameter for Class on the CT-
Object card). This parameter can be defined
by the user or determined by the guesser
function.
Question mark is returned with the value -1.
RV_OBJECT_I_PN Type: double
Rated primary current (parameter I-pn on
the CT-Object card). This parameter can be
defined by the user or determined by the
guesser function (see
RV_OBJECT_I_PN_GUESS below).
RV_OBJECT_I_PN_GUESS Type: bool
Value: 1 = determined by guesser function
Indicates whether the value for I-pn was
determined by the guesser function or
defined by the user.
RV_OBJECT_I_SN Type: double
Rated secondary current (parameter I-sn on
the CT-Object card). This parameter can be
defined by the user or determined by the
guesser function (see
RV_OBJECT_I_SN_GUESS below).
RV_OBJECT_I_SN_GUESS Type: bool
Value: 1 = determined by guesser function
Indicates whether the value for I-sn was
determined by the guesser function or
defined by the user.

OMICRON 155
CTA Remote Control Programming Manual

RV_OBJECT_IAL Type: double


Defined accuracy limiting secondary
excitation current on the Object page. This
parameter can be defined by the user or
determined by the guesser function.
RV_OBJECT_IAL_GUESS Type: bool
Value: 1 = determined by guesser function
Indicates whether the value for Ial was
determined by the guesser function or
defined by the user.
RV_OBJECT_IDENTITY Type: string
Test identification (parameter Ident.)
specified on the CT-Object card (40
characters max.).
RV_OBJECT_IE Type: double
Defined accuracy limiting secondary
excitation current on the Object page
according to IEC 60044-1 class PC. This
parameter can be defined by the user or
determined by the guesser function.
RV_OBJECT_IE_GUESS Type: bool
Value: 1 = determined by guesser function
Indicates whether the value for Ie was
determined by the guesser function or
defined by the user.
RV_OBJECT_K Type: double
K factor for IEC 60044-6 class TPS.
RV_OBJECT_KSSC Type: double
Rated symmetrical short-circuit current
factor.
RV_OBJECT_KSSC_GUESS Type: bool
Value: 1 = determined by guesser function
Indicates whether the value for Kssc was
determined by the guesser function or
defined by the user.
RV_OBJECT_KTD_CALCULATION Type: enum TCTAKtdCalculation (page
123)
identical to
It is possible to select whether the
RV_EXCITATION_KTD_ calculation of the Ktd is done according to
CALCULATION
IEC 60044-6 (remanence not considered) or
according to OMICRON (remanence
considered).
RV_OBJECT_KTD Type: double
Rated transient dimensioning factor.
RV_OBJECT_KTD_GUESS Type: bool
Value: 1 = determined by guesser function
Indicates whether the value for Ktd was
determined by the guesser function or
defined by the user.

156 OMICRON
Enumeration types, test settings and test results

RV_OBJECT_KX Type: double


Dimensioning factor defined on the
CT Object card.
RV_OBJECT_KX_GUESS Type: bool
Value: 1 = determined by guesser function
Indicates whether the value for Kx was
determined by the guesser function or
defined by the user.
RV_OBJECT_NOM_BURDEN_COSPHI Type: double
Cosϕ of the nominal burden (not the
parameter Cosϕ on the CT-Object card).
This parameter is used for nominal burden
dependent calculations. The parameter
cannot be entered. It is chosen by the
device automatically depending on the
selected standard and the selected nominal
burden.
RV_OBJECT_NOM_BURDEN Type: double
Nominal burden of CT. Used to calculate
the behavior of the CT at nominal burden
(parameter VA on the CT-Object card).
For the nominal burden, the cosϕ cannot be
adjusted since the cosϕ value defined in the
according standards is used instead.
RV_OBJECT_NOM_BURDEN_GUESS Type: bool
Value: 1 = determined by guesser function
Indicates whether the value for the nominal
burden (VA) was determined by the guesser
function or defined by the user.
RV_OBJECT_OP_BURDEN Type: double
Operating burden (parameter Burden on the
CT-Object card). This parameter is used for
operating burden-dependent calculations.
RV_OBJECT_OP_BURDEN_GUESS Type: bool
Value: 1 = determined by guesser function
Indicates whether the value for the
operating burden (Burden) was determined
by the guesser function or defined by the
user.
RV_OBJECT_OP_BURDEN_COSPHI Type: double
cosϕ of the operating burden (parameter
Cosϕ on the CT-Object card). This
parameter is used for operating burden-
dependent calculations.

OMICRON 157
CTA Remote Control Programming Manual

RV_OBJECT_OP_BURDEN_COSPHI_ Type: bool


GUESS Value: 1 = determined by guesser function
Indicates whether the CosPhi (CosPhi)
value for the operating burden was
determined by the guesser function or
defined by the user.
RV_OBJECT_RCT Type: double
Secondary winding resistance (parameter
Rct on the extended parameter page of the
CT-Object card). Only used for assessment.
RV_OBJECT_RCT_GUESS Type: bool
Value: 1 = determined by guesser function
Indicates whether the value for Rct was
determined by the guesser function or
defined by the user.
RV_OBJECT_RF Type: double
Continuous current rating factor according
to IEEE C57.13 (parameter RF (Class) on
the CT-Object card).
RV_OBJECT_SEQ Type: enum TCTASequence (page 124).
Specified duty cycle according to
IEC 60044-6 (parameter Seq on the
extended parameter page of the CT-Object
card).
RV_OBJECT_STD Type: enum TCTAStandard (page 125).
Defined standard for the CT test (parameter
Std on the CT-Object card).
RV_OBJECT_T1 Type: double
Duration of the first current flow according to
IEC 60044-6 (parameter t1 on the extended
parameter page of the CT-Object card)
RV_OBJECT_T2 Type: double
Duration of the second current flow
according to IEC 60044-6 (parameter t2 on
the extended parameter page of the CT-
Object card).
RV_OBJECT_TAL1 Type: double
Permissible time to accuracy limit for first
energizing period of the duty cycle
according to IEC 60044-6 (parameter t-al1
on the extended parameter page of the CT-
Object card).
RV_OBJECT_TAL2 Type: double
Permissible time to accuracy limit for
second energizing period of the duty cycle
cycle according to IEC 60044-6 (parameter
t-al2 on the extended parameter page of the
CT-Object card).

158 OMICRON
Enumeration types, test settings and test results

RV_OBJECT_TFR Type: double


Dead time between first opening and
reclosure cycle according to IEC 60044-6
(parameter tfr on the extended parameter
page of the CT-Object card).
RV_OBJECT_TP Type: double
Specified primary time constant (parameter
Tp on the extended parameter page of the
CT-Object card).
RV_OBJECT_TS Type: double
Secondary loop time constant (parameter
Ts on the extended parameter page of the
CT-Object card).
RV_OBJECT_TS_GUESS Type bool
Value: 1 = determined by guesser function
Indicates whether the value for Ts was
determined by the guesser function or
defined by the user.
RV_OBJECT_VAL Type: double
Rated equivalent excitation limiting
secondary voltage (parameter V-al on the
extended parameter page of the CT-Object
card).
RV_OBJECT_VAL_GUESS Type bool
Value: 1 = determined by guesser function
Indicates whether the value for the accuracy
limiting voltage (Val) was determined by the
guesser function or defined by the user.
RV_OBJECT_VB Type: double
Rated secondary terminal voltage according
to IEEE C57.13 (second parameter of Class
on the CT-Object card). Question mark is
returned with the value -1.
RV_RATIO_CARD_EN Type: bool
Ratio card activated or deactivated.
RV_RATIO_COMPOSITE_ERROR_ Type: double
PERC Composite error according to IEC 60044-1
at the specified primary current and
operating burden (parameter εc on the Ratio
card).
RV_RATIO_CORE_MEASURMENT_ Type: double
I1_V Debug parameter, returns the rms current
measured during core ratio measurement.
RV_RATIO_CORE_MEASURMENT_ Type: integer
NR_POINTS Number of measurement points during core
ratio measurement.

OMICRON 159
CTA Remote Control Programming Manual

RV_RATIO_CORE_MEASURMENT_ Type: double


PHV1_VCORE_DEGREES Debug parameter, returns the phase
between input SEC and Vcore during core
ratio measurement.
RV_RATIO_CORE_MEASURMENT_ Type: double
PHV12_DEGREES Debug parameter, returns the phase
between inputs SEC and PRIM during core
ratio measurement.
RV_RATIO_CORE_MEASURMENT_ Type: double
PHV1I_DEGREES Debug parameter, returns the phase
between input SEC and the output current
during core ratio measurement.
RV_RATIO_CORE_MEASURMENT_ Type: double
V1_V Debug parameter, returns the rms voltage
at input SEC during core ratio
measurement.
RV_RATIO_CORE_MEASURMENT_ Type: double
V2_V Debug parameter, returns the rms voltage
at input PRIM during core ratio
measurement.
RV_RATIO_CORE_MEASURMENT_ Type: double
VCORE_V Debug parameter, returns the rms voltage in
the core during core ratio measurement.
RV_RATIO_CORE_RATIO Type: double
Measured turns ratio (parameter N on the
Ratio card).
RV_RATIO_CURVE_NUMBER_ Type: integer
POINTS Number of measurement points available
for the extended excitation curve (points at
low voltage).
RV_RATIO_DELTA_COMPENSATION Type: enum TCTACompensation (page
122)
Possible values:
Ratio 1, Ratio 2/3, Ratio 1/3
Defined type of ratio correction factor for the
measurements of CTs in delta winding
transformers.
RV_RATIO_DEVIATION_PERC Type: double
Deviation from the rated ratio in % (second
value of parameter Ratio on the Ratio card).
RV_RATIO_DISPL_STRING Type: string
Ratio shown as string (e.g. 2000:0.9997).
The deviation is not included.
RV_RATIO_ERROR_LOC Type: integer
Location in the software where the error
was detected. Necessary to determine the
exact cause of error.

160 OMICRON
Enumeration types, test settings and test results

RV_RATIO_ERROR_NR Type: integer


For each error number, a detailed
description is available in the CT Analyzer
User Manual, explaining the error cause
and possible solutions.
RV_RATIO_ERROR_PRIOR Type: integer
Indicates the severity of an error. See
chapter "Appendix: Error priority classes".
RV_RATIO_PHASE_ERROR_DEGREE Type: double
Phase displacement (in degree) at nominal
primary current and operating burden.
RV_RATIO_POLARITY Type: integer
Values: 0 = not ok / 1 = ok
Polarity OK, phase error in the range of
0° ± 45°.
RV_RATIO_PRIM_A Type: integer
Primary current of the parameter Ratio on
the Ratio card, identical with primary current
on CT-Object card.
RV_RATIO_RCF Type: double
Ratio correction factor according to
IEEE C57.13 (parameter RCF on the Ratio
card).
RV_RATIO_SEC_A Type: double
Secondary current of the parameter Ratio
on the Ratio card. The secondary current is
calculated at I-pn and the operating burden.
RV_RATIO_SIMUL_PRIMARY_ Type: double
I_P_A Primary current for the calculation of the
ratio error and the phase displacement with
the operating burden, defined in the CT-
Object card (parameter I-p on the Ratio
card).
RV_RATIO_TABLE_NR_COLUMNS Type: integer
Number of columns in the Ratio Table and
the Phase Table (of the Ratio card).
RV_RATIO_TABLE_NR_ROWS Type: integer
Number of rows in the Ratio Table and the
Phase Table (of the Ratio card).
RV_RATIO_TEST_STATUS Type: enum TCTAResultTestStatus (page
124).
Shows the status of the Ratio test.
RV_RESISTANCE_CARD_EN Type: bool
Resistance card activated or deactivated.
RV_RESISTANCE_ERROR_LOC Type: integer
Location in the software where the error
was detected. Necessary to determine the
exact cause of error.

OMICRON 161
CTA Remote Control Programming Manual

RV_RESISTANCE_ERROR_NR Type: integer


For each error number, a detailed
description is available in the CT Analyzer
User Manual, explaining the error cause
and possible solutions.
RV_RESISTANCE_ERROR_PRIOR Type: integer
Indicates the severity of an error. See
chapter "Appendix: Error priority classes".
RV_RESISTANCE_IDC_MEAS Type: double
Measurement current during winding
resistance test (parameter I-DC on the
Resistance card).
RV_RESISTANCE_ITEST Type: double
Selected test current to measure the
winding resistance (parameter I-test on the
Resistance card).
RV_RESISTANCE_R_MEAS Type: double
Measured resistance at ambient
temperature (parameter R-meas on the
Resistance card).
RV_RESISTANCE_R_REF Type: double
Reference resistance (temperature-
compensated resistance, compensated to
T-ref) (parameter R-ref on the Resistance
card).
RV_RESISTANCE_TEST_STATUS Type: enum TCTAResultTestStatus (page
124).
Shows the status of the resistance test.
RV_RESISTANCE_TMEAS Type: double
Defined ambient temperature (parameter
T-meas on the Resistance card).
RV_RESISTANCE_TEMP_UNIT Type: enum TCTATempUnit (page 125).
Temperature unit used for T-meas in the
Resistance card (°C or °F).
RV_RESISTANCE_TREF Type: double
Reference temperature (parameter T-ref on
the Resistance card).
RV_RESISTANCE_VDC_MEAS Type: double
Measurement voltage during winding
resistance test (parameter V-DC on the
Resistance card).
RV_SENSORS_SENSOR_V1_GAIN Type: double
For external sensors, currently not used.
RV_SENSORS_SENSOR_V1_OFFS Type: double
For external sensors, currently not used.
RV_SENSORS_SENSOR_V1_PHASE Type: double
For external sensors, currently not used.

162 OMICRON
Enumeration types, test settings and test results

RV_SENSORS_SENSOR_V2_GAIN Type: double


For external sensors, currently not used.
RV_SENSORS_SENSOR_V2_OFFS Type: double
For external sensors, currently not used.
RV_SENSORS_SENSOR_V2_PHASE Type: double
For external sensors, currently not used.
RV_RATIO_TURNS_ERROR Type: double
Shows the turns ratio error.

Additional result values since version 3.0

Element (parameter) Type and description


RV_OBJECT_LOCATION Type: string (255 characters max.)
Text specified in the "Location:" field on the
CT-Object card.
RV_OBJECT_LOC_COMPANY Type: string (40 characters max.)
Text specified in the "Company:" field on
the Location settings menu.
Improvement of the CT location definition.
RV_OBJECT_LOC_COUNTRY Type: string (40 characters max.)
Text specified in the "Country:" field on the
Location settings menu.
Improvement of the CT location definition.
RV_OBJECT_LOC_STATION Type: string (40 characters max.)
Text specified in the "Station:" field on the
Location settings menu.
Improvement of the CT location definition.
RV_OBJECT_LOC_FEEDER Type: string (40 characters max.)
Text specified in the "Feeder:" field on the
Location settings menu.
Improvement of the CT location definition.
RV_OBJECT_LOC_PHASE Type: string (40 characters max.)
Text specified in the "Phase:" field on the
Location settings menu.
Improvement of the CT location definition.
RV_OBJECT_LOC_IECID Type: string (40 characters max.)
Text specified in the "IEC-ID:" field on the
Location settings menu.
Improvement of the CT location definition.

OMICRON 163
CTA Remote Control Programming Manual

RV_OBJECT_OBJECT Type: string (255 characters max.)


Text specified in the "Object:" field on the
CT-Object card.
Note: Delivers a string consisting of
RV_OBJECT_OBJ_MANUF
RV_OBJECT_OBJ_CT_TYPE
RV_OBJECT_OBJ_SER_NR
RV_OBJECT_OBJ_CORE_NR
RV_OBJECT_OBJ_TAP
RV_OBJECT_OBJ_OPTION1
The strings are separated by a "\" character
RV_OBJECT_OBJ_MANUF Identical to
RV_OBJECT_CT_MANUFACTURER.
RV_OBJECT_OBJ_CT_TYPE Identical to RV_OBJECT_CT_TYPE.
RV_OBJECT_OBJ_CT_SER_NR Identical to RV_OBJECT_CT_SERIAL_NR.
RV_OBJECT_OBJ_CT_CORE_NR Identical to RV_OBJECT_CT_CORE_NR.
RV_OBJECT_OBJ_CT_TAP Type: string (40 characters max.)
Text specified in the "Tap:" field on the
Object settings menu.
Improvement of the CT object definition.
RV_OBJECT_OBJ_OPTION1 Type: string (40 characters max.)
Text specified in the "Optional 1:" field on
the Object settings menu.
Improvement of the CT object definition.
RV_OBJECT_EXT Type: double
Rated extended primary current
represented as percentage of the rated
primary current.
The value returned is the value as it was
defined on the CT-Object card.
RV_OBJECT_FS_GUESS Type: bool
Value: 1 = determined by guesser function
Indicates whether the value for the
instrument security factor (FS) was
determined by the guesser function or
defined by the user.
RV_OBJECT_ALF_GUESS Type: bool
Value: 1 = determined by guesser function
Indicates whether the value for the
accuracy limiting factor (ALF) was
determined by the guesser function or
defined by the user.
RV_OBJECT_VB_GUESS Type: bool
Value: 1 = determined by guesser function
Indicates whether the value for the rated
secondary terminal voltage (Vb) was
determined by the guesser function or
defined by the user.

164 OMICRON
Enumeration types, test settings and test results

RV_OBJECT_IE1 Type: double


Second setpoint (excitation current at E1)
defined on the Object page. This parameter
can be defined by the user or determined
by the guesser function.
Depending on the standard, this result
represents the peak current (for standard
IEC 60044-6 (TPS)) or the rms current (for
standard IEC 60044-1 (PX)).
RV_OBJECT_IE1_GUESS Type: bool
Value: 1 = determined by guesser function
Indicates whether the value for Ie1 was
determined by the guesser function or
defined by the user.
RV_OBJECT_E1 Type: double
Second setpoint (EMF voltage 1) defined
on the Object page. This parameter can be
defined by the user or determined by the
guesser function
RV_OBJECT_E1_GUESS Type: bool
Value: 1 = determined by guesser function
Indicates whether the value for E1 was
determined by the guesser function or
defined by the user.
RV_EXCITATION_IE1 Type: double
Second measuring point (excitation current
at E1).
Depending on the standard, this result
represents the peak current (for standard
IEC 60044-6 (TPS)) or the rms current (for
standard IEC 60044-1 (PX)).
RV_EXCITATION_E1 Type: double
Second measuring point defined (EMF
voltage 1).
Delivers the same value as
RV_OBJECT_E1.
RV_ASSESSMENT_AUTO_ Type: enum TCTAAssessment (page 119).
ASSESS_IE1 Assessment result for Ie1 (excitation
current at E1) according to IEC 60044-6
(for class TPS) or according to IEC 60044-
1 (for class PX). For details about the
assessment, please refer to the
CT Analyzer User Manual.
RV_ASSESSMENT_AUTO_ Type: enum TCTAAssessment (page 119).
ASSESS_EPSILON_AT_20ISN Assessment result for ratio error at
20 * I-sn according to IEEE C57.13
protection CTs.
For details about the assessment, please
refer to the CT Analyzer User Manual.

OMICRON 165
CTA Remote Control Programming Manual

RV_ASSESSMENT_AUTO_ Type: enum TCTAAssessment (page 119).


ASSESS_EPSILON_AT_VB Assessment result for Vb according to
IEEE C57.13 protection CTs.
For details about the assessment, please
refer to the CT Analyzer User Manual.
RV_ASSESSMENT_AUTO_ Type: enum TCTAAssessment (page 119).
ASSESS_EPSILON Assessment result for ratio error.
Depending on the selected standard and
class, different ranges of the ratio error are
assessed (see CT Analyzer User Manual,
chapter "Assessment Card" for detailed
information).
RV_ASSESSMENT_AUTO_ Type: enum TCTAAssessment (page 119).
ASSESS_DELTAPHI Assessment result for phase error.
Depending on the selected standard and
class, different ranges of the phase error
are assessed (see CT Analyzer User
Manual, chapter "Assessment Card" for
detailed information).
RV_ASSESSMENT_AUTO_ Type: enum TCTAAssessment (page 119).
ASSESS_EPSILON_C Assessment result for composite error.
Depending on the selected standard and
class, different ranges of the composite
error are assessed (see CT Analyzer User
Manual, chapter "Assessment Card" for
detailed information).
RV_ASSESSMENT_AUTO_ Type: enum TCTAAssessment (page 119).
ASSESS_EPSILON_PEAK Assessment result for peak error.
Depending on the class selected for
standard IEC 60044-6, different ranges of
the peak error are assessed (see
CT Analyzer User Manual, chapter
"Assessment Card" for more information).
RV_ASSESSMENT_AUTO_ Type: enum TCTAAssessment (page 119).
ASSESS_EPSILON_T Assessment result for turns error according
to class PX (for IEC 60044-1) and class
TPS (for IEC 60044-6). See CT Analyzer
User Manual, chapter "Assessment Card"
for detailed information.

166 OMICRON
Enumeration types, test settings and test results

RV_ASSESSMENT_MANUAL_ Type: enum TCTAAssessment (page 119).


ASSESS_IE1 Shows the status of the manual
RV_ASSESSMENT_MANUAL_ assessment entered by the user for the
ASSESS_EPSILON_AT_20ISN respective parameter on the Assessment
RV_ASSESSMENT_MANUAL_ card.
ASSESS_EPSILON_AT_VB This assessment is fully independent from
RV_ASSESSMENT_MANUAL_ the automatic assessment of the
ASSESS_EPSILON CT Analyzer.
RV_ASSESSMENT_MANUAL_
ASSESS_DELTAPHI
RV_ASSESSMENT_MANUAL_
ASSESS_EPSILON_C
RV_ASSESSMENT_MANUAL_
ASSESS_EPSILON_PEAK
RV_ASSESSMENT_MANUAL_
ASSESS_EPSILON_T
RV_AL_ERROR_GRAPH_ERROR Type: double
Delivers the defined accuracy limiting error
in % that is used to calculate the AL-Error
graph.
RV_AL_ERROR_GRAPH_NUMBER_ Type: double
POINTS Delivers the number of points of the AL-
Error graph.
RV_AL_ERROR_GRAPH_NOM_ Type: double
BURDEN_KVALUE Delivers the K value (= Ip at ALFi / Ip nom.)
calculated for the resistive nominal burden
and the specified error in the AL-Error
graph.
RV_AL_ERROR_GRAPH_NOM_ Type: double
BURDEN_RESISTANCE Delivers the resistive nominal burden used
to calculate the accuracy limit at the
specified K value (= Ip at ALFi / Ip nom.) in
the AL-Error graph.
RV_AL_ERROR_GRAPH_OP_ Type: double
BURDEN_KVALUE Delivers the K value (= Ip at ALFi / Ip nom.)
calculated for the resistive operating
burden and the specified error in the AL-
Error graph.
RV_AL_ERROR_GRAPH_OP_ Type: double
BURDEN_RESISTANCE Delivers the resistive operating burden
used to calculate the accuracy limit at the K
value (= Ip at ALFi / Ip nom.) in the AL-
Error graph.
RV_AL_ERROR_GRAPH_ENABLE Type: bool
Delivers true, if the AL-Error graph is
enabled.
Delivers false, if the AL-Error graph is not
enabled.

OMICRON 167
CTA Remote Control Programming Manual

RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).


VKNEE Assessment result for Vknee.
RV_ASSESSMENT_MANUAL_
Depending on the selected standard (see
ASSESS_VKNEE
CT Analyzer User Manual, chapter
"Assessment Card" for detailed
information).
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
RCF Assessment result for RCF.
RV_ASSESSMENT_MANUAL_
Depending on the selected standard (see
ASSESS_RCF
CT Analyzer User Manual, chapter
"Assessment Card" for detailed
information).
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
EPSILON_AT_ISN Assessment result for ratio error @ Isn.
RV_ASSESSMENT_MANUAL_
Depending on the selected standard (see
ASSESS_EPSILON_AT_ISN
CT Analyzer User Manual, chapter
"Assessment Card" for detailed
information).
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
VK_IK Assessment result for user defined test
RV_ASSESSMENT_MANUAL_ point Vk/Ik.
ASSESS_VK_IK
Depending on the selected standard (see
CT Analyzer User Manual, chapter
"Assessment Card" for detailed
information).
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
VK1_IK1 Assessment result for user defined test
RV_ASSESSMENT_MANUAL_ point Vk1/Ik1.
ASSESS_VK1_IK1
Depending on the selected standard (see
CT Analyzer User Manual, chapter
"Assessment Card" for detailed
information).
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
TOTAL Total assessment for the whole
RV_ASSESSMENT_MANUAL_ measurement.
ASSESS_TOTAL
This assessment is Ok if all assessments
for the different measurements are Ok.
RV_OBJ_RE20, Type: integer
RV_OBJECT_RE20 User defined setting value for epsilon @ 20
* Isn
RV_RATIO_TCF Type: double
Result value for TCF (C57.13)
RV_RES_REMANENCE_FLUX Type: double
Residual flux - absolute value [in Vs]"
"of the residual magnetic flux in the CT,
determined by the CT Analyzer.
RV_RES_REMANENCE_PERCENT Type: double
Residual magnetism - ratio of measured
residual flux to saturation flux [in %].

168 OMICRON
Enumeration types, test settings and test results

RV_RES_REMANENCE_CARD_EN Type: bool


Remanence card enabled or disabled.
RV_RES_REMANENCE_TEST_ Type: enum TCTAResultTestStatus
STATUS Test status of the remanence
measurement.
RV_RES_REMANENCE_ERROR_ Type: integer
PRIOR The priority of the error during the
remanence measurement (if any).
RV_RES_REMANENCE_ERROR_NR Type: integer
The error number during the remanence
measurement (if any).
RV_RES_REMANENCE_ERROR_LOC Type: integer
The error location during the remanence
measurement (if any).
RV_PRIM_RESISTANCE_CARD_EN Type: bool
Primary resistance card activated or
deactivated.
RV_PRIM_RESISTANCE_ERROR_ Type: integer
LOC Location in the software where the error
was detected. Necessary to determine the
exact cause of error.
RV_PRIM_RESISTANCE_ERROR_NR Type: integer
For each error number, a detailed
description is available in the CT Analyzer
User Manual, explaining the error cause
and possible solutions.
RV_PRIM_RESISTANCE_ERROR_PR Type: integer
IOR Indicates the severity of an error. See
chapter "Appendix: Error priority classes".
RV_PRIM_RESISTANCE_IDC_MEAS Type: double
Measurement current during primary
winding resistance test (parameter I-DC on
the Resistance card).
RV_PRIM_RESISTANCE_ITEST Type: double
Selected test current to measure the
primary winding resistance (parameter I-test
on the Resistance card).
RV_PRIM_RESISTANCE_R_MEAS Type: double
Measured resistance at ambient
temperature (parameter R-meas on the
Resistance card).
RV_PRIM_RESISTANCE_R_REF Type: double
Reference resistance (temperature-
compensated resistance, compensated to
T-ref) (parameter R-ref on the Resistance
card).

OMICRON 169
CTA Remote Control Programming Manual

RV_PRIM_RESISTANCE_TEST_ Type: enum TCTAResultTestStatus (page


STATUS 124).
Shows the status of the resistance test.
RV_PRIM_RESISTANCE_TMEAS Type: double
Defined ambient temperature (parameter
T-meas on the Resistance card).
RV_PRIM_RESISTANCE_TEMP_ Type: enum TCTATempUnit (page 125).
UNIT Temperature unit used for T-meas in the
Resistance card (°C or °F).
RV_PRIM_RESISTANCE_TREF Type: double
Reference temperature (parameter T-ref on
the Resistance card).
RV_PRIM_RESISTANCE_VDC_MEAS Type: double
Measurement voltage during winding
resistance test (parameter V-DC on the
Resistance card).
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment (page 119).
RPRIM Assessment, if the resistance entered in the
RV_ASSESSMENT_MANUAL_ object page is > than the resistance
ASSESS_RPRIM
measured.
RV_SWITCHBOX_SERIAL_NUMBER Type: string
The serial number of a connected
Switchbox: (e.g. "AC015S")
RV_SWITCHBOX_VERSION Type: string
The version of a connected Switchbox:
e.g. "0.06/0.00" ... Firmware / Hardware
RV_SWITCHBOX_TYPE Type: string
The type of a connected Switchbox:
e.g. "CT SB2"
RV_EXCITATION_VA_EPSI Type: double
Indirect composite error (epsilon_i) at
nominal burden (parameter VA on the CT-
Object card). For the calculation, please
refer to the CT Analyzer User Manual.
RV_EXCITATION_VA_EPSI_Q Type: string (value ">" or empty)
Qualifier for epsilon_i at nominal burden.
Epsilon_i is prefixed by the ">" sign, if the
CT Analyzer is not able to measure up to
the accuracy limit
RV_EXCITATION_BURDEN_EPSI Type: double
Indirect composite error (epsilon_i) at
operating burden (parameter Burden on the
CT-Object card). For the calculation, please
refer to the CT Analyzer User Manual.

170 OMICRON
Enumeration types, test settings and test results

RV_EXCITATION_BURDEN_EPSI_Q Type: string (value ">" or empty)


Qualifier for epsilon_i at nominal burden.
Epsilon_i is prefixed by the ">" sign, if the
CT Analyzer is not able to measure up to
the accuracy limit
RV_OBJECT_MIN_BURDEN Type: double
Used setting on the CT Analyzer for:
"Min. VA at M-cores Isn 5A"
RV_RATIO_TABLE_NR_ROWS_EX Type: integer
Number of rows in the extended Ratio-Table
and the extended Phase-Table (of the Ratio
card).
RV_RATIO_TABLE_NR_COLUMNS_ Type: integer
EX Number of columns in the extended Ratio-
Table and the extended Phase-Table (of the
Ratio card).
RV_GENERAL_XML_FILE_ Type: integer
SUBVERSION The subversion of the result XML-file.
RV_GENERAL_XML_FILE_ Type: string
VERSION_EX The combined version / subversion of the
XML-file as a string:
e.g. "4.10"
RV_EXCITATION_KNEEPOINT_ Type: double
IEC_69_2_V IEEE 61689-2 kneepoint voltage
RV_EXCITATION_KNEEPOINT_ Type: double
IEC_69_2_I IEEE 61689-2 kneepoint current
RV_EXCITATION_KNEEPOINT_2_I Type: double
EC_69_2_V IEEE 61689-2 second kneepoint voltage
RV_EXCITATION_KNEEPOINT_2_ Type: double
IEC_69_2_I IEEE 61689-2 second kneepoint current
RV_EXCITATION_REFCURVE_ Type: double
KNEEPOINT_IEC_69_2_V IEEE 61689-2 reference curve kneepoint
voltage
RV_EXCITATION_REFCURVE_ Type: double
KNEEPOINT_IEC_69_2_I IEEE 61689-2 reference curve kneepoint
current
RV_EXCITATION_REFCURVE_KNEE Type: double
POINT_2_IEC_69_2_V IEEE 61689-2 reference curve second
kneepoint voltage
RV_EXCITATION_REFCURVE_KNEE Type: double
POINT_2_IEC_69_2_I IEEE 61689-2 reference curve second
kneepoint current
RV_OBJECT_EXT_VA Type: Boolean
Extended VA according to IEEE 61869-2
RV_OBJECT_ENABLE_ANSI_E02 Type: Boolean
Enable high accuracy burden according to
IEEE C57.13.6-2005 (5.0VA, Pf 1.0)

OMICRON 171
CTA Remote Control Programming Manual

RV_OBJECT_ENABLE_ANSI_E004 Type: Boolean


Enable high accuracy burden according to
IEEE C57.13.6-2005 (1.0VA, Pf 1.0)
RV_ASSESSMENT_AUTO_ASSESS_ Type: enum TCTAAssessment
Kx Assessment, if the Kx value entered in the
RV_ASSESSMENT_MANUAL_ object page is > than the Kx value
ASSESS_Kx
measured.
RV_OBJECT_CHECK_SETTINGS Type: Boolean
Enables the check of relevant settings prior
to start of the measurement process.
RV_OBJECT_TP_SPEC_MTD Type: enum TCTATPSpecMtd
The Ktd specification method for standard
61869-2 and TP-CTs.
RV_EXCITATION_PSI_SAT Type: double
Saturation Flux specification for standard
61869-2.
RV_EXCITATION_PSI_SAT_TR100 Type: double
Saturation Flux specification for standard
61869-2 TR100.
RV_OBJECT_DESIGN Type: string
Burden designation for IEEE 57.13 as
String representation:
Example: “B0.5 – B0.9”
RV_OBJECT_NOM_BURDEN_LOW Type: double
For IEEE 57.13 M-core types the low range
value of the nominal burden [VA]
RV_OBJECT_BURDEN_TYPE Type: enum TCTABurdenType
For IEEE 57.13 the nominal burden
designation
RV_OBJECT_BURDEN_TYPE_LOW Type: enum TCTABurdenType
For IEEE 57.13 M-core types the low range
value of the burden designation
RV_OBJECT_CLASS_ASSESS_AT Type: bool
For IEEE 57.13 M-core types the accuracy
class given is specific only to that burden it
is assigned.
Example: 0.3 @ B-0.5

172 OMICRON
Enumeration types, test settings and test results

7.4.2 TCTAResultIndexedValue
The type TCTAResultIndexedValue contains the test result parameters the
result of which is not a single value but a list (array) of values instead.
Element (parameter) Description
RV_EXCITATION_CURVE_ANSI30_ Type: double (e.m.f. voltage [Vrms])
EMF_V
Measured voltage curve acc. to
IEEE C57.13 (30°).
RV_EXCITATION_CURVE_ANSI30_ Type: double (excitation current [Arms])
RMS_I
Measured current curve acc. to
IEEE C57.13 (30°).
RV_EXCITATION_CURVE_ANSI45_ Type: double (e.m.f. voltage [Vrms])
EMF_V
Measured voltage curve acc. to
IEEE C57.13 (45°).
RV_EXCITATION_CURVE_ANSI45_ Type: double (excitation current [Arms])
RMS_I
Measured current curve acc. to
IEEE C57.13 (45°).
RV_EXCITATION_CURVE_ Type: double (terminal voltage [Vrms])
IEC60044_1_RMS_V
Measured voltage curve acc. to
IEC 60044-1.
RV_EXCITATION_CURVE_ Type: double (excitation current [Arms])
IEC60044_1_RMS_I
Measured current curve acc. to
IEC 60044-1.
RV_EXCITATION_CURVE_ Type: double (e.m.f. voltage [Vrms])
IEC60044_6_EMF_V
Measured voltage curve acc. to
IEC 60044-6.
RV_EXCITATION_CURVE_ Type: double (excitation current [Apeak])
IEC60044_6_PEAK_I
Measured current curve acc. to
IEC 60044-6.
RV_EXCITATION_CURVE_FLUX_VS Type: double (flux in CT core [Vs])
Calculated flux out of the emf voltage
(core voltage).
RV_EXCITATION_CURVE_EMF_V Type: double (e.m.f. voltage [Vrms])
emf voltage for measurement points of
excitation curve, identical with
_ANSI30_EMV_V.
RV_EXCITATION_CURVE_ Type: double (terminal voltage [Vrms])
TERMINAL_V
Terminal voltage from measurement
points of excitation curve.
RV_EXCITATION_CURVE_ICTRMS_I Type: double (excitation current [Arms])
Excitation current for measurement points
of the excitation curve, identical with
..._IEC60044_1_RMS_I.

OMICRON 173
CTA Remote Control Programming Manual

RV_EXCITATION_CURVE_ Type: double (excitation current [Apeak])


ICTPEAK_I
Peak excitation current for measurement
points of the excitation curve, identical
with ..._IEC60044_6_PEAK_I.
RV_EXCITATION_CURVE_ Type: double (rectified excitation current
ICTRECT_I [Arms])
Rectified average excitation current
calibrated to r.m.s.
RV_EXCITATION_CURVE_PH_UCT_ Type: double (phase [°])
ICT_DEGREE
Phase angle between terminal voltage
(Uct) and excitation current (Ict).
RV_EXCITATION_CURVE_PH_ Type: double (phase [°])
UCORE_ICT_DEGREE
Phase angle between emf voltage
(Ucore) and excitation current (Ict)
RV_EXCITATION_CURVE_REM_ Type: double (remanence flux [Vs])
FLUX_VS
Remanence Flux for measurement points
of the excitation curve.
RV_EXCITATION_CURVE_ Type: double (inductance [H])
INDUCTIVITY_H
Inductance for measurement points of the
excitation curve.
RV_EXCITATION_REFCURVE_ Type: double (e.m.f. voltage [Vrms])
ANSI30_EMF_V
Reference voltage curve acc. to
IEEE C57.13 (30°). The reference curve
has to be loaded on the CT Analyzer.
RV_EXCITATION_REFCURVE_ Type: double (excitation current [Arms])
ANSI30_RMS_I
Reference current curve acc. to
IEEE C57.13 (30°).
RV_EXCITATION_REFCURVE_ Type: double (e.m.f. voltage [Vrms])
ANSI45_EMF_V
Reference voltage curve acc. to
IEEE C57.13 (45°).
RV_EXCITATION_REFCURVE_ Type: double (excitation current [Arms])
ANSI45_RMS_I
Reference current curve acc. to
IEEE C57.13 (45°).
RV_EXCITATION_REFCURVE_ Type: double (terminal voltage [Vrms])
IEC60044_1_RMS_V
Reference voltage curve acc. to
IEC 60044-1.
RV_EXCITATION_REFCURVE_ Type: double (excitation current [Arms])
IEC60044_1_RMS_I
Reference current curve acc. to
IEC 60044-1.
RV_EXCITATION_REFCURVE_ Type: double (e.m.f. voltage [Vrms])
IEC60044_6_EMF_V
Reference voltage curve acc. to
IEC 60044-6.
RV_EXCITATION_REFCURVE_ Type: double (excitation current [Apeak])
IEC60044_6_PEAK_I
Reference current curve acc. to
IEC 60044-6.

174 OMICRON
Enumeration types, test settings and test results

RV_EXCITATION_REFCURVE_ Type: double (flux in CT core [Vs])


FLUX_VS
Calculated flux out of the emf voltage
(core voltage) of reference curve.
RV_EXCITATION_REFCURVE_EMF_V Type: double (e.m.f. voltage [Vrms])
emf voltage for measurement points of
reference excitation curve.
RV_EXCITATION_REFCURVE_ Type: double (terminal voltage [Vrms])
TERMINAL_V
Terminal voltage from measurement
points of reference excitation curve.
RV_EXCITATION_REFCURVE_ Type: double (excitation current [Arms])
ICTRMS_I
Excitation current for measurement points
of reference excitation curve.
RV_EXCITATION_REFCURVE_ Type: double (excitation current [Apeak])
ICTPEAK_I
Peak excitation current for measurement
points of reference excitation curve.
RV_EXCITATION_REFCURVE_ Type: double (rectified excitation current
ICTRECT_I [Arms])
Rectified average excitation current
calibrated to r.m.s.
RV_EXCITATION_REFCURVE_PH_ Type: double (phase [°])
UCT_ICT_DEGREE
Phase angle between terminal voltage
(Uct) and excitation current (Ict).
RV_EXCITATION_REFCURVE_PH_ Type: double (phase [°])
UCORE_ICT_DEGREE
Phase angle between emf voltage
(Ucore) and excitation current (Ict).
RV_EXCITATION_REFCURVE_REM_ Type: double (remanence flux [Vs])
FLUX_VS
Remanence flux for measurement points
of reference excitation curve.
RV_EXCITATION_REFCURVE_ Type: double (inductance [H])
INDUCTIVITY_H
Inductance for measurement points of
reference excitation curve.
RV_RATIO_REFCURVE_TERMINAL_V Type: double (terminal voltage [Vrms])
Terminal voltage points of reference
excitation curve.
RV_RATIO_TABLE_ROWHEADER_ Type: double (power [VA])
NOM_BURDEN_VA
Burden values shown in the row header
of the ratio table.
RV_RATIO_TABLE_ROWHEADER_ Type: double
NOM_BURDEN_COSPHI
Cos ϕ values shown in the row header of
the ratio table.
RV_RATIO_TABLE_COLUMNHEADER_ Type: double (% of nominal current )
CURRENT_PERCENTAGE
Current ratio error in % at % of rated
current shown in the column header of
the ratio table.
RV_RATIO_TABLE_ROW1_ Type: double (current deviation [%])
CURRENT_DEVIATION

OMICRON 175
CTA Remote Control Programming Manual

RV_RATIO_TABLE_ROW2_ Values shown in the corresponding row of


CURRENT_DEVIATION the ratio table (1st to 4th row).
RV_RATIO_TABLE_ROW3_
CURRENT_DEVIATION
RV_RATIO_TABLE_ROW4_
CURRENT_DEVIATION
RV_RATIO_TABLE_ROW1_ Type: string (value "!" or empty)
CURRENT_DEVIATION_Q
Qualifier for the values shown in the
RV_RATIO_TABLE_ROW2_ corresponding row of the ratio table (1st
CURRENT_DEVIATION_Q to 4th row).
RV_RATIO_TABLE_ROW3_ Values without the prefix "!" have
CURRENT_DEVIATION_Q guaranteed accuracy.
RV_RATIO_TABLE_ROW4_ The accuracy of values marked with the
CURRENT_DEVIATION_Q prefix "!" is reduced by factor 2 since
these values are not directly measured
but calculated from the measured values
instead.
RV_RATIO_TABLE_ROW1_ Type: double (phase deviation [°])
PHASE_DEVIATION
Values shown in the corresponding row of
RV_RATIO_TABLE_ROW2_ the phase table (1st to 4th row).
PHASE_DEVIATION
RV_RATIO_TABLE_ROW3_
PHASE_DEVIATION
RV_RATIO_TABLE_ROW4_
PHASE_DEVIATION
RV_RATIO_TABLE_ROW1_ Type: string (value "!" or empty)
PHASE_DEVIATION_Q
Qualifier for the values shown in the
RV_RATIO_TABLE_ROW2_ corresponding row of the phase table (1st
PHASE_DEVIATION_Q to 4th row).
RV_RATIO_TABLE_ROW3_ Values without the prefix "!" have
PHASE_DEVIATION_Q guaranteed accuracy.
RV_RATIO_TABLE_ROW4_ The accuracy of values marked with the
PHASE_DEVIATION_Q prefix "!" is reduced by factor 2 since
these values are not directly measured
but calculated from the measured values
instead.
RV_RATIO_CURVE_FLUX_VS Type: double (flux in CT core [Vs])
Calculated flux (calculated from the core
voltage) from the extended excitation
curve (measured during ratio test).
RV_RATIO_CURVE_EMF_V Type: double (e.m.f. voltage [Vrms])
emf voltage for measurement points of
extended excitation curve (measured
during ratio test).
RV_RATIO_CURVE_TERMINAL_V Type: double (terminal voltage [Vrms])
Terminal voltage from measurement
points of extended excitation curve
(measured during ratio test).

176 OMICRON
Enumeration types, test settings and test results

RV_RATIO_CURVE_ICTRMS_I Type: double (excitation current [Arms])


Excitation current for measurement points
of extended excitation curve (measured
during ratio test).
RV_RATIO_CURVE_ICTPEAK_I Type: double (excitation current [Apeak])
Peak excitation current for measurement
points of extended excitation curve
(measured during ratio test).
RV_RATIO_CURVE_ICTRECT_I Type: double (rectified excitation current
[Arms])
Rectified average excitation current
calibrated to r.m.s. (measured during ratio
test).
RV_RATIO_CURVE_PH_UCT_ICT_ Type: double (phase [°])
DEGREE
Phase angle between terminal voltage
(Uct) and excitation current (Ict) of
extended ratio curve (measured during
ratio test).
RV_RATIO_CURVE_PH_UCORE_ Type: double (phase [°])
ICT_DEGREE
Phase between emf voltage (Ucore) and
extended excitation current (Ict)
(measured during ratio test).
RV_RATIO_CURVE_REM_FLUX_VS Type: double (remanence flux [Vs])
Remanence flux for measurement points
of extended excitation curve (measured
during ratio test).
RV_RATIO_CURVE_INDUCTIVITY_H Type: double (inductance [H])
Inductance for measurement points of
extended excitation curve (measured
during ratio test).
RV_DEBUG_00 Type: internal parameter
Not for customer use.
RV_RATIO_TABLE_ROWHEADER_ Type: double
NOM_BURDEN_COSPHI
CosPhi of the burden (operating burden)
used to calculate the ratio error on the
Ratio card.
RV_RATIO_TABLE_ROWHEADER_ Type: double
NOM_BURDEN_VA
VA value of the burden (operating
burden) used to calculate the ratio error
on the Ratio card.

OMICRON 177
CTA Remote Control Programming Manual

Additional indexed values since version 3.0

Element (parameter) Description


RV_AL_ERROR_GRAPH_KVALUE Type: double
K value (= Ip at ALFi / Ip nominal) at the
specified index in the AL-Error graph
table.
RV_AL_ERROR_GRAPH_RESISTANCE Type: double
Resistance at the specified index in the
AL-Error graph table.
RV_EXCITATION_CURVE_ Type: double (coercivity [A])
COERCIVITY_I
Coercivity for measurement points of the
excitation curve.
RV_EXCITATION_REFCURVE_ Type: double (coercivity [A])
COERCIVITY_I
Coercivity for measurement points of the
reference excitation curve.
RV_RATIO_CURVE_COERCIVITY_I Type: double (coercivity [H])
Coercivity for measurement points of
extended excitation curve (measured
during ratio test).
RV_RATIO_TABLE_ROWHEADER_ Type: enum TCTABurdenType
NOM_BURDEN_DESIGNATION_EX
Burden designations corresponding to the
burdens shown in the row header of the
extended ratio table.
RV_RATIO_TABLE_ROWHEADER_ Type: double (power [VA])
NOM_BURDEN_VA_EX
Burden values shown in the row header
of the extended ratio table.
RV_RATIO_TABLE_ROWHEADER_ Type: double
NOM_BURDEN_COSPHI_EX
Cos ϕ values shown in the row header of
the extended ratio table.
RV_RATIO_TABLE_COLUMNHEADER_ Type: double (% of nominal current )
CURRENT_PERCENTAGE_EX
Current ratio error in % at % of rated
current shown in the column header of
the extended ratio table.

178 OMICRON
Enumeration types, test settings and test results

RV_RATIO_TABLE_ROW1_CURRENT_ Type: double (current deviation [%])


DEVIATION_EX,
Values shown in the corresponding row of
RV_RATIO_TABLE_ROW2_CURRENT_ the extended ratio table.
DEVIATION_EX,
RV_RATIO_TABLE_ROW3_CURRENT_
DEVIATION_EX, There are max. 8 rows possible. The
RV_RATIO_TABLE_ROW4_CURRENT_
actual number of rows is defined with:
DEVIATION_EX, RV_RATIO_TABLE_NR_ROWS_EX
RV_RATIO_TABLE_ROW5_CURRENT_
DEVIATION_EX,
RV_RATIO_TABLE_ROW6_CURRENT_
DEVIATION_EX,
RV_RATIO_TABLE_ROW7_CURRENT_
DEVIATION_EX,
RV_RATIO_TABLE_ROW8_CURRENT_
DEVIATION_EX
RV_RATIO_TABLE_ROW1_CURRENT_ Type: string (value "!" or empty)
DEVIATION_Q_EX,
Qualifier for the values shown in the
RV_RATIO_TABLE_ROW2_CURRENT_ corresponding row of the extended ratio
DEVIATION_Q_EX,
table (1st to 8th row).
RV_RATIO_TABLE_ROW3_CURRENT_
Values without the prefix "!" have
DEVIATION_Q_EX,
guaranteed accuracy.
RV_RATIO_TABLE_ROW4_CURRENT_
DEVIATION_Q_EX, The accuracy of values marked with the
prefix "!" is reduced by factor 2 since
RV_RATIO_TABLE_ROW5_CURRENT_
DEVIATION_Q_EX,
these values are not directly measured
but calculated from the measured values
RV_RATIO_TABLE_ROW6_CURRENT_
instead.
DEVIATION_Q_EX,
RV_RATIO_TABLE_ROW7_CURRENT_
DEVIATION_Q_EX,
RV_RATIO_TABLE_ROW8_CURRENT_
DEVIATION_Q_EX
RV_RATIO_TABLE_ROW1_CURRENT_ Type: enum TCTAAssessment
DEVIATION_ASSESS_EX,
Assessment value for the values shown in
RV_RATIO_TABLE_ROW2_CURRENT_ the corresponding row of the extended
DEVIATION_ASSESS_EX,
ratio table.
RV_RATIO_TABLE_ROW3_CURRENT_
If this vale is ASS_NOT_ASSESSED the
DEVIATION_ASSESS_EX,
corresponding ratio value is not used for
RV_RATIO_TABLE_ROW4_CURRENT_
any class assessment.
DEVIATION_ASSESS_EX,
RV_RATIO_TABLE_ROW5_CURRENT_
DEVIATION_ASSESS_EX,
RV_RATIO_TABLE_ROW6_CURRENT_
DEVIATION_ASSESS_EX,
RV_RATIO_TABLE_ROW7_CURRENT_
DEVIATION_ASSESS_EX,
RV_RATIO_TABLE_ROW8_CURRENT_
DEVIATION_ASSESS_EX

OMICRON 179
CTA Remote Control Programming Manual

RV_RATIO_TABLE_ROW1_PHASE_ Type: double (phase deviation [°])


DEVIATION_EX,
Values shown in the corresponding row of
RV_RATIO_TABLE_ROW2_PHASE_ the extended phase table (1st to 8th row).
DEVIATION_EX,
RV_RATIO_TABLE_ROW3_PHASE_
DEVIATION_EX, There are max. 8 rows possible. The
RV_RATIO_TABLE_ROW4_PHASE_
actual number of rows is defined with:
DEVIATION_EX, RV_RATIO_TABLE_NR_ROWS_EX
RV_RATIO_TABLE_ROW5_PHASE_
DEVIATION_EX,
RV_RATIO_TABLE_ROW6_PHASE_
DEVIATION_EX,
RV_RATIO_TABLE_ROW7_PHASE_
DEVIATION_EX,
RV_RATIO_TABLE_ROW8_PHASE_
DEVIATION_EX
RV_RATIO_TABLE_ROW1_PHASE_ Type: string (value "!" or empty)
DEVIATION_Q_EX,
Qualifier for the values shown in the
RV_RATIO_TABLE_ROW2_PHASE_ corresponding row of the extended phase
DEVIATION_Q_EX,
table (1st to 8th row).
RV_RATIO_TABLE_ROW3_PHASE_
Values without the prefix "!" have
DEVIATION_Q_EX,
guaranteed accuracy.
RV_RATIO_TABLE_ROW4_PHASE_
DEVIATION_Q_EX, The accuracy of values marked with the
prefix "!" is reduced by factor 2 since
RV_RATIO_TABLE_ROW5_PHASE_
DEVIATION_Q_EX,
these values are not directly measured
but calculated from the measured values
RV_RATIO_TABLE_ROW6_PHASE_
instead.
DEVIATION_Q_EX,
RV_RATIO_TABLE_ROW7_PHASE_
DEVIATION_Q_EX,
RV_RATIO_TABLE_ROW8_PHASE_
DEVIATION_Q_EX,
RV_RATIO_TABLE_ROW1_PHASE_ Type: enum TCTAAssessment
DEVIATION_ASSESS_EX,
Assessment value for the values shown in
RV_RATIO_TABLE_ROW2_PHASE_ the corresponding row of the extended
DEVIATION_ASSESS_EX,
phase table.
RV_RATIO_TABLE_ROW3_PHASE_
If this vale is ASS_NOT_ASSESSED the
DEVIATION_ASSESS_EX,
corresponding phase value is not used for
RV_RATIO_TABLE_ROW4_PHASE_
any class assessment.
DEVIATION_ASSESS_EX,
RV_RATIO_TABLE_ROW5_PHASE_
DEVIATION_ASSESS_EX,
RV_RATIO_TABLE_ROW6_PHASE_
DEVIATION_ASSESS_EX,
RV_RATIO_TABLE_ROW7_PHASE_
DEVIATION_ASSESS_EX,
RV_RATIO_TABLE_ROW8_PHASE_
DEVIATION_ASSESS_EX

180 OMICRON
Enumeration types, test settings and test results

7.4.3 TCTAAssessParameter
The type TCTAAssessParameter together with the type TCTAAssessInfo
(see below) contain the test result parameters, the result of which is a single
value.

The type TCTAAssesParameter defines the assessment,


The type TCTAAssessInfo defines the different values for this assessment.

Element (parameter) Description


ASS_PARAM_UNSPECIFIED Not implemented.
ASS_PARAM_CLASS, These parameters throw an error.
ASS_PARAM_RATIO_ERR,
ASS_PARAM_PHASE_ERR,
ASS_PARAM_RCF
ASS_PARAM_TURN_ERR Read detailed assessment info for the turns
ratio error assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_COMP_ERR Read detailed assessment info for the
composite error assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_PEAK_ERR Read detailed assessment info for the peak
error assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_PEAK_ERR_AC Read detailed assessment info for the peak
error ac assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_RE_AT_ISN Read detailed assessment info for the ratio
error @ Isn assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_RE_AT_20_ISN Read detailed assessment info for the ratio
error @ 20 x Isn assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_EK Read detailed assessment info for the EK
assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_IE Read detailed assessment info for the IE
assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.

OMICRON 181
CTA Remote Control Programming Manual

ASS_PARAM_IE1 Read detailed assessment info for the IE1


assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_VAL Read detailed assessment info for the VAL
assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_IAL Read detailed assessment info for the IAL
assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_IK Read detailed assessment info for the IK
assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_IK1 Read detailed assessment info for the IK1
assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_KX Read detailed assessment info for the KX
assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_K_KSSC Read detailed assessment info for the KSSC
assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_KTD_KSSC Read detailed assessment info for the KTD x
KSSC assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_FS Read detailed assessment info for the FS
assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_FSI Read detailed assessment info for the FS
indirect assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_ALF Read detailed assessment info for the ALF
assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.

182 OMICRON
Enumeration types, test settings and test results

ASS_PARAM_ALFI Read detailed assessment info for the ALF


indirect assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_TS Read detailed assessment info for the Ts
assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_KR Read detailed assessment info for the Kr
assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_VB Read detailed assessment info for the Vb
assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_VKNEE Read detailed assessment info for the Vknee
assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_RCT Read detailed assessment info for the RCT
assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_RPRIM Read detailed assessment info for the
R-Primary assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.
ASS_PARAM_BURDEN Read detailed assessment info for the brden
assessment.
For details about the assessment, please refer
to the CT Analyzer User Manual.

OMICRON 183
CTA Remote Control Programming Manual

7.4.4 TCTAAssessInfo
The type TCTAAssessInfo together with the type TCTAAssessParameter
(see above) contains the test result parameters, the result of which is a single
value.

The type TCTAAssesParameter defines the assessment,


The type TCTAAssessInfo defines the different values for this assessment.

Element (parameter) Description


ASS_INFO_ASSIGNED Type : boolean
Assessment result for assignment :
0 … no assessment assigned
1 … assessment assigned
ASS_INFO_MEASURED_VAL Type : double
Result for the measured value of this
assessment.
ASS_INFO_MEASURED_DISPL Type : BSTR
Result for the string representation of the
measured value of this assessment.
ASS_INFO_QUALIFIER Type : TCTAQualifier
Result for measurement qualifier of this
assessment.
ASS_INFO_RATED_VAL Type : double
Result for the rated value of this assessment.
ASS_INFO_RATED_DISPL Type : BSTR
Result for the string representation of the
measured value of this assessment.
ASS_INFO_MIN_VAL Type : double
Result for the rated min. value of this
assessment.
ASS_INFO_MIN_DISPL Type : BSTR
Result for the string representation of the rated
min.value of this assessment.
ASS_INFO_MAX_VAL Type : double
Result for the rated max. value of this
assessment.
ASS_INFO_MAX_DISPL Type : BSTR
Result for the string representation of the rated
max.value of this assessment.
ASS_INFO_ASSESSMENT Type : TCTAAssessment
Result for the assessment-operation of this
assessment.

184 OMICRON
Enumeration types, test settings and test results

ASS_INFO_ASSESS_RULE Type : TCTAAssessRule


Result for the rules assigned to this
assessment.

OMICRON 185
CTA Remote Control Programming Manual

7.5 Quick
7.5.1 TCTAQuickOutMode
The elements of the type TCTAQuickOutMode specify the operating mode of
the built in signal generator. The elements are used by the function
ICTAQuick::SetSetting(QSV_OUT_MODE, parameter) as possible parameter
value.

Element Description
QSG_OFF Signal generator OFF
QSG_AC_I Signal generator outputs AC current
QSG_AC_U Signal generator outputs AC voltage
QSG_DC_I Signal generator outputs DC current
QSG_DC_U Signal generator outputs DC voltage

7.5.2 TCTAQuickRangeMode
The elements of the type TCTAQuickRangeMode specify the ranging mode of
the measurement channels of the CT Analyzer. The elements are used by the
function ICTAQuick::SetSetting(QSV_RANGE_MODE, parameter) as possible
parameter value.

Element Description
QRM_MANUAL Manual ranging.
Set ranges explicit with:
SetSetting(QSV_V1_RANGE, …)
SetSetting(QSV_V2_RANGE, …)
SetSetting(QSV_I1_RANGE, …)
QRM_AUTO Auto ranging for all 3 measurement channels.

7.5.3 TCTAQuickRangeV1
The elements of the type TCTAQuickRangeV1 specify the range of the
measurement channel SEC of the CT Analyzer. The elements are used by the
functions ICTAQuick::SetSetting(QSV_V1_RANGE, parameter) as possible
parameter value.
Element Description
QRANGE_V1_300mV Range SEC channel up to 300mV rms
QRANGE_V1_3V Range SEC channel up to 3V rms
QRANGE_V1_30V Range SEC channel up to 30V rms
QRANGE_V1_300V Range SEC channel up to 300V rms

186 OMICRON
Enumeration types, test settings and test results

7.5.4 TCTAQuickRangeV2
The elements of the type TCTAQuickRangeV2 specify the range of the
measurement channel PRIM of the CT Analyzer. The elements are used by
the functions ICTAQuick::SetSetting(QSV_V2_RANGE, parameter) as
possible parameter value.
Element Description
QRANGE_V2_30mV Range PRIM channel up to 30mV rms
QRANGE_V2_300mV Range PRIM channel up to 300mV rms
QRANGE_V2_3V Range PRIM channel up to 3V rms
QRANGE_V2_30V Range PRIM channel up to 30V rms

7.5.5 TCTAQuickRangeI1
The elements of the type TCTAQuickRangeI1 specify the range of the
measurement channel OUT of the CT Analyzer. The elements are used by the
functions ICTAQuick::SetSetting(QSV_I1_RANGE, parameter) as possible
parameter value.

Element Description
QRANGE_I1_150mA Range OUT channel up to 150mA rms
For the current measurement an internal shunt
of 1 ohm is used.
QRANGE_I1_1500mA Range OUT channel up to 1500mA rms
For the current measurement an internal shunt
of 1 ohm is used.
QRANGE_I1_3A Range OUT channel up to 3A rms
For the current measurement an internal shunt
of 0.05 ohms is used.
QRANGE_I1_30A Range OUT channel up to 30A rms
For the current measurement an internal shunt
of 0.05 ohms is used.

OMICRON 187
CTA Remote Control Programming Manual

7.5.6 TCTAQuickFilterMode
The elements of the type TCTAQuickFilterMode specify the operating
mode of the input filters of the measurement channels. The elements are used
by the functions ICTAQuick::SetSetting(QSV_MEAS_MODE, parameter) as
possible parameter value.

Element Description
QFM_RMS The measurement values (amplitude) are built
by means of standard RMS calculation
algorithm.
QFM_FILTER The input signals are fed through a digital filter
with adjustable bandwidth.
The bandwith can be adjusted with
SetSetting(QSV_BANDWIDTH, …)
and is centered to the nominal signal frequency.
QFM_DC The measurement values (amplitude) are built
by means of standard averaging algorithm.

7.5.7 TCTAQuickMeasType
The elements of the type TCTAQuickMeasType specify the predefined
settings for some useful measurements. The elements are used by the
functions ICTAQuick::SetSetting(QSV_MEAS_TYPE, parameter) as possible
parameter value.

Element Description
QMT_VT_RATIO Configures all settings for VT-Ratio
measurement:
SetSetting(QSV_OUT_MODE, QSG_AC_U)
SetSetting(QSV_OUT_AMPL, 1.0)
SetSetting(QSV_OUT_FREQ, 50.0)
SetSetting(QSV_MEAS_MODE,
QFM_FILTER)
SetSetting(QSV_BANDWIDTH, 6.0)
QMT_CT_RATIO Configures all settings for CT-Ratio
measurement:
SetSetting(QSV_OUT_MODE, QSG_AC_U)
SetSetting(QSV_OUT_AMPL, 1.0)
SetSetting(QSV_OUT_FREQ, 50.0)
SetSetting(QSV_MEAS_MODE,
QFM_FILTER)
SetSetting(QSV_BANDWIDTH, 6.0)
SetSetting(QSV_LOAD_R, 1.0)
SetSetting(QSV_LOAD_L, 50.0)

188 OMICRON
Enumeration types, test settings and test results

QMT_RESISTANCE Configures all settings for resistance


measurement:
SetSetting(QSV_OUT_MODE, QSG_DC_I)
SetSetting(QSV_OUT_AMPL, 1.0)
SetSetting(QSV_MEAS_MODE, QFM_DC)
QMT_IMPEDANCE Configures all settings for impedance
measurement:
SetSetting(QSV_OUT_MODE, QSG_AC_I)
SetSetting(QSV_OUT_AMPL, 1.0)
SetSetting(QSV_OUT_FREQ, 50.0)
SetSetting(QSV_MEAS_MODE,
QFM_FILTER)
SetSetting(QSV_BANDWIDTH, 6.0)
QMT_REACTANCE Configures all settings for reactance
measurement:
SetSetting(QSV_OUT_MODE, QSG_AC_U)
SetSetting(QSV_OUT_AMPL, 1.0)
SetSetting(QSV_OUT_FREQ, 400.0)
SetSetting(QSV_MEAS_MODE,
QFM_FILTER)
SetSetting(QSV_BANDWIDTH, 6.0)
QMT_ADVANCED Configures all settings for standard
measurement:
SetSetting(QSV_OUT_MODE, QSG_AC_U)
SetSetting(QSV_OUT_AMPL, 1.0)
SetSetting(QSV_OUT_FREQ, 50.0)
SetSetting(QSV_MEAS_MODE, QFM_RMS)
SetSetting(QSV_OFFS_REGULATION, 0)

OMICRON 189
CTA Remote Control Programming Manual

7.5.8 TCTAQuickSetting
The elements of the type TCTAQuickSetting specify the setting parameters
(quick test settings) of the CT Analyzer. The elements are used by the function
ICTAQuick::SetSetting(setting-ID, parameter) as possible values of the setting-
ID.
Note The CTA remote component automatically limits the adjusted values to
their valid ranges.

Element Description
QSV_MEAS_TYPE Type: TCTAQuickMeasType
Specify the predefined measurements on the
CT Analyzer.
This command automatically defines some
other settings (see TCTAQuickMeasType on
page 188).
QSV_OUT_MODE Type: TCTAQuickOutMode
Specify the operating mode of the built in signal
generator of the CT Analyzer (see Quick
TCTAQuickOutMode on page 186)
QSV_OUT_AMPL Type: double
Possible values:
for AC_I mode : 0 – 5A
for AC_U mode: 0 – 40V
for DC_I mode : 0 – 10A
for DC_U mode: 0 – 120V

Specify the output amplitude of the signal


generator.
For the modes AC_I and DC_I the value is in
ampere (RMS),
for the modes AC_U and DC_U the value is in
volts (RMS).
QSV_OUT_FREQ Type: double
Possible values: 5 – 400Hz
Specify the output frequency of the signal
generator.
QSV_LOAD_R Type: double
Possible values: 0 – 1000 ohms
Specify one of the regulation parameters for the
built in offset regulator for the output current
(see also QSV_OFFS_REGULATION)

190 OMICRON
Enumeration types, test settings and test results

QSV_LOAD_L Type: double


Possible values: 0 – 1000 henry
Specify one of the regulation parameters for the
built in offset regulator for the output current
(see also QSV_OFFS_REGULATION)
QSV_RANGE_MODE Type: TCTAQuickRangeMode
Specify the ranging mode of the measurement
channels OUTPUT, SEC and PRIM (see
TCTAQuickRangeMode on page 186)
QSV_V1_RANGE Type: TCTAQuickRangeV1
Specify the manual range of the measurement
channel SEC (see TCTAQuickRangeV1 on
page 186)
QSV_V2_RANGE Type: TCTAQuickRangeV2
Specify the manual range of the measurement
channel PRIM (see TCTAQuickRangeV2 on
page 187)
QSV_I1_RANGE Type: TCTAQuickRangeI1
Specify the manual range of the measurement
channel OUTPUT (see TCTAQuickRangeI1 on
page 187)
QSV_MEAS_MODE Type: TCTAQuickFilterMode
Specify the operating mode of the input filters of
the measurement channels (see
TCTAQuickFilterMode on page 188)
QSV_INTEGR_TIME Type: double
Possible values: 0.5 sec
Specify the integration time (measurement
time) of the measurement channels for RMS-
measurements.
Note: for filter-measurements, the integration
time is automatically adjusted.
QSV_BANDWIDTH Type: double
Possible values: 3 – 20 Hz
Specify the bandwidth of the built in digital filter.
Only applicable in filter mode (see
TCTAQuickFilterMode on page 188)
QSV_CUTOFF_FREQ Type: double
Possible values: 1.5 – 10 Hz
Specify the cut off frequency of the built in
digital filter.
This is always the same as setting the
bandwidth divided by 2.
For example:
SetSetting(QSV_BANDWIDTH, 6.0)
is the same as
SetSetting(QSV_CUTOFF_FREQ, 3.0)

OMICRON 191
CTA Remote Control Programming Manual

QSV_INP_COMP Type: BOOLEAN


Specify the compensation of the input current
on the SEC input.
If TRUE, this input current must be subtracted
from the measured OUTPUT-current.
This is necessary for precise current
measurement.
Normally, keep this setting TRUE.
QSV_OFFS_REGULATION Type: BOOLEAN
Specify if the offset regulator for the output
current is ON or OFF.
This regulator is necessary for ratio-
measurements, to prevent a slowly drift of the
magnetic flux in the CT-core.
For proper working of the regulator also the
settings:
QSV_LOAD_R … the winding resistance
and
QSV_LOAD_L … the inductivity
of the connected CT are necessary.

192 OMICRON
Enumeration types, test settings and test results

7.5.9 TCTAQuickResult
The elements of the type TCTAQuickResult specify the measurement
results (quick test) of the CT Analyzer. The elements are used by the function
ICTAQuick::GetResult(setting-ID) as possible values of the setting-ID.

Element Description
QRV_COUNT Type: integer
The number of measurement results (cycles) since the
start of quick test.
QRV_MEAS_TYPE Type: TCTAQuickMeasType
The applied predefined meas type (see
QSV_MEAS_TYPE).
QRV_V1_RANGE Type: TCTAQuickRangeV1
The actual range of the SEC measurement channel.
The same value as with GetV1Results() … array[0].
QRV_V1_RMS Type: double
The actual RMS value (volts) of the SEC measurement
channel.
The same value as with GetV1Results() … array[1].
QRV_V1_AC Type: double
The actual AC value (volts) of the SEC measurement
channel.
The same value as with GetV1Results() … array[2].
AC value means:
before calculation of the RMS value, the DC portion of
the input signal is subtracted.
QRV_V1_DC Type: double
The actual DC value (volts) of the SEC measurement
channel.
The same value as with GetV1Results() … array[3].
QRV_V1_FREQU Type: double
The actual frequency value (Hz) of the SEC
measurement channel.
The same value as with GetV1Results() … array[4].
QRV_V1_PHASE Type: double
This value is always 0.0 because the channel SEC is
the reference for phase measurements.
The same value as with GetV1Results() … array[5].
QRV_V1_PEAK_P Type: double
The actual positive peak value (volts) of the SEC
measurement channel.
The same value as with GetV1Results() … array[6].
QRV_V1_PEAK_N Type: double
The actual negative peak value (volts) of the SEC
measurement channel.
The same value as with GetV1Results() … array[7].

OMICRON 193
CTA Remote Control Programming Manual

QRV_V2_RANGE Type: TCTAQuickRangeV2


The actual range of the PRIM measurement channel.
The same value as with GetV2Results() … array[0].
QRV_V2_RMS Type: double
The actual RMS value (volts) of the PRIM measurement
channel.
The same value as with GetV2Results() … array[1].
QRV_V2_AC Type: double
The actual AC value (volts) of the PRIM measurement
channel.
The same value as with GetV2Results() … array[2].
AC value means:
before calculation of the RMS value, the DC portion of
the input signal is subtracted.
QRV_V2_DC Type: double
The actual DC value (volts) of the PRIM measurement
channel.
The same value as with GetV2Results() … array[3].
QRV_V2_FREQU Type: double
The actual frequency value (Hz) of the SEC
measurement channel.
The same value as with GetV2Results() … array[4].
QRV_V2_PHASE Type: double
The actual phase difference between SEC channel and
PRIM channel (degrees).
The same value as with GetV2Results() … array[5].
QRV_V2_PEAK_P Type: double
The actual positive peak value (volts) of the PRIM
measurement channel.
The same value as with GetV2Results() … array[6].
QRV_V2_PEAK_N Type: double
The actual negative peak value (volts) of the PRIM
measurement channel.
The same value as with GetV2Results() … array[7].
QRV_I1_RANGE Type: TCTAQuickRangeI1
The actual range of the OUTPUT measurement
channel.
The same value as with GetI1Results() … array[0].
QRV_I1_RMS Type: double
The actual RMS value (ampere) of the OUTPUT
measurement channel.
The same value as with GetI1Results() … array[1].

194 OMICRON
Enumeration types, test settings and test results

QRV_I1_AC Type: double


The actual AC value (ampere) of the OUTPUT
measurement channel.
The same value as with GetI1Results() … array[2].
AC value means:
before calculation of the RMS value, the DC portion of
the input signal is subtracted.
QRV_I1_DC Type: double
The actual DC value (ampere) of the OUTPUT
measurement channel.
The same value as with GetI1Results() … array[3].
QRV_I1_FREQU Type: double
The actual frequency value (Hz) of the SEC
measurement channel.
The same value as with GetI1Results() … array[4].
QRV_I1_PHASE Type: double
The actual phase difference between SEC channel and
OUTPUT channel (degrees).
The same value as with GetI1Results() … array[5].
QRV_I1_PEAK_P Type: double
The actual positive peak value (ampere) of the
OUTPUT measurement channel.
The same value as with GetI1Results() … array[6].
QRV_I1_PEAK_N Type: double
The actual negative peak value (ampere) of the
OUTPUT measurement channel.
The same value as with GetI1Results() … array[7].
QRV_CALC_N Type: double
The ratio between SEC and PRIM channel (V1rms /
V2rms).
The same value as with
GetCalculatedResults() … array[0].
QRV_CALC_Z Type: double
The impedance of the device under test (V1rms / I1rms)
in ohms.
The same value as with
GetCalculatedResults() … array[1].
QRV_CALC_PHASE Type: double
The phase between SEC and OUTPUT in degrees.
The same value as with
GetCalculatedResults() … array[2].
QRV_CALC_RS Type: double
The real part of the impedance in the serial equivalent
circuit in ohms.
The same value as with
GetCalculatedResults() … array[3].

OMICRON 195
CTA Remote Control Programming Manual

QRV_CALC_RP Type: double


The real part of the impedance in the parallel equivalent
circuit in ohms.
The same value as with
GetCalculatedResults() … array[4].
QRV_CALC_XS Type: double
The imaginary part of the impedance in the serial
equivalent circuit in ohms.
The same value as with
GetCalculatedResults() … array[5].
QRV_CALC_XP Type: double
The imaginary part of the impedance in the parallel
equivalent circuit in ohms.
The same value as with
GetCalculatedResults() … array[6].
QRV_CALC_LS Type: double
The inductivity in the serial equivalent circuit in henry.
The same value as with
GetCalculatedResults() … array[7].
QRV_CALC_LP Type: double
The inductivity in the parallel equivalent circuit in henry.
The same value as with
GetCalculatedResults() … array[8].
QRV_CALC_CS Type: double
The capacity in the serial equivalent circuit in farad.
The same value as with
GetCalculatedResults() … array[9].
QRV_CALC_CP Type: double
The capacity in the parallel equivalent circuit in farad.
The same value as with
GetCalculatedResults() … array[10].
QRV_CUR_OVL Type: boolean
A current overload occurred in the actual measurement
cycle.
QRV_PWR_OVL Type: boolean
A power overload occurred in the actual measurement
cycle.

196 OMICRON
Enumeration types, test settings and test results

7.5.10 TCTAQuickStatus
The elements of the type TCTAQuickStatus sp.ecify the return value of the
property ICTAQuick::Status.
Element Description
QST_NO_RESULTS Actually no new measurement result are
available on the CT Analyzer.
QST_NEW_RESULTS New measurement results are availabe on the
CT Analyzer, and can be read out.
QST_USER_ABORT The user has aborted the running Quick test, by
pressing the I/O-key or the ESC-key on the
CT Analyzer.
QST_CURRENT_OVL A current overflow occured during the last
measurement cycle.
QST_POWER_OVL A power overflow occured during the last
measurement cycle.
QST_CONN_LOST The connection with the CT Analyzer was lost.
Check the serial cable connection.

OMICRON 197
CTA Remote Control Programming Manual

8 Multi-ratio support
8.1 Prepare a multi-ratio measurement

Defining a multi-ratio measurement is exactly the same job as defining a


single-ratio measurement.
To address the requirements for multi-ratio measurement some types and
enumeration values are added.

TCTASettingValue:
Beside the existing enumerating values these values are added:
Element (parameter) Type and description
SV_RATIO_TYPE Type: enum TCTARatioType
Type of the CT measurement:
SINGLE_RATIO,
MULTI_RATIO
measurement.
SV_MR_NO_TAPS Type: integer
Possible values: 2 – 6
Number of tap connections of the CT.
SV_MR_COMMON_TAP Type: integer
Possible values: 1 or the value set with
SV_MR_NO_TAPS.
The common tap is the tap that is used
as reference for all tap combinations.
SV_MR_TAP_IN_USE Type: enum TCTATapValue
The tap in use is the tap combination
actually used
during operation of the CT.
SV_MR_TEST_ENABLE_X1_X2 Type: integer
... Possible values: 0 - 1
for all combinations Disable/enable a measurement or
between X1 and X6 calculation on the appropriate tap
... combination.
SV_MR_TEST_ENABLE_X5_X6
SV_MR_I_PN_X1_X2 Type: double
... Possible values: 1.0 – 99000.0, -1.0
for all combinations A value of -1.0 defines a "guesser –
between X1 and X6 value".
...
Defines the nominal primary current on
SV_MR_I_PN_X5_X6 the appropriate tap combination.
( … see also 8.1.1 below)

198 OMICRON
Multi-ratio support

SV_MR_NOM_BURDEN_X1_X2 Type: double


... Possible values: 0.0 – 300.0, -1.0
for all combinations A value of -1.0 defines a “guesser –
between X1 and X6 value”.
...
Nominal burden of the CT on the
SV_MR_NOM_BURDEN_X5_X6 appropriate tap combination, used to
calculate the behavior of the CT at the
nominal burden.
(… see also 8.1.1 below)
SV_MR_NOM_COSPHI_X1_X2 Type: double
... Possible values: 0.0 – 1.0, -1.0
for all combinations A value of -1.0 defines a "guesser –
between X1 and X6 value".
...
cosϕ of nominal burden on the
SV_MR_NOM_COSPHI_X5_X6
appropriate tap combination.
SV_MR_NOM_BURDEN_TYPE_X1_X2 Type: enum TCTABurdenType
... Nominal burden designation of the CT on
for all combinations the appropriate tap combination, used to
between X1 and X6 calculate the behavior of the CT at the
... nominal burden.
SV_MR_NOM_BURDEN_TYPE_X5_X6 (only for IEEE C57.13)

8.1.1 Recalculations
If you change the nominal primary current or the nominal burden (burden
designation TCTABurdenType for C57.13) on the outer tap, all burdens for the
inner tap-combinations are recalculated, according to following formula:
Burdeni = Burdenouter-tap * Ipnouter-tap / Ipni
i ... inner tap combination X1-X2 to X5-X6
The resulting burden is then rounded to the nearest standard burden.

8.1.2 Enumeration types

TCTARatioType:
The elements of the type TCTARatioType specify the possible values of a
multi-ratio measurement. The elements are used by the parameter
SV_RATIO_TYPE of the type TCTASettingValue.
Element (parameter) Description
SINGLE_RATIO Measurement of a single-ratio CT.
MULTI_RATIO Measurement of a multi-ratio CT.

OMICRON 199
CTA Remote Control Programming Manual

TCTATapValue:
The elements of the type TCTATapValue specify a certain tap combination of
the taps X1 – X6. The elements are used by the parameter
SV_MR_TAP_IN_USE of the type TCTASettingValue.
Element (parameter) Description
X1_X2 Specify the winding between the taps X1 and X2.
X1_X3 Specify the winding between the taps X1 and X3.
X1_X4 Specify the winding between the taps X1 and X4.
X1_X5 Specify the winding between the taps X1 and X5.
X1_X6 Specify the winding between the taps X1 and X6.
X2_X3 Specify the winding between the taps X2 and X3.
X2_X4 Specify the winding between the taps X2 and X4.
X2_X5 Specify the winding between the taps X2 and X5.
X2_X6 Specify the winding between the taps X2 and X6.
X3_X4 Specify the winding between the taps X3 and X4.
X3_X5 Specify the winding between the taps X3 and X5.
X3_X6 Specify the winding between the taps X3 and X6.
X4_X5 Specify the winding between the taps X4 and X5.
X4_X6 Specify the winding between the taps X4 and X6.
X5_X6 Specify the winding between the taps X5 and X6.

Example:
Define a multi ratio CT with 5 taps and standard ratios 1200:5A
ICTAPtr pCTA(CLSID_CTA);
pCTA->Settings->ClearSettings();
pCTA->Settings->SetValue(SV_RATIO_TYPE, MULTI_RATIO); // Define multi
// ratio
pCTA->Settings->SetValue(SV_I_SN, 5.0); // Isn for all taps
pCTA->Settings->SetValue(SV_MR_NR_TAPS, 5); // 5 Taps (X1 – X5)
pCTA->Settings->SetValue(SV_MR_COMMON_TAP, 1); // Common Tap is X1
pCTA->Settings->SetValue(SV_MR_TAP_IN_USE, X1_X5); // Tap in use is
// outer tap
// (default)
// Settings for outer tap (X1-X5)
pCTA->Settings->SetValue(SV_MR_TEST_ENABLE_X1_X5, 1); // Enable test
pCTA->Settings->SetValue(SV_MR_I_PN_X1_X5, 1200.0); // Set Ipn

// Settings for tap X1-X4


pCTA->Settings->SetValue(SV_MR_TEST_ENABLE_X1_X4, 1); // Enable test
pCTA->Settings->SetValue(SV_MR_I_PN_X1_X4, 800.0); // Set Ipn

// Settings for tap X1-X3


pCTA->Settings->SetValue(SV_MR_TEST_ENABLE_X1_X3, 1); // Enable test
pCTA->Settings->SetValue(SV_MR_I_PN_X1_X3, 300.0); // Set Ipn

// Settings for tap X1-X2


pCTA->Settings->SetValue(SV_MR_TEST_ENABLE_X1_X2, 1); // Enable test

200 OMICRON
Multi-ratio support

pCTA->Settings->SetValue(SV_MR_I_PN_X1_X2, 200.0); // Set Ipn

// SetValue(SV_MR_TEST_ENABLE_..., 1) for inter taps are not necessary


// Settings for inter tap X2-X5
pCTA->Settings->SetValue(SV_MR_I_PN_X2_X5, 1000.0); // Set Ipn

// Settings for inter tap X2-X4


pCTA->Settings->SetValue(SV_MR_I_PN_X2_X4, 600.0); // Set Ipn

// Settings for inter tap X2-X3


pCTA->Settings->SetValue(SV_MR_I_PN_X2_X3, 100.0); // Set Ipn

// Settings for inter tap X3-X5


pCTA->Settings->SetValue(SV_MR_I_PN_X3_X5, 900.0); // Set Ipn

// Settings for inter tap X3-X4


pCTA->Settings->SetValue(SV_MR_I_PN_X3_X4, 500.0); // Set Ipn

// Settings for inter tap X4-X5


pCTA->Settings->SetValue(SV_MR_I_PN_X4_X5, 400.0); // Set Ipn

pCTA->Settings->LocalSaveSettings(L"C:\CTA_Test\MRSettings.xml");

OMICRON 201
CTA Remote Control Programming Manual

8.2 Read a multi-ratio measurement (protocol)


Reading a multi-ratio measurement is exactly the same job as reading a
single-ratio measurement.
To address the requirements for multi-ratio measurement some types and
enumeration values are added.

TCTAResultValue:
Beside the existing enumerating values these values are added:
Element (parameter) Type and description
RV_RATIO_TYPE Type: enum TCTARatioType
Type of the CT measurement:
SINGLE_RATIO,
MULTI_RATIO
measurement.
RV_MR_NO_TAPS Type: integer
Possible values: 2 – 6
Number of tap connections of the CT.
RV_MR_TAP_IN_USE Type: enum TCTATapValue
The tap in use is the tap combination actually used
during operation of the CT.
RV_MR_TEST_ENABLE_ Type: integer
X1_X2 Possible values: 0 - 1
...
Disable/enable a measurement or calculation on
for all combinations the appropriate tap combination.
between X1 and X6
...
SV_MR_TEST_ENABLE_
X5_X6
RV_MR_DEFINE_TAP Type: enum TCTATapValue
Select a certain tap combination.
Subsequent readings of measurement values with
Results.GetValue(RV_...) return the results of the
selected tap combination.
This selection is valid until a new selection is made.
RV_MR_SEC_WINDING_ Type: double
RATIO Possible values: 0.0 – 1.0
The measured secondary winding ratio of the
selected tap combination.

202 OMICRON
Multi-ratio support

Example:
Read some values of multi ratio CT
ICTAPtr pCTA(CLSID_CTA);
pCTA->Results->LocalLoadReport(L"C:\CTA_Test\MRResults.xml");

// Read the CT type (Single-/Multi-ratio)


TCTARatioType result = pCTA->Results->GetValue(RV_RATIO_TYPE);
// Read number of taps
int result = ->Results->GetValue(RV_MR_NO_TAPS);
// Rad tap in use
TCTATapValue result = pCTA->Results->GetValue(RV_MR_TAP_IN_USE);

// Read some values for tap X2 – X3


TCTATapValue result = pCTA->Results->SetValue(RV_MR_DEFINE_TAP, X2_X3);
double result = pCTA->Results->GetValue(RV_RATIO_COMPOSITE_ERROR_PERC);
double result = pCTA->Results->GetValue(RV_RATIO_RCF);
double result = pCTA->Results->GetValue(RV_RESISTANCE_R_MEAS);

// Read the same values for tap X1 – X5


TCTATapValue result = pCTA->Results->SetValue(RV_MR_DEFINE_TAP, X1_X5);
double result = pCTA->Results->GetValue(RV_RATIO_COMPOSITE_ERROR_PERC);
double result = pCTA->Results->GetValue(RV_RATIO_RCF);
double result = pCTA->Results->GetValue(RV_RESISTANCE_R_MEAS);

OMICRON 203
CTA Remote Control Programming Manual

9 Application examples

The following application examples are installed to your PC during the


installation of the CTA Remote Control Software. You can find the
corresponding files in the installation directory of the software.
The default installation directory is
C:\Program Files\OMICRON\CT Analyzer PC Toolset\Samples\

9.1 Available application examples


• Excel/VBA: Remote Excel Fileloader for CT Analyzer
• Excel/VBA: CTA Remote test.xlt
• VC++: CTA Remote Test

204 OMICRON
Error handling

10 Error handling
Errors can occur within the CTA remote component or can be sent from the
device itself. An example for the first is when a local report or settings file can’t
be loaded (no communication with the CT Analyzer happens during these
operations). An example for the latter is a failure in test execution.
For both cases, the error condition is communicated in several ways.

10.1 Overview of error communication


mechanisms
10.1.1 Result code (HRESULT)
The CTA remote component is technically solved as a COM server. Every
function or property call to a COM server returns a COM result code, a 4-byte
integer value.
This result code is hidden in Visual Basic and not accessible, but for program
languages such as C++, it’s an easy way to check for errors:
HRESULT hr;
hr = cta->USBConnect();
if (FAILED(hr)) {

}
hr = cta->Disconnect();
if (SUCCEEDED(hr)) {

}

There are two useful C++ macros to deal with result codes. A look to their
implementation makes clear how this mechanism works:

#define FAILED(hr) ((HRESULT)(hr) < 0)

#define SUCCEEDED(hr) ((HRESULT)(hr) >= 0)

Any negative value indicates a failure. To find out the reason of the error, the
Device Information can be consulted.

OMICRON 205
CTA Remote Control Programming Manual

10.1.2 Device Information


Refer to ICTAInfo on page 51 for a detailed description.
When an error occurs, the Device Information is updated with the error class,
number, location code and a verbose description. If an information is already
available from a previous error, this information is overwritten, unless it is of a
higher error class than the new error condition: An error will overwrite a
warning message, a warning message itself overwrites tooltips and hints, etc.
The Device Information is kept until it is explicitly cleared (using
Info.Clear).

10.1.3 Error Object


At the time, the new content is placed into the Device Information record, an
Error Object is set as well. The Error Object is the standard way to inform
Visual Basic programs about errors (in contrast to C++, where the result code
is used for this).
Note that the Error Object is created at the same time as the Device
Information is updated, but it has to be cleared independently, i.e. by calling
Err.Clear in Visual Basic. Clearing the Device Information does not clear
the Error Object and vice versa.
In the section “Handling Errors in Visual Basic” you will find more information
about this mechanism. For C++ this is not of importance.

10.1.4 Logfile
During operation, the CTA remote component writes a log file for the purpose
of error diagnosis. The log file is stored in the installation folder of the CTA
Remote Control Software, which is by default C:\Program
Files\OMICRON\CT Analyzer PC Toolset\CTARemote.exe.log
The log file can be very useful for coping with failures that are hard to find,
since it contains more information than the Device Information record and
includes the access history.

206 OMICRON
Error handling

10.2 Unstructured exception handling in Visual


Basic
This section discusses the different ways to treat the Error Object in Visual
Basic. In contrast to structured exception handling (Try…Catch…Finally
statements), unstructured exception handling involves the On Error
statement. Unstructured error handling using On Error can degrade
application performance and result in code that is difficult to debug and
maintain.
Therefore, it is generally recommended to use structured exception handling.
However, structured exception handling is only available in Visual Basic.NET
and not in Visual Basic for Applications (“Excel Visual Basic”). There, only
unstructured exception handling is considered.
When no exception handling is done, Visual Basic raises a run-time error,
shows a message box and stops the application.

10.2.1 Basics
In case of unstructured exception handling, an On Error statement is
inserted at the beginning of a block of code in order to handle any errors
occurring within that block. When an exception is raised in a procedure after
the On Error statement executes, the program branches to the line
argument specified in the On Error statement. The line argument (a line
number or line label) indicates the exception handler location.
Sometimes, a call is made from the original procedure to another procedure,
and an exception occurs in the called procedure. In this case, the exception
will propagate back to the calling procedure and execution will branch to the
line argument, if the called procedure does not handle the exception.
Note Unstructured error handling using On Error can degrade application
performance and result in code that is difficult to debug and maintain.

10.2.2 On Error GoTo Line


The On Error GoTo Line statement assumes that error handling code
starts at the line specified in the required line argument. If a run-time error
occurs, control branches to the line label or line number specified in the
argument, activating the error handler. The specified line must be in the same
procedure as the On Error GoTo Line statement. Otherwise, Visual Basic
generates a compiler error. The following example illustrates the use of an
error handler with a line label:
Sub TestSub
On Error GoTo ErrorHandler
' Code that may or may not contain errors.
Exit Sub

ErrorHandler:
' Code that handles errors.
Resume
End Sub

OMICRON 207
CTA Remote Control Programming Manual

The example contains an error handler named ErrorHandler. If any code in


the TestSub subroutine generates an error, Visual Basic immediately
executes the code following the ErrorHandler label. At the end of the error
handling block, the Resume statement passes control back to the code line
where the error occurred. The rest of the subroutine then continues executing
as if the error did not occur.
Note You must place an Exit Sub statement immediately before the error
handling block. Otherwise, Visual Basic will run the error handling code
when it reaches the end of the subroutine, and thus cause unwanted or
unexpected results.

10.2.3 On Error Resume Next


The On Error Resume Next statement specifies that in the event of a run-
time error, control passes to the statement immediately following the one in
which the error occurred. Execution continues at that point. On Error
Resume Next enables you to put error handling routines where errors will
occur, rather than transferring control to another location in the procedure.
Note If your procedure calls another procedure, the On Error Resume
Next statement becomes inactive during the execution of the called
procedure. Therefore, you should place an On Error Resume Next
statement to each called procedure that needs one. This is necessary
because the Resume Next behavior only applies to the procedure
containing the On Error Resume Next statement. If an unhandled
error occurs in a called procedure, the exception propagates back to
the calling procedure, and execution resumes at the statement
following the call. In such cases, the error is not handled.

Resume can also be used alone, outside the On Error statement. When
Resume is used this way, Visual Basic returns control to the statement that
caused the error. You generally use Resume after an error handler corrects
the error.
Visual Basic also provides the Resume Next statement, which directs control
to the line immediately following the line of code that caused the error. You
might use Resume Next for cases in which an error will not cause your
application to stop working. You might also use it if an error will not change the
expected results of your subroutine.
Another variation of the Resume statement is Resume Line, which is similar
to On Error GoTo Line. Resume Line passes control to a line you specify
in the line argument. You can use Resume Line only within an error handler.
Note When debugging your code, you must disable the On Error Resume
Next statement.

208 OMICRON
Error handling

10.2.4 On Error GoTo 0


The On Error GoTo 0 statement disables any error handler in the current
procedure. If you do not include an On Error GoTo 0 statement, the error
handler is still disabled when the procedure containing the exception handler
ends.
Note The On Error GoTo 0 statement is not meant to specify line 0 as the
start of the error handling code, even if the procedure contains a line
numbered 0.

10.2.5 On Error GoTo -1


The On Error GoTo -1 statement disables any exception handlers in the
current procedure. If you do not include an On Error GoTo -1 statement,
the exception is automatically disabled when its procedure ends.
Note The On Error GoTo -1 statement is not meant to specify line -1 as
the start of the error handling code, even if the procedure contains a
line numbered -1.

10.2.6 An example
In the following code, the exception handler is named DivideByZero and
handles a specific error - that of attempting to divide by zero. If a different error
occurs, Visual Basic raises a run-time error and stops the application.

OMICRON 209
CTA Remote Control Programming Manual

Sub ErrorTest ()
' Declare variables.
Dim x As Integer, y As Integer, z As Integer
' The exception handler is named "DivideByZero".
On Error GoTo DivideByZero
' The main part of the code, which might cause an error.
x = 2
y = 0
z = x \ y
' This line disables the exception handler.
On Error GoTo 0
Console.WriteLine(x & "/" & y & " = " & z)
' Exit the subroutine before the error-handling code.
' Failure to do so can create unexpected results.
Exit Sub

' This is the exception handler, which deals with the error.
DivideByZero:
' Include a friendly message to let the user know what is happening.
Console.WriteLine("You have attempted to divide by zero!")

' Provide a solution to the error.


y = 2

' The Resume statement returns to the point at which


' the error first occurred, so the application
' can continue to run.
Resume
End Sub

210 OMICRON
Warning messages of the CTA Remote Control Software

11 Warning messages of the CTA


Remote Control Software
532 CTA:CopyFromCTA: error accessing remote file
Reason / File on the CT Analyzer cannot be accessed. File does
Troubleshooting not exist or is protected.

532 CTA:CopyToCTA: error accessing remote file


Reason / File cannot be created.
Troubleshooting

537 CTA:CTASettings: failed to save settings '%s'


Reason / An error occurred while saving the settings (indicates an
Troubleshooting internal error).

525 CTA:GetSerialNumber: CTA not connected


Reason / Device is not connected. Check the plugs and try to
Troubleshooting connect again.

520 CTA:InitCom: unable to setup communication line (%d)


Reason / The serial line couldn’t be configured. Internal error.
Troubleshooting

525 CTA:ProcessMsg: CTA not connected


Reason / Command couldn’t be processed because the device is
Troubleshooting not connected. Check the plugs and try again.

533 CTA:SaveNode: node %s not found


Reason / Internal error, possibly due to version incompatibility.
Troubleshooting

523 CTA:SendCmd: communication error: corrupted msg (%d bytes)


Reason / The data received from the device are invalid. This can
Troubleshooting be caused by mechanical problems with the plug, voltage
coupling into the serial line or internal errors.

521 CTA:SendCmd: communication error: invalid msg size


Reason / The data received from the device are invalid. This can
Troubleshooting be caused by mechanical problems with the plug, voltage
coupling into the serial line or internal errors.

OMICRON 211
CTA Remote Control Programming Manual

538 CTA:SendCmd: communication error: loopback detected - no CTA


connected
Reason / The data received from the device are invalid. This can
Troubleshooting be caused by mechanical problems with the plug, voltage
coupling into the serial line or internal errors.

524 CTA:SendCmd: communication error: unexpected frame number


Reason / The data received from the device are invalid. This can
Troubleshooting be caused by mechanical problems with the plug, voltage
coupling into the serial line or internal errors.

502 CTA:SendCmd: communication error: watchdog


Reason / The device does not answer. Check the plugs or reboot
Troubleshooting the device.

522 CTA:SendCmd: communication rx timeout


Reason / The device does not answer. Check the plugs or reboot
Troubleshooting the device.

522 CTA:SendCmd: communication rx timeout msg


Reason / The device does not answer. Check the plugs or reboot
Troubleshooting the device.

534 CTA:SerialConnect: error opening COM port %d, maybe it's in use (%d)
Reason / Another application has locked the serial line. Close that
Troubleshooting application.

528 CTA:UpgradeFirmware: download failed


Reason / Download of firmware image failed. Possible causes:
Troubleshooting Insufficient memory on the device or connection
problems.

529 CTA:USB: unable to enlist devices


Reason / Internal error. USB device list cannot be accessed.
Troubleshooting

530 CTA:USB: unable to get device info


Reason / Internal error. Error reported by USB device driver.
Troubleshooting

531 CTA:USB: unable to set line characteristics


Reason / Internal error. Error reported by USB device driver.
Troubleshooting

212 OMICRON
Warning messages of the CTA Remote Control Software

532 CTAResults:GetNodeText: no file specified


Reason / A result value is accessed but no file was loaded. Call
Troubleshooting LocalLoadReport to load a file before.

533 CTAResults:LocalLoadReport: file %s couldn't be verified


Reason / The file is corrupted. It is not a well-formed XML file.
Troubleshooting

532 CTAResults:LocalLoadReport: file %s doesn't exist


Reason / File could not be opened for reading. The file does not
Troubleshooting exist or is possibly locked.

536 CTASettings: failed to load settings '%s'


Reason / LocalLoadSettings failed. Problems in data
Troubleshooting consistency. Check the log file for further information.

535 CTASettings:LoadNode: could't set value for %s


Reason / LocalLoadSettings failed. Problems in data
Troubleshooting consistency. Check the log file for further information.

533 CTASettings:LoadNode: node %s not found


Reason / LocalLoadSettings failed. Problems in data
Troubleshooting consistency. Check the log file for further information.

533 CTASettings:LoadNode: refnode %s not found


Reason / LocalLoadSettings failed. Problems in data
Troubleshooting consistency. Check the log file for further information.

532 CTASettings:LocalLoadSettings: file %s couldn't be opened


Reason / File could not be opened for reading. The file does not
Troubleshooting exist or is possibly locked.

533 CTASettings:LocalSaveSettings: couldn't verify file %s


Reason / The file is corrupted. It is not a well-formed XML file.
Troubleshooting

532 CTASettings:LocalSaveSettings: error opening file %s


Reason / File could not be opened for writing. The file is possibly
Troubleshooting locked.

533 CTASettings:OpenXMLFile: file %s couldn't be verified


Reason / The file is corrupted. It is not a well-formed XML file.
Troubleshooting

OMICRON 213
CTA Remote Control Programming Manual

532 CTASettings:OpenXMLFile: file %s doesn't exist


Reason / File could not be opened for reading. The file does not
Troubleshooting exist or is possibly locked.

214 OMICRON
Error and warning messages of the CT Analyzer

12 Error and warning messages of the


CT Analyzer
Please refer to the CT Analyzer User Manual for a complete list of error and
warning messages of the CT Analyzer.

OMICRON 215
CTA Remote Control Programming Manual

Support
When you are working with our products we want to provide you with the greatest
possible benefits. If you need any support, we are here to assist you!

24/7 Technical support – get support


www.omicronenergy.com/support
At our technical support hotline, you can reach well-educated technicians for all
of your questions. Around the clock – competent and free of charge.
Make use of our 24/7 technical support hotlines:
Americas: +1 713 830-4660 or +1 800-OMICRON
Asia-Pacific: +852 3767 5500
Europe / Middle East / Africa: +43 59495 4444
Additionally, you can find our Service Center or Sales Partner closest to you at
www.omicronenergy.com.

Customer area – stay informed


www.omicronenergy.com/customer
The customer area on our website is an international knowledge exchange
platform. Download the latest software updates for all products and share your
own experiences in our user forum.
Browse through the knowledge library and find application notes, conference
papers, articles about daily working experiences, user manuals and much more.

OMICRON Academy – learn more


www.omicronenergy.com/academy
Learn more about your product in one of the training courses offered by the
OMICRON Academy.

OMICRON electronics GmbH, Oberes Ried 1, 6833 Klaus, Austria, +43 59495

216 OMICRON
ENU 1039 06 01

You might also like