その他｜VB.NET-TIPS などプログラミングについて

2018/03/22

標準コントロールのTimerコントロールとは異なり、タイマイベントを別スレッドとして起動するスレッドタイマの説明をします。

タイマイベントはSystem.Threadingの名前空間にある、Timerクラスで、 MSDNの説明によれば以下の様になっています。

System.Threading.Timer について

<コンストラクター(複数ある中の今回利用のもの)>
Public Sub New (
    callback As TimerCallback, :TimerCallback を実行するメソッドを表すデリゲート
    state As Object,           :コールバック メソッドで使用される情報を格納したオブジェクト
                                または nullです。
    dueTime As Integer,        :前に遅延する時間 callback ミリ秒単位で呼び出されます。 
                                指定 Timeout.Infinite 、タイマーが起動しないようにします。
                                0 を指定して、タイマーをすぐに開始します。
    period As Integer          :呼び出しの間の時間間隔 callback, 、(ミリ秒単位)。
                                指定 Timeout.Infinite 周期的なシグナル通知を無効にします。
)
<メソッド>
Public Function Change (
    dueTime As Integer,        :時に指定されたコールバック メソッドを呼び出す前に遅延する時間数、
                                Timer (ミリ秒単位) が作成されました。
                                指定 Timeout.Infinite タイマーが再開されないようにします。
                                0 を指定して、タイマーをすぐに再開します。
    period As Integer          :コールバック メソッドの呼び出し間の時間間隔が指定されたときに、
                                Timer (ミリ秒単位) が作成されました。
                                指定 Timeout.Infinite 周期的なシグナル通知を無効にします。
) As Boolean
    戻り値：true の場合は、タイマーが正常に更新されました。それ以外の場合、 falseです。

今回の例としては、スレッドタイマを作成し、 TimerCallback イベントで出力ウインドウに現在の時刻を表示する動作をします。

スレッドタイマの使い方

Imports System.Threading
Imports System.Threading.Thread

Public Class frmTimer2

    'スレッドタイマ
    Private mtimer As System.Threading.Timer

    ''' 
    ''' フォームロードイベント
    ''' 
    Private Sub frmTimer2_Load(sender As Object, e As EventArgs) Handles Me.Load
        'タイマコールバック関数
        Dim timerDelegate As TimerCallback = New TimerCallback(AddressOf TimerEvent)
        '1000msecタイマ生成（コールバック関数の設定）
        mtimer = New Timer(timerDelegate, Nothing, 0, 1000)
    End Sub

    ''' 
    ''' System.Threading.Timer からの呼び出しを処理するメソッド
    ''' 
    ''' <param name="state">このデリゲートで呼び出されたメソッドに関連するアプリケーション固有の情報を格納するオブジェクト</param>
    Private Sub TimerEvent(ByVal state As Object)
        '出力ウインドウに時刻表示
        Console.WriteLine("Time:" & Now.ToString("hh:mm:ss"))
    End Sub

End Class

実行させると、1000msec毎に関数 TimerEvent が呼び出され、出力ウインドウに現在の時刻が表示されることが確認できます。

そこで、以下のページの様にフォーム上のラベルに時刻を表示させてみようとしました。
・Timerコントロールの使い方　：[Timer,Interval]

しかし、思っていた様にラベルには時刻が表示されずに、以下の様なエラーが表示されてしまいました。

「有効ではないスレッド間の操作: コントロールが作成されたスレッド以外のスレッドからコントロール 'Label1' がアクセスされました。」

スレッドタイマの使い方・エラーの出たフォーム上のラベルへの表示

Imports System.Threading
Imports System.Threading.Thread

Public Class frmTimer2

    'スレッドタイマ
    Private mtimer As System.Threading.Timer

    ''' 
    ''' フォームロードイベント
    ''' 
    Private Sub frmTimer2_Load(sender As Object, e As EventArgs) Handles Me.Load
        'タイマコールバック関数
        Dim timerDelegate As TimerCallback = New TimerCallback(AddressOf TimerEvent)
        '1000msecタイマ生成（コールバック関数の設定）
        mtimer = New Timer(timerDelegate, Nothing, 0, 1000)
    End Sub

    ''' 
    ''' System.Threading.Timer からの呼び出しを処理するメソッド
    ''' 
    ''' <param name="state">このデリゲートで呼び出されたメソッドに関連するアプリケーション固有の情報を格納するオブジェクト</param>
    Private Sub TimerEvent(ByVal state As Object)
        ''出力ウインドウに時刻表示
        'Console.WriteLine("Time:" & Now.ToString("hh:mm:ss"))
        'ラベルに現在時刻表示
        Me.Label1.Text = Now.ToString("hh:mm:ss")
    End Sub

End Class

「有効ではないスレッド間の操作...」エラーは、あるスレッドから異なるスレッド上のコントロールにアクセスしようとしたことが原因でした。
つまりスレッドタイマの TimerEvent と、フォームのラベルがあるスレッドとは全く別にスレッド上で動作していることになります。

これを解決するには、デリゲートという方法を使います。デリゲートを使えば別スレッドからフォーム上のコントロールへのアクセスが出来る様になります。

デリゲートの方法ですがソースを見た方が分かりやすいと思いますので、以下に示します。

スレッドタイマの使い方・デリゲート宣言とInvoke関数

Imports System.Threading
Imports System.Threading.Thread

Public Class frmTimer2

    'スレッドタイマ
    Private mtimer As System.Threading.Timer

    ''' 
    ''' フォームロードイベント
    ''' 
    Private Sub frmTimer2_Load(sender As Object, e As EventArgs) Handles Me.Load
        'タイマコールバック関数
        Dim timerDelegate As TimerCallback = New TimerCallback(AddressOf TimerEvent)
        '1000msecタイマ生成（コールバック関数の設定）
        mtimer = New Timer(timerDelegate, Nothing, 0, 1000)
    End Sub

    ''' 
    ''' System.Threading.Timer からの呼び出しを処理するメソッド
    ''' 
    ''' <param name="state">このデリゲートで呼び出されたメソッドに関連するアプリケーション固有の情報を格納するオブジェクト</param>
    Private Sub TimerEvent(ByVal state As Object)
        'ラベルに現在時刻表示
        Dim strDate As String = Now.ToString("hh:mm:ss")
        Invoke(New SetLabelTextDelegate(AddressOf SetLabelText),
               New Object() {strDate})
    End Sub

    ' ラベル表示デリゲート宣言
    Private Delegate Sub SetLabelTextDelegate(ByVal strText As String)

    ''' 
    ''' ラベル表示
    ''' 
    ''' <param name="strText">表示文字列</param>
    Private Sub SetLabelText(ByVal strText As String)
        Label1.Text = strText
    End Sub
End Class

このソースで一応ラベルへの表示は以下図の様に出来る様になりました。

ここで重要なのは、ラベル表示用関数のデリゲート宣言と Invoke 関数です。デリゲート(delegate)という動詞には「委譲する、委任する」、名詞では「代理人」などという意味が有りますが、デリゲートの呼び出し側からすれば、関数の引数を合わせて、デリゲートされたものを Invoke 関数で呼出すだけのことになります。
デリゲートとして宣言されている中身の処理については、そちらままかせの感じになります。

デリゲートとして宣言された関数を Invoke で呼出してやれば、スレッドを超えて処理が可能になります。さて、 Invoke ですがMSDNの説明では以下の様になっています。

Public Function Invoke(method As System.Delegate, ParamArray args() As Object) As Object
概要:
  コントロールの基になるウィンドウ ハンドルを所有するスレッド上で、
  指定した引数リストを使用して、指定したデリゲートを実行します。

パラメーター:
  method: args パラメーターに指定されている数および型と同じ数
          および型のパラメーターをとるメソッドへのデリゲート。
  args:   指定したメソッドに引数として渡すオブジェクトの配列。
          メソッドが引数をとらない場合、このパラメーターは null になります。

指定した精度の桁数に数値を切り上げ

    ''' ------------------------------------------------------------------------
    ''' 
    ''' 指定した精度の数値の切り上げ
    ''' 
    ''' <param name="Val">丸め対象の倍精度浮動小数点数</param>
    ''' <param name="intUnit">戻り値の有効桁数の精度</param>
    ''' 切り上げられた数値。
    ''' ------------------------------------------------------------------------
    Public Function RoundUp(ByVal Val As Double, ByVal intUnit As Integer) As Double
        Dim dblPow As Double = System.Math.Pow(10, intUnit)

        If Val > 0 Then
            'Ceiling:指定した倍精度浮動小数点数以上の数のうち、最小の整数値を返します
            Return System.Math.Ceiling(Val / dblPow) * dblPow
        Else
            'Floor:指定した倍精度浮動小数点数以下の数のうち、最大の整数を返します
            Return System.Math.Floor(Val / dblPow) * dblPow
        End If
    End Function

    Public Function RoundUp(ByVal Val As Decimal, ByVal intUnit As Integer) As Decimal
        Dim decPow As Decimal = System.Math.Pow(10, intUnit)

        If Val > 0 Then
            'Ceiling:指定した 10 進数以上の数のうち、最小の整数値を返します
            Return System.Math.Ceiling(Val / decPow) * decPow
        Else
            'Floor:指定した 10 進数以下の数のうち、最大の整数を返します
            Return System.Math.Floor(Val / decPow) * decPow
        End If
    End Function

    Public Function RoundUp(ByVal Val As Long, ByVal intUnit As Integer) As Long
        Dim decPow As Decimal = System.Math.Pow(10, intUnit)

        If Val > 0 Then
            Return System.Math.Ceiling(Val / decPow) * decPow
        Else
            Return System.Math.Floor(Val / decPow) * decPow
        End If
    End Function

    '*****
    '仮にテストプログラム
    '*****
    Private Sub BtnRoundUp_Click(sender As Object, e As EventArgs) Handles BtnRoundUp.Click
        Try
            Dim decData As Decimal = 123456
            Dim dblData As Double = 123456
            Dim lngData As Long = 123456

            Dim str As String = ""
            str &= "Decimal:" & decData.ToString & "-->" & RoundUp(decData, 3).ToString & vbCrLf
            str &= "Double :" & dblData.ToString & "-->" & RoundUp(dblData, 2).ToString & vbCrLf
            str &= "Long   :" & lngData.ToString & "-->" & RoundUp(decData, 1).ToString & vbCrLf
            decData = -decData
            dblData = -dblData
            lngData = -lngData
            str &= "Decimal:" & decData.ToString & "-->" & RoundUp(decData, 3).ToString & vbCrLf
            str &= "Double :" & dblData.ToString & "-->" & RoundUp(dblData, 2).ToString & vbCrLf
            str &= "Long   :" & lngData.ToString & "-->" & RoundUp(decData, 1).ToString & vbCrLf
            MsgBox(str)

        Catch ex As Exception
            'エラー
            MsgBox(ex.Message)
        End Try
    End Sub

その他
0CM

2018/03/22

右詰でバイト配列のコピーを行う

指定されたコピー元のバイト配列から、指定されたコピー先バイト配列に、右詰でコピーを行う関数です。
関数としては、コピー元の配列数がコピー先の配列数より多い場合は、コピー先のコピー開始位置を右にずらして配列数分までをコピーします。
また、コピー元の配列数がコピー先の配列数より少ない場合、コピー先の残りに指定のバイト値を埋めます。

右詰でバイト配列のコピーを行う

    ''' -----------------------------------------------------------------------------
    ''' 
    ''' 右詰でバイト配列のコピーを行う。
    ''' 
    ''' <param name="srcArr">コピー元バイト配列</param>
    ''' <param name="desArr">コピー先バイト配列</param>
    ''' <param name="fillByte">指定バイトデータ(規定値：0x00)</param>
    ''' コピー元のバイト数が、コピー先より小さい場合に、先頭から余った領域にバイトデータを埋める。
    ''' -----------------------------------------------------------------------------
    Public Sub CopyByteArrRight(ByVal srcArr As Byte(), ByVal desArr As Byte(), Optional ByVal fillByte As Byte = &H0)
        Dim idx As Integer
        If srcArr.Length = 0 Then
            '元の配列長が０の場合、指定バイトデータを埋める
            For idx = 0 To desArr.Length - 1
                desArr(idx) = fillByte
            Next
        Else
            'コピー先に収まるバイト数を計算
            Dim copyBytes As Integer = srcArr.Length    'コピー元の長さ
            If srcArr.Length > desArr.Length Then
                'コピー元の長さがコピー先の長さより大きい場合、コピー先の長さをコピー数にする
                copyBytes = desArr.Length
            End If
            'コピー元の長さで、コピー先の開始位置を右にずらして、左からコピー
            Array.Copy(srcArr, 0, desArr, desArr.Length - copyBytes, copyBytes)
            'コピー元のバイト数が、コピー先のバイト数より小さい場合、指定バイトデータを埋める
            If copyBytes < desArr.Length Then
                For idx = 0 To (desArr.Length - copyBytes) - 1
                    desArr(idx) = fillByte
                Next
            End If
        End If
    End Sub

    '*****
    '仮にテストプログラム
    '*****
    Private Sub CopyArrRight_Click(sender As Object, e As EventArgs) Handles CopyArrRight.Click
        Try
            '配列宣言
            Dim byteArr(10) As Byte     'コピー元
            Dim byteArr2(12) As Byte    'コピー先
            'コピー元配列を「&H55」で埋める
            FillByteArr(byteArr, &H55)  '
            'コピー元からコピー先へコピーする
            CopyByteArrRight(byteArr, byteArr2, &HAA)
            '結果の表示
            Dim str As String = ""
            For i = 0 To byteArr2.Length - 1
                str &= String.Format("byteArr2[{0}] = {1}", i, byteArr2(i).ToString("X")) & vbCrLf
            Next
            MsgBox(str)

        Catch ex As Exception
            'エラー
            MsgBox(ex.Message)
        End Try
    End Sub

左詰でバイト配列のコピーを行う

    ''' -----------------------------------------------------------------------------
    ''' 
    ''' 左詰でバイト配列のコピーを行う。
    ''' 
    ''' <param name="srcArr">コピー元バイト配列</param>
    ''' <param name="desArr">コピー先バイト配列</param>
    ''' <param name="fillByte">指定バイトデータ(規定値：0x00)</param>
    ''' コピー元のバイト数が、コピー先より小さい場合に、余った領域に埋めるバイトデータを埋める。
    ''' -----------------------------------------------------------------------------
    Public Sub CopyByteArrLeft(ByVal srcArr As Byte(), ByVal desArr As Byte(), Optional ByVal fillByte As Byte = &H0)
        Dim idx As Integer
        If srcArr.Length = 0 Then
            'コピー元の配列長が０の場合、指定バイトデータを埋める
            For idx = 0 To desArr.Length - 1
                desArr(idx) = fillByte
            Next
        Else
            'コピー先に収まるバイト数を計算
            Dim copyBytes As Integer = srcArr.Length    'コピー元の長さ
            If srcArr.Length > desArr.Length Then
                'コピー元の長さがコピー先の長さより大きい場合、コピー先の長さをコピー数にする
                copyBytes = desArr.Length
            End If
            '左からコピー
            Array.Copy(srcArr, desArr, copyBytes)
            'コピー元のバイト数が、コピー先のバイト数より小さい場合、後ろに指定バイトデータ埋める
            If copyBytes < desArr.Length Then
                For idx = copyBytes To desArr.Length - 1
                    desArr(idx) = fillByte
                Next
            End If
        End If
    End Sub

    '*****
    '仮にテストプログラム
    '*****
    Private Sub CopyArrLeft_Click(sender As Object, e As EventArgs) Handles CopyArrLeft.Click
        Try
            '配列宣言
            Dim byteArr(10) As Byte     'コピー元
            Dim byteArr2(12) As Byte    'コピー先
            'コピー元配列を「&H55」で埋める
            FillByteArr(byteArr, &H55)  '
            'コピー元からコピー先へコピーする
            CopyByteArrLeft(byteArr, byteArr2, &HAA)
            '結果の表示
            Dim str As String = ""
            For i = 0 To byteArr2.Length - 1
                str &= String.Format("byteArr2[{0}] = {1}", i, byteArr2(i).ToString("X")) & vbCrLf
            Next
            MsgBox(str)

        Catch ex As Exception
            'エラー
            MsgBox(ex.Message)
        End Try
    End Sub

VB.NET-TIPS などプログラミングについて

System.Threading.Timer について

スレッドタイマの使い方

スレッドタイマの使い方・エラーの出たフォーム上のラベルへの表示

スレッドタイマの使い方・デリゲート宣言とInvoke関数

関連する記事

指定した精度の桁数に数値を切り上げ

右詰でバイト配列のコピーを行う

関連する記事

左詰でバイト配列のコピーを行う

関連する記事