Академический Документы
Профессиональный Документы
Культура Документы
Automation Interface
OMICRON Test Universe
2
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
3
OMICRON Test Universe
4
Advanced Distance Automation Interface
1 Test Settings: it defines the test model and the test parameters.
2 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
5
OMICRON Test Universe
3 Shots collection
4 SearchLines collection
5 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.
6
Advanced Distance Automation Interface
Syntax: object.Constants
Description: Returns the object with the constant values (Constants) you
can use with several functions.
Syntax: object.Document
7
OMICRON Test Universe
Syntax: object.Name
Type: String
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).
8
Advanced Distance Automation Interface
Visible
Syntax: object.Visible
Type: Boolean
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.Quit
Return None
type:
9
OMICRON Test Universe
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
Application (read only)
Syntax: Object.Application
Comment
Syntax: object.Comment
Type: String
Description: This property allows access to the comment string which can
be shown in the report.
10
Advanced Distance Automation Interface
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).
Syntax: object.FaultTypes
11
OMICRON Test Universe
Shot
Syntax: 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.
TestSettings
Syntax: object.TestSettings
Type: Object
12
Advanced Distance Automation Interface
Methods
RemoveAllAll
Syntax: object.RemoveAllAll
Type: None
Description: This method removes all shots and lines for all fault types
RemoveAllChecks
Syntax: object.RemoveAllChecks
Type: None
Description: This method removes all check lines for all fault types
13
OMICRON Test Universe
RemoveAllSearches
Syntax: object.RemoveAllSearches
Type: None
Description: This method removes all search lines for all fault types
RemoveAllShots
Syntax: object.RemoveAllShots
Type: None
Description: This method removes all shots for all fault types
14
Advanced Distance Automation Interface
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.
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.
15
OMICRON Test Universe
TestSettings Object
Properties
AllowReduction
Syntax: object.AllowReduction
Type: Boolean
CBSimulationON
Syntax: object.CBSimulationON
Type: Boolean
16
Advanced Distance Automation Interface
DCOffset
Syntax: object.DCOffset
Type: Boolean
ExtendedZonesActive
Syntax: object.ExtendedZonesActive
Type: Boolean
17
OMICRON Test Universe
FaultInceptionAngle
Type: Double
FaultInceptionMode
Type: Long
18
Advanced Distance Automation Interface
IgnoreNominalChar
Type: Boolean
IVTest
Syntax: object.IVTest
Type: Double
Description: This property specifies the test current or the test voltage
(depending on the test mode).
19
OMICRON Test Universe
KSMag
Syntax: object.KSMag
Type: Double
KSAngle
Syntax: object.KSAngle
Type: Double
Description: This property specifies the angle of the KS factor. The unit
is °.
MaxFaultTime
Syntax: object.MaxFaultTime
Type: Double
20
Advanced Distance Automation Interface
PostFaultTime
Syntax: object.PostFaultTime
Type: Double
PreFaultTime
Syntax: object.PreFaultTime
Type: Double
21
OMICRON Test Universe
SearchInterval
Syntax: object.SearchInterval
Type: Double
Description: This property specifies the search interval. The unit is Ohm.
SearchIntervalAbs
Syntax: object.SearchResolutionAbs
Type: Double
22
Advanced Distance Automation Interface
SearchIntervalRel
Syntax: object.SearchResolutionAbs
Type: Double
Description: This property specifies the relative search resolution. The unit
is %.
SwitchOffAtZeroCrossing
Syntax: object.SwitchOffAtZeroCrossing
Type: Boolean
23
OMICRON Test Universe
TestMode
Syntax: object.TestMode
Type: Long
TimeReference
Syntax: object.TimeReference
Type: Long
24
Advanced Distance Automation Interface
ZSMag
Syntax: object.ZSMag
Type: Double
ZSAngle
Syntax: object.ZSAngle
Type: Double
25
OMICRON Test Universe
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.
26
Advanced Distance Automation Interface
Syntax: object.Application
27
OMICRON Test Universe
Syntax: object.Count
Type: Long
Syntax: object.Parent
Type: Object
Description: This property always returns the parent object in the object
hierarchy. In this case it is the Document Object (Document).
28
Advanced Distance Automation Interface
Methods
Add
Syntax: object.Add
Syntax: object.Item(Index)
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.
Remove
Syntax: object.Remove
Return None
type:
29
OMICRON Test Universe
FaultType Object
Properties
FTString (read only)
Syntax: object.FTString
Type: String
Syntax: object.Shots
30
Advanced Distance Automation Interface
Syntax: object.SearchLines
31
OMICRON Test Universe
Syntax: object.Application
Syntax: object.Count
Type: Long
32
Advanced Distance Automation Interface
Syntax: object.Parent
Type: Object
Description: This property always returns the parent object in the object
hierarchy. In this case it is the Fault Type Object (FaultType).
Methods
Add
Syntax: object.Add
Description: This method adds a shot to the Shots collection and returns
the created Shot Object (Shot).
AddRelative
Description: This method adds a relative shot to the Shots collection and
returns the created Shot Object (Shot).
33
OMICRON Test Universe
AddRX
Syntax: object.AddRX(R, X)
Double R
Double X
AddZPhi
Remove
Syntax: object.Remove(index)
Long index
Return none
type:
Description: This method removes the specified shot from the Shots
collection.
RemoveAll
Syntax: object.RemoveAll
Return none
type:
Description: This method removes all the shots from the Shots collection.
34
Advanced Distance Automation Interface
Syntax: object.Item(index)
Long index
Description: This method returns a Shot Object (Shot) from the Shots
Collection. The parameter is the shot index in the collection.
35
OMICRON Test Universe
ItemIndex
Syntax: object.ItemIndex(Index)
Variant Index – Index number of the 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).
36
Advanced Distance Automation Interface
Shot Object
Properties
Dev (read only)
Syntax: object.Dev
Type: Double
37
OMICRON Test Universe
Syntax: object.IsFailed
Type: Boolean
Syntax: object.IVTest
Type: Double
Description: This property returns the test current or the test voltage
(depending on the test mode).
38
Advanced Distance Automation Interface
PercentZone
Syntax: object.PercentZone
Type: Double
Phi
Syntax: object.Phi
Type: Double
Description: This property specifies the shot angle. The unit is degree.
39
OMICRON Test Universe
Phi1FaultInc
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.
40
Advanced Distance Automation Interface
ShotType
Syntax: object.ShotType
Type: Long
41
OMICRON Test Universe
Syntax: object.Status
Type: Long
42
Advanced Distance Automation Interface
Syntax: object.StatusString(format)
Syntax: object.TAct
Type: Double
43
OMICRON Test Universe
Syntax: object.TMax
Type: Double
44
Advanced Distance Automation Interface
Syntax: object.TMin
Type: Double
Syntax: object.X
Type: Double
45
OMICRON Test Universe
Syntax: object.Z
Type: Double
ZeroCrossing
Syntax: object.ZeroCrossing
Type: Boolean
46
Advanced Distance Automation Interface
ZoneKey
Syntax: object.ZoneKey
Type: Long
Description: This property specifies the zone-key, the zone index used for
a relative shot.
47
OMICRON Test Universe
Syntax: object.Application
Syntax: object.Count
Type: Long
48
Advanced Distance Automation Interface
Syntax: object.Parent
Type: Object
Description: This property always returns the parent object in the object
hierarchy. In this case it is the Fault Type Object (FaultType).
Methods
Add
Syntax: object.Add
49
OMICRON Test Universe
AddRelRX
AddRelZPhi
50
Advanced Distance Automation Interface
AddRX
51
OMICRON Test Universe
AddZPhi
Remove
Syntax: object.Remove(index)
Long index
Return none
type:
Description: This method removes the specified search line from the
SearchLines collection.
RemoveAll
Syntax: object.RemoveAll
Return none
type:
Description: This method removes all the search lines from the
SearchLines collection.
52
Advanced Distance Automation Interface
Syntax: object.Item(index)
Long index
ItemIndex
Syntax: object.ItemIndex(Index)
Variant Index – Index number of the search line.
53
OMICRON Test Universe
SearchLine Object
Properties
Absolute
Syntax: object.Absolute
Type: Boolean
Angle
Syntax: object.Angle
Type: Double
Description: This property specifies the search line angle. The unit is
degree
54
Advanced Distance Automation Interface
Syntax: object.IsFailed
Type: Boolean
Description: This property returns True if the search line test has failed.
Length
Syntax: object.Length
Type: Double
Description: This property specifies the search line length. The unit is Ohm
55
OMICRON Test Universe
PercentZone
Syntax: object.PercentZone
Type: Double
Phi
Syntax: object.Phi
Type: Double
Description: This property specifies the angle of the search line origine.
The unit is degree.
56
Advanced Distance Automation Interface
Syntax: object.R
Type: Double
Description: This property specifies the R value of the search line origine.
The unit is Ohm.
57
OMICRON Test Universe
Syntax: object.Status
Type: Long
58
Advanced Distance Automation Interface
Syntax: object.Reaches
Syntax: object.X
Type: Double
Description: This property specifies the X value of the search line origine.
The unit is Ohm.
59
OMICRON Test Universe
Syntax: object.Z
Type: Double
Description: This property specifies the Z value of the search line origine.
The unit is Ohm.
ZoneKey
Syntax: object.ZoneKey
Type: Long
60
Advanced Distance Automation Interface
Syntax: object.Application
61
OMICRON Test Universe
Syntax: object.Count
Type: Long
Syntax: object.Parent
Type: Object
Description: This property always returns the parent object in the object
hierarchy. In this case it is the Search Line Object
(SearchLine).
62
Advanced Distance Automation Interface
Methods
Item (default property)
Syntax: object.Item(index)
Long index
Example:
Reach Object
Properties
IsStepUp
Syntax: object.IsStepUp
Type: Boolean
63
OMICRON Test Universe
Syntax: object.RAct
Type: Double
64
Advanced Distance Automation Interface
Syntax: object.RDev
Type: Double
Syntax: object.RDevPercent
Type: Double
Syntax: object.RNom
Type: Double
65
OMICRON Test Universe
Syntax: object.Status
Type: Long
Syntax: object.StatusString(format)
Syntax: object.Tlower
Type: Double
Syntax: object.TMax
Type: Double
66
Advanced Distance Automation Interface
Syntax: object.TMin
Type: Double
Syntax: object.TUpper
Type: Double
Syntax: object.TUpper
Type: Long
Syntax: object.XAct
Type: Double
67
OMICRON Test Universe
Syntax: object.XDev
Type: Double
Syntax: object.XDevPercent
Type: Double
Syntax: object.XNom
Type: Double
Syntax: object.ZAct
Type: Double
68
Advanced Distance Automation Interface
Syntax: object.ZDev
Type: Double
Syntax: object.ZMax
Type: Double
Syntax: object.ZMin
Type: Double
Syntax: object.ZNom
Type: Double
69
OMICRON Test Universe
Syntax: object.ZoneLabelHigh
Type: String
Syntax: object.ZoneLabelLow
Type: String
70
Advanced Distance Automation Interface
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
Reach Status
RSFailed
RSNotTested
RSOutOfRange
RSOverloadFailed
RSOverloadPassed
RSOverloadTrippedPrefault
RSPassed
RSTrippedPrefault
71
OMICRON Test Universe
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
Advanced Distance Automation Interface
Zone Type
ZTExtended
ZTNonTripping
ZTStarting
ZTTripping
73
OMICRON Test Universe
74