Pulse Ramping

Automation Interface
 OMICRON Test Universe

Article Number VESD5011 - Manual Version: PULSRAMP.AE.1

© OMICRON electronics 2002. All rights reserved.
This Reference Manual is a publication of OMICRON electronics GmbH, Oberes Ried 1, 6833 Klaus,
Austria.
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.

2
 Contents

Contents
Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3
Object Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Application Object 9
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
Document Object 14
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
Ramps Collection Object 18
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21
Ramp Object 22
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
SignalIDs Collection Object 35
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37
State Object 40
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40
AnalogOutputs Collection Object 44
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
AnalogOutput Object 48
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48
BinaryOutputs Collection Object 53
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
BinaryOutput Object 57
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57
Measurements Collection Object 60
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63
Measurement Object 64
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64
Constants Object 77
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77
Analog Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77

3
Product Name

Binary Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79

Binary Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80
Enums 81
TESTSTARTCONDITION . . . . . . . . . . . . . . . . . . . . .81
RAMPQUANTITY . . . . . . . . . . . . . . . . . . . . . . . . . . .81
MEASCRITERION. . . . . . . . . . . . . . . . . . . . . . . . . . .82

4
Contents

5
Product Name

6
 Pulse Ramping Automation Interface

Pulse Ramping Automation Interface

Object Hierarchy
A Pulse Ramping document contains one Ramps Collection, which is a
collection of Ramp objects. In the first version of Pulse Ramping, the Ramps
Collection contains exactly one Ramp object.
A pulse ramp is a succession of fault states in which one quantity (magnitude,
phase angle or frequency) is ramped for one or more signals, each fault state
being immediately followed by one reset state to enable the test object to reset
between 2 faults.
The Ramp object contains all the Ramp Parameters necessary to the definition
of the actual pulse ramp as well as following objects:
• SignalIDs Collection: a collection of signal identifiers for the definition of the
Ramp Output (the signal or group of signals to be ramped)
• Reset State: for the complete definition of the reset state
• Fault State: for the complete definition of the fault state
Each "State" (Fault State and Reset State) contains 2 different collections
(AnalogOutputs and BinaryOutputs) of objects (AnalogOutput object and
BinaryOutput object), for the definition of the parameters relative to all the
analog and binary outputs that are routed.
• Measurements Collection: a collection of Measurement objects; in the first
version of Pulse Ramping, the Measurements Collection contains exactly
one Measurement object.
The Measurement object contains all the parameters necessary to the
definition and the analysis of the measurement performed during the test.

7
 OMICRON Test Universe

Figure 1:
Pulse Ramping Object
Hierarchy

8
 Pulse Ramping Automation Interface

Reference
Application Object
The application object is the root of the OMICRON Pulse Ramping 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 Pulse Ramping Module. If you want
to create another Application object with CreateObject, a new instance of the
OMICRON Pulse Ramping 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.

Properties
Application (read only)

Syntax: object.Application
Type: Object
Description: Returns the Application Object (Application).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim obj As Object
Set obj = pulseRampApp.Application
‘ Free object references at the end of the
procedure
Set obj = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

9
 OMICRON Test Universe

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 pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim constants As Object
Set constants = pulseRampApp.Constants
‘ Free object references at the end of the
procedure
Set constants = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

Document (read only)

Syntax: object.Document
Type: Object (Document)
Description: This property returns a Document Object (Document).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim doc As Object
Set doc = pulseRampApp.Document
‘ Free object references at the end of the
procedure
Set doc = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

10
 Pulse Ramping Automation Interface

Name (read only)

Syntax: object.Name
Type: String
Description: Returns the name of the application.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim Str As String
Set Str = pulseRampApp.Name
‘ Free object references at the end of the
procedure
Set pulseRampApp = Nothing
Set otm = Nothing

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 pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim obj As Object
Set obj = pulseRampApp.Parent
‘ Free object references at the end of the
procedure
Set obj = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

11
 OMICRON Test Universe

Visible

Syntax: object.Visible
Type: Boolean
Description: Shows/hides the main application window.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
'Is the application visible ?
If pulseRampApp.Visible then
MsgBox "Application is visible"
Else'Make the application visible
pulseRampApp.Visible = TRUE
End If
‘ Free object references at the end of the
procedure
Set pulseRampApp = Nothing
Set otm = Nothing

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 Pulse Ramping application) you have to set
the Visible property to True to see the main window of the application.

12
 Pulse Ramping Automation Interface

Methods
Quit

Syntax: object.Quit
Return type: None
Description: This command quits the OMICRON Pulse Ramping application
and closes all open windows and the document.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
pulseRampApp.Quit
‘ Free object references at the end of the
procedure
Set pulseRampApp = Nothing
Set otm = Nothing

13
 OMICRON Test Universe

Document Object
With the Document Object (Document) you can control the document.
From this object fyou can get references to the ramps collection Object (Ramps)
(definition of the ramps).

Properties
Application (read only)

Syntax: object.Application
Type: Object (Application)
Description: Returns the Application Object (Application).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim app As Application
Set app = pulseRampApp.Document.Application
‘ Free object references at the end of the
procedure
Set app = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

14
 Pulse Ramping Automation Interface

Comment

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 pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
'Set comment
pulseRampApp.Document.Comment = "This test is
simulated."
‘ Free object references at the end of the
procedure
Set pulseRampApp = Nothing
Set otm = Nothing

StartTestOn

Syntax: object.StartTestOn
Type: TESTSTARTCONDITION (enum)
Description: This property specifies how the ramp will be started after an order
for starting the test has been given (Immediately, manually, on
binary input activation or on GPS pulse). By default this value is
set to tcsImmediate.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
' Start the test manually
pulseRampApp.Document.StartTestOn = tscManual
‘ Free object references at the end of the
procedure
Set pulseRampApp = Nothing
Set otm = Nothing

15
 OMICRON Test Universe

PrefaultTime

Syntax: object.StartTestOn
Type: Double
Description: This property specifies the prefault time; it can only be read (and
is equal to the reset time) when the chosen option for the Start
Condition is “Immediately” or “Manually”; it can be set when the
ramp should be start.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
' Start the test on binary input
Set pulseRampApp.Document.StartTestOn =
tscOnBinInp
' Set the prefault time to 500 ms
Set pulseRampApp.Document.PrefaultTime = 0.5
‘ Free object references at the end of the
procedure
Set pulseRampApp = Nothing
Set otm = Nothing

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 pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim obj As Object
Set obj = pulseRampApp.Document.Parent
‘ Free object references at the end of the
procedure
Set obj = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

16
 Pulse Ramping Automation Interface

Ramps (read only)

Syntax: object.Ramps
Type: Object (OMPlsRmp.Ramps)
Description: This property returns the Ramps Collection Object (Ramps) of
the document. With this object you can manipulate all the ramps
in your document.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim ramps As Object
Set ramps = pulseRampApp.Document.Ramps
‘ Free object references at the end of the
procedure
Set ramps = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

17
 OMICRON Test Universe

Ramps Collection Object

Properties
Application (read only)

Syntax: object.Application
Type: Object (OMPlsRmp.Application)
Description: Returns the Application Object (Application).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim app As Application
Set app =
pulseRampApp.Document.Ramps.Application
‘ Free object references at the end of the
procedure
Set app = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

18
 Pulse Ramping Automation Interface

Count (read only)

Syntax: object.Count
Type: Long
Description: This property returns the number of ramps in the document.
Note: By default and in the first version of OMICRON Pulse
Ramping, only one ramp is present in the collection.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
'Count twice
Dim s As Object
Dim ss As Object
i = 0
Set ss = pulseRampApp.Document.Ramps
For Each s in ss
i = i+1
Next
If i = ss.Count then
MsgBox "We've counted twice"
End If
‘ Free object references at the end of the
procedure
Set ss = Nothing
Set s = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

Parent (read only)

19
 OMICRON Test Universe

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
(OMPlsRmp.Document).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim obj As Object
Set obj = pulseRampApp.Document.Ramps.Parent
‘ Free object references at the end of the
procedure
Set obj = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

20
 Pulse Ramping Automation Interface

Methods
Item (default property)

Syntax: object.Item(Index)
Return type: Object (OMPlsRmp.Ramp)
Description: This property provides a Ramp Object (OMPlsRmp.Ramp) from
the Ramps Collection. The index is the number of the ramp in the
document (between 1 and Ramps.Count).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim ramps As Object
set ramps = pulseRampApp.Document.Ramps
Dim plsRamp As OMPlsRmp.Ramp
Set plsRamp = ramps.Item(1)
‘ Free object references at the end of the
procedure
Set plsRamp = Nothing
Set ramps = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

21
 OMICRON Test Universe

Ramp Object
Properties
Application (read only)

Syntax: object.Application
Type: Object (Application)
Description: Returns the Application Object (Application).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim app As Application
Set app =
pulseRampApp.Document.Ramps(1).Application
MsgBox(app.Name)
‘ Free object references at the end of the
procedure
Set app = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

22
 Pulse Ramping Automation Interface

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 Ramps collection
(OMPlsRmp.Ramps).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim obj As OMPlsRmp.Ramps
Set obj = pulseRampApp.Document.Ramps(1).Parent
‘ Free object references at the end of the
procedure
Set obj = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

Quantity

Syntax: object.Quantity
Type: RAMPQUANTITY (enum)
Description: This property specifies which quantity will be rampe (magnitude,
phase angle or frequency). By default this value is set to
qMagnitude.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
' Let’s ramp the phase angle
pulseRampApp.Document.Ramps(1).Quantity =
qAngle
‘ Free object references at the end of the
procedure
Set pulseRampApp = Nothing
Set otm = Nothing

23
 OMICRON Test Universe

SignalIDs (read only)

Syntax: object.SignalIDs
Type: Object (OMPlsRmp. SignalIDs)
Description: This property returns the SignalIDs Collection Object (SignalIDs)
of the Ramp object. With this object, you can set the ramp output,
i.e. select the signals that you want to apply the ramp to.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim sigIds As Object
Set sigIds =
pulseRampApp.Document.Ramps(1).SignalIDs
‘ Free object references at the end of the
procedure
Set sigIds = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

From

Syntax: object.From
Type: Double
Description: This property specifies the absolute secondary value (of the
ramped quantity) at which the ramp starts.
Example: Dim pulseRampApp As Object
Dim plsRamp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Set plsRamp = pulseRampApp.Document.Ramps(1)
‘Start the ramp at 1.0 A secondary
plsRamp.From = 1.0
‘ Free object references at the end of the
procedure
Set plsRamp = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

24
 Pulse Ramping Automation Interface

To

Syntax: object.To
Type: Double
Description: This property specifies the absolute secondary value (of the
ramped quantity) at which the ramp would end if not stopped
before its end.
Example: Dim pulseRampApp As Object
Dim plsRamp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Set plsRamp = pulseRampApp.Document.Ramps(1)
‘Start the ramp at 6.0 A secondary
plsRamp.To = 6.0
‘ Free object references at the end of the
procedure
Set plsRamp = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

25
 OMICRON Test Universe

Delta

Syntax: object.Delta
Type: Double
Description: This property specifies the absolute secondary value by which
the ramped quantity is increasing or decreasing between 2
consecutive fault states.
Example: Dim pulseRampApp As Object
Dim plsRamp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Set plsRamp = pulseRampApp.Document.Ramps(1)
‘Let’s make a ramp with a 100.0 mA secondary
current step
plsRamp.Delta = 0.1
‘ Free object references at the end of the
procedure
Set plsRamp = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

26
 Pulse Ramping Automation Interface

Reset

Syntax: object.Reset
Type: Double
Description: This property specifies the absolute secondary value the ramp
quantity is reset to at every reset state.
Example: Dim pulseRampApp As Object
Dim plsRamp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Set plsRamp = pulseRampApp.Document.Ramps(1)
‘Let’s reset the current magnitude at 500 mA
between 2 faults
plsRamp.Reset = 0.5
‘ Free object references at the end of the
procedure
Set plsRamp = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

ResetTime

Syntax: object.ResetTime
Type: Double
Description: This property specifies the duration in seconds of each reset
state.
Example: Dim pulseRampApp As Object
Dim plsRamp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Set plsRamp = pulseRampApp.Document.Ramps(1)
‘Each reset state will last 800 milliseconds
plsRamp.ResetTime = 0.8
‘ Free object references at the end of the
procedure
Set plsRamp = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

27
 OMICRON Test Universe

FaultTime

Syntax: object.FaultTime
Type: Double
Description: This property specifies the duration in seconds of each fault
state.
Example: 'Let’s make a slow ramp
Dim pulseRampApp As Object
Dim plsRamp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Set plsRamp = pulseRampApp.Document.Ramps(1)
‘Each fault state will last 10 seconds
plsRamp.FaultTime = 10.0
‘ Free object references at the end of the
procedure
Set plsRamp = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

28
 Pulse Ramping Automation Interface

StepCount (read only)

Syntax: object. StepCount

Type: Long
Description: This property returns the number of ramp steps. The value is
calculated from the difference of From and To value of a ramp
state devided by the Delta value plus 1.
Example: Dim otm As Object
Dim pulseRampApp As Object
Dim plsRamp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Set plsRamp = pulseRampApp.Document.Ramps(1)
MsgBox "The ramp has " & plsRamp.StepCount & "
steps"
‘ Free object references at the end of the
procedure
Set plsRamp = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

29
 OMICRON Test Universe

MaxDuration (read only)

Syntax: object.MaxDuration
Type: Double
Description: This property returns the estimated duration of a complete (non
interrupted) ramp in seconds. It is the product of
(FaultTime+ResetTime) and RampSteps plus PrefaultTime.
Example: Dim otm As Object
Dim pulseRampApp As Object
Dim plsRamp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Set plsRamp = pulseRampApp.Document.Ramps(1)
MsgBox "The maximal duration of the ramp is " &
plsRamp.MaxDuration & "s"
‘ Free object references at the end of the
procedure
Set plsRamp = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

30
 Pulse Ramping Automation Interface

StopAfterMeasurement

Syntax: object.StopAfterMeasurement
Type: Boolean
Description: This property specifies wether a ramp state should stop after the
measurement occurred.
By default, this property is set to True.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim plsRamp As Object
Set plsRamp = pulseRampApp.Document.Ramps(1)
plsRamp.StopAfterMeasurement = False
‘ Free object references at the end of the
procedure
Set plsRamp = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

31
 OMICRON Test Universe

DelayTime

Syntax: object.DelayTime
Type: Double
Description: This property specifies the delay time in seconds, during which
the outputs are maintained at their last value after the
measurement has occurred.
By default, this time is 0.0.
Note: DelayTime is only in use during a test if
StopAfterMeasurement is set to True.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim plsRamp As Object
Set plsRamp = pulseRampApp.Document.Ramps(1)
‘End the ramp on measurement
PlsRamp. StopAfterMeasurement = true
plsRamp.DelayTime = 2.0
‘ Free object references at the end of the
procedure
Set plsRamp = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

32
 Pulse Ramping Automation Interface

ResetState (read only)

Syntax: object.ResetState
Type: Object (OMPlsRmp.State)
Description: This property returns the reset state State Object (ResetState) of
the Ramp object. With this object you can manipulate the
parameters relative to the reset states of a ramp.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim resetState As Object
Set resetState =
pulseRampApp.Document.Ramps(1).ResetState
‘ Free object references at the end of the
procedure
Set resetState = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

FaultState (read only)

Syntax: object.FaultState
Type: Object (OMPlsRmp.State)
Description: This property returns the fault state State Object (ResetState) of
the Ramp object. With this object you can manipulate the
parameters relative to the fault states of a ramp.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim resetState As Object
Set FaultState =
pulseRampApp.Document.Ramps(1).FaultState
‘ Free object references at the end of the
procedure
Set resetState = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

33
 OMICRON Test Universe

Measurements (read only)

Syntax: object.Measurements
Type: Object (OMPlsRmp. Measurements)
Description: This property returns the Measurements Collection Object
(Measurements) of the Ramp object. With this object you can
manipulate all the measurements in your document.
Note: in the first version of Pulse Ramping, only one
measurement will be available.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim measConds As Object
Set measConds =
pulseRampApp.Document.Ramps(1).Measurements
‘ Free object references at the end of the
procedure
Set measConds = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

34
 Pulse Ramping Automation Interface

SignalIDs Collection Object

Properties
Application (read only)

Syntax: object.Application
Type: Object (OMPlsRmp.Application)
Description: Returns the Application Object (Application).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim app As Application
Set app =
pulseRampApp.Document.Ramps(1).SignalIDs.Applic
ation
‘ Free object references at the end of the
procedure
Set app = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

35
 OMICRON Test Universe

Count (read only)

Syntax: object.Count
Type: Long
Description: This property returns the number of signals used as ramp output.
Note: By default, only one signal is present in the collection.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
If
pulseRampApp.Document.Ramps(1).SignalIDs.Count
= 3 then
MsgBox "The ramp output is a triple"
End If
‘ Free object references at the end of the
procedure
Set pulseRampApp = Nothing
Set otm = Nothing

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 Ramp Object (OMPlsRmp.Ramp).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim obj As Object
Set obj =
pulseRampApp.Document.Ramps(1).SignalIDs.Parent
‘ Free object references at the end of the
procedure
Set obj = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

36
 Pulse Ramping Automation Interface

Methods
Item (default property)

Syntax: object.Item(Index)
Return type: Long (Signal ID of the analog output)
Description: This property provides a signal identifier from the SignalIDs
Collection. The index (Index As Long) is the number of the signal
in the ramp output (between 1 and SignalIDs.Count).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim sigIds As Object
set sigIds =
pulseRampApp.Document.Ramps(1).SignalIDs
Dim sigId1 As Long
If sigIds.Count > 0 Then
sigId1 = sigIds.Item(1)
End If
‘ Free object references at the end of the
procedure
Set sigIds = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

37
 OMICRON Test Universe

Add

Syntax: object.Add(SignalID)
Return type: Long (index)
Description: This method adds a signal to the other signals building the ramp
output. The index (Long) of the signal identifier (Long) in the
SignalIDs collection is returned. If there is already a second ramp
quantity the method call is ignored but the Quantity Object of the
second ramp quantity is returned.
Note: the signal is added only if it is possible, that is:
– If it is not already in the SignalIDs collection and it
belongs to the same triple as the signals already
contained in the collection
– or if it is not already in the SignalIDs collection, the
3 signals of a triple are already selected as ramp
output and it belongs to another triple; thus the “All
outputs” selection will be applied
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
'Add ramp quantity
Dim sigIds As Object
Set sigIds =
pulseRampApp.Document.Ramps(1).SignalIDs
sigIds.Add(pulseRampApp.Constants.sigidIL2)
‘ Free object references at the end of the
procedure
Set sigIds = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

38
 Pulse Ramping Automation Interface

RemoveAll

Syntax: object.RemoveAll
Return type: None
Description: This method removes all the signals from the ramp output, i.e.
from the SignalIDs collection.
Note: after using RemoveAll, there’s no signal selected any
more and no test is possible; the user has to add at
least one new signal to the collection so that a test gets
possible again.
Example: ‘Change the ramp output to IL2;L3
Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
'Add measurement condition
Dim sigIds As Object
Set sigIds =
pulseRampApp.Document.Ramps(1).SignalIDs
sigIds.RemoveAll ‘First remove everything
sigIds.Remove
sigIds.Add(pulseRampApp.Constants.sigidIL2)
‘add IL2
sigIds.Remove
sigIds.Add(pulseRampApp.Constants.sigidIL3)
‘add IL3
‘ Free object references at the end of the
procedure
Set sigIds = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

39
 OMICRON Test Universe

State Object
Properties
Application (read only)

Syntax: object.Application
Type: Object (Application)
Description: Returns the Application Object (Application).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim app As Application
Set app =
pulseRampApp.Document.Ramps(1).ResetState.Appli
cation
MsgBox(app.Name)
‘ Free object references at the end of the
procedure
Set app = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

40
 Pulse Ramping Automation Interface

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 Ramp Object (OMPlsRmp.Ramp).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim obj As Object
Set obj =
pulseRampApp.Document.Ramps(1).ResetState
‘Set the To value of the ramp to 10.0
obj.Parent.To = 10.0
‘ Free object references at the end of the
procedure
Set obj = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

41
 OMICRON Test Universe

AnalogOutputs (read only)

Syntax: object.AnalogOutputs
Type: Object (OMPlsRmp.AnalogOutputs)
Description: This property returns the Analog Outputs Collection Object
(AnalogOutputs) of a given State Object (FaultState or
ResetState). With this object you can manipulate all the analog
outputs settings of the corresponding state of the considered
pulse ramp.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim resetAnaouts As Object
Dim faultAnaOuts As Object
Set resetAnaouts =
pulseRampApp.Document.Ramps(1).ResetState.Analo
gOutputs
Set faultAnaOuts =
pulseRampApp.Document.Ramps(1).FaultState.Analo
gOutputs
‘ Free object references at the end of the
procedure
Set faultAnaOuts = Nothing
Set resetAnaouts = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

42
 Pulse Ramping Automation Interface

BinaryOutputs (read only)

Syntax: object.BinaryOutputs
Type: Object (BinaryOutputs)
Description: This property returns the Binary Outputs Collection Object
(BinaryOutputs) of a given State Object (FaultState or
ResetState). With this object you can manipulate the binary
outputs settings of the corresponding state of the considered
pulse ramp.
Example: Dim otm As Object
Dim pulseRampApp As Object
Dim binouts As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim resetBinouts As Object
Dim faultBinOuts As Object
Set resetBinouts =
pulseRampApp.Document.Ramps(1).ResetState.Binar
yOutputs
Set faultBinOuts =
pulseRampApp.Document.Ramps(1).FaultState.Binar
yOutputs
‘ Free object references at the end of the
procedure
Set faultBinOuts = Nothing
Set resetBinouts = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

43
 OMICRON Test Universe

AnalogOutputs Collection Object

Properties
Application (read only)

Syntax: object.Application
Type: Object (Application)
Description: Returns the Application Object (Application).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim app As Application
Set app =
pulseRampApp.Document.Ramps(1).ResetState.Analo
gOutputs.Application
‘ Free object references at the end of the
procedure
Set app = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

44
 Pulse Ramping Automation Interface

Count (read only)

Syntax: object.Count
Type: Long
Description: This property returns the number of analog outputs in the state.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
MsgBox "Number of analog outputs in reset
state: " &
pulseRampApp.Document.Ramps(1).ResetState.Analo
gOutputs.Count
‘ Free object references at the end of the
procedure
Set pulseRampApp = Nothing
Set otm = Nothing

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 corresponding State Object
(ResetState or FaultState).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim obj As Object
Set obj =
pulseRampApp.Document.Ramps(1).ResetState.Analo
gOutputs.Parent
‘ Free object references at the end of the
procedure
Set obj = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

45
 OMICRON Test Universe

Methods
Item (default property)

Syntax: object.Item(SignalID)
Long SignalID – Signal ID of the analog output
Return type: Object (AnalogOutput)
Description: This property provides an AnalogOutput Object (AnalogOutput)
from the AnalogOutputs Collection. The parameter is the signal
ID of the analog output in the collection. Signal IDs are constants
from the Constants object of the Application object.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
'Set amplitude of I L1 to 2A in reset state
Dim resetState As Object
Set resetState =
pulseRampApp.Document.Ramps(1).ResetState
resetState.AnalogOutputs(pulseRampApp.Constants
.sigidIL1).Amplitude = 2.0
‘ Free object references at the end of the
procedure
Set resetState = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

46
 Pulse Ramping Automation Interface

ItemIndex

Syntax: object.ItemIndex(Index)
Variant Index – Index number of the analog output
Return type: Object (AnalogOutput)
Description: This property provides an AnalogOutput Object (AnalogOutput)
from the AnalogOutputs Collection. The index is the number of
the analog output in the collection (between 1 and
AnalogOutputs.Count).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
'Set amplitude of first three analog outputs to
0 in reset state
Dim state As Object
Set state =
pulseRampApp.Document.Ramps(1).ResetState
For i = 1 To 3
state.AnalogOutputs.ItemIndex(i).Amplitude =
0.0
Next I
‘ Free object references at the end of the
procedure
Set state = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

47
 OMICRON Test Universe

AnalogOutput Object
Properties
Application (read only)

Syntax: object.Application
Type: Object (Application)
Description: Returns the Application Object (Application).
Example: Dim otm As Object
Dim plsRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set plsRampApp = otm.Specific
Dim app As Application
Set app =
plsRampApp.Document.Ramps(1).ResetState.AnalogO
utputs(1).Application
‘ Free object references at the end of the
procedure
Set app = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

48
 Pulse Ramping Automation Interface

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 corresponding AnalogOutputs
Collection Object.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim obj As Object
Set obj =
pulseRampApp.Document.Ramps(1).ResetState.Analo
gOutputs(1).Parent
‘ Free object references at the end of the
procedure
Set obj = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

49
 OMICRON Test Universe

Amplitude

Syntax: object.Amplitude
Type: Double
Description: This property specifies the magnitude of the analog output.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
'Set amplitude of I L1 to 2A in reset state
Dim state As Object
Set state =
pulseRampApp.Document.Ramps(1).ResetState
state.AnalogOutputs(pulseRampApp.Constants.sigi
dIL1).Amplitude = 2.0
‘ Free object references at the end of the
procedure
Set state = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

50
 Pulse Ramping Automation Interface

Frequency

Syntax: object.Frequency
Type: Double
Description: This property specifies the frequency of the analog output.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
'Set frequency of I L1 to 60Hz in reset state
Dim state As Object
Set state =
pulseRampApp.Document.Ramps(1).ResetState
state.AnalogOutputs(pulseRampApp.Constants.sigi
dIL1).Frequency = 60.0
‘ Free object references at the end of the
procedure
Set state = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

51
 OMICRON Test Universe

Phase

Syntax: object.Phase
Type: Double
Description: This property specifies the phase of the analog output.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
'Set phase of I L1 to 37.4° in reset state
Dim state As Object
Set state =
pulseRampApp.Document.Ramps(1).ResetState
state.AnalogOutputs(pulseRampApp.Constants.sigi
dIL1).Phase = 37.4
‘ Free object references at the end of the
procedure
Set state = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

52
 Pulse Ramping Automation Interface

BinaryOutputs Collection Object

Properties
Application (read only)

Syntax: object.Application
Type: Object (Application)
Description: Returns the Application Object (Application).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim app As Application
Set app =
pulseRampApp.Document.Ramps(1).ResetState.Binar
yOutputs.Application
‘ Free object references at the end of the
procedure
Set app = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

53
 OMICRON Test Universe

Count (read only)

Syntax: object.Count
Type: Long
Description: This property returns the number of binary outputs in the state.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
MsgBox "Number of binary outputs in state 1: " &
pulseRampApp.Document.Ramps(1).ResetState.Binar
yOutputs.Count
‘ Free object references at the end of the
procedure
Set pulseRampApp = Nothing
Set otm = Nothing

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 corresponding State Collection
Object (ResetState or FaultState).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim obj As Object
Set obj =
pulseRampApp.Document.Ramps(1).ResetState.Binar
yOutputs.Parent
‘ Free object references at the end of the
procedure
Set obj = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

54
 Pulse Ramping Automation Interface

Methods
Item (default property)

Syntax: object.Item(SignalID)
Long SignalID – Signal ID of the binary output
Return type: Object (BinaryOutput)
Description: This property provides a BinaryOutput Object (BinaryOutput)
from the BinaryOutputs Collection. The parameter is the signal ID
of the binary output in the collection. Signal IDs are constants
from the Constants object.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
'Set binary output for circuit breaker in fault
state
Dim state As Object
Set state =
pulseRampApp.Document.Ramps(1).FaultState
state.BinaryOutputs(pulseRampApp.Constants.sigi
dAUX_CONT).Value = 1
‘ Free object references at the end of the
procedure
Set state = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

55
 OMICRON Test Universe

ItemIndex

Syntax: object.ItemIndex(Index)
Variant Index – Index number of the binary output
Return type: Object (BinaryOutput)
Description: This property provides a BinaryOutput Object (BinaryOutput)
from the BinaryOutputs Collection. The index is the number of the
binary output in the collection (between 1 and
BinaryOutputs.Count).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
'Set all binary outputs in fault state
Dim state As Object
Set state =
pulseRampApp.Document.Ramps(1).FaultState
For i = 1 To state.BinaryOutputs.Count
state.BinaryOutputs.ItemIndex(i).Value = True
Next I
‘ Free object references at the end of the
procedure
Set state = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

56
 Pulse Ramping Automation Interface

BinaryOutput Object
Properties
Application (read only)

Syntax: object.Application
Type: Object (Application)
Description: Returns the Application Object (Application).
Example: Dim otm As Object
Dim plsRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set plsRampApp = otm.Specific
Dim app As Application
Set app =
plsRampApp.Document.Ramps(1).ResetState.BinaryO
utputs(1).Application
‘ Free object references at the end of the
procedure
Set app = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

57
 OMICRON Test Universe

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 corresponding BinaryOutputs
Collection Object.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim obj As Object
Set obj =
pulseRampApp.Document.Ramps(1).ResetState.Binar
yOutputs(1).Parent
‘ Free object references at the end of the
procedure
Set obj = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

58
 Pulse Ramping Automation Interface

Value (default property)

Syntax: object.Value
Type: Boolean
Description: This property specifies wether the binary output is set (active) or
not (inactive).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
'Set binary output for circuit breaker in fault
state
Dim state As Object
Set state =
pulseRampApp.Document.Ramps(1).FaultState
state.BinaryOutputs(pulseRampApp.Constants.sigi
dAUX_CONT).Value = True
‘ Free object references at the end of the
procedure
Set state = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

59
 OMICRON Test Universe

Measurements Collection Object

Properties
Application (read only)

Syntax: object.Application
Type: Object (OMPlsRmp.Application)
Description: Returns the Application Object (Application).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim app As Application
Set app =
pulseRampApp.Document.Ramps(1).Measurements.App
lication
‘ Free object references at the end of the
procedure
Set app = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

60
 Pulse Ramping Automation Interface

Count (read only)

Syntax: object.Count
Type: Long
Description: This property returns the number of measurements in the
document.
Note: By default and in the first version of OMICRON Pulse
Ramping, only one measurement is present in the
collection.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
If
pulseRampApp.Document.Ramps(1).Measurements.Cou
nt > 2 then
MsgBox "Jackpot !"
End If
‘ Free object references at the end of the
procedure
Set pulseRampApp = Nothing
Set otm = Nothing

Parent (read only)

61
 OMICRON Test Universe

Syntax: object.Parent
Type: Object
Description: This property always returns the parent object in the object
hierarchy. In this case it is the Ramp Object (OMPlsRmp.Ramp).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim obj As Object
Set obj =
pulseRampApp.Document.Ramps(1).Measurements.Par
ent
‘ Free object references at the end of the
procedure
Set obj = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

62
 Pulse Ramping Automation Interface

Methods
Item (default property)

Syntax: object.Item(Index)
Return type: Object (OMPlsRmp.Measurement)
Description: This property provides a Measurement Object (OMPlsRmp.
Measurement) from the Measurements Collection. The
index is the number of the measurement in the
document (between 1 and Measurements.Count).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim measurements As Object
set measurements =
pulseRampApp.Document.Ramps(1).Measurements
Dim meas As OMPlsRmp.Measurement
Set meas = measurements.Item(1)
‘ Free object references at the end of the
procedure
Set measurements = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

63
 OMICRON Test Universe

Measurement Object
Properties
Application (read only)

Syntax: object.Application
Type: Object (OMPlsRmp.Application)
Description: Returns the Application Object (Application).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim app As Application
Set app =
pulseRampApp.Document.Ramps(1).Measurements(1).
Application
‘ Free object references at the end of the
procedure
Set app = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

64
 Pulse Ramping Automation Interface

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 Measurements Collection Object
(OMPlsRmp.Measurements).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim obj As Object
Set obj =
pulseRampApp.Document.Ramps(1).Measurements(1).
Parent
‘ Free object references at the end of the
procedure
Set obj = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

Name (read only)

Syntax: object.Name
Type: String
Description: Returns the name of the measurement (as seen in the report in
the “Threshold” column).
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim Str As String
Set Str =
pulseRampApp.Document.Ramps(1).Measurements(1).
Name
‘ Free object references at the end of the
procedure
Set pulseRampApp = Nothing
Set otm = Nothing

65
 OMICRON Test Universe

MeasureOn

Syntax: object.MeasureOn
Type: MEASCRITERION (enum)
Description: This property specifies how the measurement will be performed
(on activation or de-activation of the TRIP binary input or through
a manual action). By default this value is set to
moBinInpComeSlope.
Note: the choice of the measurement with binary input is only
possible if the TRIP binary input is routed; if not the
case, the manual action will be the default and only
possible measurement criterion.
Example: Dim otm As Object
Dim app As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set app = otm.Specific
' Measure on de-activation of the binary input
app.Document.Ramps(1).Measurements(1).MeasureOn
= moBinInpGoSlope
‘ Free object references at the end of the
procedure
Set app = Nothing
Set otm = Nothing

66
 Pulse Ramping Automation Interface

Nom

Syntax: object.Nom
Type: Double
Description: This property specifies the nominal (expected) value (absolute
and, if relevant, secondary) for the measurement.
Example: Dim otm As Object
Dim pulseRampApp As Object
Dim meas As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Set meas =
pulseRampApp.Document.Ramps(1).Measurements(1)
meas.Nom = 10.0
‘ Free object references at the end of the
procedure
Set meas = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

67
 OMICRON Test Universe

DevNeg

Syntax: object.DevNeg
Type: Double
Description: This property specifies the value (absolute and, if relevant,
secondary) for the negative deviation tolerance for a
measurement.
Example: Dim otm As Object
Dim pulseRampApp As Object
Dim meas As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Set meas =
pulseRampApp.Document.Ramps(1).Measurements(1)
meas.DevNeg = 0.05
‘ Free object references at the end of the
procedure
Set meas = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

68
 Pulse Ramping Automation Interface

DevPos

Syntax: object.DevPos
Type: Double
Description: This property specifies the value (absolute and, if relevant,
secondary) for the positive deviation tolerance for a
measurement.
Example: Dim otm As Object
Dim pulseRampApp As Object
Dim meas As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Set meas =
pulseRampApp.Document.Ramps(1).Measurements(1)
meas.DevPos = 0.06
‘ Free object references at the end of the
procedure
Set meas = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

69
 OMICRON Test Universe

ManualInstruction

Syntax: object.ManualInstruction
Type: String
Description: This property specifies the text that is displayed in the dialog box
when the ramp sequence is waiting for the user to signify
manually (through “key press”) that the measurement should be
done.
The usage of this property only makes sense when MeasureOn
is set to moManualAction.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
Dim meas As Object
Set meas =
pulseRampApp.Document.Ramps(1).Measurements(1)
meas.MeasureOn = moManualAction
meas.ManualTitle = “Manual measurement”
meas.ManualInstruction = “As soon as the LED
gets green, press OK”
‘ Free object references at the end of the
procedure
Set meas = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

ManualTitle

Syntax: object.ManualTitle
Type: String
Description: This property specifies the title that is displayed in the dialog box
when the ramp sequence is waiting for the user to signify
manually (through “key press”) that the measurement should be
done.
The usage of this property only makes sense when
TriggerManual is set to True.
Example: see Manual Instruction

70
 Pulse Ramping Automation Interface

UseRelativeTolerance

Syntax: object.UseRelativeTolerance
Type: Boolean
Description: This property specifies wether the deviations (positive, negative
and result) should be displayed in % (of the Nom value) or in the
same unit as Nom in the user interface of Pulse Ramping.
By default, this property is False.
Note: this property can only be set to True when Nom is
different from 0.0.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
pulseRampApp.Document.Ramps(1).Measurements(1).
UseRelativeTolerance = True
‘ Free object references at the end of the
procedure
Set pulseRampApp = Nothing
Set otm = Nothing

71
 OMICRON Test Universe

Act (read only)

Syntax: object.Act
Type: Double
Description: This property provides the actual value of the ramped quantity
when the measurement took place. The property provides an
undefined value if no measurement occurred. To check whether
this value is valid, use the IsActValid property.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
'Be sure that a result does exist
Dim meas As Object
Set meas =
pulseRampApp.Document.Ramps(1).Measurements(1)
If meas.IsActValid = True then
MsgBox "Measured value: " & meas.Act
End If
‘ Free object references at the end of the
procedure
Set meas = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

72
 Pulse Ramping Automation Interface

IsActValid (read only)

Syntax: object.IsActValid
Type: Boolean
Description: This property provides information about the validity of the actual
value. It is True when a result is available and when a
measurement occurred otherwise it is False.
This method should be called before an actual value is taken for
further calculation since object.Act returns an undefined value
when no measurement occurred.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
'Be sure that a result does exist
Dim meas As Object
Set meas =
pulseRampApp.Document.Ramps(1).Measurements(1)
If meas.IsActValid = True then
MsgBox "Measured value: " & meas.Act
Else
MsgBox "No value has been measured"
End If
‘ Free object references at the end of the
procedure
Set meas = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

73
 OMICRON Test Universe

Assessment (read only)

Syntax: object.Assessment
Type: Boolean
Description: This property provides assessment information for the
measurement. It is True when measurement has been assessed
as Passed and False otherwise.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
'Be sure that a result does exist
Dim meas As Object
Set meas =
pulseRampApp.Document.Ramps(1).Measurements(1)
MsgBox "Assessment: " & meas.Assessment
‘ Free object references at the end of the
procedure
Set meas = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

74
 Pulse Ramping Automation Interface

Dev (read only)

Syntax: object.Dev
Type: Double
Description: This property provides the difference of the actual and the
nominal values, when a measurement occurred. The property
provides an undefined value if the deviation value is not valid. To
check whether this value is valid, use the IsDevValid property.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
'Be sure that a result does exist
Dim meas As Object
Set meas =
pulseRampApp.Document.Ramps(1).Measurements(1)
If meas.IsDevValid = True then
MsgBox "Deviation: " & meas.Dev
End If
‘ Free object references at the end of the
procedure
Set meas = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

IsDevValid (read only)

Syntax: object.IsDevValid
Type: Boolean
Description: This property provides information about the validity of the
deviation. It is True when a valid deviation is available, otherwise
it is False. This method should be called before the deviation is
accessed.
Example: See example for Dev

75
 OMICRON Test Universe

MeasTime (read only)

Syntax: object.MeasTime
Type: Double
Description: This property provides the value of the time elapsed between the
beginning of the last fault state and the moment when the
measurement was done. The property provides an undefined
value if no measurement occurred. To check whether this value
is valid, use the IsMeasTimeValid property.
Example: Dim otm As Object
Dim pulseRampApp As Object
Set otm =
Document.InsertObject(“OMPlsRmp.Document”)
Set pulseRampApp = otm.Specific
'Be sure that a result does exist
Dim meas As Object
Set meas =
pulseRampApp.Document.Ramps(1).Measurements(1)
If meas.IsMeasTimeValid = True then
MsgBox "Time to measurement: " & meas.MeasTime
End If
‘ Free object references at the end of the
procedure
Set meas = Nothing
Set pulseRampApp = Nothing
Set otm = Nothing

IsMeasTimeValid (read only)

Syntax: object.IsMeasTimeValid
Type: Boolean
Description: This property provides information about the validity of the actual
value. It is True when a result is available and when a
measurement occurred otherwise it is False
This method should be called before an actual value is taken for
further calculation since object.MeasTime returns an undefined
value when no measurement occurred.
Example: See example for MeasTime

76
 Pulse Ramping Automation Interface

Constants Object
Properties
The following is a list of all signal IDs supported by the OMICRON Pulse
Ramping module.
Analog Outputs
sigidUL1E
sigidUL2E
sigidUL3E
sigidU_E
sigidU_0
sigidU_1
sigidU_2
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_E
sigidI_0
sigidI_1

77
 OMICRON Test Universe

sigidI_2
sigidI_PRIM_L1
sigidI_PRIM_L2
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

78
 Pulse Ramping Automation Interface

Binary Inputs
sigidTRIP
sigidTRIP_L1
sigidTRIP_L2
sigidTRIP_L3
sigidTRIP_L1_ONLY
sigidTRIP_L2_ONLY
sigidTRIP_L3_ONLY
sigidTRIP_1_PHASE
sigidTRIP_3_PHASE
sigidTRIP_IDIFF_GR
sigidTRIP_IDIFF_GRGR
sigidSTART
sigidSTART_L1
sigidSTART_L2
sigidSTART_L3
sigidUSER_INPBIN_DEF1
sigidUSER_INPBIN_DEF2
sigidUSER_INPBIN_DEF3
sigidUSER_INPBIN_DEF4
sigidUSER_INPBIN_DEF5
sigidUSER_INPBIN_DEF6
sigidUSER_INPBIN_DEF7
sigidUSER_INPBIN_DEF8
sigidUSER_INPBIN_DEF9
sigidUSER_INPBIN_DEF10

79
 OMICRON Test Universe

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

80
 Pulse Ramping Automation Interface

Enums
Some properties of some objects presented in the previous sections can take a
finite number of values. These ones are described below.

TESTSTARTCONDITION
This enum gives the possible values for the StartTestOn property of the
Document object:

- tcsImmediate:
Set StartTestOn to this value when the ramp should be started immediately
after the test was started.

- tcsManual:
Set StartTestOn to this value when the ramp should be started manually after
the test was started, i.e. by the user pressing himself the OK button of the
“Manual Start” dialog box of Pulse Ramping.

- tcsOnBinInp:
Set StartTestOn to this value when the ramp should be started on the coming
(0>1) slope of the Trigger binary input after the test was started (if the Trigger
binary input is not routed, this value cannot be applied to StartTestOn).

- tcsOnGPS:
Set StartTestOn to this value when the ramp should be started on GPS
synchronization pulse after the test was started.

RAMPQUANTITY
This enum gives the possible values for the Quantity property of the Ramp
object

- qMagnitude:
Set Quantity to this value when the magnitude of the selected ramp output
should be ramped.

- qAngle:
Set Quantity to this value when the phase angle of the selected ramp output
should be ramped.

81
 OMICRON Test Universe

- qFrequency:
Set Quantity to this value when the frequency of the selected ramp output
should be ramped.

MEASCRITERION
This enum gives the possible values for the MeasureOn property of the
Measurement object:

- moBinInpGoSlope:
Set Measurement to this value when the measurement should be done on
the falling (1>0) slope of the Trip binary input

- moBinInpComeSlope:
Set Measurement to this value when the measurement should be done on
the coming (0>1) slope of the Trip binary input

- moManualAction:
Set Measurement to this value when the measurement should be done
manually, i.e. by the user pressing himself the OK button of the “Manual
Measurement” dialog box of Pulse Ramping

82