PLMC-M3EX API 詳細
=========================
| 各クラスのメソッドの詳細を説明します.
| ※コマンドの説明にある(REQ_XXXやDAT_XXX)は,
| PLMC-M3EX送受信データマニュアル(TB00-0984)に記載されているコマンド番号です.

.. csv-table:: クラス概略
   :header: "クラス名", "概略"

   "pyfinemotion.plm3ex", "統合クラス"
   "pyfinemotion.plm3excomm", "通信コマンド発行"
   "pyfinemotion.plm3exstatus", "ステータス確認"
   "pyfinemotion.plm3exparam", "パラメーター確認"
   "pyfinemotion.plm3exiniParser", "iniファイル読込"
   "pyfinemotion.plm3extcnv", "テクノコードプログラム変換"
   "pyfinemotion.plm3exgcnv", "Gコードプログラム変換"
   "pyfinemotion.plm3exconst", "モーションコントローラ内部定数定義"
   "pyfinemotion.plm3exdata", "通信データフォーマット定義"
   "pyfinemotion.commerror", "通信エラー定義"
   "pyfinemotion.prgconverror", "プログラム変換エラー定義"

pyfinemotion.plm3ex
-------------------------------
| PLMC-M3EXを操作するクラスです.このクラスをインスタンス化して下さい.
| plm3excommを継承しています.
| またplm3extcnv, plm3exgcnvをインスタンス化しています.
| ほとんどのメソッドはplm3excommのメソッドを継承しているだけですが, 
| プログラム読込&書込, TPCロギングなど, 
| プログラム変換クラスの使用やTPCロギングでの複雑な処理については, 
| このクラスで実装してます.

.. automodule:: pyfinemotion.plm3ex
    :members:
    :undoc-members:
    :show-inheritance:

pyfinemotion.plm3excomm
-----------------------------------
| PLMC-M3EXとの通信を実装したクラスです.plm3exクラスが継承します.
| 通信ライブラリの通信コマンドに適切なデータを渡してコマンドを呼び, 
| 戻り値をPython型として受け取るための処理が実装されています.
| 各メソッドの詳細については[PLMC-M3EX 送受信データマニュアル:TB00-0984]内の, 
| 対応する通信コマンド番号(例:DAT_PROGRAM=0x01)をご確認ください.

.. automodule:: pyfinemotion.plm3excomm
    :members:
    :undoc-members:
    :show-inheritance:

pyfinemotion.plm3exstatus
-------------------------------------
| PLMC-M3EXのステータス情報をPythonクラスとして定義しています.

.. automodule:: pyfinemotion.plm3exstatus
    :members:
    :noindex:
    :undoc-members:
    :show-inheritance:

pyfinemotion.plm3exparam
------------------------------------
| PLMC-M3EXで使用するパラメータ設定をPythonクラスとして定義しています.

.. automodule:: pyfinemotion.plm3exparam
    :members:
    :noindex:
    :undoc-members:
    :show-inheritance:

pyfinemotion.plm3exconst
------------------------------------
| PLMC-M3EXの内部定数をPythonクラスとして定義しています.
| 直接操作する必要はありませんが, カスタムクラスを作成する際に参考として下さい.

.. automodule:: pyfinemotion.plm3exconst
    :members:
    :undoc-members:
    :show-inheritance:

pyfinemotion.plm3exdata
-----------------------------------
| PLMC-M3EXの内部定数をPythonクラスとして定義しています.
| 直接操作する必要はありませんが, カスタムクラスを作成する際に参考として下さい.

.. automodule:: pyfinemotion.plm3exdata
    :members:
    :noindex:
    :undoc-members:
    :show-inheritance:

pyfinemotion.plm3exiniparser
----------------------------------
| セッティングPCソフトで作成したplm3exdrv.iniファイルをPythonで読み込み, 
| PLMC-M3EXインスタンスに渡すためのクラスです.

.. automodule:: pyfinemotion.plm3exiniparser
    :members:
    :undoc-members:
    :show-inheritance:

pyfinemotion.plm3extcnv
-----------------------------
| Tコードで作成した運転プログラムをPLMC-M3EX用のバイナリに変換及び, 
| PLMC-M3EX内のバイナリプログラムをTコードのテキストプログラムに変換するモジュールです.
| PLMC-M3EXインスタンスがプログラムを変換する際に使用します.

.. automodule:: pyfinemotion.plm3extcnv
    :members:
    :undoc-members:
    :show-inheritance:

pyfinemotion.plm3exgcnv
-----------------------------
| Gコードで作成した運転プログラムをPLMC-M3EX用のバイナリに変換及び, 
| PLMC-M3EX内のバイナリプログラムをTコードのテキストプログラムに変換するモジュールです.
| PLMC-M3EXインスタンスがプログラムを変換する際に使用します.

.. automodule:: pyfinemotion.plm3exgcnv
    :members:
    :undoc-members:
    :show-inheritance:

pyfinemotion.commerror
----------------------------------
| PLMC-M3EXを操作した際にエラーが発生した場合に, Pythonが投げるエラーを設定しています.
| エラー内容に応じ必要な例外処理を実装してください.

.. automodule:: pyfinemotion.commerror
    :members:
    :noindex:
    :undoc-members:  
    :show-inheritance:

pyfinemotion.prgconverror
-------------------------------------
| Tコード又はGコードのプログラムの変換に失敗した場合に, Pythonが投げるエラーを設定しています.
| エラー内容に応じ必要な例外処理を実装してください.

.. automodule:: pyfinemotion.prgconverror
    :members:
    :noindex:
    :undoc-members:
    :show-inheritance: