Diff OC Automation Interface

8/10/2019 Diff OC Automation Interface

1/74

Diff OCAutomation Interface


2/74

OMICRON Test Universe

2

Manual Version: DiffOCAut.AE.1

OMICRON electronics 2004. All rights reserved.

This Reference Manual is a publication of OMICRON electronics GmbH.

All rights including translation reserved. Reproduction of any kind, e.g., photocopying, microfilming or

storage in electronic data processing systems, requires the explicit consent of OMICRON electronics.

Reprinting, wholly or in part, is not permitted.

This Reference Manual represents the technical status at the time of printing. The product information,

specifications, and all technical data contained within this reference manual are not contractually

binding. OMICRON electronics reserves the right to make changes at any time to the technology and/or

configuration without announcement. OMICRON electronics is not to be held liable for statements and

declarations given in this reference manual. The user is responsible for every application described in

this reference manual and its results. OMICRON electronics explicitly exonerates itself from all liability

for mistakes in this manual.


3/74

Contents

3

Contents

Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Advanced Differential Operating Characteristics Automation Interface . . . .3

Object Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Application Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Document Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

TestSettings Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17FixedTrigger Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Trigger Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

BinaryOutputs Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

BinaryOutput Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

HwInfo Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

TestObject Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Properties of the Device Section of the Test Object . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Properties of the Differential OC Section of the Test Object . . . . . . . . . . . . . . . . . . . . . 42

Other Properties of Test Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

OperatingChar Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Segments Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Segment Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Winding Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
http://preface_cms251.pdf/http://preface_cms251.pdf/


4/74


4

Test Object Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60SearchLines Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

SearchLine Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Search Lines Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

ShotPoints Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

ShotPoint Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72


5/74

5

Advanced Differential Operating Characteristics Automation Interface

Advanced Differential OperatingCharacteristics Automation Interface

Object Hierarchy

Figure 1:

Object hierarchy of a

Advanced Differential

Operating

Characteristics

Document


6/74


6

ReferenceThe following section contains the enumeration of all the objects, properties and

methods available via automation in the OMDiffOC module. All the examples are

given in the OMICRON Control Center Scripting Language (VBA compatible).

Application Object

The application object is the root of the OMICRON Differential OC object

hierarchy. It is the only object that can be created directly by other OLEAutomation controllers (e.g. MS Excel using CreateObject).

This object is unique within the OMICRON Differential OC Module. If you want

to create another Application object with CreateObject, a new instance of the

OMICRON Differential OC program is started to handle this object.

You can use this object as a starting point to navigate through the hierarchy tree.

You can get references to the Document Object (Document) and the Predefined

Constant Values (Constants) objects.

Properties

Application (read only)

Syntax: object.Application

Type: Object (Application)

Description: Returns the application itself, for coherence.

Example: Dim otm As Object

Dim DiffOC As Object

Set otm =

Document.InsertObject("OMDiffOC.Document")

Set DiffOC = otm.Specific

Dim app As ObjectSet app = DiffOC.Application'app must be the

'same object as

DiffOC


7/74

7


Constants (read only)

Document (read only)

Syntax: object.Constants

Type: Object (Constants)

Description: Returns the object containing the constant values (Constants)

you can use across OMDiffOC automation.



Dim Con As Object

Set otm =



Set Con = DiffOC.Constants

Syntax: object.Document

Type: Object (Document)

Description: This property returns a Document Object (Document). The

Document contains all test data, settings and results.


Dim DiffOC As ObjectDim Con As Object

Dim Doc As Object

Set otm =




Set Doc = DiffOC.Document


8/74


8

Name (read only)

Parent (read only)

Syntax: object.Name

Type: String

Description: Returns the name of the application.



Set otm =



Dim Name As String

Set Name = DiffOC.Name

Syntax: object.Parent

Type: Object

Description: This property always returns the parent object in the object

hierarchy. In this case it is the Application Object itself

(Application).


Dim DiffOC As ObjectDim Con As Object

Dim Parent As Object

Set otm =



Set Parent = DiffOC.Parent

'In this case, Parent will be the same

'object as DiffOC


9/74

9


Visible

Note: If you use an external OLE Automation controller (e.g. OMICRON Con-

trol Center) and you create the Application Object (Application) therefore start-

ing the OMICRON Differential OC program, you have to set the visible property

to True before you see the main window of the application.

Methods

Quit

Syntax: object.Visible

Type: Boolean

Description: Shows/hides the main application window.



Set otm =



'Is the application visible?

If DiffOC.Visible then

MsgBox "Application is already visible"

Else 'Make the application visible

DiffOC.Visible = TrueEnd If

Syntax: object.Quit

Return

type:

None

Description: This command quits the OMICRON Advanced Distance

application and closes all open windows and the document.



Set otm = Document.TestModules(1)


DiffOC.Test

DiffOC.Quit


10/74


10

Document ObjectWith the Document Object (Document) you have access to all the data in the

Differential OC module.

Properties


Syntax: Object.Application


Description: Returns the Application Object (Application).



Set otm =



Dim app As Object

Set app = DiffOC.Document.Application

'app must be the

'same object as DiffOC


11/74

11


ChangeAllowed (read only)

Comment

Syntax: object.ChangeAllowed

Type: Boolean

Description: This property returns True if the document can be modified.

Trying to modify a read-only document, or any of the objects

contained therein, will cause a Protection exception.



Set otm =



If DiffOC.Document.ChangeAllowed Then

MsgBox "the document is read-write"

Else

Msg Box "the document is Read-Only"

End If

Syntax: object.Comment

Type: String

Description: This property allows access to the comment string which can

be shown in the report.



Set otm =



'Set comment in the report

DiffOC.Document.Comment = "This test is

simulated"


12/74


12

HwInfo (read only)

Parent (read only)

ShotPoints (read only))

Syntax: object.HwInfo

Type: Object (HwInfo)

Description: Get the HwInfo object to access different properties of the

hardware.



Set otm =



Dim hwInfo As Object

Set hwInfo = DiffOC.Document.HwInfo


Type: Object


hierarchy. In this case it is the Application Object

(Application).

Syntax: object.ShotPoints

Type: Object (ShotPoints)

Description: Returns the ShotPoints collection object.


Dim DiffOC As ObjectSet otm =



Dim shots As Object

Set shots = DiffOC.Document.ShotPoints


13/74

13


SearchLines (read only)

TestObject (read only))

Syntax: object.SearchLines

Type: Object (SearchLines)

Description: Returns the SearchLines collection object.



Set otm =



Dim searchs As Object

Set searchs = DiffOC.Document.SearchLines

Syntax: object.TestObject

Type: Object (TestObject)

Description: Returns the TestObject object



Set otm =

Document.InsertObject("OMDiffOC.Document")Set DiffOC = otm.Specific

Dim to As Object

Set to = DiffOC.Document.TestObject


14/74


14

TestSettings (read only))

Syntax: object.TestSettings

Type: Object (TestSetting)

Description: Returns the TestSettings object.



Set otm =



Dim settings As Object

Set settings = DiffOC.Document.TestSettings


15/74

15


TestType (read only)

Syntax: object.TestType

Type: Long

Description: The module can only test in Shot or Search mode. A test

mode is selected by adding tests to the Shot or Search tables.

Once one of the tables contains tests, no tests can be added

to the other table. The values of this property can be:TESTTYPE_SHOT (There are tests in the Shot table)

TESTTYPE_SEARCH (There are tests in the Search table)

TESTTYPE_NONE (Both tables are empty)



Dim Con As Object

Set otm =




Dim test As Long

Set test = DiffOC.Document.TestSettings

Select Case test

Case Con.TESTTYPE_SHOT

MsgBox "Test is SHOT"

Case Con.TESTTYPE_SEARCH

MsgBox "Test is SEARCH"

Case Else

MsgBox "Test not yet defined"

End Select


16/74


16

Version (read only)

Methods

UpdateAllViews(hint)

Syntax: object.Version

Type: String

Description: Returns the version of the OMMeter module in form

"M.mm.bbb" where:

M: major

m: minor

b: build



Set otm =


Set DiffOC = otm.SpecificMsgBox = "Module version is " +

DiffOC.Document.Version

Syntax: object.UpdateAllViews(hint)

Long hint

Type: None

Description: This method updates the UI and the report. The optional Hint

parameter is used to add information that the views can

interpret. By calling this method without parameters, all the UI

is fully updated.

Example: Dim otm As ObjectDim DiffOC As Object

Set otm =



DiffOC.Document.Comment = "This is an

Automation test"

DiffOC.Document.UpdateAllViews


17/74

17


TestSettings ObjectThis object allows access to the settings that are common for all Shot or Search

tests.

Properties

AbsResolution


Syntax: object.AbsResolution

Type: Double

Description: Get / Set the absolute resolution for the Search Test in times I

nominal



Set otm =





settings.AbsResolution = 0.01



Description: Returns the Application object (Application).


18/74


18

ApplyPreFault

BinaryOutputs (read only)

Syntax: object.ApplyPreFault

Type: Boolean

Description: Get / Set whether the shot sequence will include a pre-fault

time before the onset of the fault.




Set otm =




settings.ApplyPreFault = True'The test will

begin with prefault

Syntax: object.BinaryOutputs

Type: Object (BinaryOutputs)

Description: Get the BinaryOutputs object to access the Binary Outputs in

the module.



Set otm =



Dim bin As Object

Set bin =

DiffOC.Document.TestSettings.BinaryOutputs


19/74

19


FaultTypeShot

Syntax: object.FaultTypeShot

Type: Long

Description: Get / Set the type of fault for which the Shot test will be

performed. The Differential OC module can only test in one

fault loop, this property selects which one is tested. This value

can be accessed independently of whether a Shot Test or aSearch test is defined. The possible values for this property

are:

FAULT_L1E

FAULT_L2E

FAULT_L3E

FAULT_L1L2

FAULT_L3L1

FAULT_L2L3FAULT_L1L2L3



Dim Con As object


Set otm =





settings.FaultTypeShot = Con.FAULT_L1L2L3

'Three-phase fault


20/74


20

FaultTypeSearch

Syntax: object.FaultTypeSearch

Type: Long

Description: Get / Set the type of fault for which the Search test will be

performed. The Differential OC module can only test in one

fault loop, this property selects which one is tested. This value

can be accessed independently of whether a Shot Test or a

Search test is defined. The possible values for this propertyare:

FAULT_L1E

FAULT_L2E

FAULT_L3E

FAULT_L1L2

FAULT_L3L1

FAULT_L2L3

FAULT_L1L2L3



Dim Con As object


Set otm =





settings.FaultTypeSearch = Con.FAULT_L1E

'Line-to-Neutral


21/74

21


FixedTrigger (read only)

IgnoreNominalChar

Syntax: object.FixedTrigger

Type: Object (FixedTrigger)

Description: Get a FixedTrigger object for access to the trigger condition in

the module.



Set otm =



Dim trigger As Object

Set trigger =

DiffOC.Document.TestSettings.FixedTrigger

Syntax: object.IgnoreNominalChar

Type: Boolean

Description: In the Search test, do not consider the nominal characteristic.

The test mechanism will be different if this property is True.


Set otm =





settings.IgnoreNominalChar = False'Use

optimized search

OMICRON T t U i


22/74


22

Parent (read only)

PreFaultCurrent

PreFaultTime




hierarchy. In this case it is the Document Object (Document).

Syntax: object.PreFaultCurrent

Type: Double

Description: Get / Set the pre-fault current in times In



Set otm =Document.InsertObject("OMDiffOC.Document")




settings.PreFaultCurrent = 0.90

Syntax: object.PreFaultTime

Type: Double

Description: Get / Set the pre-fault Time in seconds.







settings.PreFaultTime = 0.500



23/74

23


RelResolution

Syntax: object.RelResolution

Type: Double

Description: Get / Set the relative resolution for the Search Test in percent.



Set otm =





settings.RelResolution = 1.5'1.5 %



24/74


24

SupplySideSel

Syntax: object.SupplySideSel

Type: Long

Description: Get, and if possible set, the supply and fault windings for the

test. For 3-winding transformers with Reference Winding set

to "Primary", it is possible to select the supply as primary-to-

secondary or primary-to-tertiary. For all other cases, the test

direction is automatically determined from the Test Object

settings, and cannot be changed. If this is the case, changes

to this property will be discarded.

The values for this property can be:

SUPP_PRIM_TO_SEC(Supply primary - fault secondary)

SUPP_PRIM_TO_TERT(Supply primary - fault tertiary)

SUPP_SEC_TO_PRIM(Supply secondary - fault primary)SUPP_TERT_TO_PRIM(Supply tertiary - fault primary)



Set otm =





settings.SupplySideSel =

Con.SUPP_PRIM_TO_TERT

If settings.SupplySideSel

Con.SUPP_PRIM_TO_TERT Then

MsgBox "Supply Side was determined

automatically"

End If



25/74

25


VOut

Syntax: object.VOut

Type: Boolean

Description: Select whether voltage output is desired







settings.VOut = True'Voltage output enabled



26/74

26

VOutWinding

Syntax: object.VOutWinding

Type: Long

Description: Get / Set the reference winding for the voltage output. The

voltages will have angles corresponding to the pre-fault

currents in the selected winding.

The possible values for this property are:

PRIMARY

SECONDARY

TERTIARY

TERTIARY is only acceptable for 3-winding transformers, for

any other protected object it will be rejected.



Dim Con As object

Set otm =






settings.VOutWinding = Con.SECONDARY



27/74

27

FixedTrigger ObjectThis object allows reading and setting the Fixed Trigger object. This king of

trigger has a fixed number of binary inputs plus one trigger criterion (AND or

OR).

Properties

Input (index)

Syntax: object.Input(index)Integer index (1 to 10)

Type: Long

Description: This method has the same effect as pressing the Set

Defaults button on the Test Settings page. It loads the default

test settings defined in the Test Object.

Example: Get / Set the state of a given input.The possible values for this property are:

TRIG_POS (Input must be active for

the trigger to be fulfilled)

TRIG_NEG (Input must be inactive for


TRIG_DONTCARE(Input does not affect the

trigger)

It is only possible to set the input if it isassigned to a physical input (InputSelected

has returned True) - otherwise the write

operation will have no effect, and the read

operation will always return

TRIGGER_DONT_CARE.



28/74

28

InputName (index) (read only)

InputSelected (index) (read only))

Logic

Syntax: object.InputName(index)

Integer index (1 to 10)

Type: String

Description: Get the name of a given input. This name is the same that will

appear in the UI.

Syntax: object.InputSelected(index)


Type: Boolean

Description: Returns true if the input is selected - that is, if there is a

physical input associated to the logical input.

Syntax: object. Logic

Type: Long

Description: Get / Set the logic relationship between the trigger inputs.

The possible values for this property are:LOGIC_AND (The logic AND of all inputs activates the

trigger)

LOGIC_OR (The logic OR of all inputs activates the

trigger)



29/74

29

Trigger Example

Example: Syntax:object.Input(index)


Type: Long

Description:This method has the same effect

as pressing the Set Defaults button on the

Test Settings page. It loads the default testsettings defined in the Test Object.

Example:Get / Set the state of a given input.

The possible values for this property are:

TRIG_POS (Input must be active for


TRIG_NEG (Input must be inactive forthe trigger to be fulfilled)

TRIG_DONTCARE(Input does not affect the

trigger)

It is only possible to set the input if it is

assigned to a physical input (InputSelected

has returned True) - otherwise the write

operation will have no effect, and the readoperation will always return

TRIGGER_DONT_CARE.



30/74

30

BinaryOutputs Collection Object

This object allows access to the assigned binary outputs. The outputs will be set

to the programmed values during test, so this is a test setting, and not direct

control of the CMC hardware.

The OMDiffOC module does not control expanded I/O devices, so only the on-

device binary outputs can be controlled from this object.

Properties

Count (read only)

Syntax: object.Count

Type: Long

Description: Returns the number of binary outputs that are assigned to

physical outputs.


Set otm =



Dim bin As Object

Set bin =

DiffOC.Document.TestSettings.BinaryOutputs

MsgBox "There are " + Str(bin.Count) +

"output(s) assigned"



31/74

31

Item (Default Property - read only)

Syntax: object.Item(SignalID)

Long SignalID - Signal ID of the binary output

Type: Object (BinaryOutput)

Description: This property returns a Binary Output Object (BinaryOutput)

from the Binary Outputs Collection. The parameter is the

signal ID of the binary output in the collection. Signal IDs are

constants from the Constants object. Their possible values

are:

sigidUSER_OUTBIN_DEF1










Set otm =



'Set binary output for User Defined BinaryOutput 1

Dim st As Object

Set st = DiffOC.Document.TestSettings

Dim out As Object

Set out = st.BinaryOutputs(DiffOC.Constants.

sigidUSER_OUTBIN_DEF1)

out.Value = 1



32/74

32

ItemIndex (read only))

Syntax: object.Item(Index)

Variant Index - Index number of the binary output

Type: Object (BinaryOutput)

Description: This property returns a Binary Output Object (BinaryOutput)

from the Binary Outputs Collection. The index is the number

of the binary output in the collection (between 1 and Binary-

Outputs.Count).



Set otm =



'Set all binary outputs

Dim st As ObjectSet st = DiffOC.Document.TestSettings

For i = 1 To st.BinaryOutputs.Count

st.BinaryOutputs.ItemIndex(i).Value = 1

Next i



33/74

33

BinaryOutput Object

Properties

Value (default property)

Syntax: object.Value

Type: Boolean

Description: This property is True when the binary output is set (active),and False when it is not (inactive).



Set otm =



'Set binary output for User Defined BinaryOutput 1

Dim st As Object


Dim out As Object

Set out = st.BinaryOutputs(DiffOC.Constants.

sigidUSER_OUTBIN_DEF1)

out.Value = 1



34/74

34

Name (read only)

Syntax: object.Name

Type: String

Description: Get the name of the output (as set by the user in the

Hardware Configuration dialog).


Dim DiffOC As ObjectSet otm =



'Get name of User Defined Binary Output 1

Dim st As Object


Dim out As Object

Set out = st.BinaryOutputs(DiffOC.Constants.sigidUSER_OUTBIN_DEF1)

MsgBox "The name of the output is " + out.Name



35/74

35

HwInfo Object

This object allows reading some values from the hardware. All the values are

read-only

Properties

CMCIDStr (read only)

CMCSerNo (read only)

Syntax: object.CMCIDStr

Type: String

Description: Returns the ID of the CMC used in the test.

Generally it will be "1"; in case of off-line testing, the string will

be empty.



Set otm =



Dim CMCID As String

CMCID = DiffOC.HwInfo.CMCIDStr

Syntax: object.CMCSerNo

Type: String

Description: Returns the Serial Number of the CMC used in the test.

In case of off-line testing, the string will be "???????"





Dim CMCSer As String

CMCSer = DiffOC.HwInfo.CMCSerNo



36/74

36

CMCType (read only)

Syntax: object.CMCType

Type: String

Description: Returns the Type of the CMC used in the test (e.g. "CMC256-

6")

In case of off-line testing, it will return the type of the

simulated device selected.



Set otm =



Dim CMCType As String

CMCSer = DiffOC.HwInfo.CMCType



37/74

37

TestObject Object

This object allows access to the Differential OC Test Object, including the

Device block.

When changing the value of the Test Object settings, the Test Module must be

reconfigured to adapt to the new settings, which is done automatically after each

change of a Test Object setting. As this can take a noticeable amount of time,

the TestObject automation object provides a flag to disable the automatic

reconfiguration. The property AutoUpdate, True by default, selects whether or

not the OMDiffOC module should be automatically configured whenever anysettings are changed. If the user sets this property to False, then he should call

the PostProcessTOChangesmethod after he is finished doing changes.

PostProcessTOChangesis called automatically when theTestObjectobject

is destroyed, if any changes are still unprocessed.

Properties of the Device Section of the Test Object

AddInfo1

AddInfo2

Address

Syntax: object.AddInfo1

Type: String

Description: Get / Set the device's additional info / 1.

Syntax: object.AddInfo2

Type: String

Description: Get / Set the device's additional info / 2.

Syntax: object.Address

Type: String

Description: Get / Set the device's address.



38/74

38

BayAddr

BayName

CTRatio (Read Only)

DebounceTime

DeglitchTime

DevType

Syntax: object.BayAddr

Type: String

Description: Get / Set the Address of the Bay.

Syntax: object.BayName

Type: String

Description: Get / Set the Name of the Bay.

Syntax: object.CTRatio

Type: Double

Description: Get the ratio of the CT. This Value is equal toIprim / INom

Syntax: object.DebounceTime

Type: Double

Description: Get / Set the binary inputs debounce time in s.

Syntax: object.DeglitchTime

Type: Double

Description: Get / Set the binary inputs deglitch time in s.

Syntax: object.DevType

Type: String

Description: Get / Set the device's type.



39/74

39

Fnom

IMax

INom

Iprim

Manufacturer

Syntax: object.Fnom

Type: Double

Description: Get / Set the nominal frequency in Hz.

Syntax: object.IMax

Type: Double

Description: Get / Set the device's maximum current in A.

This is the highest current that can be applied to the device by

the OMICRON equipment without risk of damage.

Syntax: object.INom

Type: Double

Description: Get / Set the nominal current in A.

Syntax: object.Iprim

Type: Double

Description: Get / Set the primary current in A.

Syntax: object.Manufacturer

Type: String

Description: Get / Set the device manufacturer's description.


40/74



41/74

41

SubsAddr

SubsName

VMax

VNom

Vprim

Syntax: object.SubsAddr

Type: String

Description: Get / Set the address of the substation.

Syntax: object.SubsName

Type: String

Description: Get / Set the device's serial number as string.

Syntax: object.VMax

Type: Double

Description: Get / Set the device's maximum voltage in V.

This is the highest voltage that can be applied to the device

by the OMICRON equipment without risk of damage.

Syntax: object.VNom

Type: Double

Description: Get / Set the nominal voltage in V.

Syntax: object.Vprim

Type: Double

Description: Get / Set the primary voltage in V.



42/74

42

Properties of the Differential OC Section of the Test Object

CurrDiffGr

CurrDiffGrGr

CurrTolAbs

CurrTolRel

DelayTime

Syntax: object.CurrDiffGr

Type: Double

Description: Get / Set the setting for the trip limit (values of Idiff smaller

than CurrDiffGr will not cause a trip.) The value is set in times

In.

Syntax: object.CurrDiffGrGr

Type: Double

Description: Get / Set the setting for the instantaneous trip limit (values of

Idiff greater than IDiffGrGrwill always cause a trip,regardless of the value of Ibias.) The value is set in times In.

Syntax: object.CurrTolAbs

Type: Double

Description: Get / Set the Absolute Current Tolerance in times In.

Syntax: object.CurrTolRel

Type: Double

Description: Get / Set the Relative Current Tolerance in %.

Syntax: object.DelayTime

Type: Double

Description: Get / Set the delay time (time between shots to let the relay

recover from trip) in seconds.



43/74

43

DeltaCTPrim

DeltaCTPrimPermitted (Read Only)

DeltaCTSec

4.8.2.9 DeltaCTSecPermitted (Read Only)

Syntax: object.DeltaCTPrim

Type: Boolean

Description: Get / Set whether the primary winding has a delta-connected

CT. This property can only be set to Trueif DeltaCTPrimPer-

mittedis True.

Syntax: object.DeltaCTPrimPermitted

Type: Boolean

Description: Get whether the primary winding may have a delta-connected

CT. This property will be true if the test object is two-winding,

the Primary winding is connected in Y, and the secondary

winding is connected in Delta with an odd connection number.

Syntax: object.DeltaCTSec

Type: Boolean

Description: Get / Set whether the primary winding has a delta-connected

CT. This property can only be set to Trueif DeltaCTSecPer-mittedis True.

Syntax: object.DeltaCTSecPermitted

Type: Boolean

Description: Get whether the secondary winding may have a delta-connected CT. This property will be true if the test object is

two-winding, the Primary winding is connected in Delta, and

the secondary winding is connected in Y with an odd

connection number



44/74

44

I0Elimination

IBiasCalculation

IBiasDivider

Syntax: object.I0Elimination

Type: Long

Description: Get / Set the Zero sequence elimination method. This method

can be one of the following:

I0ELIMINATION_YD

I0ELIMINATION_ILI0

I0ELIMINATION_YDY

I0ELIMINATION_NONE

Syntax: object.IBiasCalculation

Type: Long

Description: Get / Set the Ibias calculation method.

This method can be one of the following:

ISTAB_METHOD_ABS_IP_IS_DIV_D(|Ip| + |Is|) / K1

ISTAB_METHOD_VEC_IP_IS_DIV_D(Ip + Is) / K1

ISTAB_METHOD_ABS_IP_IS_K2_DIV_D(|Ip| + |Is| * K2) / K1

ISTAB_METHOD_MAX_IP_ISmax(Ip, Is)

ISTAB_METHOD_MIN_IP_ISmin(Ip, Is)

ISTAB_METHOD_SQRT_IPIS_COS_Asqrt(Ip * Is * cos(a))

Syntax: object.IBiasDivider

Type: Double

Description: Get / Set the K1 divider for the IBiasCalculationformulas.

The permissible range is 1 to 10.



45/74

45

NormUsing

NumOfWindings

OperatingChar (Read Only)

Syntax: object.NormUsing

Type: Long

Description: Get / Set the normalization method. This method can be one

of the following:

USING_PO_NOM(Normalize using the relay's nominal

current)USING_TRF_NOM(Normalize uding the CT's nominal

current)

Syntax: object.NumOfWindings

Type: Long

Description: Get / Set the number of windings in the protected object. For

transformers, the number of windings may be 2 or 3, for all

the other protected objects it is fixed at 2. Please note that all

windings are accessible even if the Tertiary winding is not

used.

Syntax: object.OperatingChar

Type: Object (OperatingChar)

Description: Get / Set the Operating Characteristic object.



46/74

46

ProtectedObject

ReferenceWinding

TestMaxTime

Syntax: object.ProtectedObject

Type: Long

Description: Get / Set whether the protected object is a transformer,

generator, busbar or motor. The possible values are:

PO_TRANSFORMER

PO_GENERATOR

PO_MOTOR

PO_BUSBAR

Syntax: object.ReferenceWinding

Type: Long

Description: Get / Set the reference winding. The possible values are:

PRIMARY

SECONDARY

TERTIARY

TERTIARY is possible only when NumOfWindings is 3

Syntax: object.TestMaxTime

Type: Double

Description: Get / Set the maximum test time - that is, the maximum time

the module will wait for trigger fulfillment after fault inception

before deciding that the unit has not tripped.



47/74

47

TimeDiffGr

TimeDiffGrGr

TimeTolAbs

TimeTolRel

UseGndCT

Syntax: object.TimeDiffGr

Type: Double

Description: Get / Set the nominal tripping time for trips between Idiff> and

Idiff>>

The value is set in seconds.

Syntax: object.TimeDiffGrGr

Type: Double

Description: Get / Set the nominal tripping time for trips above Idiff>>

The value is set in seconds.

Syntax: object.TimeTolAbs

Type: Double

Description: Get / Set the Absolute Time Tolerance in seconds.

Syntax: object.TimeTolRel

Type: Double

Description: Get / Set the Relative Time Tolerance in %.

Syntax: object.UseGndCT

Type: Boolean

Description: Get / Set whether direct measurement of the Ground current

is enabled (applies to windings that have their star-points put

to ground.)



48/74

48

Winding (Index) (Read Only)

Syntax: object.Winding(index)

Long index

Type: Object (Winding)

Description: Get the Winding objects. The index must be one from

PRIMARY, SECONDARY and TERTIARY. TERTIARY is

always accessible, regardless of the number of windings of

the Test Object.



49/74

49

Other Properties of Test Object


Parent (read only)

AutoUpdate


Return

type:

Object (Application)

Description: Returns the application object (Application).


Return

type:

Object (Document)


hierarchy. In this case it is the Document Object (Document).

Syntax: object.AutoUpdate

Return

type:

Boolean

Description: Get / Set whether the module will be updated automatically

after changes to the TestObject parameters. If this property is

set to False, it is the responsibility of the programmer to

update the module after all the changes are done, by calling

the UpdateAfterChangesmethod.

This is not a property of the Differential Test Object, but of the

TestObject automation object. Therefore, the variable is

destroyed when the TestObject is destroyed, and is reset to

its default value of True every time a new TestObject is

created.



50/74

50

Methods

UpdateAfterChanges()

Syntax: object.UpdateAfterChanges()

Return

type:

none

Description: Updates the module after changes to the Test Object. If

AutoUpdateis True, the module will be automaticallyupdated after each change to the Test Object. To gain

efficiency, the programmer can set AutoUpdateto False and

call this method expressly after all changes are done. Please

note that in that case, the module will be in an unpredictable

state after any changes to the Test Object are made, and until

this method is called.



51/74

51

OperatingChar Object

This object gives access to the operating characteristic. It is composed of a

certain number of segments, and both the first and last segments are expanded

to infinity.

Properties

Segments (read only)

Syntax: object.Segments

Type: Object (Segments)

Description: Returns the Segmentscollection object. These segments

define the operating characteristic.



52/74

52

Segments Collection Object

Properties


Count (read only))

Item (default property - read only)

Parent (read only)





Type: Long

Description: Returns the number of segments in the characteristic.


Long Index (optional parameter)

Type: Object (Segment)

Description: Returns a characteristic segment Object (Segment) from the

Segmentscollection. The index is the number of the entry in

the list (between 1 and Segments.Count). If no index is

given, the Segments Collection Object is returned (reference

to self)


Type: Object (OperatingChar)


hierarchy. In this case it is the Operating Characteristic

(OperatingChar).



53/74

53

Methods

Reset(x1, y1, x2, y2)

Append (x2, y2)

Syntax: object.Reset(x1, y1, x2, y2)

Double x1

Double x2

Double y1

Double y2

Return

Type:

Boolean

Description: Clears the existing characteristic and sets the first segment

for the new characteristic. The operating characteristic cannot

be empty, this system ensures that there is at least one

segment at all times. X1 and Y1 are the Cartesian

coordinates of the first point of the segment, X2 and Y2 of the

last. Returns True if successful, False otherwise.

Syntax: object.Append(x2, y2)

Double x2

Double y2

Return

Type:

Object (Segment)

Description: Appends a segment at the end of the characteristic. The first

point of the new segment is the last point of the last existing

segment. Returns the Segmentobject for the newly added

segment if successful, NOTHING otherwise. Please note that

the operating characteristic must be built to grow rightwards

and upwards - segments that do not follow this general

direction will not be accepted.



54/74

54

Segment Object

This object allows access to a segment of the OC operating characteristic. All

properties are read only, the segment's parameters are totally defined by the

Segments.Appendmethod.

Properties

X1 (read only)

Y1 (read only)

X2 (read only)

Y2 (read only)

Syntax: object.X1

Type: Double

Description: Returns the x coordinate of the first (left and/or down) point of

the segment.

Syntax: object.Y1

Type: Double

Description: Returns the y coordinate of the first (left and/or down) point of

the segment.

Syntax: object.X2

Type: Double

Description: Returns the x coordinate of the second (right and/or up) point

of the segment.

Syntax: object.Y2

Type: Double

Description: Returns the y coordinate of the second (right and/or up) point

of the segment.



55/74

55

Slope (read only)

Syntax: object.Slope

Type: Double

Description: Returns the segment's slope, or -1 for vertical segments.



56/74

56

Winding Object

This object gives access to each of the three possible windings of the protected

object.

Properties

ConnGroup

ConnNum

GndIprim

Syntax: object.ConnGroup

Type: Long

Description: Get / Set the winding's vector group. The value can be one of

the following:

CONN_Dfor Delta-connected winding

CONN_Y for star-connected winding

CONN_Zfor Z-connected winding

Syntax: object.ConnGroup

Type: Long

Description: Get / Set the connection number for the winding.

Syntax: object.GndIprim

Type: Double

Description: Get / Set the primary current of the Ground measuring CT.

This setting will be used if UseGndCTis true and the winding

is grounded.


G dI


57/74

57

GndIsec

GndStrPtGndDir

Iprim

Isec)

Syntax: object.GndIsec

Type: Double

Description: Get / Set the secondary current of the Ground measuring CT.

This setting will be used if UseGndCTis true and the winding

is grounded.

Syntax: object.GndStrPtGndDir

Type: Long

Description: Get / Set the winding's Ground CT star-point grounding

direction. The value can be one of the following:

TOWARDS_GROUND Grounded towards ground

TOWARDS_PO Grounded towards the protectedobject

Syntax: object.Iprim

Type: Double

Description: Get / Set the CT primary current.

Syntax: object.Isec

Type: Double

Description: Get / Set the CT secondary current.


Name


58/74

58

Name

PwrNom

StrPtGnd

StrPtGndDir

Syntax: object.Name

Type: String

Description: Get / Set the winding's name. The names of the three

windings must be different. The names are case sensitive,

therefore PRIMARY and Primary are considered different.

This name will be used across the UI and in the Report.

Syntax: object.PwrNom

Type: Double

Description: Get / Set the winding's nominal power, in VA

Syntax: object.StrPtGnd

Type: Boolean

Description: Get / Set the winding's star-point (if existing) is wired to

ground. This setting makes sense only for windings with Y

vector group.

Syntax: object.StrPtGndDir

Type: Long

Description: Get / Set the winding's CT star-point (if existing) grounding

direction. This setting makes sense only for windings with Y

vector group and when StrPtGnd is true. The value can be

one of the following:

TOWARDS_LINEGrounded towards the line

TOWARDS_POGrounded towards the protected object


VNom


59/74

59

VNom

Syntax: object.VNom

Type: Double

Description: Get / Set the winding's nominal Voltage, in Volts.


Test Object Example


60/74

60

Test Object Example

This example will set the Test Object to the configuration of a SEL 501b

differential protection. When finished, the module will be in the same state as

after importing the RIO file provided with the OMICRON Test Library

(Schweitzer SEL 501b.rio)

Option Explicit

Dim otm As Object


Dim Con As Object

Dim Doc As Object

Dim ocTO As Object

Public Sub OnCmdScriptRun()

Set otm = Document.TestModules(1)'Object (TestModule)

otm.Connect

Set DiffOC = otm.SpecificSet Con = DiffOC.Constants


Set ocTO = Doc.TestObject

'Since we are going to do many changes, we

'disable the TO AutoUpdate feature

ocTO.AutoUpdate = False

'Let's begin with the TO common settings

ocTO.Name = "SEL 501"

ocTO.Manufacturer = "Schweitzer Engineering"

ocTO.Serial = "n/a"

ocTO.DevType = "87"

ocTO.Address = "n/a"

ocTO.SubsName = "n/a"

ocTO.SubsAddr = "n/a"ocTO.BayName = "n/a"

ocTO.BayAddr = "n/a"

ocTO.AddInfo1 = "Feeder #1"

ocTO.AddInfo2 = ""

ocTO.Phases = 3

ocTO.VNom = 120.0

ocTo.VMax = 250.0


ocTo.Vprim = 23900.0


61/74

61

p

ocTo.INom = 5.0

ocTo.IMax = 25.0

ocTo.Iprim = 600.0

ocTo.Fnom = 60.0

octo.DeglitchTime = 0

ocTo.DebounceTime = 0

'Now, the Differential common settings

ocTo.NumOfWindings = 2

ocTo.ReferenceWinding = Con.PRIMARY

ocTo.ProtectedObject = Con.PO_TRANSFORMER

ocTo.CurrTolAbs = 0.05

ocTo.CurrTolRel = 2

ocTo.TimeTolAbs = 0.01

ocTO.TimeTolRel = 3

ocTO.DelayTime = 0.25'250ms delay between shots

ocTO.TestMaxTime = 1.5'1.5s maximum fault timeocTO.NormUsing = Con.USING_PO_NOM

ocTO.CurrDiffGr = 0.5'Idiff> set to 0.5In

ocTO.CurrDiffGrGr = 2.0'Idiff>> set to 2.0In

ocTO.TimeDiffGr = 0.03'Idiff> nominal trip time set to

30ms

ocTO.TimeDiffGrGr = 0.023'Idiff>> nominal trip time set to

23ms

ocTO.IBiasCalculation = Con.ISTAB_METHOD_ABS_IP_IS_DIV_D

ocTO.IBiasDivider = 1.0

ocTO.I0Elimination = Con.I0ELIMINATION_ILI0

ocTo.UseGndCT = False

'The operating characteristic

Dim opChar As ObjectSet opChar = ocTO.OperatingChar.Segments

opChar.Reset(0.0, 0.4, 5.0, 1.0)'First segment: from (0.0,

0.4) to (5.0, 1.0)

opChar.Append(9.0, 2.2)'Second segment: from (5.0, 1.0) to

(9.0, 2.2)


Set opChar = Nothing


62/74

62

'Now let's set the windings

Dim Winding As Object

Set Winding = ocTO.Winding(Con.PRIMARY)

Winding.ConnGroup = Con.CONN_Y

Winding.ConnNum = 0

Winding.Name = "PrimDefault"

Winding.Isec = 1.0Winding.Iprim = 200.0

Winding.StrPtGnd = False

Winding.StrPtGndDir = Con.TOWARDS_PO

Winding.GndIsec = 1.0

Winding.GndIprim = 200.0

Winding.GndStrPtGndDir = Con.TOWARDS_PO

Winding.VNom = 115500

Winding.PwrNom = 4e+7

Set Winding = ocTO.Winding(Con.SECONDARY)

Winding.ConnGroup = Con.CONN_Y

Winding.ConnNum = 0

Winding.Name = "SecDefault"

Winding.Isec = 1.0

Winding.Iprim = 800.0

Winding.StrPtGnd = False

Winding.StrPtGndDir = Con.TOWARDS_PO

Winding.GndIsec = 1.0

Winding.GndIprim = 800.0

Winding.GndStrPtGndDir = Con.TOWARDS_PO

Winding.VNom = 30000

Winding.PwrNom = 4e+7

Set Winding = Nothing

'Let's process all changes

ocTO.UpdateAfterChanges()

'And leave the module

DiffOC.Quit

Set ocTO = Nothing


Set Doc = Nothing


63/74

63

Set Con = Nothing

Set DiffOC = Nothing

Set otm = Nothing

End Sub


SearchLines Collection Object


64/74

64

j

This collection holds the individual lines that make up the test sequence for the

Search test.

Properties


Count (read only)


Parent (read only)





Type: Long

Description: This property returns the number of test lines in the collection.



Type: Object (SearchLine)

Description: This property returns a search line object (SearchLine) from

the SearchLinescollection. The index is the number of the

entry in the list (between 1 and SearchLines.Count). If no

index is given, the SearchLinesCollection Object is returned

(reference to self).




hierarchy. In this case it is the Document object (Document).


65/74


SearchLine Object


66/74

66

This object gives access to the search line nominal values and results.

Properties

Ibias (read only)

IdiffActual (read only)

IdiffNom (read only)

Overload (read only)

Syntax: object.Ibias

Type: Double

Description: Get the value of Ibias, in times the nominal current. Since

Ibias is on the X axis, a search line is a vertical line having the

equation y = Ibias.

Syntax: object.IdiffActual

Type: Double

Description: Get the found Idiff. This property is meaningful only when

TestStatusis TEST_TESTED.

Syntax: object.IdiffNom

Type: Double

Description: Get the nominal Idiff, obtained from the operating

characteristic at the given Ibias. This value is 0 if TestSet-

tings.IgnoreNominalCharis True.

Syntax: object.Overload

Type: Boolean

Description: Get whether overload was detected during testing. The user

must then decide whether the value of TestOk is useful.

This property is meaningful only when TestStatusis

TEST_TESTED.


RelError (read only)


67/74

67

TestOk (read only)

TestStatus (read only)

Syntax: object.RelError

Type: Double

Description: Get the relative error in %. This error will be 0 if there was no

nominal Idiff (TestSettings.IgnoreNominalChar is True).


TEST_TESTED.

Syntax: object.TestOk

Type: Boolean

Description: Passed / failed status of the line. The property is True if the

line was evaluated as "Passed", False otherwise. This

property is meaningful only when TestStatusis

TEST_TESTED.

Syntax: object.TestStatus

Type: Boolean

Description: Get the status of the search line. The property will return a

value from among the following:

TEST_NOT_TESTEDLine not yet tested

TEST_TESTED Line tested

TEST_OUT_OF_RANGELine not tested due to out of range

values


Search Lines Example


68/74

68

Option Explicit

Dim otm As Object


Dim Con As Object

Dim Doc As Object

Dim ocSL As Object

Public Sub OnCmdScriptRun()Set otm = Document.TestModules(1)'Object (TestModule)

otm.Connect




Set ocSL = Doc.SearchLines

otm.Clear'Clear test results

If Doc.TestType = Con.TESTTYPE_SHOT Then'if there are shot

points defined

Doc.ShotPoints.RemoveAll()'remove them

ElseIf Doc.TestType = Con.TESTTYPE_SEARCH Then

ocSL.RemoveAll()'same thing for the search lines

End If

ocSL.Add(1.0)'Set search line at Ibias = 1.0In

Doc.TestSettings.IgnoreNominalChar = False'We want to

consider the nominal 'characteristic to save time

otm.Test'Perform the test

Dim SingleLine As Object

Set SingleLine = ocSL(1)

Dim msg As String

If SingleLine.TestStatus = Con.TEST_TESTED Then

msg = "Results of search line at Ibias = " +

Str(SingleLine.Ibias) + vbCrLf + vbCrLf

msg = msg + vbTab + "Idiff detected = " +

Str(SingleLine.IdiffActual) + vbCrLf

msg = msg + vbTab + "Relative error = " +

Str(SingleLine.RelError) + vbCrLf


msg = msg + vbTab + "Evaluation: "


69/74

69

If SingleLine.TestOk Then

msg = msg + "PASSED"

Else

msg = msg + "FAILED"

End If

End If

MsgBox msg

Set SingleLine = Nothing

DiffOC.Quit

Set ocSL = Nothing

Set Doc = Nothing

Set Con = Nothing

Set DiffOC = Nothing

Set otm = Nothing

End Sub


ShotPoints Collection Object


70/74

70

This collection holds the individual points that make up the test sequence for the

Shot test.

Properties


Count (read only)


Parent (read only)





Type: Long

Description: This property returns the number of test points in the

collection.



Type: Object (ShotPoint)

Description: This property returns a search line object (ShotPoint) from

the ShotPointscollection. The index is the number of the

entry in the list (between 1 and ShotPoints.Count). If no

index is given, the ShotPoints Collection Object is returned

(reference to self).




hierarchy. In this case it is the Document object (Document).


Methods

Add (Ibi Idiff)


71/74

71

Add (Ibias, Idiff)

Remove (index)

RemoveAll()

Syntax: object.Add(Ibias, Idiff)

Double Ibias

Double Idiff

Return

Type:

Object (ShotPoint)

Description: Creates a new test point at the Cartesian coordinates (Ibias,

Idiff) and adds it to the collection. Returns the ShotPoint

object if the line was successfully created and added, Noth-

ing if the method could not add the point. New points are

added at the end of the test line list and cannot be resorted.

The user must provide both parameters times the nominal

current. It is not possible to add points having the same

coordinates as one point already in the table; it is also not

possible to add points if there are searches in the search test

table.

Syntax: object.Remove(Index)

Long Index

Return

Type:

Boolean

Description: Removes a point from the list. Returns True if the point was

removed, False otherwise. The Index provided must go from

1 to ShotPoints.Count.

Syntax: object.RemoveAll()

Type: Boolean

Description: Removes all shot points.


ShotPoint Object

This object gives access to the shot test point nominal values and results


72/74

72

This object gives access to the shot test point nominal values and results.

Properties

ActualTime (read only)

Ibias (read only)

Idiff (read only)

Overload (read only)

Syntax: object.ActualTime

Type: Double

Description: Get the actual test time in seconds or -1 if no trip was

detected.


POINT_TESTED.

Syntax: object.Ibias

Type: Double

Description: Get the value of Ibias, in times the nominal current.

Syntax: object.Idiff

Type: Double

Description: Get the value of Idiff, in times the nominal current.

Syntax: object.Overload

Type: Boolean

Description: Get whether overload was detected during testing. The usermust then decide whether the value of TestOkis useful.


TEST_TESTED.


RelError (read only)

Syntax: object RelError


73/74

73

TestOk (read only)

TestTime (read only)

Syntax: object.RelError

Type: Double

Description: Get the relative error in %. This error will be 0 if the error is

infinite (the point tripped when it should not have tripped or

viceversa). This property is meaningful only when TestStatus

is TEST_TESTED.

Please note that this error is informative only, and is not usedto evaluate the point. The point is "Passed" or "Failed" only

according to whether or not it tripped, not to its trip time.

Syntax: object.TestOk

Type: Boolean

Description: Passed / failed status of the point. The property is True if the

point was evaluated as "Passed", False otherwise. This

property is meaningful only when TestStatusis

TEST_TESTED.

Syntax: object.TestTime

Type: Double

Description: Get the nominal trip time for the point in seconds or -1 if it is

infinite (no trip).


TestStatus (read only)

Syntax: object TestStatus


74/74

74

Syntax: object.TestStatus

Type: Boolean

Description: Get the status of the search point. The property will return a

value from among the following:

TEST_NOT_TESTEDPoint not yet tested

TEST_TESTED Point tested

TEST_OUT_OF_RANGEPoint not tested due to out of rangevalues

TEST_TRIP_PREFAULTPoint tripped during the pre-fault

time: Not tested.

TEST_OVERLINE Point is over the maximum torque line:

Not tested

TEST_TRIP_POSTFAULTPoint tripped during the post-fault

time

Diff OC Automation Interface

Documents

Transcript of Diff OC Automation Interface