CUE CueSiteManager Programmers - Manual (Page 25)

25
Cue Site Manager / Programmer’s Manual / CSMDataProvider (driver)
© CUE, a.s. All Rights Reserved. | www.cuesystem.com | [email protected]
Functions
GetLastMessageFromOperator (ByRef message As Text, ByRef receivelocaltime As Time)
This function returns last message from operator. Text of the message will be passed to the ByRef parameter
message, local time of received message will be passed to the ByRef parameter receivelocaltime. Message is
stored in internal driver buffer (ready for reading by this function) until is overwritten by newer message or
until function ClearLastMessageFromOperator is used.
Example
Private Var MyMessage As Text [200]
Private Var MyMessageTime As Time
GetLastMessageFromOperator (MyMessage, MyMessageTime)
FullscreenWindow1.StaticTextMessage.SetText(MyMessage)
ClearLastMessageFromOperator ()
This function deletes last message from operator from internal driver buffer. Receive time of message is set
to 0:0.0.
After using this function empty text will be read by function GetLastMessageFromOperator until new message
will be received.
SetUserHelpRequest (Optional newrequestreason As Text := “”)
SetUserMaintenanceRequest (Optional newrequestreason As Text := “”)
SetUserSecurityAlert (Optional newalertreason As Text := “”)
SetUserServiceRequest (Optional newrequestreason As Text := “”)
These functions can be used for triggering user requests (help, maintenance, service) and security alert.
These functions set internal CSMDatProvider driver request flags to true and store reason of request
to the internal driver buffer. This data will be send to CSM operator console and will be displayed on
operator display. Requests will be displayed on operator console until functions ClearUserHelpRequest
(ClearUserMaintenanceRequest, ClearUserServiceRequest, ClearUserSecurityAlert) will be used or until
corresponding function from operator console will be called. Each time this functions are used, corresponding
events (OnUserHelpRequestChange, OnUserMaintenanceRequestChange, OnUserServiceRequestChange or
OnUserSecurityAlertChange) are raised.
Example
SetUserMaintenanceRequest (“Please send me the cleaning squad.”)
GetUserHelpRequest (ByRef requestreason As Text) As Boolean
GetUserMaintenanceRequest (ByRef requestreason As Text) As Boolean
GetUserSecurityAlert (ByRef alertreason As Text) As Boolean
GetUserServiceRequest (ByRef requestreason As Text) As Boolean
These functions return true, if corresponding request (alert) is set or false, if request is not set. Reason text
of the request (alert) is passed to the ByRef variable requestreason (alertreason).
Example
Private Var MyMaintenanceReason As Text [50]
If GetUserServiceRequest (MyMaintenanceReason) Then
FullscreenWindow1.IndicatorMaintenanceReason.SetValue( True )
FullscreenWindow1.StaticTextMaintenancereason.SetText(MyMaintenanceReason)
Else
FullscreenWindow1.IndicatorMaintenanceReason.SetValue( False )
FullscreenWindow1.StaticTextMaintenancereason.SetText( “” )
End If