Klasser og biblioteker

I dette kapittelet skal vi lage en egen klasse som vi senere kan lage flere objekter ut fra. Vi skal gjøre det i form av et bibliotek, slik at også andre programmerere kan dra nytte av jobben vi gjør. Dette eksempelet viser hvor bra objektorientert programmering er fra et samarbeidsperspektiv. Ved å dokumentere klassene godt (og lage mange åpne/fleksible metoder) kan flere programmerere jobbe parallelt med hver sin del av et større program. 

#ifndef MorsePulse_h
#define MorsePulse_h

#include "Arduino.h"

class MorsePulse {
  public:

  private:
};

#endif

I kildekodefilen begynner vi med å inkludere Arduinos standardfunksjoner og header-filen.

Del 1/6 av MorsePulse.cpp

Vi lager deretter klassens såkalte konstruktør. Konstruktøren er den funksjonen som kjøres når noen lager et nytt objekt av klassen. Konstruktøren skal ha samme navn som klassen, og alle funksjoner som tilhører klassen, skal navngis med klassens navn etterfulgt av dobbelt kolon og funksjonens navn. Konstruktøren skal i vårt tilfelle hete MorsePulse::MorsePulse.

Vår konstruktør skal ha to argumenter (dvs. to attributter som skal angis når et nytt objekt lages):

• hvilken GPIO-pinne som skal brukes
• hvilken morsepulslengde som skal brukes.

GPIO-pinnen lagrer vi i en byte-variabel ved navn ledPin, og hastigheten lagrer vi i en usignert long-variabel ved navn morseSpeed. Vi flytter deretter innholdet i variablene ledPin- og morseSpeed til to nye variabler ved navn _ledPin og _morseSpeed. Grunnen til dette er at vi vil ha tilgang til GPIO-pinnenummeret og morsepulslengden utenfor konstruktøren. Vi kunne ha gitt de nye variablene andre navn, men navngivingskonvensjonene innen APL sier at variablene skal ha samme navn med innledende understrekingstegn.

Del 2/6 av MorsePulse.cpp

Legg merke til at vi ikke har deklarert variablene ennå (og vi kan ikke initiere variabler som ikke har blitt deklarert). Vi hopper derfor tilbake til header-filen (MorsePulse.h) og deklarerer variablene der. Vi kan enten deklarere dem som allmenne variabler eller som private variabler. Disse to variablene skal bare brukes inni MorsePulse-klassen, og vi angir dem derfor som private variabler. MorsePulse-konstruktøren skal derimot være allmenn, slik at den kan kalles opp fra andre skisser.

#ifndef MorsePulse_h
#define MorsePulse_h

#include "Arduino.h"

class MorsePulse {
  public:
    MorsePulse(byte ledPin, unsigned long morseSpeed);

  private:
    byte _ledPin;
    unsigned long _morseSpeed; 
};

#endif

Uferdig version av MorsePulse.h

Tilbake i kildekodefilen (MorsePulse.cpp) er det på tide å lage nye funksjoner. Den ene heter shortPulse og brukes til å utføre et kort blink. Den andre heter longPulse og brukes til å utføre et langt blink. Begge funksjonene har et argument, pulses, som angir hvor mange ganger et kort eller langt blink skal utføres.

Vi bruker variabelen _morseSpeed som referanse for hvor lenge en kort eller lang puls skal være. Hvis _morseSpeed settes til 200 ms, vil et kort blink være 200 ms langt og et langt blink 600 ms langt (_morseSpeed * 3).

Del 3/6 av MorsePulse.cpp

Ifølge morsespråket skal bokstaver atskilles med en pause som tilsvarer tre korte pulser. Hele ord skal skilles med en pause som tilsvarer seks korte pulser. Vi lager derfor to nye funksjoner som gir oss akkurat disse pauselengdene: nextLetter og nextWord.

Del 4/6 av MorsePulse.cpp

Klassens nest siste funksjon gir vi navnet pulseLetter. Den er denne funksjonen som skal oversette alle bokstaver til morsekommandoer. Funksjonen mottar en bokstav som et argument. Deretter går bokstaven gjennom en switch-setning for å finne ut hvilken kombinasjon av morsepulser den tilsvarer. Til slutt kaller vi opp kombinasjoner av shortPulse og longPulse for å få utført blinkingen.

Obs! Du kan laste ned oversettelsen mellom bokstaver og morsekoder fra github.com/kjellcompany. Hvis du skriver av boken (og ikke vil skrive av alt), er det nok å skrive av bokstavene d, e, h, l, o, r, w og mellomrom.

Del 5/6 av MorsePulse.cpp

Klassens siste funksjon gir vi navnet pulseText. Den funksjonen skal dele opp strenger i separate bokstaver og gå gjennom bokstavene etter hverandre via pulseLetter-funksjonen. Siden morse ikke gjør forskjell på små og store bokstaver, begynner vi med å gjøre om alle bokstaver til små bokstaver. Det gjør vi ved å kalle opp metoden toLowerCase. Deretter skriver vi en for-løkke som går gjennom bokstavene i tekststrengen.

Del 6/6 av MorsePulse.cpp

Obs! Legg merke til at text oppfører seg mer som et objekt enn en variabel. Det er fordi String egentlig er en klasse og text er et String-objekt. Text-objektet har blant annet metodene toLowerCase (for å omforme til små bokstaver), length, (for å avgjøre hvor lang strengen er) og charAt (for å få ut tegnet ved en bestemt posisjon).

Alle nye funksjoner må også være med i header-filen. Vi går derfor tilbake til MorsePulse.h-fanen og legger inn funksjonene. PulseLetter og pulseText er to funksjoner som skal kunne kalles opp utenfor selve klassen (allment). Det går imidlertid ikke an å kalle opp shortPulse, longPulse, nextWord eller nextLetter utenfor klassen.

Ferdig versjon av MorsePulse.h

Vi lager en ny nøkkelordfil ved å åpne et valgfritt tekstredigeringsprogram (for eksempel Notisblokk eller Sublime Text) og lage en ny fil ved navn keywords.txt. Deretter skriver vi inn nøkkelordene etterfulgt av et tabulatortegn og enten KEYWORD1 eller KEYWORD2. Alla klasser skal være KEYWORD1, og alle funksjoner skal være KEYWORD2.

MorsePulse     KEYWORD1
pulseText      KEYWORD2
pulseLetter    KEYWORD2

keywords.txt

For at andre programmerere skal kunne bruke biblioteket vårt sender vi med en eksempelfil. Den viser kort og godt hvordan biblioteket kan brukes. Vi skriver derfor en skisse som heter BlinkHelloWorld.ino og gjør akkurat det som navnet antyder: blinker "Hello World" med morsekode.

Vi innleder skissen ved å inkludere MorsePulse-biblioteket (MorsePulse-klassen vår) og lage et nytt MorsePulse-objekt ved navn blinker. Blinker får to attributter: GPIO-pinne 13 og 200 ms. I loop-funksjonen skriver vi deretter at blinker skal blinke teksten "Hello World". Merk at skissen ikke vil fungere før vi har ferdigstilt biblioteket.

// Include the MorsePulse library
#include <MorsePulse.h>

// Create a MorsePulse object on GPIO pin 13 with 200 ms Morse pulses
MorsePulse blinker(13, 200);

void setup() {
  
}

void loop() {

  // Blink "Hello World"
  blinker.pulseText("Hello World");
}

BlinkHelloWorld.ino