test
Diff: EC.h
- Revision:
- 6:8eaadd1e43f1
- Parent:
- 5:4e39c821be9c
- Child:
- 7:f81ffb5b69bf
--- a/EC.h Thu Jul 04 12:11:31 2019 +0000 +++ b/EC.h Thu Jul 04 12:21:14 2019 +0000 @@ -5,9 +5,9 @@ #define M_PI 3.14159265359f #endif -/**@section SAMPLE -@code -//プログラム例 +/** @section SAMPLE +* @code +* //プログラム例 * #include "mbed.h" * #include "EC.h" * @@ -21,13 +21,13 @@ * //Ec2multi EC(p7,p8,RESOLUTION); //2逓倍用class * //or * //Ec4multi EC(p7,p8,RESOLUTION); //4逓倍用class -* void calOmega(); +* void calcOmega(); * * int main() * { * int count=0; * double omega; -* ticker.attach(&calOmega,0.05); +* ticker.attach(&calcOmega,0.05); * * while(1) { * count=EC.getCount(); @@ -36,7 +36,7 @@ * pc.printf("omega=%f\r\n",omega); * } * } -* void calOmega() +* void calcOmega() * { * EC.calOmega(); * } @@ -44,10 +44,10 @@ */ /** -* @brief increment型エンコーダ用class -* @details 1逓倍:Ec1multi -* 2逓倍:Ec2multi -* 4逓倍:Ec4multi +* @brief increment型エンコーダ用class +* @details 1逓倍:Ec1multi +* 2逓倍:Ec2multi +* 4逓倍:Ec4multi **/ class Ec { @@ -69,25 +69,25 @@ @remarks このclassは各逓倍のclassに継承されるため、使用者が宣言する必要はない */ Ec(int res,int multi); - /**@fn int getCount() - * エンコーダのcountを返す関数 - * 1周のcount=分解能×逓倍 - * @return count + /** @fn int getCount() + * @details エンコーダのcountを返す関数 + * 1周のcount=分解能×逓倍 + * @return count */ int getCount(); /** - * 軸の角速度を返す関数 - * @return ω(rad/s) + * 軸の角速度を返す関数 + * @return ω(rad/s) */ double getOmega(); /** - * 角速度を計算するための関数 - * 微分を微小時間の変位として計算しているので、タイマー割込などで回さなければいけない + * 角速度を計算するための関数 + * 微分を微小時間の変位として計算しているので、タイマー割込などで回さなければいけない */ void calOmega(); /** - * 分解能を指定するための関数 - * @param res エンコーダの分解能 + * 分解能を指定するための関数 + * @param res エンコーダの分解能 */ void setResolution(int res); ///エンコーダのcountやωをリセットするための関数 @@ -101,14 +101,15 @@ DigitalIn signalB_; void upA(); public: - /**コンストラクタの定義 - main関数の前に必ず一度宣言する - 使うエンコーダの数だけ設定する必要がある + /** + * @brief コンストラクタの定義 + * @details main関数の前に必ず一度宣言する + * 使うエンコーダの数だけ設定する必要がある - @param signalA エンコーダのA相のピン名 - @param signalB エンコーダのB相のピン名 - @param res エンコーダの分解能 - @remark 2,4逓倍も同様 + @ param signalA エンコーダのA相のピン名 + @ param signalB エンコーダのB相のピン名 + @ param res エンコーダの分解能 + @ remark 2,4逓倍も同様 */ Ec1multi(PinName signalA,PinName signalB,int res); }; @@ -120,13 +121,14 @@ void upA(); void downA(); public: - /**コンストラクタの定義 - main関数の前に必ず一度宣言する - 使うエンコーダの数だけ設定する必要がある + /** + * @brief コンストラクタの定義 + * @details main関数の前に必ず一度宣言する + * 使うエンコーダの数だけ設定する必要がある - @param signalA エンコーダのA相のピン名 - @param signalB エンコーダのB相のピン名 - @param res エンコーダの分解能 + @ param signalA エンコーダのA相のピン名 + @ param signalB エンコーダのB相のピン名 + @ param res エンコーダの分解能 */ Ec2multi(PinName signalA,PinName signalB,int res); }; @@ -141,13 +143,14 @@ void downB(); int pa_,pb_; public: - /**コンストラクタの定義 - main関数の前に必ず一度宣言する - 使うエンコーダの数だけ設定する必要がある + /** + * @brief コンストラクタの定義 + * @details main関数の前に必ず一度宣言する + * 使うエンコーダの数だけ設定する必要がある - @param signalA エンコーダのA相のピン名 - @param signalB エンコーダのB相のピン名 - @param res エンコーダの分解能 + @ param signalA エンコーダのA相のピン名 + @ param signalB エンコーダのB相のピン名 + @ param res エンコーダの分解能 */ Ec4multi(PinName signalA,PinName signalB,int res); };