advanced distance automation interface

8/10/2019 Advanced Distance Automation Interface

1/74

Advanced Distance

Automation Interface


2/74

OMICRON Test Universe

2

Manual Version: AdvDistAut.AE.2

OMICRON electronics 2005. 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. OMIRON electronics explicitly exonerates itself from all liability

for mistakes in this manual.


3/74


4/74


4


5/74

5

Advanced Distance Automation Interface

Advanced Distance AutomationInterface

Object Hierarchy

An Advanced Distance Documentcontains two different objects (refer to

figure 1):

Figure 1:

Object hierarchy of an

Advanced Distance

Document

Test Settings: it defines the test model and the test parameters.

Fault Types Collection: there are 7 fault types in a test:

L1N, L2N, L3N, L1L2, L2L3, L3L1 L1L2L3.

1

2

1

2

3

4

5


6/74


7/74

7


Constants (read only)

Document (read only)

Syntax: object.Constants

Type: Object (Constants)

Description: Returns the object with the constant values (Constants) you

can use with several functions.

Example: Dim otm As Object

Dim dist As Object

Set otm =

Document.InsertObject(OMADist.Document)

Set dist = otm.Specific

Dim constants As Object

Set constants = dist.Constants

Syntax: object.Document

Type: Object (Document)

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


Dim dist As Object

Set otm =



Dim doc As Object

Set doc = dist.Document


8/74


8

Name (read only)

Parent (read only)

Syntax: object.Name

Type: String

Description: Returns the name of the application.


Dim dist As Object

Set otm =



Dim Str As String

Set Str = dist.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

(Application).


Dim dist As Object

Set otm =



Dim obj As Object

Set obj = dist.Parent


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) (and start the

OMICRON Advanced Distance application) you have to set the visible property

to TRUE to see the main window of the application.

Methods

Quit

Syntax: object.Visible

Type: Boolean

Description: Shows/hides the main application window.


Dim dist As Object

Set otm =



'Is the application visible ?

If dist.Visible then

MsgBox "Application is visible"

Else'Make the application visible

dist.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.


Dim dist As Object

Set otm =



dist.Quit


10/74


10

Document ObjectWith the Document Object (Document) you can control the document.

From this object you can get references to the Fault Types Collection Object

(FaultTypes), the Test Settings Object (TestSettings).

Properties

Application (read only)

Comment

Syntax: Object.Application

Type: Object (Application)

Description: Returns the Application Object (Application).


Dim dist As Object

Set otm =Document.InsertObject(OMADist.Document)


Dim app As Application

Set app = dist.Document.Application

Syntax: object.Comment

Type: String

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

be shown in the report.


Dim dist As Object

Set otm =



'Set comment

dist.Document.Comment = "This test is

simulated."


11/74

11


Parent (read only)

FaultTypes (read only)


Type: Object


hierarchy. In this case it is the Application Object

(Application).


Dim dist As Object

Set otm =



Dim obj As Object

Set obj = dist.Document.Parent

Syntax: object.FaultTypes

Type: Object (FaultTypes)

Description: This property returns the Fault Types Collection Object

(FaultTypes) of the document. With this object you can

access to the the Fault Types in your document. This

collection contains 7 elements and has no New or Add

method.


Dim dist As Object

Set otm =



Dim FaultTypes As Object

Set FaulTypes = dist.Document.FaultTypes


12/74


12

Shot

TestSettings

Syntax: object.Shot

Type: Object (Shot)

Description: This property returns a shot object (Shot). The returned shot

object can be modified but the changes do not affect the test.

Example: This example shows how to find out

nominal trip times for specific

locations at the line

Dim otm As Object

Dim dist As Object

Dim const As Object

Dim loc As Integer

Set otm =



Dim shot As Object

Set shot = dist.Document.Shot

Set const = dist.Constants

shot.ShotType = const.STRelative

shot.ZoneKey = 1 line length

For loc = 10 To 370 Step 40

shot.PercentZone = loc

MsgBox("Loc.: " & loc & "%: TNom = " &

shot.TNom)Next

Syntax: object.TestSettings

Type: Object

Description: This property returns the test settings object.


Dim dist As Object

Set otm =



Dim obj As Object

Set obj = dist.Document.TestSettings


13/74

13


MethodsRemoveAllAll

RemoveAllChecks

Syntax: object.RemoveAllAll

Type: None

Description: This method removes all shots and lines for all fault types

Example: Dim otm As ObjectDim dist As Object

Set otm =



'Remove all shots and lines

dist.Document.RemoveAllAll

Syntax: object.RemoveAllChecks

Type: None

Description: This method removes all check lines for all fault types


Dim dist As Object

Set otm =



'Remove all check lines

dist.Document.RemoveAllChecks


14/74


14

RemoveAllSearches

RemoveAllShots

Syntax: object.RemoveAllSearches

Type: None

Description: This method removes all search lines for all fault types


Dim dist As Object

Set otm =



'Remove all search lines

dist.Document.RemoveAllSearches

Syntax: object.RemoveAllShots

Type: None

Description: This method removes all shots for all fault types


Dim dist As Object

Set otm =

Document.InsertObject(OMADist.Document)Set dist = otm.Specific

'Remove all shots

dist.Document.RemoveAllShots


15/74

15


TestSetDefaults

UpdateAllViews

Syntax: object.TestSetDefaults

Type: None

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.


Dim dist As Object

Set otm =



' Set defaults

dist.Document.TestSetDefaults

Syntax: object.UpdateAllViews(hint)

Long hint

Type: None

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

parameter specifies which view becomes the update. Bycalling this method without parameter, all the UI is updated.


Dim dist As Object

Set otm =



dist.FaultTypes(1).Shots.Add

dist.Document.UpdateAllViews


16/74


16

TestSettings ObjectProperties

AllowReduction

CBSimulationON

Syntax: object.AllowReduction

Type: Boolean

Description: Get/Set the allow-reduction-of-Itest flag.


Dim dist As Object

Set otm =



Allow reduction of Itest

dist.Document.TestSettings.AllowReduction =True

Syntax: object.CBSimulationON

Type: Boolean

Description: Get/Set the CB-Simulation-ON flag.


Dim dist As Object

Set otm =



CB simulation ON

dist.Document.TestSettings.CBSimulationON =

True


17/74

17


DCOffset

ExtendedZonesActive

Syntax: object.DCOffset

Type: Boolean

Description: Get/Set the DC-Offset flag.


Dim dist As Object

Set otm =



Set DC offset

dist.Document.TestSettings.DCOffset = True

Syntax: object.ExtendedZonesActive

Type: Boolean

Description: Get/Set the Extended-Zone-Active flag.


Dim dist As Object

Set otm =


Extended zones are active

dist.Document.TestSettings.ExtendedZonesActiv

e = True


18/74


18

FaultInceptionAngle

FaultInceptionMode

Syntax: object. FaultInceptionAngle

Type: Double

Description: Get/Set the fault inception angle. The unit is degree.


Dim dist As Object

Set otm =



Set the fault inception angle to 30.5

dist.Document.TestSettings.FaultInceptionAngl

e = 30.5

Syntax: object. FaultInceptionMode

Type: Long

Description: Get/Set the fault inception mode.

Possible values are (see Constants object):

FIMFixed

FIMMaximum

FIMRandom

FIMZero


Dim dist As Object

Dim distConst As Object

Set otm =



Set distConst = dist.Constants

Set the fault inception mode to random

dist.Document.TestSettings.FaultInceptionMode

= distConst.FIMRandom


19/74

19


IgnoreNominalChar

IVTest

Syntax: object. IgnoreNominalChar

Type: Boolean

Description: Get/Set the ignore-nominal-characteristic flag.


Dim dist As Object

Set otm =



Ignore nominal characteristic

dist.Document.TestSettings.IgnoreNominalChar

= True

Syntax: object.IVTest

Type: Double

Description: This property specifies the test current or the test voltage

(depending on the test mode).


Dim dist As ObjectSet otm =



dist.Document.TestSettings.IVTest = 5.0


20/74


20

KSMag

KSAngle

MaxFaultTime

Syntax: object.KSMag

Type: Double

Description: This property specifies the magnitude of the KS factor.


Dim dist As Object

Set otm =



dist.Document.TestSettings.KSMag = 1.0

Syntax: object.KSAngle

Type: Double

Description: This property specifies the angle of the KS factor. The unit

is .


Dim dist As Object

Set otm =


dist.Document.TestSettings.KSAngle = 0.0

Syntax: object.MaxFaultTime

Type: Double

Description: This property specifies the max-fault time in second.


Dim dist As Object

Set otm =



dist.Document.TestSettings.MaxFaultTime = 2.5


21/74

21


PostFaultTime

PreFaultTime

Syntax: object.PostFaultTime

Type: Double

Description: This property specifies the post-fault time in second.


Dim dist As Object

Set otm =



dist.Document.TestSettings.PostFaultTime =

0.5

Syntax: object.PreFaultTime

Type: Double

Description: This property specifies the pre-fault time in second.


Dim dist As Object

Set otm =


dist.Document.TestSettings.PreFaultTime = 1.0

OMICRON T t U i


22/74


22

SearchInterval

SearchIntervalAbs

Syntax: object.SearchInterval

Type: Double

Description: This property specifies the search interval. The unit is Ohm.


Dim dist As Object

Set otm =



dist.Document.TestSettings.SearchInterval =

0.2

Syntax: object.SearchResolutionAbs

Type: Double

Description: This property specifies the absolute search resolution. The

unit is Ohm.


Dim dist As Object



dist.Document.TestSettings.SearchResolutionAb

s = 0.05



23/74

23


SearchIntervalRel

SwitchOffAtZeroCrossing

Syntax: object.SearchResolutionAbs

Type: Double

Description: This property specifies the relative search resolution. The unit

is %.


Dim dist As Object

Set otm =



dist.Document.TestSettings.SearchResolutionRe

l = 1.0

Syntax: object.SwitchOffAtZeroCrossing

Type: Boolean

Description: Get/Set the switch off at zero crossing flag.


Dim dist As Object



CB simulation ON

dist.Document.TestSettings.SwitchOffAtZeroCro

ssing= True


24/74



25/74

25


ZSMag

ZSAngle

Syntax: object.ZSMag

Type: Double

Description: This property specifies the ZS magnitude. The unit is Ohm.


Dim dist As Object

Set otm =



dist.Document.TestSettings.ZSMag = 2.0

Syntax: object.ZSAngle

Type: Double

Description: This property specifies the ZS angle. The unit is .


Dim dist As Object

Set otm =


Set dist = otm.Specificdist.Document.TestSettings.ZSAngle = 30.0



26/74

26

Methods

TestSetDefaults

Syntax: object.TestSetDefaults

Type: None

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.


Dim dist As Object

Set otm =



' Set default test settings

dist.Document.TestSettings.TestSetDefaults



27/74

27

FaultTypes Collection ObjectProperties


Syntax: object.Application




Dim dist As Object

Set otm =




Set app =dist.Document.FaultTypes.Application



28/74

28

Count (read only)

Parent (read only)

Syntax: object.Count

Type: Long

Description: This property returns the number of fault types in the

document.

Note: By design there is always 7 fault types.


Set otm =



'Count twice

Dim s As Object

Dim ss As Object

i = 0

Set ss = dist.Document.FaultTypes

For Each s in ss

i = i+1

Next

If i = ss.Count then

MsgBox "We've counted twice"

End If


Type: Object


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


Dim dist As Object

Set otm =

Document.InsertObject(OMAdist.Document)


Dim obj As Object

Set obj = dist.Document.FaultTypes.Parent



29/74

29

Methods

Add

Item (default property)

Remove

Syntax: object.Add

Return

type:

Object (State)

Description: Not supported.

Syntax: object.Item(Index)

Return

type:

Object (FaultType/FaultTypes)

Description: This method returns a Fault Type Object (FaultType) from the

FaultTypes Collection. The index is the number of the faulttypes in the document (between 1 and FaultTypes.Count). If

no index is given, the FaultTypes Collection Object

(FaultTypes) is returned.


Dim dist As Object

Set otm =



'Get FaultTypes object

Dim FaultTypes As Object

set FaultTypes = dist.Document. FaultTypes

'Get FaultType object 2

Dim FT2 As Object

Set FT2 = FaultTypes.Item(2)

Syntax: object.Remove

Return

type:

None

Description: Not supported.



30/74

30

FaultType Object

Properties

FTString (read only)

Shots (read only)

Syntax: object.FTString

Type: String

Description: This property returns the Fault Type string.


Dim dist As Object

Set otm =



Dim strFT As string

strFT = dist.Document.FaultType(1).FTString

Syntax: object.Shots

Type: Object (Shots)

Description: This property returns the Shots Collection Object (Shots) of a

given Fault Type Object (FaultType).


Dim dist As Object

Set otm =



Dim shots As Object

Set shots = dist.Document.FaultType(1).Shots



31/74

31

SearchLines (read only)

Syntax: object.SearchLines

Type: Object (SearchLines)

Description: This property returns the Search Lines Collection Object

(SearchLines) of a given Fault Type Object (FaultType).


Dim dist As Object

Set otm =



Dim searchlines As Object

Set searchlines =

dist.Document.FaultType(1).SearchLines



32/74

32

Shots Collection Object

Properties


Count (read only)





Dim dist As Object

Set otm =




Set app =dist.Document.FaultTypes(1).Shots.Application


Type: Long

Description: This property returns the number of shots.


Dim dist As Object

Set otm =



MsgBox "Number of shots in fault type L1N: " &

dist.Document.FaultTypes(1).Shots.Count



33/74

33

Parent (read only)

MethodsAdd

AddRelative


Type: Object


hierarchy. In this case it is the Fault Type Object (FaultType).





Dim obj As Object

Set obj =

dist.Document.FaultTypes(1).Shots.Parent

Syntax: object.Add

Return

type:

Object (Shot)

Description: This method adds a shot to the Shots collection and returnsthe created Shot Object (Shot).

Syntax: object.AddRelative (Phi, PercentZone, ZoneKey)

Double Phi

Double PercentZone

Long ZoneKey

Return

type:

Object (Shot)

Description: This method adds a relative shot to the Shots collection and

returns the created Shot Object (Shot).



34/74

34

AddRX

AddZPhi

Remove

RemoveAll

Syntax: object.AddRX(R, X)

Double R

Double X

Return

type:

Object (Shot)

Description: This method adds an absolute shot to the Shots collection

and returns the created Shot Object (Shot).

Syntax: object.AddZPhi(Z, Phi)

Double Z

Double Phi

Returntype: Object (Shot)

Description: This method adds an absolute shot to the Shots collection

and returns the created Shot Object (Shot).

Syntax: object.Remove(index)

Long index

Return

type:

none

Description: This method removes the specified shot from the Shots

collection.

Syntax: object.RemoveAll

Return

type:

none

Description: This method removes all the shots from the Shots collection.



35/74

35


Syntax: object.Item(index)

Long index

Return

type:

Object (Shot)

Description: This method returns a Shot Object (Shot) from the Shots

Collection. The parameter is the shot index in the collection.


Dim dist As Object

Set otm =


Set shot = otm.Specific

'Set R of first L1N shot to 2 Ohm

Dim shot As Object

Set shot =

dist.Document.FaultTypes(dist.Constants.FTL1N

).Shot(1)

shot.R = 2.0



36/74

36

ItemIndex

Syntax: object.ItemIndex(Index)

Variant Index Index number of the shot.

Return

type:

Object (Shot)

Description: This method returns a Shot Object (Shot) from the Shots

Collection. The index is the number of the shot in the

collection (between 1 and Shots.Count).


Dim dist As Object

Set otm =



'Set X of first three shots to 0

Dim shotFT As Object

Set shotFT = dist.Document.FaultTypes(1)

For i = 1 To 3

shotFT.Shots.ItemIndex(i).X = 0.0

Next i



37/74

37

Shot Object

Properties

Dev (read only)

Syntax: object.Dev

Type: Double

Description: This property returns the time deviation in %.


Dim dist As Object

Set otm =



Dim shots As Object

Set shots =

dist.Document.FaultTypes(dist.Constants.FTL1L

2).Shots

shots.AddRX(0,1)

otm.Test

Dim dev As double

dev = shots(1).Dev



38/74

38

IsFailed (read only)

IVTest (read only)

Syntax: object.IsFailed

Type: Boolean

Description: This property returns True if the shot has failed.


Dim dist As Object



Dim shots As Object

Set shots =


2).Shots

shots.AddRX(0,1)

otm.Test

If shots(1).IsFailed then MsgBox(Test

failed)

Syntax: object.IVTest

Type: Double

Description: This property returns the test current or the test voltage

(depending on the test mode).


Dim dist As Object

Set otm =


Set dist = otm.SpecificDim shots As Object

Set shots =


2).Shots

shots.AddRX(0,1)

Dim IVTest As double

IVTest = shots(1).IVTest



39/74

39

PercentZone

Phi

Syntax: object.PercentZone

Type: Double

Description: This property gets/sets the percentage of zone for a relative

shot.





Dim shots As Object

Set shots =


2).Shots

Dim shot As Object

Set shot = shots.Add

shot.PercentZone = 110 110%

Syntax: object.Phi

Type: Double

Description: This property specifies the shot angle. The unit is degree.


Dim dist As Object

Set otm =



Dim shots As ObjectSet shots =


2).Shots

Dim shot As Object


shot.Z = 1.0

shot.Phi = 45.0



40/74

40

Phi1FaultInc

R

Syntax: object.Phi1FaultInc

Type: Double

Description: This property returns the fault inception angle on phase one.

The unit is degree.

Example:

Syntax: object.R

Type: Double

Description: This property specifies the R value of the shot. The unit is

Ohm.


Dim dist As Object

Set otm =



'Set R of L2N to 2 Ohm

Dim shot As Object

Set shot =


).Shots(1)

shot.R = 2.0



41/74

41

ShotType

Syntax: object.ShotType

Type: Long

Description: This property specifies the shot type (absolute or relative).

Possible values are:

STAbsolute

STRelative


Dim dist As Object

Set otm =



Dim shots As Object

Set shots =

dist.Document.FaultTypes(dist.Constants.FTL1L2).Shots

Dim shot As Object


shot.ShotType = dist.Constants.STRelative



42/74

42

Status (read only)

Syntax: object.Status

Type: Long

Description: This property returns the shot status.


SSFailed

SSNotTested

See Constants object for complete list.


Dim dist As Object

Set otm =



Dim shots As ObjectSet shots =


2).Shots

Dim shot As Object


If shot.Status = dist.Constants.SSNotTested

Then

MsgBox(Not Tested)

End If


43/74



44/74

44

TMax (read only)

Syntax: object.TMax

Type: Double

Description: This property returns the maximum zone time in s according

to the time tolerance.





Dim shots As Object

Set shots =


2).Shots

shots.AddRX(1,0)otm.Test

Dim tmax As double

tmax = shots(1).TMax



45/74

45

TMin (read only)

X

Syntax: object.TMin

Type: Double

Description: This property returns the minimum zone time in s according to

the time tolerance.





Dim shots As Object

Set shots =


2).Shots

shots.AddRX(1,0)otm.Test

Dim tmin As double

tmin = shots(1).TMin

Syntax: object.X

Type: Double

Description: This property specifies the X value of the shot.


Dim dist As Object

Set otm =



'Set X of L2N to 2 Ohm

Dim shot As Object

Set shot =


).Shots(1)

shot.X = 2.0



46/74

46

Z

ZeroCrossing

Syntax: object.Z

Type: Double

Description: This property specifies the Z value. The unit is degree.


Dim dist As Object



Dim shots As Object

Set shots =


2).Shots

Dim shot As Object

Set shot = shots.Addshot.Z = 1.0

shot.Phi = 45.0

Syntax: object.ZeroCrossing

Type: Boolean

Description: This property specifies the zero-crossing flag.


Dim dist As Object

Set otm =



Dim shots As Object

Set shots =


2).Shots

shots.Add

shots(1).ZeroCrossing = True



47/74

47

ZoneKey

Syntax: object.ZoneKey

Type: Long

Description: This property specifies the zone-key, the zone index used for

a relative shot.





Dim shots As Object

Set shots =


2).Shots

shots.Addshots(1).ZoneKey = 1



48/74

48

SearchLines Collection Object

Properties


Count (read only)





Dim dist As Object

Set otm =




Set app =

dist.Document.FaultTypes(1).SearchLines.Appli

cation


Type: Long

Description: This property returns the number of search lines.


Dim dist As Object

Set otm =



MsgBox "Number of shots in fault type L1N: " &

dist.Document.FaultTypes(1).SearchLines.Count



49/74

49

Parent (read only)

Methods

Add


Type: Object


hierarchy. In this case it is the Fault Type Object (FaultType).





Dim obj As Object

Set obj =

dist.Document.FaultTypes(1).SearchLines.Paren

t

Syntax: object.Add

Return

type:

Object (SearchLine)

Description: This method adds a search line to the SearchLines collection

and returns the created search line Object (SearchLine).



50/74

50

AddRelRX

AddRelZPhi

Syntax: object.AddRelRX(R, X, Angle, PercentZone, ZoneKey)

Double R

Double X

Double Angle

Double PercentZone

Long ZoneKey

Return

type:

Object (SearchLine)

Description: This method adds a relative search line to the SearchLines

collection and returns the created search line Object

(SearchLine).



51/74

51

AddRX

Syntax: object.AddRelZPhi(Z, Phi, Angle, PercentZone, ZoneKey)

Double Z

Double Phi

Double Angle

Double PercentZone

Long ZoneKey

Return

type:

Object (SearchLine)

Description: This method adds a relative search line to the SearchLines


(SearchLine).

Syntax: object.AddRX(R, X, Angle, Length)

Double R

Double X

Double Angle

Double Length

Return

type:

Object (SearchLine)

Description: This method adds an absolute search line to the SearchLines


(SearchLine).



52/74

52

AddZPhi

Remove

RemoveAll

Syntax: object.AddZPhi(Z, Phi, Angle, Length)

Double Z

Double Phi

Double Angle

Double Length

Return

type:

Object (SearchLine)

Description: This method adds an absolute search line to the SearchLines


(SearchLine).

Syntax: object.Remove(index)

Long index

Return

type:

none

Description: This method removes the specified search line from the

SearchLines collection.

Syntax: object.RemoveAll

Return

type:

none

Description: This method removes all the search lines from the

SearchLines collection.



53/74

53


ItemIndex


Long index

Return

type:

Object (SearchLine)

Description: This method returns a search line Object (SearchLine) from

the SearchLines Collection. The parameter is the search line

index in the collection.

Syntax: object.ItemIndex(Index)

Variant Index Index number of the search line.

Return

type:

Object (SearchLine)

Description: This method returns a Search Line Object (SearchLine) from

the SearchLines Collection. The index is the number of the

search lines in the collection (between 1 and

SearchLines.Count).



54/74

54

SearchLine Object

Properties

Absolute

Angle

Syntax: object.Absolute

Type: Boolean

Description: This property specifies if the search line is absolute (True).


Dim dist As Object

Set otm =




Set searchlines =


2).searchlines

searchlines.Add

searchlines(1).Absolute = False

Syntax: object.Angle

Type: Double

Description: This property specifies the search line angle. The unit is

degree


Dim dist As Object

Set otm =



Set searchlines =


2).searchlines

searchlines.Add

searchlines(1).Angle = 45.0



55/74

55

IsFailed (read only)

Length

Syntax: object.IsFailed

Type: Boolean

Description: This property returns True if the search line test has failed.


Dim dist As Object

Set otm =




Set searchlines =


2).searchlines

searchlines.Add

otm.TestIf searchlines(1).IsFailed then MsgBox(Test

failed)

Syntax: object.Length

Type: Double

Description: This property specifies the search line length. The unit is Ohm


Dim dist As Object

Set otm =




Set searchlines =


2).searchlines

searchlines.Add

searchlines(1).Length = 1.0



56/74

56

PercentZone

Phi

Syntax: object.PercentZone

Type: Double

Description: This property specifies the zone percent of a relative search

line. The unit is %


Dim dist As Object

Set otm =




Set searchlines =


2).searchlines

searchlines.Addsearchlines(1).Percent = 95.0

Syntax: object.Phi

Type: Double

Description: This property specifies the angle of the search line origine.The unit is degree.


Dim dist As Object

Set otm =




Set searchlines =


2).SearchLines

Dim searchline As Object

Set searchline = searchlines.Add

searchline.Z = 1.0

searchline.Phi = 45.0


R


57/74

57

R

Syntax: object.R

Type: Double

Description: This property specifies the R value of the search line origine.

The unit is Ohm.


Dim dist As Object

Set otm =



Set searchlines =


2).SearchLines


Set searchline = searchlines.Addsearchline.R = 1.0


Status (read only)


58/74

58

Status (read only)


Type: Long

Description: This property returns the search line status.


SSFailed

SSNotTested



Dim dist As Object

Set otm =




Set searchlines =


2).searchlines



If searchlines.Status =

dist.Constants.SSNotTested Then

MsgBox(Not Tested)End If


Reaches (read only)


59/74

59

Reaches (read only)

X

Syntax: object.Reaches

Type: Object (Reaches)

Description: This property returns the Reaches Collection Object

(Reaches) of a given Search Line Object (SearchLine).


Dim dist As Object

Set otm =



Dim reaches As Object

Set reaches =

dist.Document.FaultType(1).SearchLines(1).rea

ches

Syntax: object.X

Type: Double

Description: This property specifies the X value of the search line origine.

The unit is Ohm.


Set otm =



Set searchlines =


2).SearchLines



searchline.X = 1.0


Z


60/74

60

Z

ZoneKey

Syntax: object.Z

Type: Double

Description: This property specifies the Z value of the search line origine.

The unit is Ohm.


Dim dist As Object

Set otm =



Set searchlines =


2).SearchLines



searchline.Z = 1.0

Syntax: object.ZoneKey

Type: Long

Description: This property specifies the zone-key, the zone index of a

relative search line.


Dim dist As Object

Set otm =



Set searchlines =


2).SearchLines



searchline.ZoneKey = 2


Reaches Collection Object


61/74

61

Reaches Collection Object

Properties






Dim dist As Object

Set otm =



Set searchlines =


2).SearchLines




Set app = searchline.Reaches.Application


Count (read only)


62/74

62

Parent (read only)


Type: Long

Description: This property returns the number of search lines.


Dim dist As Object

Set otm =



Set searchlines =


2).SearchLines



MsgBox "Number of reaches: " &

searchline.Reaches.Count


Type: Object


hierarchy. In this case it is the Search Line Object

(SearchLine).


Dim dist As Object

Set otm =



Set searchlines =


2).SearchLines



Dim obj As Object

Set obj = searchline.Reaches.Parent


Methods


63/74

63


Reach Object

Properties

IsStepUp


Long index

Return

type:

Object (Reach)

Description: This method returns a Reach Object (Reach) from the

Reaches Collection. The parameter is the reach index in the

collection.

Example:

Syntax: object.IsStepUp

Type: Boolean

Description: This property returns True if step up.


Dim dist As Object

Set otm =




Set searchlines =


2).searchlines

searchlines.AddRX(0,0,90,2)

otm.Test

If searchlines.Reaches.Count > 0 Then

debug.Print searchlines.Reaches(1).IsStepUp

End If


RAct (read only)


64/74

64

Syntax: object.RAct

Type: Double

Description: This property returns the actual R.


Dim dist As Object

Set otm =




Set searchlines =


2).searchlines

searchlines.AddRX(0,0,90,2)

otm.Test

If searchlines.Reaches.Count > 0 Then

debug.Print searchlines.Reaches(1).RAct

debug.Print searchlines.Reaches(1).RDev

debug.Print

searchlines.Reaches(1).RDevPercent

debug.Print searchlines.Reaches(1).RNom

debug.Print searchlines.Reaches(1).Status

debug.Printsearchlines.Reaches(1).StatusString(Status:

%s)

debug.Print searchlines.Reaches(1).TLower

debug.Print searchlines.Reaches(1).TMax

debug.Print searchlines.Reaches(1).TMin

debug.Print searchlines.Reaches(1).TUpper

debug.Print searchlines.Reaches(1).Type

debug.Print searchlines.Reaches(1).XAct debug.Print searchlines.Reaches(1).XDev

debug.Print

searchlines.Reaches(1).XDevPercent


Example debug.Print searchlines.Reaches(1).XNom


65/74

65

RDev (read only)

RDevPercent (read only)

RNom (read only)

Example

(cont.):

debug.Print searchlines.Reaches(1).XNom

debug.Print searchlines.Reaches(1).ZAct

debug.Print searchlines.Reaches(1).ZDev

debug.Print searchlines.Reaches(1).ZMax

debug.Print searchlines.Reaches(1).ZMin

debug.Print searchlines.Reaches(1).ZNom

debug.Print

searchlines.Reaches(1).ZoneLabelHigh

debug.Print

searchlines.Reaches(1).ZoneLabelLow

End If

Syntax: object.RDev

Type: Double

Description: This property returns the R deviation in Ohm.

Example: See RAct example.

Syntax: object.RDevPercent

Type: Double

Description: This property returns the R deviation in %.


Syntax: object.RNom

Type: Double

Description: This property returns the nominal R.



Status (read only)


66/74

66

StatusString (read only)

TLower (read only)

TMax (read only)


Type: Long

Description: This property returns the reach status.


RSFailed

RSNotTested



Syntax: object.StatusString(format)

Type: String format

Description: This property returns the reach status string.

The format parameter is used to format the returned string.


Syntax: object.Tlower

Type: Double

Description: This property returns the lower time in s.


Syntax: object.TMax

Type: Double

Description: This property returns the time max in s.



TMin (read only)


67/74

67

TUpper (read only)

Type (read only)

XAct (read only)

Syntax: object.TMin

Type: Double

Description: This property returns the time min in s.


Syntax: object.TUpper

Type: Double

Description: This property returns the time upper in s.


Syntax: object.TUpper

Type: Long

Description: This property returns the reach type.


Syntax: object.XAct

Type: Double

Description: This property returns the actual X in Ohm.



XDev (read only)


68/74

68

XDevPercent (read only)

XNom (read only)

ZAct (read only)

Syntax: object.XDev

Type: Double

Description: This property returns the X deviation in Ohm.


Syntax: object.XDevPercent

Type: Double

Description: This property returns the X deviation in %.


Syntax: object.XNom

Type: Double

Description: This property returns the nominal X.


Syntax: object.ZAct

Type: Double

Description: This property returns the actual Z in Ohm.



69/74


ZoneLabelHigh (read only)


70/74

70

ZoneLabelLow (read only)

Syntax: object.ZoneLabelHigh

Type: String

Description: This property returns the zone label high.


Syntax: object.ZoneLabelLow

Type: String

Description: This property returns the zone label low.



Constants Object

P ti


71/74

71

Properties

The following is a list some useful IDs supported by the OMICRON Advanced

Distance Module.

Note: Do NOT use these IDs out of the Automation scope.

Fault Types

FTL1N

FTL2N

FTL3N

FTL1L2

FTL2L3

FTL3L1

FTL1L2L3

Fault Inception Mode

FIMFixed

FIMMaximum

FIMRandom

FIMZero

Reach Status

RSFailed

RSNotTested

RSOutOfRange

RSOverloadFailed

RSOverloadPassed

RSOverloadTrippedPrefault

RSPassed

RSTrippedPrefault


Reach Type

RTIdentify


72/74

72

RTIdentify

RTSearchZ

RTVerify

Shot Status

SSFailed

SSNotTested

SSOutOfRange

SSOverloadFailed

SSOverloadPassed

SSOverloadTrippedPrefault

SSPassed

SSTrippedPrefault

Shot Type

STAbsolute

STRelative

Test Mode

TMConstantCurrent

TMConstantVoltage

TMConstantSourceImp

Time Reference

TRFaultInception

TRStarting


Zone Type

ZTExtended


73/74

73

ZTExtended

ZTNonTripping

ZTStarting

ZTTripping



74/74

74

advanced distance automation interface

Documents