前回は、Arduino のスケッチで、クラスを宣言し利用する手順を学びました。
そしてできたのが、下のスケッチです。2 つの LED が、同時に、独立して L チカ Flash します。
今回はこのスケッチを基にして、クラスのメンバ (変数と関数) のアクセスの制限について、学習します。
メンバへのアクセスの制限
結論を先に言うと、一般に、メンバ変数は private、メンバ関数は public にします。
前回のスケッチでは、メンバ変数は public になっています。なので、クラスの宣言の外である setup() で、メンバ変数へ直接、値を代入できています。でも、クラスではふつう、そのようなことはしません。メンバ変数は private にして、直接には値を代入できないようにします。
じゃ、どうやって値を代入するのか?
public に指定されているメンバ関数を通して代入する方法をとります。クラスの外から不正な値が代入される、といった不具合を防ぐための、クラスのしくみです。
メンバ変数を private に指定してみましょう。
- class Flasher {
- private:
- byte ledPin;
- int onTime;
- int offTime;
- byte ledStat = LOW;
- unsigned long prevMillis = 0;
- public:
- void attach(byte pin);
- void update(int on, int off);
- };
メンバ変数に private の指定を付けました。メンバ関数は public のままです。
メンバ変数の値は、メンバ関数に引数として渡すことができます。attach() にはピン番号 pin を、update() には点灯時間 on と消灯時間 off を渡すことにしましょう。(10〜11行)
残りの変数 ledStat と prevMillis はどうしましょうか?
これらは、ステートマシンの状態を記憶しておくための変数で、ひとつのインスタンスのなかでだけ生きていればよい変数です。そんな子たちは、メンバ変数の定義とともに、初期値を代入してしまいましょ。(6〜7行)
引数を使って値を渡す
メンバ関数の定義です。引数を受け取るように変更しました。
- void Flasher::attach(byte pin) {
- ledPin = pin;
- pinMode(ledPin, OUTPUT);
- }
- void Flasher::update(int on, int off) {
- onTime = on;
- offTime = off;
- unsigned long currMillis = millis();
- if((HIGH == ledStat) && (onTime < currMillis - prevMillis)) {
- ledStat = LOW;
- prevMillis = currMillis;
- digitalWrite(ledPin, ledStat);
- }
- else if((LOW == ledStat) && (offTime < currMillis - prevMillis)) {
- ledStat = HIGH;
- prevMillis = currMillis;
- digitalWrite(ledPin, ledStat);
- }
- }
メンバ関数といっても、普通の関数と同じように、引数で必要な値を渡すことができます。attach() にはピン番号を、update() には点灯時間と消灯時間を渡しています。(14〜15、19〜21行)
その他の部分は、前回と変わりありません。
オブジェクトの生成と利用
オブジェクトの生成を行ないます。これも前回と同じ。(36〜37行)
- Flasher led1;
- Flasher led2;
- void setup() {
- led1.attach(12);
- led2.attach(13);
- }
- void loop() {
- led1.update(100, 400);
- led2.update(350, 350);
- }
メンバ関数 attach() には、LED がつながれたピン番号を引数として与えます。(40〜41行)
同様に update() には、点灯時間 onTime と消灯時間 offTime を与えました。(45〜46行)
前回のスケッチと比べると、setup() のなかがスッキリしましたね。
ちなみに、前回のように setup() 内でメンバ変数に直接、値を代入するようにして、スケッチを書き込みすると、
'byte Flasher::ledPin' is private within this context
って感じで叱られます。外からの代入ができなくなっていることがわかります。
ということで、メンバ変数を private にしたスケッチができました。L チカ Flash は、前回と同様に動作しています。
このように、クラスのなかにメンバ変数、メンバ関数をまとめ、private に指定して、外から変数の値を変更できなくすることを「カプセル化」といいます。
スケッチ – メンバへのアクセスの制限
今回できあがったスケッチです。
- class Flasher {
- private:
- byte ledPin;
- int onTime;
- int offTime;
- byte ledStat = LOW;
- unsigned long prevMillis = 0;
- public:
- void attach(byte pin);
- void update(int on, int off);
- };
- void Flasher::attach(byte pin) {
- ledPin = pin;
- pinMode(ledPin, OUTPUT);
- }
- void Flasher::update(int on, int off) {
- onTime = on;
- offTime = off;
- unsigned long currMillis = millis();
- if((HIGH == ledStat) && (onTime < currMillis - prevMillis)) {
- ledStat = LOW;
- prevMillis = currMillis;
- digitalWrite(ledPin, ledStat);
- }
- else if((LOW == ledStat) && (offTime < currMillis - prevMillis)) {
- ledStat = HIGH;
- prevMillis = currMillis;
- digitalWrite(ledPin, ledStat);
- }
- }
- Flasher led1;
- Flasher led2;
- void setup() {
- led1.attach(12);
- led2.attach(13);
- }
- void loop() {
- led1.update(100, 400);
- led2.update(350, 350);
- }
まとめ
一般に、メンバ変数は private に、メンバ関数は public に指定します。
private: や public: は「アクセス指定子」と呼ばれています。アクセス指定子を省略すると、private になります。
ちなみに、アクセス指定子には、そのほかに protected: というものもあるそうです。
クラスにメンバ変数とメンバ関数をまとめ、メンバ変数を private に指定することで外からメンバ変数にアクセスできなくすることを「カプセル化」といいます。
では次回は、コンストラクタという関数を使って、メンバ変数などを初期化する方法を学びます。