Beruflich Dokumente
Kultur Dokumente
Automation Interface
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
Test Settings: it defines the test model and the test parameters.
Figure 1:
Object hierarchy of an
Advanced Distance
Document
1
2
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.
object.Constants
Type:
Object (Constants)
Description:
Example:
object.Document
Type:
Object (Document)
Description:
Example:
object.Name
Type:
String
Description:
Example:
Syntax:
object.Parent
Type:
Object
Description:
Example:
Visible
Syntax:
object.Visible
Type:
Boolean
Description:
Example:
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:
Example:
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
Type:
Object (Application)
Description:
Example:
Comment
10
Syntax:
object.Comment
Type:
String
Description:
Example:
object.Parent
Type:
Object
Description:
Example:
object.FaultTypes
Type:
Object (FaultTypes)
Description:
Example:
11
Shot
Syntax:
object.Shot
Type:
Object (Shot)
Description:
Example:
TestSettings
12
Syntax:
object.TestSettings
Type:
Object
Description:
Example:
Methods
RemoveAllAll
Syntax:
object.RemoveAllAll
Type:
None
Description:
This method removes all shots and lines for all fault types
Example:
RemoveAllChecks
Syntax:
object.RemoveAllChecks
Type:
None
Description:
This method removes all check lines for all fault types
Example:
13
RemoveAllSearches
Syntax:
object.RemoveAllSearches
Type:
None
Description:
This method removes all search lines for all fault types
Example:
RemoveAllShots
14
Syntax:
object.RemoveAllShots
Type:
None
Description:
Example:
TestSetDefaults
Syntax:
object.TestSetDefaults
Type:
None
Description:
Example:
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:
15
TestSettings Object
Properties
AllowReduction
Syntax:
object.AllowReduction
Type:
Boolean
Description:
Example:
CBSimulationON
16
Syntax:
object.CBSimulationON
Type:
Boolean
Description:
Example:
DCOffset
Syntax:
object.DCOffset
Type:
Boolean
Description:
Example:
ExtendedZonesActive
Syntax:
object.ExtendedZonesActive
Type:
Boolean
Description:
Example:
17
FaultInceptionAngle
Syntax:
object. FaultInceptionAngle
Type:
Double
Description:
Example:
FaultInceptionMode
18
Syntax:
object. FaultInceptionMode
Type:
Long
Description:
Example:
IgnoreNominalChar
Syntax:
object. IgnoreNominalChar
Type:
Boolean
Description:
Example:
IVTest
Syntax:
object.IVTest
Type:
Double
Description:
Example:
19
KSMag
Syntax:
object.KSMag
Type:
Double
Description:
Example:
KSAngle
Syntax:
object.KSAngle
Type:
Double
Description:
Example:
MaxFaultTime
20
Syntax:
object.MaxFaultTime
Type:
Double
Description:
Example:
PostFaultTime
Syntax:
object.PostFaultTime
Type:
Double
Description:
Example:
PreFaultTime
Syntax:
object.PreFaultTime
Type:
Double
Description:
Example:
21
SearchInterval
Syntax:
object.SearchInterval
Type:
Double
Description:
Example:
SearchIntervalAbs
22
Syntax:
object.SearchResolutionAbs
Type:
Double
Description:
Example:
SearchIntervalRel
Syntax:
object.SearchResolutionAbs
Type:
Double
Description:
Example:
SwitchOffAtZeroCrossing
Syntax:
object.SwitchOffAtZeroCrossing
Type:
Boolean
Description:
Example:
23
TestMode
Syntax:
object.TestMode
Type:
Long
Description:
Example:
TimeReference
24
Syntax:
object.TimeReference
Type:
Long
Description:
Example:
ZSMag
Syntax:
object.ZSMag
Type:
Double
Description:
Example:
ZSAngle
Syntax:
object.ZSAngle
Type:
Double
Description:
Example:
25
Methods
TestSetDefaults
26
Syntax:
object.TestSetDefaults
Type:
None
Description:
Example:
object.Application
Type:
Object (Application)
Description:
Example:
27
object.Count
Type:
Long
Description:
Example:
28
Syntax:
object.Parent
Type:
Object
Description:
Example:
Methods
Add
Syntax:
object.Add
Return
type:
Object (State)
Description:
Not supported.
object.Item(Index)
Return
type:
Object (FaultType/FaultTypes)
Description:
Example:
Remove
Syntax:
object.Remove
Return
type:
None
Description:
Not supported.
29
FaultType Object
Properties
FTString (read only)
Syntax:
object.FTString
Type:
String
Description:
Example:
30
Syntax:
object.Shots
Type:
Object (Shots)
Description:
Example:
object.SearchLines
Type:
Object (SearchLines)
Description:
Example:
31
object.Application
Type:
Object (Application)
Description:
Example:
32
Syntax:
object.Count
Type:
Long
Description:
Example:
object.Parent
Type:
Object
Description:
Example:
Methods
Add
Syntax:
object.Add
Return
type:
Object (Shot)
Description:
AddRelative
Syntax:
Return
type:
Object (Shot)
Description:
33
AddRX
Syntax:
object.AddRX(R, X)
Double R
Double X
Return
type:
Object (Shot)
Description:
AddZPhi
Syntax:
object.AddZPhi(Z, Phi)
Double Z
Double Phi
Return
type:
Object (Shot)
Description:
Remove
Syntax:
object.Remove(index)
Long index
Return
type:
none
Description:
RemoveAll
34
Syntax:
object.RemoveAll
Return
type:
none
Description:
This method removes all the shots from the Shots collection.
object.Item(index)
Long index
Return
type:
Object (Shot)
Description:
Example:
35
ItemIndex
36
Syntax:
object.ItemIndex(Index)
Variant Index Index number of the shot.
Return
type:
Object (Shot)
Description:
Example:
Shot Object
Properties
Dev (read only)
Syntax:
object.Dev
Type:
Double
Description:
Example:
37
object.IsFailed
Type:
Boolean
Description:
Example:
38
Syntax:
object.IVTest
Type:
Double
Description:
Example:
PercentZone
Syntax:
object.PercentZone
Type:
Double
Description:
Example:
Phi
Syntax:
object.Phi
Type:
Double
Description:
Example:
39
Phi1FaultInc
Syntax:
object.Phi1FaultInc
Type:
Double
Description:
Example:
R
40
Syntax:
object.R
Type:
Double
Description:
Example:
ShotType
Syntax:
object.ShotType
Type:
Long
Description:
Example:
41
42
Syntax:
object.Status
Type:
Long
Description:
Example:
object.StatusString(format)
Type:
String format
Description:
Example:
object.TAct
Type:
Double
Description:
Example:
43
44
Syntax:
object.TMax
Type:
Double
Description:
Example:
object.TMin
Type:
Double
Description:
Example:
X
Syntax:
object.X
Type:
Double
Description:
Example:
45
Z
Syntax:
object.Z
Type:
Double
Description:
Example:
ZeroCrossing
46
Syntax:
object.ZeroCrossing
Type:
Boolean
Description:
Example:
ZoneKey
Syntax:
object.ZoneKey
Type:
Long
Description:
This property specifies the zone-key, the zone index used for
a relative shot.
Example:
47
object.Application
Type:
Object (Application)
Description:
Example:
48
Syntax:
object.Count
Type:
Long
Description:
Example:
object.Parent
Type:
Object
Description:
Example:
Methods
Add
Syntax:
object.Add
Return
type:
Object (SearchLine)
Description:
49
AddRelRX
Syntax:
Return
type:
Object (SearchLine)
Description:
AddRelZPhi
50
Syntax:
Return
type:
Object (SearchLine)
Description:
AddRX
Syntax:
Return
type:
Object (SearchLine)
Description:
51
AddZPhi
Syntax:
Return
type:
Object (SearchLine)
Description:
Remove
Syntax:
object.Remove(index)
Long index
Return
type:
none
Description:
RemoveAll
52
Syntax:
object.RemoveAll
Return
type:
none
Description:
object.Item(index)
Long index
Return
type:
Object (SearchLine)
Description:
ItemIndex
Syntax:
object.ItemIndex(Index)
Variant Index Index number of the search line.
Return
type:
Object (SearchLine)
Description:
53
SearchLine Object
Properties
Absolute
Syntax:
object.Absolute
Type:
Boolean
Description:
Example:
Angle
54
Syntax:
object.Angle
Type:
Double
Description:
Example:
object.IsFailed
Type:
Boolean
Description:
This property returns True if the search line test has failed.
Example:
Length
Syntax:
object.Length
Type:
Double
Description:
This property specifies the search line length. The unit is Ohm
Example:
55
PercentZone
Syntax:
object.PercentZone
Type:
Double
Description:
Example:
Phi
56
Syntax:
object.Phi
Type:
Double
Description:
Example:
R
Syntax:
object.R
Type:
Double
Description:
Example:
57
58
Syntax:
object.Status
Type:
Long
Description:
Example:
object.Reaches
Type:
Object (Reaches)
Description:
Example:
X
Syntax:
object.X
Type:
Double
Description:
Example:
59
Z
Syntax:
object.Z
Type:
Double
Description:
Example:
ZoneKey
60
Syntax:
object.ZoneKey
Type:
Long
Description:
Example:
object.Application
Type:
Object (Application)
Description:
Example:
61
object.Count
Type:
Long
Description:
Example:
62
Syntax:
object.Parent
Type:
Object
Description:
Example:
Methods
Item (default property)
Syntax:
object.Item(index)
Long index
Return
type:
Object (Reach)
Description:
Example:
Reach Object
Properties
IsStepUp
Syntax:
object.IsStepUp
Type:
Boolean
Description:
Example:
63
64
Syntax:
object.RAct
Type:
Double
Description:
Example:
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
object.RDev
Type:
Double
Description:
Example:
object.RDevPercent
Type:
Double
Description:
Example:
object.RNom
Type:
Double
Description:
Example:
65
object.Status
Type:
Long
Description:
Example:
object.StatusString(format)
Type:
String format
Description:
Example:
object.Tlower
Type:
Double
Description:
Example:
66
Syntax:
object.TMax
Type:
Double
Description:
Example:
object.TMin
Type:
Double
Description:
Example:
object.TUpper
Type:
Double
Description:
Example:
object.TUpper
Type:
Long
Description:
Example:
object.XAct
Type:
Double
Description:
Example:
67
object.XDev
Type:
Double
Description:
Example:
object.XDevPercent
Type:
Double
Description:
Example:
object.XNom
Type:
Double
Description:
Example:
68
Syntax:
object.ZAct
Type:
Double
Description:
Example:
object.ZDev
Type:
Double
Description:
Example:
object.ZMax
Type:
Double
Description:
Example:
object.ZMin
Type:
Double
Description:
Example:
object.ZNom
Type:
Double
Description:
Example:
69
object.ZoneLabelHigh
Type:
String
Description:
Example:
70
Syntax:
object.ZoneLabelLow
Type:
String
Description:
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
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