microsoft-visualbasic-runtime/ComponentModel/DataStructures/Trigger.vb

#Region "Microsoft.VisualBasic::ae5886bdee1b150a22ab337c8978e358, Microsoft.VisualBasic.Core\ComponentModel\DataStructures\Trigger.vb"

    ' Author:
    ' 
    '       asuka (amethyst.asuka@gcmodeller.org)
    '       xie (genetics@smrucc.org)
    '       xieguigang (xie.guigang@live.com)
    ' 
    ' Copyright (c) 2018 GPL3 Licensed
    ' 
    ' 
    ' GNU GENERAL PUBLIC LICENSE (GPL3)
    ' 
    ' 
    ' This program is free software: you can redistribute it and/or modify
    ' it under the terms of the GNU General Public License as published by
    ' the Free Software Foundation, either version 3 of the License, or
    ' (at your option) any later version.
    ' 
    ' This program is distributed in the hope that it will be useful,
    ' but WITHOUT ANY WARRANTY; without even the implied warranty of
    ' MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    ' GNU General Public License for more details.
    ' 
    ' You should have received a copy of the GNU General Public License
    ' along with this program. If not, see <http://www.gnu.org/licenses/>.



    ' /********************************************************************************/

    ' Summaries:

    '     Class ITrigger
    ' 
    '         Constructor: (+1 Overloads) Sub New
    '         Sub: TestRun
    ' 
    '     Interface ITimer
    ' 
    '         Properties: Interval
    ' 
    '         Sub: [Stop]
    ' 
    '     Class ConditionTrigger
    ' 
    '         Properties: Condition
    ' 
    '         Constructor: (+1 Overloads) Sub New
    '         Function: __test
    ' 
    '     Class DailyTimerTrigger
    ' 
    '         Constructor: (+2 Overloads) Sub New
    '         Function: __test
    ' 
    '     Class TimerTrigger
    ' 
    '         Properties: Interval, Time
    ' 
    '         Constructor: (+1 Overloads) Sub New
    ' 
    '         Function: __test, Start, ToString
    ' 
    '         Sub: [Stop]
    ' 
    ' 
    ' /********************************************************************************/

#End Region

Imports Microsoft.VisualBasic.ComponentModel.DataSourceModel
Imports Microsoft.VisualBasic.Parallel.Tasks
Imports Microsoft.VisualBasic.Serialization
Imports Microsoft.VisualBasic.Serialization.JSON

Namespace ComponentModel.Triggers

    Public MustInherit Class ITrigger : Inherits ICallbackInvoke

        Sub New(invoke As Action)
            Call MyBase.New(invoke)
        End Sub

        ''' <summary>
        ''' Test if success then run callback
        ''' </summary>
        Public Sub TestRun()
            If __test() Then
                Call _execute()
            End If
        End Sub

        Protected MustOverride Function __test() As Boolean

    End Class

    Public Interface ITimer : Inherits ITaskDriver, ICallbackTask
        Property Interval As Integer

        Sub [Stop]()
    End Interface

    Public Class ConditionTrigger : Inherits ITrigger

        Public ReadOnly Property Condition As Func(Of Boolean)

        Sub New(invoke As Action, condit As Func(Of Boolean))
            Call MyBase.New(invoke)
        End Sub

        Protected Overrides Function __test() As Boolean
            Return _Condition()
        End Function
    End Class

    ''' <summary>
    ''' 这个只会比较时和分，每天都会触发
    ''' </summary>
    Public Class DailyTimerTrigger : Inherits TimerTrigger

        ''' <summary>
        ''' 
        ''' </summary>
        ''' <param name="time">只需要赋值小时和分钟即可</param>
        ''' <param name="task"></param>
        ''' <param name="interval"></param>
        Public Sub New(time As Date, task As Action, Optional interval As Integer = 100)
            MyBase.New(time, task, interval)
        End Sub

        Sub New(hh As Integer, mm As Integer, task As Action, Optional interval As Integer = 100)
            MyBase.New(New Date(Now.Year, Now.Month, Now.Day, hh, mm, 0), task, interval)
        End Sub

        Protected Overrides Function __test() As Boolean
            Dim d As Date = Now

            If d.Hour <> Time.Hour OrElse d.Minute <> Time.Minute Then
                Return False
            Else
                Return True
            End If
        End Function
    End Class

    ''' <summary>
    ''' 在指定的日期和时间呗触发，因此这个触发器只会运行一次
    ''' </summary>
    Public Class TimerTrigger : Inherits ITrigger
        Implements ITaskDriver
        Implements ITimer

        ''' <summary>
        ''' 当判定到达这个指定的时间之后就会触发动作
        ''' </summary>
        ''' <returns></returns>
        Public ReadOnly Property Time As Date

        ''' <summary>
        ''' ms
        ''' </summary>
        ''' <returns></returns>
        Public Property Interval As Integer Implements ITimer.Interval
            Get
                Return __timer.Periods
            End Get
            Set(value As Integer)
                __timer.Periods = value
            End Set
        End Property

        ReadOnly __timer As UpdateThread

        ''' <summary>
        ''' 
        ''' </summary>
        ''' <param name="time">只精确到分，不会比较秒数</param>
        ''' <param name="task"></param>
        ''' <param name="interval">ms</param>
        Sub New(time As Date, task As Action, Optional interval As Integer = 100)
            Call MyBase.New(task)

            Me.__timer = New UpdateThread(interval, AddressOf TestRun)
            Me.Time = time
            Me.Interval = interval  ' 由于会在Interval属性进行赋值，所以这里要先初始化timer对象再赋值interval
        End Sub

        ''' <summary>
        ''' 不计算毫秒
        ''' </summary>
        ''' <returns></returns>
        Protected Overrides Function __test() As Boolean
            Dim d As Date = Now

            If d.Year <> Time.Year Then
                Return False
            ElseIf d.Month <> Time.Month Then
                Return False
            ElseIf d.Day <> Time.Day Then
                Return False
            ElseIf d.Hour <> Time.Hour Then
                Return False
            ElseIf d.Minute <> Time.Minute Then
                Return False
                ' ElseIf d.Second <> Time.Second Then
                ' Return False
            Else
                Return True
            End If
        End Function

        ''' <summary>
        ''' 启动计时器线程，这个方法不会阻塞当前的线程
        ''' </summary>
        ''' <returns></returns>
        Public Function Start() As Integer Implements ITaskDriver.Run
            Return __timer.Start
        End Function

        Public Overrides Function ToString() As String
            Return Me.GetJson
        End Function

        Public Sub [Stop]() Implements ITimer.Stop
            Call __timer.Stop()
        End Sub
    End Class
End Namespace