CommentOnAck, AlarmThresholdCmdTarget Property
Syntax CommentOnAck = _Boolean
Description Consents you to set or rest this option for inserting an alarm acknowledge comment.
Parameter Description
None None
Result Boolean
Example:
Public Sub Click()
im objAlarmWnd As AlarmWndCmdTarget Dim objAlarmThr As AlarmThresholdCmdTarget
Set objAlarmWnd = GetSynopticObject.GetSubObject("AlarmWnd").GetObjectInterface
Set objAlarmThr = objAlarmWnd.GetSelectedAlarm If Not objAlarmThr Is Nothing Then
objAlarmThr.CommentOnAck = Not objAlarmThr.CommentOnAck End If
End Sub
Condition, AlarmThresholdCmdTarget Property
Syntax Condition = _Integer
Description This proprety sets or returns the condition for verifying referenced alarm.
The possible configurations are:
0 = major-equal (>=) 1 = minor-equal (<=) 2 = equal (=)
3 = Rate Change Decrease 4 = Rate Change Incease
5 = Different (<>) 6 = Between
Parameter Description
None None
Result Integer
Example:
Public Sub AlarmLoading()
Msgbox "Alarm Condition = " & cstr(Condition), vbInformation, GetProjectTitle End Sub
DateTimeACK, AlarmThresholdCmdTarget Property
Syntax DateTimeACK = _Date
Description This property sets or returns the date and time in which the alarm acknowledgement took place. Accepts a date parameter type. This property changes the value displayed in the alarms window only and has not influence in the historical log.
Parameter Description
None None
Result Date
Example:
Public Sub OnResetAlarm(bRet As Boolean) Debug.Print DateTimeAck End Sub
DateTimeACKMs, AlarmThresholdCmdTarget Property
Syntax DateTimeACKMs = _Integer
Description This property sets or returns the milliseconds of the second in which the alarm acknowledgement took place. To get the complete time data format you can combine it together with the DateTimeAck but be careful when using different variable types (date format and integer for this property).
This property changes the value displayed in the alarms window only and does not influence the historical log.
Parameter Description
None None
Result Integer
Example:
Public Sub OnResetAlarm(bRet As Boolean)
Debug.Print "ON = " & Format(DateTimeOn,"yyyy/mm/dd hh.nn.ss") & "," & DateTimeOnMs ' ON = 2001/03/16 11.27.17,10
Debug.Print "ACK = " & Format(DateTimeAck,"yyyy/mm/dd hh.nn.ss") & "," &
DateTimeACKMs ' ACK = 2001/03/16 11.27.24,210 End Sub
DateTimeFromTimeStamp,
AlarmThresholdCmdTarget Property
Syntax DateTimeFromTimeStamp = _Boolean
Description This property sets or returns the activation status of the alarm threshold's "Use Variable TimeStamp" property through which you can make the alarm's TimeStamp coincide with the that of the variable's.
Parameter Description
None None
Result Boolean
Example:
Public Sub Click()
Dim objAlarm As AlarmCmdTarget
Dim objAlarmThreshold As AlarmThresholdCmdTarget Set objAlarm = GetAlarm("Alarm01")
Set objAlarmThreshold = objAlarm.GetAlarmThreshold("Threshold01") MsgBox " DateTimeFromTimeStamp = " &
CStr(objAlarmThreshold.DateTimeFromTimeStamp),vbInformation,GetProject Title
Set objAlarm = Nothing
Set objAlarmThreshold = Nothing End Sub
DateTimeOFF, AlarmThresholdCmdTarget Property
Syntax DateTimeOFF = _Date
Description This property sets or returns the date and time in which the alarm is turned OFF. Accepts a date parameter type. This property changes the
value displayed in the alarms window only and does not influence the historical log.
Parameter Description
None None
Result Date
Example:
Public Sub OnResetAlarm(bRet As Boolean) DateTimeOFF = CDate(Date) Debug.Print DateTimeOFF End Sub
DateTimeOFFMs, AlarmThresholdCmdTarget Property
Syntax DateTimeOFFMs = _Integer
Description This property sets or returns the milliseconds of the second in which the alarm turned OFF. To get a complete time format you can combine this with the DateTimeOFF taking care with the different variables being used (date format and integer for this property). This property changes the value displayed in the alarms window only and does not influence the historical log.
Parameter Description
None None
Result Integer
Example:
Public Sub OnResetAlarm(bRet As Boolean)
Debug.Print "OFF = " & Format(DateTimeOff,"yyyy/mm/dd hh.nn.ss") & "," &
DateTimeOFFMs End Sub
DateTimeON, AlarmThresholdCmdTarget Property
Syntax DateTimeON = _Date
Description This property sets or resets the data and time in which the alarm turned ON. Accepts a date parameter. This changes the value displayed in the alarms window only and does not influence the historical log.
Parameter Description
None None
Result Date
Example:
Public Sub OnAckAlarm(bRet As Boolean) DateTimeOn = CDate(Date) Debug.Print DateTimeOn End Sub
DateTimeOnMs, AlarmThresholdCmdTarget Property
Syntax DateTimeOnMs = _Integer
Description This property sets or returns the milliseconds of the secon in which the alarm turned ON. To get the complete time format you can combine this with the DateTimeOn taking care with the different variables being used (date format and integer). This property changes the value displayed in the alarms window only and has no influence on the historical log.
Parameter Description
None None
Result Integer
Example:
Public Sub OnResetAlarm(bRet As Boolean)
Debug.Print "ON = " & Format(DateTimeOn,"yyyy/mm/dd hh.nn.ss") & "," &
DateTimeOnMs ' ON = 2001/03/16 11.27.17,10
Debug.Print "ACK = " & Format(DateTimeAck,"yyyy/mm/dd hh.nn.ss") & "," &
DateTimeAckMs ' ACK = 2001/03/16 11.27.24,210 End Sub
DateTimeRESET, AlarmThresholdCmdTarget Property
Syntax DateTimeRESET = _Date
Description This property sets or returns the date and time in which the alarm reset took place. Accepts a date parameter. This property changes the value displayed in the alarms window only and does not influence the historical log.
Parameter Description
None None
Result Date
Example:
Public Sub OnResetAlarm(bRet As Boolean) Debug.Print DateTimeRESET End Sub
DateTimeRESETMs,
AlarmThresholdCmdTarget Property
Syntax DateTimeRESETMs = _Integer
Description This property sets or returns the milliseconds of the second in which the alarm reset took place. To get a complete date format you can combine this with the DateTimeAck taking care with the different variables being used (date format and integer for this property). This property changes the value displayed in the alarms window only and does not influence the historical log.
Parameter Description
None None
Result Integer
Example:
Public Sub OnResetAlarm(bRet As Boolean)
Debug.Print "RESET = " & Format(DateTimeRESET,"yyyy/mm/dd hh.nn.ss") & "," &
DateTimeRESETMs End Sub
DurationFormat, AlarmThresholdCmdTarget Property
Syntax DurationFormat = _String
Description This property allows a message to be inserted which will be filed under the
"CommCol" column in the "Alarms" table of the Historical Log. The message will be recorded only on the "Alarm Off" event.
The message can include the following special codes only:
%D = Days of alarm duration
%H = Hours of alarm duration
%M = Minutes of alarm duration
%S = Seconds of alarm durationalarm's total duration with the following string:
Duration total 0,00:00:00
where 00:00:00 indicates the alarm duration in days, hours, minutes and seconds.
Parameter Description
None None
Result String
Example:
Public Sub OnResetAlarm(bRet As Boolean) Debug.Print DurationFormat End Sub