ToolTalk メッセージの一般的な定義と表記法

ヘッダー 

次のフォーマットでメッセージを 1 行で説明したもの。 

MsgName (Tt_class)

MsgName はメッセージ名、Tt_class は要求か通知を表す。

名前 

メッセージ名と 1 行のメッセージの説明 

説明 

メッセージの要求操作または通知イベントについての説明 

フォーマット 

メッセージを次のようなフォーマットの ToolTalk 型ファイル構文 (ToolTalk 型コンパイラ tt_type_comp が処理する構文に似ている) で表記したもの。

<fileAttrib> <opName> (<requiredArgs> [<optionalArgs>]); 

フォーマットは、メッセージの種類ごとに示される。 

<fileAttrib>: メッセージのファイル属性。必須、オプション、指定不可のいずれかを示す。 

<opName>: 操作やイベント名を「op name」または「op」と呼ぶ。ツールが異なっても、同じ opName で異なるものを表さないことが重要である。このため、標準以外のメッセージの opName は一意にしなければならない。たとえば、「Acme_Hoarktool_My_Frammistat」のように、<会社名><製品名> という接頭辞を付けるのは良い方法である。 

<requiredArgs>、<optionalArgs>: メッセージに常に指定しなければならない引数。個々の引数は、次のフォーマットで表される。 

<mode> <vtype> <argument name> 

mode には in、out、inout のどれか 1 つを指定する。vtype はメッセージ引数のデータの種類を記述する文字列であり、プログラマが定義する。argument name は引数名を表す。

ToolTalk サービスは vtype を使用して、送信メッセージのインスタンスと登録済みメッセージパターンを照合する。通常、vtype は単一の決まったデータ型に対応する。 

必須引数 

メッセージに常に指定しなければならない引数。 

<vtype> <argumentName> 

「vtype」は、メッセージ引数のデータの種類を記述する文字列であり、プログラマが定義する。ToolTalk が vtype を使用するのは、送信メッセージのインスタンスと登録済みメッセージパターンの照合を行うためだけである。 

通常、vtype はすべて単一の決まったデータ型に対応させる。ToolTalk 引数のデータ型は、整数、文字列、バイトのいずれかである。メッセージ引数やパターン引数のデータ型は、その値を設定する ToolTalk API 関数で決まる。 

引数名は、C の typedef でのパラメタ名と同様、引数の構文の意味を分かりやすくするコメントである。 

オプション引数 

メッセージに指定してもよい引数。特に断らないかぎり、必須引数の後であれば、オプション引数をどのように組み合わせても、どのような順序で追加してもよい。 

説明 

要求が意味する操作や、通知が知らせるイベントについての説明 

エラー 

要求のハンドラや通知の送信側が設定できるエラーコードの一覧