【実務・中級編】【初心者向け】図面保存時に指定カスタムプロパティの入力漏れを検知して保存をストップする入力バリデーションVBA – SolidWorks VBA解析バイブル

スポンサーリンク
スポンサーリンク

誤った設計はコストを生む。SolidWorks図面における「堅牢なバリデーション」の設計思想

設計現場において、最もコストが高く、最も回避すべき事態は何か?
それは「不完全なデータが次工程へ流出すること」だ。

図面における「材質」の記載漏れ、あるいは「承認者」の未入力。これらは一見、些細なミスに見える。しかし、これらがBOM(部品構成表)や製造指示書へと連鎖し、誤った材料での発注や、承認を得ていない設計の製作へと繋がった瞬間、そのコストは数万、数百万、あるいはそれ以上の損失へと膨れ上がる。

多くのプログラマは、単に「プロパティが空ならメッセージを出す」というコードを書く。しかし、それは「ツール」ではない。ただの「スクリプト」だ。
本稿では、実務の現場で、設計者のミスを確実に防ぎ、かつシステムの信頼性を担保するための「バリデーション・ゲートキーパー(検証門番)」としてのVBA設計手法を伝授する。

1. 初心者が陥る「脆弱な設計」の罠

まず、避けるべき「悪い例」を提示しよう。多くの初心者が書くコードは、以下のようなロジックだ。

' --- 避けるべきアンチパターン ---
Sub BadValidation()
    Dim swApp As SldWorks.SldWorks
    Set swApp = Application.SldWorks
    Dim swModel As SldWorks.ModelDoc2
    Set swModel = swApp.ActiveDoc

    ' プロパティを直接取得しようとする(プロパティ自体が存在しないとエラーで止まる)
    Dim propVal As String
    propVal = swModel.GetCustomInfoValue("", "材質") 

    If propVal = "" Then
        MsgBox "材質を入力してください!"
        Exit Sub
    End If
    
    swModel.Save3 swSaveAsOptions_e.swSaveAsOptions_Silent, 0, 0
End Sub

なぜこのコードは「プロの仕事」ではないのか?

1. 存在しないプロパティへの無防備さ: `GetCustomInfoValue` は、指定したプロパティ名が存在しない場合にエラーを吐くか、予期せぬ挙動を示す。実務では「プロパティ名そのものが作成されていない」ケースが多々ある。
2. 単一責任の原則の欠如: 「チェックする機能」と「保存する機能」が混ざっている。これでは、チェックだけを行いたい時や、保存以外のプロセス(PDFエクスポートなど)に流用したい時に、コードを書き直さなければならない。
3. 拡張性の欠如: チェックしたい項目が増えるたびに `If` 文を増設していく設計は、保守性を著しく低下させる。

2. 堅牢なアーキテクチャ:バリデーション・エンジンの設計

プロフェッショナルな設計では、「データ(必須項目リスト)」と「ロジック(検証エンジン)」を分離する。
また、エラーが発生した際に「どの項目が原因か」を明確にユーザーへフィードバックする仕組みが必要だ。

設計指針

  • Fail-Fast(早期失敗): 不備が見つかった瞬間に、それ以上の無駄な処理を行わず、詳細なエラーレポートと共に停止させる。
  • Abstraction(抽象化): 必須項目のリストを配列やコレクションとして定義し、検証ロジックはそれをループで回す構造にする。
  • Error Handling(エラーハンドリング): 予期せぬオブジェクトの欠如(図面が開かれていない等)を完全に制御する。

3. プロダクション・グレードのコード例

以下に、そのまま業務に投入可能なレベルの、堅牢なバリデーション・コードを提示する。

Option Explicit

''' <summary>
''' 図面保存時のバリデーション・ゲートキーパー
''' 必須カスタムプロパティを検証し、不備があれば保存を中断する。
''' </summary>
Sub SmartSaveGatekeeper()
    Dim swApp As SldWorks.SldWorks
    Dim swModel As SldWorks.ModelDoc2
    Dim swDraw As SldWorks.DrawingDoc
    Dim swCustPropMgr As SldWorks.CustomPropertyManager
    
    ' --- 設定領域: ここを編集するだけで保守が可能 ---
    Dim requiredProperties As Variant
    requiredProperties = Array("材質", "承認者", "設計番号", "プロジェクト名")
    ' ----------------------------------------------

    On Error GoTo ErrorHandler

    Set swApp = Application.SldWorks
    Set swModel = swApp.ActiveDoc

    ' 1. ドキュメントの存在確認
    If swModel Is Nothing Then
        MsgBox "エラー: ドキュメントが開かれていません。", vbCritical, "システムエラー"
        Exit Sub
    End If

    ' 2. 図面ファイルであるかの確認
    If swModel.GetType <> swDocDRAWING Then
        MsgBox "エラー: このマクロは図面ファイル専用です。", vbExclamation, "タイプエラー"
        Exit Sub
    End If

    Set swDraw = swModel
    ' カスタムプロパティマネージャーの取得(ファイル全体のプロパティ)
    Set swCustPropMgr = swModel.Extension.CustomPropertyManager("")

    ' 3. バリデーション・ロジック
    Dim missingItems As String
    Dim propName As Variant
    Dim valOut As String
    Dim resolvedValOut As String
    Dim wasResolved As Boolean

    missingItems = ""

    For Each propName In requiredProperties
        ' Get5メソッドを使用し、値の取得と「解決済みか否か」を厳密に判定
        ' Get5(PropertyName, UseCached, ValOut, ResolvedValOut, WasResolved)
        swCustPropMgr.Get5 propName, False, valOut, resolvedValOut, wasResolved
        
        ' 値が空、またはプロパティ自体が存在しない(resolvedValOutが空)場合を検知
        If resolvedValOut = "" Then
            missingItems = missingItems & " ・ " & propName & vbCrLf
        End If
    Next propName

    ' 4. 結果の判定とアクション
    If missingItems <> "" Then
        ' 不備がある場合:警告を表示して終了(保存は行わない)
        MsgBox "【保存中断】以下の必須項目が入力されていません。" & vbCrLf & vbCrLf & _
               missingItems & vbCrLf & _
               "これらは製造・管理プロセスに必須の項目です。", vbCritical, "バリデーション失敗"
        Exit Sub
    Else
        ' 全てクリア:保存を実行
        Dim saveStatus As Boolean
        saveStatus = swModel.Save3(swSaveAsOptions_e.swSaveAsOptions_Silent, 0, 0)
        
        If saveStatus Then
            swApp.SendMsgToUser2 "図面は正常に検証され、保存されました。", swMsgBoxTask, swMbInformation
        Else
            MsgBox "エラー: 保存に失敗しました。ファイルが読み取り専用でないか確認してください。", vbCritical, "保存エラー"
        End If
    End If

    Exit Sub

ErrorHandler:
    MsgBox "予期せぬエラーが発生しました。" & vbCrLf & "Error No: " & Err.Number & vbCrLf & _
           "Description: " & Err.Description, vbCritical, "実行時エラー"
End Sub

4. エンジニアとしての深掘り:なぜこの実装なのか

`Get5` メソッドの選択

コード内で `swCustPropMgr.Get5` を使用している点に注目してほしい。
SolidWorks APIにおいて、プロパティの取得は非常に「汚い」部分だ。プロパティが定義されていない場合、単なる `GetCustomInfoValue` ではエラーの温床となる。
`Get5` は、値がプロパティ式(例:`”SW-Material”`)によって計算されているのか、それとも静的な文字列なのかを `WasResolved` で返してくれる。我々が求めているのは「最終的にユーザーが目にする値(`ResolvedValOut`)」だ。これを使うことで、計算式の結果が空である場合も確実に検知できる。

拡張性と保守性

`requiredProperties = Array(…)` という一文。これが設計の肝だ。
将来的に「検査員」という項目を追加したくなったとき、優秀なエンジニアは `If` 文を書き足さない。この配列に文字列を一つ追加するだけで、ロジック全体が自動的に対応する。これを「データ駆動型設計」と呼ぶ。

ユーザーエクスペリエンス (UX)

単に `MsgBox “Error”` と出すのは素人の仕事だ。
「何が足りないのか」をリストアップし、`vbCritical` アイコンを用いて「なぜ保存できないのか」の理由をロジカルに提示する。これにより、ユーザーはマクロを「邪魔なツール」ではなく「自分をミスから守ってくれるガードレール」として認識するようになる。

5. さらなる高みへ:実務への統合アドバイス

このマクロを実務で運用する際は、以下のステップを検討せよ。

1. 標準保存ボタンの置き換え:
ユーザーに「保存するときはこのマクロを使ってください」と頼むのは限界がある。可能であれば、SolidWorksのツールバーにこのマクロを登録したカスタムボタンを作成し、標準の保存アイコンの横に配置させる。
2. データベース連携への布石:
もし、材質やプロジェクト名をExcelやSQLデータベースから自動取得する仕組みを作るなら、この `requiredProperties` のループの中で、データベース照合ロジックを呼び出すだけでいい。アーキテクチャが分離されているから、コードの破壊的な変更は不要だ。
3. 読み取り専用チェック:
実務では、PDM(Product Data Management)を使用している場合、ファイルが「読み取り専用」で開かれているケースが多々ある。保存前に `swModel.IsReadOnly` をチェックするロジックを一行加えるだけで、ツールとしての完成度はさらに高まる。

結びに

自動化エンジニアの真の価値は、「動くものを作る」ことではなく、「壊れない仕組みを作る」ことにある。
今回紹介したバリデーションの設計思想を、君の次のプロジェクトにも必ず持ち帰ってほしい。ミスを防ぐコードこそが、設計者の信頼を勝ち取る最強の武器となるのだ。

タイトルとURLをコピーしました