Escolar Documentos
Profissional Documentos
Cultura Documentos
Automation Interface
Contents
Contents
Annunciation Checker Automation Interface . . . . . . . . . . . . . . . . . . . . . . . . . .3
Object Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Application Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Document Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Signals Collection Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Signal Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
nonFCSignals collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
nonFCSignal Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
BinOuts Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
BinOut Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Locations Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Location Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
TestPoints Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
TestPoint Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Constants Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Application Object
Properties
Application (read only)
The application object is the root of the OMICRON Annunciation Checker 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 Annunciation Checker. If you want to
create another Application object with CreateObject, a new instance of the
OMICRON Annunciation Checker 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:
Example:
object.Document
Type:
Object (Document)
Description:
Example:
object.Parent
Type:
Object
Description:
Example:
Visible
Syntax:
object.Visible
Type:
Boolean
Description:
Example:
Note:
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 Signals Collection Object
(Signals) (definition of test signals) and the Measurements Collection Object
(Measurements) (definition of measurement conditions and results).
Properties
Application (read only)
Syntax:
object.Application
Type:
Object (Application)
Description:
Example:
10
Syntax:
object.Parent
Type:
Object
Description:
Example:
object.Signals
Type:
Object (Signals)
Description:
Example:
object.Locations
Type:
Object (Locations)
Description:
Example:
11
Comment
Syntax:
object.Comment
Type:
String
Description:
Example:
Autolock
Syntax:
object.Autolock
Type:
Boolean
Description:
Example:
12
LockTestedTestPoints
Syntax:
object.LockTestedTestPoints()
Type:
None
Description:
This method locks all tested test points. Locked test points
cannot be changed or retested anymore. Clear the test
results to unlock the test points.
Example:
13
14
Syntax:
object.Application
Type:
Object (Application)
Description:
Example:
object.Count
Type:
Long
Description:
Example:
object.Parent
Type:
Object
Description:
Example:
15
16
Syntax:
object.Item(Index)
(optional) Variant Index - Index number of the signal
Return type:
Object (Signal)
Description:
Example:
Methods
Add
Syntax:
object.Add()
Return type:
Object (Signal)
Description:
Example:
Remove
Syntax:
object.Remove(Index)
Long Index - Index of the signal to remove
Return type:
None
Description:
Example:
17
RemoveMulti
18
Syntax:
object.RemoveMulti(IndexBegin, IndexEnd)
Long IndexBegin - Index of the first signal to remove
Long IndexEnd - Index of the last signal to remove
Return type:
None
Description:
Example:
Move
Syntax:
object.Move(IndexFrom, IndexTo)
Long IndexFrom - Index of the signal to move
Long IndexTo - Index of the target where the signal is to be
moved to
Return type:
None
Description:
Example:
19
MoveMulti
20
Syntax:
Return type:
None
Description:
Example:
Duplicate
Syntax:
object.Duplicate(IndexFrom, IndexTo)
Long IndexFrom - Index of the signal to duplicate
Long IndexTo - Index of the target where the signal is to be
duplicated to
Return type:
None
Description:
Example:
21
Duplicate Multi
22
Syntax:
object.DuplicateMulti(beginIndexFrom, endIndexFrom,
IndexTo)
Long beginIndexFrom - Index of the first signal to duplicate
Long endIndexFrom - Index of the end signal to duplicate
Long IndexTo - Index of the target where the multiple signals
are to be duplicated to
Return type:
None
Description:
Example:
Signal Object
Properties
FCState
Syntax:
object.FCState
Type:
Object (FCState)
Description:
Example:
object.BinOuts
Type:
Object (BinOuts)
Description:
Example:
23
object.TestPoints
Type:
Object (TestPoints)
Description:
Example:
24
Syntax:
object.nonFCSignals
Type:
Object (nonFCSignals)
Description:
Example:
Name
Syntax:
object.Name
Type:
String
Description:
Example:
25
Type
26
Syntax:
object.Type
Type:
Long
Description:
This property allows you to read, or set the type of the signal.
0 = Shot
1 = Steady State
2 = No Output
There are constants defined in the Constants object for
convienence:
cSignalTypeShot, cSignalTypeSteadyState,
cSignalTypeNoOutput
Example:
LED
Syntax:
object.LED
Type:
String
Description:
Example:
PreFaultCurr
Syntax:
object.PreFaultCurr
Type:
double
Description:
This property allows you to read or set the pre-fault current (in
amps) of the Signal.
Example:
27
PreFaultTime
Syntax:
object.PreFaultTime
Type:
double
Description:
This property allows you to read or set the pre-fault time (in
seconds) of the Signal.
Example:
MaxFaultTime
Syntax:
object.MaxFaultTime
Type:
double
Description:
This property allows you to read or set the post-fault time (in
seconds) of the Signal.
Example:
28
PostFaultTime
Syntax:
object.PostFaultTime
Type:
double
Description:
This property allows you to read or set the post-fault time (in
seconds) of the Signal.
Example:
Instructions
Syntax:
object.Instructions
Type:
string
Description:
Example:
29
PopupMsg
Syntax:
object.PopupMsg
Type:
string
Description:
Example:
TriggerID
30
Syntax:
object.TriggerID
Type:
long
Description:
Example:
TriggerCondition
Syntax:
object.TriggerCondition
Type:
long
Description:
Example:
BinOutLatching
Syntax:
object.BinOutLatching
Type:
Boolean
Description:
Example:
31
nonFCSignals collection
These are the "extra" analog outputs that are not included in the FCSignals
collection, for example, the fourth voltage output, or the second current triplet of
a CMC256 would be included in this collection.
Properties
Application (read only)
Syntax:
object.Application
Type:
Object (Application)
Description:
Example:
32
Syntax:
object.Count
Type:
Long
Description:
Example:
object.Item(Index)
(optional) Variant Index - Index number of the non FC signal
Return type:
Object (nonFCSignal)
Description:
Example:
33
ItemIndex
34
Syntax:
object.ItemIndex(Index)
Variant Index - Index number of the non FC signal
Return type:
Object (nonFCSignal).
Description:
Example:
nonFCSignal Object
Properties
Amplitude
Syntax:
object.Amplitude
Return type:
Double
Description:
Example:
35
Frequency
Syntax:
object.Frequency
Return type:
Double
Description:
Example:
Phase
36
Syntax:
object.Phase
Return type:
Double
Description:
Example:
object.Application
Type:
Object (Application)
Description:
Example:
object.Count
Type:
Long
Description:
Example:
37
38
Syntax:
object.Item(SignalID)
Long SignalID - Signal ID of the binary output
Return type:
Object (BinOut)
Description:
Example:
ItemIndex
Syntax:
object.ItemIndex(Index)
Variant Index - Index number of the binary output
Return type:
Object (BinOut)
Description:
Example:
39
BinOut Object
Properties
Value (default property)
40
Syntax:
object.Value
Type:
Boolean
Description:
Example:
object.Application
Type:
Object (Application)
Description:
Example:
object.Parent
Type:
Object
Description:
Example:
41
object.Count
Type:
Long
Description:
Example:
42
Syntax:
object.Item(Index)
(optional) Variant Index - Index number of the location
Return type:
Object (Location)
Description:
Example:
Methods
Add
Syntax:
object.Add()
Return type:
Object (Location)
Description:
Example:
Remove
Syntax:
object.Remove(Index)
Long Index - Index of the location to remove
Return type:
None
Description:
Example:
43
RemoveMulti
44
Syntax:
object.RemoveMulti(IndexBegin, IndexEnd)
Long IndexBegin - Index of the first location to remove
Long IndexEnd - Index of the last location to remove
Return type:
None
Description:
Example:
Move
Syntax:
object.Move(IndexFrom, IndexTo)
Long IndexFrom - Index of the location to move
Long IndexTo - Index of the target where the location is to be
moved to
Return type:
None
Description:
Example:
45
Move Multi
46
Syntax:
Return type:
None
Description:
Example:
Duplicate
Syntax:
object.Duplicate(IndexFrom, IndexTo)
Long IndexFrom - Index of the location to duplicate
Long IndexTo - Index of the target where the location is to be
duplicated to
Return type:
None
Description:
Example:
47
Duplicate Multi
48
Syntax:
object.DuplicateMulti(beginIndexFrom, endIndexFrom,
IndexTo)
Long beginIndexFrom - Index of the first location to duplicate
Long endIndexFrom - Index of the end location to duplicate
Long IndexTo - Index of the target where the multiple locations
are to be duplicated to
Return type:
None
Description:
Example:
Location Object
Properties
Name
Syntax:
object.Name
Return type:
String
Description:
Example:
49
object.Application
Return type:
Object (Application)
Description:
Example:
50
Syntax:
object.Count
Return type:
Long
Description:
Example:
object.Item(Index)
(optional) Variant Index - Index number of the testpoint
Return type:
Object (TestPoint)
Description:
Example:
51
TestPoint Object
Properties
Used
Syntax:
object.Used
Return type:
boolean
Description:
Example:
52
Expected
Syntax:
object.Expected
Return type:
String
Description:
Example:
Measured
Syntax:
object.Measured
Return type:
String
Description:
Example:
53
Assessment
54
Syntax:
object.Assessment
Return type:
long
Description:
Example:
Locked
Syntax:
object.Locked
Return type:
Boolean
Description:
Example:
Instructions
Syntax:
object.Instruction
Return type:
String
Description:
Example:
55
PopupMsg
Syntax:
object.PopupMessage
Return type:
String
Description:
Example:
TriggerID
56
Syntax:
object.TriggerID
Return type:
Long
Description:
Example:
TriggerCondition
Syntax:
object.TriggerCondition
Return type:
Long
Description:
Example:
57
InputMode
58
Syntax:
object.InputMode
Return type:
Long
Description:
This property specifies the input mode of the test point. It can
be manual (const.cInputModeManual), input value
(const.cInputModeInputValue) or trigger
(const.cInputModeTrigger).
Example:
DoAutoAssessment
Syntax:
object.DoAutoAssessment
Return type:
Boolean
Description:
Example:
59
ExpectedValue
Syntax:
object.ExpectedValue
Return type:
Double
Description:
Example:
MeasuredValue
60
Syntax:
object.MeasuredValue
Return type:
Double
Description:
Example:
Unit
Syntax:
object.Unit
Return type:
Long
Description:
Example:
cUnitNone - no unit
61
AbsoluteTolerance
Syntax:
object.AbsoluteTolerance
Return type:
Long
Description:
Example:
RelativeTolerance
62
Syntax:
object.RelativeTolerance
Return type:
Long
Description:
Example:
Constants Object
Properties
The following is a list of all signal IDs supported by the OMICRON Annunciation
Checker.
Analog Outputs
sigidUL1N
sigidUL2N
sigidUL3N
sigidUSER_U1_1
sigidUSER_U1_2
sigidUSER_U1_3
sigidUSER_U2_1
sigidUSER_U2_2
sigidUSER_U2_3
sigidUSER_U3_1
sigidUSER_U3_2
sigidUSER_U3_3
sigidUSER_U4_1
sigidUSER_U4_2
sigidUSER_U4_3
sigidIL1
sigidIL2
sigidIL3
sigidI_N
sigidI_0
sigidI_1
sigidI_2
sigidI_PRIM_L1
sigidI_PRIM_L2
63
sigidI_PRIM_L3
sigidI_ZERO_PRIM
sigidI_SEC_L1
sigidI_SEC_L2
sigidI_SEC_L3
sigidI_ZERO_SEC
sigidI_TERT_L1
sigidI_TERT_L2
sigidI_TERT_L3
sigidI_ZERO_TERT
sigidUSER_I1_1
sigidUSER_I1_2
sigidUSER_I1_3
sigidUSER_I2_1
sigidUSER_I2_2
sigidUSER_I2_3
sigidUSER_I3_1
sigidUSER_I3_2
sigidUSER_I3_3
sigidUSER_I4_1
sigidUSER_I4_2
sigidUSER_I4_3
Binary Inputs
sigidTRIP
sigidSTART
64
Binary Outputs
sigidAUX_CONT
sigidAUX_CONT_L1
sigidAUX_CONT_L2
sigidAUX_CONT_L3
sigidUSER_OUTBIN_DEF1
sigidUSER_OUTBIN_DEF2
sigidUSER_OUTBIN_DEF3
sigidUSER_OUTBIN_DEF4
sigidUSER_OUTBIN_DEF5
sigidUSER_OUTBIN_DEF6
sigidUSER_OUTBIN_DEF7
sigidUSER_OUTBIN_DEF8
Miscellanous
cTestPointPassed
cTestPointFailed
cTestPointNotTested
cSignalTypeShot
cSignalTypeSteadyState
cSignalTypeNoOutput
Input Mode
cInputModeManual
cInputModeInputValue
cInputModeTrigger
65
Units
cUnitNone
cUnitSeconds
cUnitVolt
cUnitAmper
cUnitOhm
cUnitPower
cUnitApparentPower
cUnitReactivePower
66