Advanced Distance Automation Interface

Advanced Distance
Automation Interface
OMICRON Test Universe
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.
Contents
Contents
Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2
Object Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Application Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Document Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
TestSettings Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
FaultTypes Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
FaultType Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Shots Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Shot Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
SearchLines Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
SearchLine Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Reaches Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Reach Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Constants Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Advanced Distance Automation Interface
Advanced Distance Automation

Interface
Object Hierarchy
An Advanced Distance Document contains two different objects (refer to
figure 1):
1
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.
Figure 1:
Object hierarchy of an
Advanced Distance
Document
1
2
3
A FaulType object contains 3 different objects:

3
Shots collection
SearchLines collection
CheckLines collection
Each FaultType has 1 to n Shot objects, has 1 to n SearchLine objects, and has
1 to n CheckLine objects.
Each SearchLine object has 1 to n Reach objects.
Reference
Application Object
Properties
Application (read only)
The application object is the root of the OMICRON Advanced Distance object
hierarchy. It is the only object that can be created directly by other OLE
Automation controllers (e.g. MS Excel using CreateObject).
This object is unique within the OMICRON Advanced Distance Module. If you
want to create another Application object with CreateObject, a new instance of
the OMICRON Advanced Distance 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.
Constants (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
Document (read only)

Syntax:
object.Document
Type:
Object (Document)
Description:
This property returns a Document Object (Document).
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim doc As Object
Set doc = dist.Document
Name (read only)

Syntax:
object.Name
Type:
String
Description:
Returns the name of the application.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim Str As String
Set Str = dist.Name
Parent (read only)
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).
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim obj As Object
Set obj = dist.Parent
Visible
Syntax:
object.Visible
Type:
Boolean
Description:
Shows/hides the main application window.
Example:
Dim otm As Object

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 = TRUE
End If
Note: If you use an external OLE Automation controller (e.g. OMICRON Control 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.Quit
Return
type:
None
Description:
This command quits the OMICRON Advanced Distance

application and closes all open windows and the document.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
dist.Quit
Document Object
With 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
Syntax:
Object.Application
Type:
Object (Application)
Description:
Returns the Application Object (Application).
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim app As Application
Set app = dist.Document.Application
Comment
10
Syntax:
object.Comment
Type:
String
Description:
This property allows access to the comment string which can

be shown in the report.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
'Set comment
dist.Document.Comment = "This test is
simulated."
Parent (read only)

Syntax:
object.Parent
Type:
Object
Description:

hierarchy. In this case it is the Application Object
(Application).
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim obj As Object
Set obj = dist.Document.Parent
FaultTypes (read only)

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.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim FaultTypes As Object
Set FaulTypes = dist.Document.FaultTypes
11
Shot
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
TestSettings
12
Syntax:
object.TestSettings
Type:
Object
Description:
This property returns the test settings object.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim obj As Object
Set obj = dist.Document.TestSettings
Methods
RemoveAllAll
Syntax:
object.RemoveAllAll
Type:
None
Description:
This method removes all shots and lines for all fault types
Example:
Dim otm As Object

Dim dist As Object
Set otm =
'Remove all shots and lines
dist.Document.RemoveAllAll
RemoveAllChecks
Syntax:
object.RemoveAllChecks
Type:
None
Description:
This method removes all check lines for all fault types
Example:
Dim otm As Object

Dim dist As Object
Set otm =
'Remove all check lines
dist.Document.RemoveAllChecks
13
RemoveAllSearches
Syntax:
object.RemoveAllSearches
Type:
None
Description:
This method removes all search lines for all fault types
Example:
Dim otm As Object

Dim dist As Object
Set otm =
'Remove all search lines
dist.Document.RemoveAllSearches
RemoveAllShots
14
Syntax:
object.RemoveAllShots
Type:
None
Description:
This method removes all shots for all fault types
Example:
Dim otm As Object

Dim dist As Object
Set otm =
'Remove all shots
dist.Document.RemoveAllShots
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.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
' Set defaults
dist.Document.TestSetDefaults
UpdateAllViews
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. By
calling this method without parameter, all the UI is updated.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
dist.FaultTypes(1).Shots.Add
dist.Document.UpdateAllViews
15
TestSettings Object
Properties
AllowReduction
Syntax:
object.AllowReduction
Type:
Boolean
Description:
Get/Set the allow-reduction-of-Itest flag.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Allow reduction of Itest
dist.Document.TestSettings.AllowReduction =
True
CBSimulationON
16
Syntax:
object.CBSimulationON
Type:
Boolean
Description:
Get/Set the CB-Simulation-ON flag.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
CB simulation ON
dist.Document.TestSettings.CBSimulationON =
True
DCOffset
Syntax:
object.DCOffset
Type:
Boolean
Description:
Get/Set the DC-Offset flag.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Set DC offset
dist.Document.TestSettings.DCOffset = True
ExtendedZonesActive
Syntax:
object.ExtendedZonesActive
Type:
Boolean
Description:
Get/Set the Extended-Zone-Active flag.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Extended zones are active
dist.Document.TestSettings.ExtendedZonesActiv
e = True
17
FaultInceptionAngle
Syntax:
object. FaultInceptionAngle
Type:
Double
Description:
Get/Set the fault inception angle. The unit is degree.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Set the fault inception angle to 30.5
dist.Document.TestSettings.FaultInceptionAngl
e = 30.5
FaultInceptionMode
18
Syntax:
object. FaultInceptionMode
Type:
Long
Description:
Get/Set the fault inception mode.

Possible values are (see Constants object):
FIMFixed
FIMMaximum
FIMRandom
FIMZero
Example:
Dim otm As Object

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
IgnoreNominalChar
Syntax:
object. IgnoreNominalChar
Type:
Boolean
Description:
Get/Set the ignore-nominal-characteristic flag.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Ignore nominal characteristic
dist.Document.TestSettings.IgnoreNominalChar
= True
IVTest
Syntax:
object.IVTest
Type:
Double
Description:
This property specifies the test current or the test voltage

(depending on the test mode).
Example:
Dim otm As Object

Dim dist As Object
Set otm =
dist.Document.TestSettings.IVTest = 5.0
19
KSMag
Syntax:
object.KSMag
Type:
Double
Description:
This property specifies the magnitude of the KS factor.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
dist.Document.TestSettings.KSMag = 1.0
KSAngle
Syntax:
object.KSAngle
Type:
Double
Description:
This property specifies the angle of the KS factor. The unit

is .
Example:
Dim otm As Object

Dim dist As Object
Set otm =
dist.Document.TestSettings.KSAngle = 0.0
MaxFaultTime
20
Syntax:
object.MaxFaultTime
Type:
Double
Description:
This property specifies the max-fault time in second.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
dist.Document.TestSettings.MaxFaultTime = 2.5
PostFaultTime
Syntax:
object.PostFaultTime
Type:
Double
Description:
This property specifies the post-fault time in second.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
dist.Document.TestSettings.PostFaultTime =
0.5
PreFaultTime
Syntax:
object.PreFaultTime
Type:
Double
Description:
This property specifies the pre-fault time in second.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
dist.Document.TestSettings.PreFaultTime = 1.0
21
SearchInterval
Syntax:
object.SearchInterval
Type:
Double
Description:
This property specifies the search interval. The unit is Ohm.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
dist.Document.TestSettings.SearchInterval =
0.2
SearchIntervalAbs
22
Syntax:
object.SearchResolutionAbs
Type:
Double
Description:
This property specifies the absolute search resolution. The

unit is Ohm.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
dist.Document.TestSettings.SearchResolutionAb
s = 0.05
SearchIntervalRel
Syntax:
object.SearchResolutionAbs
Type:
Double
Description:
This property specifies the relative search resolution. The unit

is %.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
dist.Document.TestSettings.SearchResolutionRe
l = 1.0
SwitchOffAtZeroCrossing
Syntax:
object.SwitchOffAtZeroCrossing
Type:
Boolean
Description:
Get/Set the switch off at zero crossing flag.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
CB simulation ON
dist.Document.TestSettings.SwitchOffAtZeroCro
ssing= True
23
TestMode
Syntax:
object.TestMode
Type:
Long
Description:
This property specifies the test mode.

TMConstantCurrent
TMConstantVoltage
TMConstantSourceImp
Example:
Dim otm As Object

Dim dist As Object
Set otm =
dist.Document.TestSettings.TestMode =
dist.Constants.TMConstantCurrent
TimeReference
24
Syntax:
object.TimeReference
Type:
Long
Description:
This property specifies the time reference.

TRFaultInception
TRStarting
Example:
Dim otm As Object

Dim dist As Object
Set otm =
dist.Document.TestSettings.TimeReference =
dist.Constants.TRStarting
ZSMag
Syntax:
object.ZSMag
Type:
Double
Description:
This property specifies the ZS magnitude. The unit is Ohm.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
dist.Document.TestSettings.ZSMag = 2.0
ZSAngle
Syntax:
object.ZSAngle
Type:
Double
Description:
This property specifies the ZS angle. The unit is .
Example:
Dim otm As Object

Dim dist As Object
Set otm =
dist.Document.TestSettings.ZSAngle = 30.0
25
Methods
TestSetDefaults
26
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.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
' Set default test settings
dist.Document.TestSettings.TestSetDefaults
FaultTypes Collection Object

Properties
Syntax:
object.Application
Type:
Description:
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Set app =
dist.Document.FaultTypes.Application
27
Count (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.
Example:
Dim otm As Object

Dim dist As Object
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
Parent (read only)
28
Syntax:
object.Parent
Type:
Object
Description:

hierarchy. In this case it is the Document Object (Document).
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Document.InsertObject(OMAdist.Document)
Dim obj As Object
Set obj = dist.Document.FaultTypes.Parent
Methods
Add
Syntax:
object.Add
Return
type:
Object (State)
Description:
Not supported.
Item (default property)

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 fault
types in the document (between 1 and FaultTypes.Count). If
no index is given, the FaultTypes Collection Object
(FaultTypes) is returned.
Example:
Dim otm As Object

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)
Remove
Syntax:
object.Remove
Return
type:
None
Description:
Not supported.
29
FaultType Object
Properties
FTString (read only)
Syntax:
object.FTString
Type:
String
Description:
This property returns the Fault Type string.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim strFT As string
strFT = dist.Document.FaultType(1).FTString
Shots (read only)
30
Syntax:
object.Shots
Type:
Object (Shots)
Description:
This property returns the Shots Collection Object (Shots) of a

given Fault Type Object (FaultType).
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim shots As Object
Set shots = dist.Document.FaultType(1).Shots
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).
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim searchlines As Object
Set searchlines =
dist.Document.FaultType(1).SearchLines
31
Shots Collection Object

Properties
Syntax:
object.Application
Type:
Description:
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Set app =
dist.Document.FaultTypes(1).Shots.Application
Count (read only)
32
Syntax:
object.Count
Type:
Long
Description:
This property returns the number of shots.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
MsgBox "Number of shots in fault type L1N: " &
dist.Document.FaultTypes(1).Shots.Count
Parent (read only)

Syntax:
object.Parent
Type:
Object
Description:

hierarchy. In this case it is the Fault Type Object (FaultType).
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim obj As Object
Set obj =
dist.Document.FaultTypes(1).Shots.Parent
Methods
Add
Syntax:
object.Add
Return
type:
Object (Shot)
Description:
This method adds a shot to the Shots collection and returns

the created Shot Object (Shot).
AddRelative
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).
33
AddRX
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).
AddZPhi
Syntax:
object.AddZPhi(Z, Phi)
Double Z
Double Phi
Return
type:
Object (Shot)
Description:
This method adds an absolute shot to the Shots collection

and returns the created Shot Object (Shot).
Remove
Syntax:
object.Remove(index)
Long index
Return
type:
none
Description:
This method removes the specified shot from the Shots

collection.
RemoveAll
34
Syntax:
object.RemoveAll
Return
type:
none
Description:
This method removes all the shots from the Shots collection.

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.
Example:
Dim otm As Object

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
35
ItemIndex
36
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).
Example:
Dim otm As Object

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
Shot Object
Properties
Dev (read only)
Syntax:
object.Dev
Type:
Double
Description:
This property returns the time deviation in %.
Example:
Dim otm As Object

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
37
IsFailed (read only)

Syntax:
object.IsFailed
Type:
Boolean
Description:
This property returns True if the shot has failed.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim shots As Object
Set shots =
2).Shots
shots.AddRX(0,1)
otm.Test
If shots(1).IsFailed then MsgBox(Test
failed)
IVTest (read only)
38
Syntax:
object.IVTest
Type:
Double
Description:
This property returns the test current or the test voltage

(depending on the test mode).
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim shots As Object
Set shots =
2).Shots
shots.AddRX(0,1)
Dim IVTest As double
IVTest = shots(1).IVTest
PercentZone
Syntax:
object.PercentZone
Type:
Double
Description:
This property gets/sets the percentage of zone for a relative

shot.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim shots As Object
Set shots =
2).Shots
Dim shot As Object
Set shot = shots.Add
shot.PercentZone = 110 110%
Phi
Syntax:
object.Phi
Type:
Double
Description:
This property specifies the shot angle. The unit is degree.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim shots As Object
Set shots =
2).Shots
Dim shot As Object
shot.Z = 1.0
shot.Phi = 45.0
39
Phi1FaultInc
Syntax:
object.Phi1FaultInc
Type:
Double
Description:
This property returns the fault inception angle on phase one.

The unit is degree.
Example:
R
40
Syntax:
object.R
Type:
Double
Description:
This property specifies the R value of the shot. The unit is

Ohm.
Example:
Dim otm As Object

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
ShotType
Syntax:
object.ShotType
Type:
Long
Description:
This property specifies the shot type (absolute or relative).

Possible values are:
STAbsolute
STRelative
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim shots As Object
Set shots =
2).Shots
Dim shot As Object
shot.ShotType = dist.Constants.STRelative
41
Status (read only)
42
Syntax:
object.Status
Type:
Long
Description:
This property returns the shot status.

SSFailed
SSNotTested
See Constants object for complete list.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim shots As Object
Set shots =
2).Shots
Dim shot As Object
If shot.Status = dist.Constants.SSNotTested
Then
MsgBox(Not Tested)
End If
StatusString (read only)

Syntax:
object.StatusString(format)
Type:
String format
Description:
This property returns the shot status string.

The format parameter is used to format the returned string.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim shots As Object
Set shots =
2).Shots
Dim shot As Object
MsgBox(shot.StatusString(Status: %s))
TAct (read only)

Syntax:
object.TAct
Type:
Double
Description:
This property returns the actual zone time in s.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim shots As Object
Set shots =
2).Shots
shots.AddRX(1,0)
otm.Test
Dim tact As double
tact = shots(1).TAct
43
TMax (read only)
44
Syntax:
object.TMax
Type:
Double
Description:
This property returns the maximum zone time in s according

to the time tolerance.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim shots As Object
Set shots =
2).Shots
shots.AddRX(1,0)
otm.Test
Dim tmax As double
tmax = shots(1).TMax
TMin (read only)

Syntax:
object.TMin
Type:
Double
Description:
This property returns the minimum zone time in s according to

the time tolerance.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim shots As Object
Set shots =
2).Shots
shots.AddRX(1,0)
otm.Test
Dim tmin As double
tmin = shots(1).TMin
X
Syntax:
object.X
Type:
Double
Description:
This property specifies the X value of the shot.
Example:
Dim otm As Object

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
45
Z
Syntax:
object.Z
Type:
Double
Description:
This property specifies the Z value. The unit is degree.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim shots As Object
Set shots =
2).Shots
Dim shot As Object
shot.Z = 1.0
shot.Phi = 45.0
ZeroCrossing
46
Syntax:
object.ZeroCrossing
Type:
Boolean
Description:
This property specifies the zero-crossing flag.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim shots As Object
Set shots =
2).Shots
shots.Add
shots(1).ZeroCrossing = True
ZoneKey
Syntax:
object.ZoneKey
Type:
Long
Description:
This property specifies the zone-key, the zone index used for
a relative shot.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim shots As Object
Set shots =
2).Shots
shots.Add
shots(1).ZoneKey = 1
47
SearchLines Collection Object

Properties
Syntax:
object.Application
Type:
Description:
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Set app =
dist.Document.FaultTypes(1).SearchLines.Appli
cation
Count (read only)
48
Syntax:
object.Count
Type:
Long
Description:
This property returns the number of search lines.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
MsgBox "Number of shots in fault type L1N: " &
dist.Document.FaultTypes(1).SearchLines.Count
Parent (read only)

Syntax:
object.Parent
Type:
Object
Description:

hierarchy. In this case it is the Fault Type Object (FaultType).
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim obj As Object
Set obj =
dist.Document.FaultTypes(1).SearchLines.Paren
t
Methods
Add
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).
49
AddRelRX
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).
AddRelZPhi
50
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).
AddRX
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).
51
AddZPhi
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).
Remove
Syntax:
object.Remove(index)
Long index
Return
type:
none
Description:
This method removes the specified search line from the

SearchLines collection.
RemoveAll
52
Syntax:
object.RemoveAll
Return
type:
none
Description:
This method removes all the search lines from the

SearchLines collection.

Syntax:
object.Item(index)
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.
ItemIndex
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).
53
SearchLine Object
Properties
Absolute
Syntax:
object.Absolute
Type:
Boolean
Description:
This property specifies if the search line is absolute (True).
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Set searchlines =
2).searchlines
searchlines.Add
searchlines(1).Absolute = False
Angle
54
Syntax:
object.Angle
Type:
Double
Description:
This property specifies the search line angle. The unit is

degree
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Set searchlines =
2).searchlines
searchlines.Add
searchlines(1).Angle = 45.0
IsFailed (read only)

Syntax:
object.IsFailed
Type:
Boolean
Description:
This property returns True if the search line test has failed.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Set searchlines =
2).searchlines
searchlines.Add
otm.Test
If searchlines(1).IsFailed then MsgBox(Test
failed)
Length
Syntax:
object.Length
Type:
Double
Description:
This property specifies the search line length. The unit is Ohm
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Set searchlines =
2).searchlines
searchlines.Add
searchlines(1).Length = 1.0
55
PercentZone
Syntax:
object.PercentZone
Type:
Double
Description:
This property specifies the zone percent of a relative search

line. The unit is %
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Set searchlines =
2).searchlines
searchlines.Add
searchlines(1).Percent = 95.0
Phi
56
Syntax:
object.Phi
Type:
Double
Description:
This property specifies the angle of the search line origine.

The unit is degree.
Example:
Dim otm As Object

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
Syntax:
object.R
Type:
Double
Description:
This property specifies the R value of the search line origine.

The unit is Ohm.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Set searchlines =
2).SearchLines
searchline.R = 1.0
57
Status (read only)
58
Syntax:
object.Status
Type:
Long
Description:
This property returns the search line status.

SSFailed
SSNotTested
Example:
Dim otm As Object

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)

Syntax:
object.Reaches
Type:
Object (Reaches)
Description:
This property returns the Reaches Collection Object

(Reaches) of a given Search Line Object (SearchLine).
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Dim reaches As Object
Set reaches =
dist.Document.FaultType(1).SearchLines(1).rea
ches
X
Syntax:
object.X
Type:
Double
Description:
This property specifies the X value of the search line origine.

The unit is Ohm.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Set searchlines =
2).SearchLines
searchline.X = 1.0
59
Z
Syntax:
object.Z
Type:
Double
Description:
This property specifies the Z value of the search line origine.

The unit is Ohm.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Set searchlines =
2).SearchLines
searchline.Z = 1.0
ZoneKey
60
Syntax:
object.ZoneKey
Type:
Long
Description:
This property specifies the zone-key, the zone index of a

relative search line.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Set searchlines =
2).SearchLines
searchline.ZoneKey = 2
Reaches Collection Object

Properties
Syntax:
object.Application
Type:
Description:
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Set searchlines =
2).SearchLines
Set app = searchline.Reaches.Application
61
Count (read only)

Syntax:
object.Count
Type:
Long
Description:
This property returns the number of search lines.
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Set searchlines =
2).SearchLines
MsgBox "Number of reaches: " &
searchline.Reaches.Count
Parent (read only)
62
Syntax:
object.Parent
Type:
Object
Description:

hierarchy. In this case it is the Search Line Object
(SearchLine).
Example:
Dim otm As Object

Dim dist As Object
Set otm =
Set searchlines =
2).SearchLines
Dim obj As Object
Set obj = searchline.Reaches.Parent
Methods
Syntax:
object.Item(index)
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:
Reach Object
Properties
IsStepUp
Syntax:
object.IsStepUp
Type:
Boolean
Description:
This property returns True if step up.
Example:
Dim otm As Object

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
63
RAct (read only)
64
Syntax:
object.RAct
Type:
Double
Description:
This property returns the actual R.
Example:
Dim otm As Object

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.Print
searchlines.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
(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
RDev (read only)

Syntax:
object.RDev
Type:
Double
Description:
This property returns the R deviation in Ohm.
Example:
See RAct example.
RDevPercent (read only)

Syntax:
object.RDevPercent
Type:
Double
Description:
This property returns the R deviation in %.
Example:
See RAct example.
RNom (read only)

Syntax:
object.RNom
Type:
Double
Description:
This property returns the nominal R.
Example:
See RAct example.
65
Status (read only)

Syntax:
object.Status
Type:
Long
Description:
This property returns the reach status.

RSFailed
RSNotTested
Example:
See RAct example.
StatusString (read only)

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.
Example:
See RAct example.
TLower (read only)

Syntax:
object.Tlower
Type:
Double
Description:
This property returns the lower time in s.
Example:
See RAct example.
TMax (read only)
66
Syntax:
object.TMax
Type:
Double
Description:
This property returns the time max in s.
Example:
See RAct example.
TMin (read only)

Syntax:
object.TMin
Type:
Double
Description:
This property returns the time min in s.
Example:
See RAct example.
TUpper (read only)

Syntax:
object.TUpper
Type:
Double
Description:
This property returns the time upper in s.
Example:
See RAct example.
Type (read only)

Syntax:
object.TUpper
Type:
Long
Description:
This property returns the reach type.
Example:
See RAct example.
XAct (read only)

Syntax:
object.XAct
Type:
Double
Description:
This property returns the actual X in Ohm.
Example:
See RAct example.
67
XDev (read only)

Syntax:
object.XDev
Type:
Double
Description:
This property returns the X deviation in Ohm.
Example:
See RAct example.
XDevPercent (read only)

Syntax:
object.XDevPercent
Type:
Double
Description:
This property returns the X deviation in %.
Example:
See RAct example.
XNom (read only)

Syntax:
object.XNom
Type:
Double
Description:
This property returns the nominal X.
Example:
See RAct example.
ZAct (read only)
68
Syntax:
object.ZAct
Type:
Double
Description:
This property returns the actual Z in Ohm.
Example:
See RAct example.
ZDev (read only)

Syntax:
object.ZDev
Type:
Double
Description:
This property returns the Z deviation in Ohm.
Example:
See RAct example.
ZMax (read only)

Syntax:
object.ZMax
Type:
Double
Description:
This property returns the Z max in Ohm
Example:
See RAct example.
ZMin (read only)

Syntax:
object.ZMin
Type:
Double
Description:
This property returns the Z min in Ohm
Example:
See RAct example.
ZNom (read only)

Syntax:
object.ZNom
Type:
Double
Description:
This property returns the nominal Z in Ohm.
Example:
See RAct example.
69
ZoneLabelHigh (read only)

Syntax:
object.ZoneLabelHigh
Type:
String
Description:
This property returns the zone label high.
Example:
See RAct example.
ZoneLabelLow (read only)
70
Syntax:
object.ZoneLabelLow
Type:
String
Description:
This property returns the zone label low.
Example:
See RAct example.
Constants Object
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
71
Reach Type
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
72
Zone Type
ZTExtended
ZTNonTripping
ZTStarting
ZTTripping
73
74

Advanced Distance Automation Interface

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Advanced Distance Automation Interface

Uploaded by

Copyright:

Available Formats

Advanced Distance

OMICRON Test Universe

Manual Version: AdvDistAut.AE.2

OMICRON Test Universe