アフィリエイト広告
アフィリエイト広告

Arduino で C++クラスを学ぶ (4) – インライン関数

2022.07.19

前回は、コンストラクタを定義して、メンバ変数の初期化などを行なうことを学びました。

Arduino で C++クラスを学ぶ (3) – コンストラクタ
前回は、クラスのメンバへのアクセス制限について学習しました。一般に、メンバ変数は private、メンバ関数は public にし、メンバ変数への値の代入はメンバ関数を通して行なうとのことでした。 できあがったスケッチは、つぎのとおり。 A...
meyon.gonna.jp
2022.07.18

さて、できあがったスケッチは、以前みたことがあるような気が。そう、マルチタスクのレッスンで、初めて C++ クラスに出会ったときの、あのチンプンカンプンだった L チカ Flash のスケッチです。

Arduino のマルチタスク (3) C++ クラス
Arduino のマルチタスクとクラスについて、勉強中です。 前回は、複数のステートマシンを組み合わせて、同時に 2 つのことを実行する方法について学びました。 でもこの方法は、同じコードを何度も繰り返すことになり、無駄があります。俺はそれ...
meyon.gonna.jp
2021.06.10

スケッチの違い

2つのスケッチを比べてみましょう。
左は、マルチメディアのレッスンで使ったスケッチ。右は、今回作ったスケッチです。

以前のレッスンのスケッチ
  1. class Flasher
  2. {
  3.     // class Member Variables
  4.     // These are initialized at startup
  5.     int ledPin;
  6.     long OnTime;
  7.     long OffTime;
  9.     // These maintain the current state
  10.     int ledState;
  11.     unsigned long previousMillis;
  13.   // Constructor - creates a Flasher
  14.   // and initializes the member variables and state
  15.   public:
  16.   Flasher(int pin, long on, long off)
  17.   {
  18.     ledPin = pin;
  19.     pinMode(ledPin, OUTPUT);
  21.     OnTime = on;
  22.     OffTime = off;
  24.     ledState = LOW;
  25.     previousMillis = 0;
  26.   }
  28.   void Update()
  29.   {
  30.     // check to see if it's time to change the state of the LED
  31.     unsigned long currentMillis = millis();
  33.     if ((ledState == HIGH) && (currentMillis - previousMillis >= OnTime))
  34.     {
  35.       ledState = LOW;
  36.       previousMillis = currentMillis;
  37.       digitalWrite(ledPin, ledState);
  38.     }
  39.     else if ((ledState == LOW) && (currentMillis - previousMillis >= OffTime))
  40.     {
  41.       ledState = HIGH;
  42.       previousMillis = currentMillis;
  43.       digitalWrite(ledPin, ledState);
  44.     }
  45.   }
  46. };
  49. Flasher led1(12, 100, 400);
  50. Flasher led2(13, 350, 350);
  52. void setup()
  53. {
  54. }
  56. void loop()
  57. {
  58.   led1.Update();
  59.   led2.Update();
  60. }
今回作成したスケッチ
  1. class Flasher {
  2.   private:
  3.     byte ledPin;
  4.     int onTime;
  5.     int offTime;
  6.     byte ledStat;
  7.     unsigned long prevMillis;
  9.   public:
  10.     Flasher(byte pin, int on, int off);
  11.     void update();
  12. };
  14. Flasher::Flasher(byte pin, int on, int off) {
  15.   ledPin = pin;
  16.   pinMode(ledPin, OUTPUT);
  17.   onTime = on;
  18.   offTime = off;
  19.   ledStat = LOW;
  20.   prevMillis = 0;
  21. }
  23. void Flasher::update() {
  24.   unsigned long currMillis = millis();
  26.   if((HIGH == ledStat) && (onTime < currMillis - prevMillis)) {
  27.     ledStat = LOW;
  28.     prevMillis = currMillis;
  29.     digitalWrite(ledPin, ledStat);
  30.   }
  31.   else if((LOW == ledStat) && (offTime < currMillis - prevMillis)) {
  32.     ledStat = HIGH;
  33.     prevMillis = currMillis;
  34.     digitalWrite(ledPin, ledStat);
  35.   }
  36. }
  38. Flasher led1(12, 100, 400);
  39. Flasher led2(13, 350, 350);
  41. void setup() {
  42. }
  44. void loop() {
  45.   led1.update();
  46.   led2.update();
  47. }

コメントが書かれているとか、変数名が違うとか、型が違うとか、こまごました違いはありますが、ほぼ同じですよね。大きな違いといえるのは、メンバ関数の定義されている場所。
左のスケッチは、メンバ関数の定義が、クラスの宣言 class Flasher { }; の内に書かれています。今回作った右のスケッチでは、クラスの宣言の外です。

L チカ Flash の動作は、どちらも同じです。結果が違わないなら、どっちでもいい、ってことでしょ？

インライン関数

関数を使ったスケッチは、関数を使っていないスケッチに比べると、実行する時に関数を呼び出したり、引数や戻り値を受け渡したりするために、余分な時間がかかります。
そんなん気になるほどのスケッチは、いまの俺は書くこともないのですけど。しかしまぁ、ちょっとした処理をやってる関数を、何度も何度も呼び出していると、それなりに時間もかさむ。マルチタスクな処理をやっていると、無視できないこともでてくるかもしれません。

そんなときに役立つのが、インライン関数、です。

難しい説明は、詳しくないのでしません m(_ _;)m けど、ようするに、関数にかかる余計な時間が短縮できる場合がある、ってこと。

インライン関数にするには、関数の先頭に inline を付けます。

  • inline void Flasher::update() {
  •   // 処理....
  • }

が、クラスのメンバ関数の場合、クラスの宣言のなかで定義すれば、自動的にインライン関数になるそうです。

  • class Flasher {
  •   public:
  •     void update() {
  •       // 処理....
  •     }
  • };

マルチタスクのレッスンで使ったスケッチは、インライン関数です。今回俺が作ってきたスケッチは、普通の関数。そんな違いがあります。

レッスンスケッチが、インライン関数を意識していたかどうかは、わかりません。loop() のなかで繰返し実行するためにインライン関数とした、のかもしれませんし、クラス宣言のなかにすべてをまとめるほうが初心者にわかりやすいから、かもしれません。

どちらにしても。俺は当面はスケッチをファイル分割するつもりもないし、関数もクラスの宣言のなかで定義してしまう形のほうが、わかりやすいんじゃないかなと、思っています。

スケッチ – インライン関数

ということで、メンバ関数をクラスの宣言のなかに移動し、インライン関数としたスケッチです。

  1. class Flasher {
  2.   private:
  3.     byte ledPin;
  4.     int onTime;
  5.     int offTime;
  6.     byte ledStat;
  7.     unsigned long prevMillis;
  9.   public:
  10.     Flasher(byte pin, int on, int off) {
  11.       ledPin = pin;
  12.       pinMode(ledPin, OUTPUT);
  13.       onTime = on;
  14.       offTime = off;
  15.       ledStat = LOW;
  16.       prevMillis = 0;
  17.     }
  19.     void update() {
  20.       unsigned long currMillis = millis();
  22.       if((HIGH == ledStat) && (onTime < currMillis - prevMillis)) {
  23.         ledStat = LOW;
  24.         prevMillis = currMillis;
  25.         digitalWrite(ledPin, ledStat);
  26.       }
  27.       else if((LOW == ledStat) && (offTime < currMillis - prevMillis)) {
  28.         ledStat = HIGH;
  29.         prevMillis = currMillis;
  30.         digitalWrite(ledPin, ledStat);
  31.       }
  32.     }
  33. };
  35. Flasher led1(12, 100, 400);
  36. Flasher led2(13, 350, 350);
  38. void setup() {
  39. }
  41. void loop() {
  42.   led1.update();
  43.   led2.update();
  44. }

メンバ関数をクラスの宣言のなかに定義した場合、スコープ解決の Flasher:: をつける必要はありません。が、ついていても問題はありません。また、inline がついていても、問題ないです。

まとめ

先頭に inline がついた関数は、インライン関数です。
インライン関数は、コンパイルした時に呼び出される位置に埋め込まれるので、処理速度が向上する場合があります。でも、埋め込まれるかどうか、向上するかどうかは、コンパイラ任せ、運任せ。

クラスの宣言のなかで定義したメンバ関数は、インライン関数になります。loop() で何回も繰返し実行するスケッチでは、インライン関数のほうが有利じゃね？知らんけど (；´Д｀)

さて、メンバ関数も関数の一種なので、オーバーロードとかデフォルト引数とかポインタを渡すとか、できます。メンバ変数も、定数とか静的変数とか、あります。
いろいろあるけど、クラスを使う方法はこんな感じかな。初めてスケッチをみたときはチンプンカンプンだったけど、わかってくると、使えるんじゃないかなぁ。これから、できるだけ使ってみようかなと。

記事一覧

Arduino で C++クラスを学ぶ (1) – クラスの宣言
Arduino で C++クラスを学ぶ (2) – メンバへのアクセス制限
Arduino で C++クラスを学ぶ (3) – コンストラクタ
Arduino で C++クラスを学ぶ (4) – インライン関数

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