OHJ-7400 Graafisen käyttöliittymän ohjelmointi, syksy 2011 Harjoitustyöohje (teknologiapuueditori) Päivityshistoria: 31.10.2011 Rekisteriin kirjoittaminen kielletty, luvattu, että testimateriaalissa resurssi- ja kategoriatunnisteet ovat ei-negatiivisia kokonaislukuja. 20.10.2011 Luvattu, että testaukseen käytettävät settings.conf-tiedostot sisältävät vain ASCIImerkkejä. 20.9.2011 Yksittäiseen TI:iin voi liittyä max. 30 resurssityyppiä. Lisätty selvennys resurssien luomista koskien. 19.9.2011 Lisätty vaatimus työtuntien kirjaamisesta välipal.dokumenttiin (luokkakaaviopaperiin). 12.9.2011 Ensimmäinen versio ohjeesta julkaistu. Yleistä Harjoitustyön, jota tämä ohje koskee, läpäisy on pakollinen osa kurssin suoritusta. (Kurssin läpäisemiseksi neljällä opintopisteellä vaaditaan tämän harjoitustyön lisäksi tentin hyväksytty suoritus.) Työssä ohjelmoidaan tämän työohjeen mukainen ohjelma Qt 4.7.4:llä käyttäen kehitysympäristönä Qt Creatoria. Harjoitustyö tehdään enintään kahden hengen ryhmissä. Yksin saa tehdä, mutta parityö on suositeltavaa. Ryhmän muodostus tapahtuu ilmoittamalla ryhmän tiedot kurssin kotisivuilta löytyvällä seittilomakkeella. Ryhmän muodostamiselle ei ole määrätty takaraja-ajankohtaa, mutta ilmoittautumisen yhteydessä generoitavaa ryhmätunnusta tarvitaan muun muassa välipalautusajan varaamiseen. Välipalautus Harjoitustyön alkuvaiheessa ohjelmoidaan käyttöliittymän prototyyppi, josta tulee käydä ilmi pääikkunan valikoiden sisällöt ja layout, ja laaditaan suunnitellun ohjelman rakenteesta luokkakaavio. Välipalautustilaisuudessa, jossa prototyyppi ja kaavio esitellään assistentille, käyminen on pakollinen osa harjoitustyön suoritusta. Välipalautukseen on varattu aikaa vain 10 minuuttia ryhmää kohti, joten huolehtikaa, että ohjelmanne on käyttövalmiina ja luokkakaavio paperille tulostettuna tai piirrettynä (kerätään pois) aikanne alkaessa. Luokkakaaviopaperiin tulee olla merkitty ryhmätunnus ja ryhmän jäsenten yhteenlaskettu harjoitustyön tekemiseen käytetty työtuntimäärä välipalautustilaisuuteen mennessä (sisältäen työohjeeseen tutustumisen, suunnittelun, luokkakaavion laatimisen ja prototyypin koodaustyön). Välipalautustilaisuudet järjestetään viikolla 41 (12.10. 14.10.). Etukäteisilmoittautuminen tapahtuu ilmoitustaululla (TC-käytävällä, TC205:n ja TC207:n välissä) olevaan listaan ryhmätunnuksella. Lista kerätään pois johonkin aikaan lauantaina 8.10. Tämä on siis takaraja ilmoittautumiselle. Mikäli ilmoittautua yrittäessänne kaikki jäljellä olevat ajat ovat täysin mahdottomia ryhmällenne, lähettäkää sähköpostia asiaa koskien osoitteeseen grako@cs.tut.fi (hyväksyy postin vain @tut.fi-osoitteista), niin yritämme järjestää ylimääräisen ajan alkuviikosta. Tällaisen sähköpostiviestin tulee olla perillä viimeistään pe 7.10. klo 12.00, muussa tapauksessa välipalautus hylätään. Ensisijaisesti käyttäkää listassa tarjottuja aikoja, mikäli mahdollista.
Välipalautukset arvostellaan asteikolla hyväksytty/hylätty. Mikäli suoritus hylätään, ryhmä voi jatkaa kurssilla, mutta harjoitustyön arvosana laskee yhdellä. Välipalautus hylätään, jos kaikkia vaatimuksia ei ole toteutettu, ryhmä ei ilmesty ajoissa paikalle tai jos assistentti katsoo ryhmän työn muuten riittämättömäksi. Koko ryhmän tulee pääsääntöisesti olla läsnä välipalautuksessa. Painavasta syystä tästä voidaan poiketa, mutta asiasta tulee sopia etukäteen. Välipalautustilaisuudessa tulee painaa mieleen assistentti, koska lopulliset palautukset tehdään samalle henkilölle. Koska työn tekemiseen kannattaa varata oikeasti reilusti aikaa ja aloittaa koodaaminen varhain, välipalautuksesta voi saada pelkän hyväksynnän lisäksi työn lopulliseen arvosteluun vaikuttavan bonuspisteen, mikäli esiteltävä toiminnallisuus ylittää selvästi minimivaatimukset. Harjoitustyön lopullinen palautus Harjoitustyön lopullisen version tulee olla palautettuna (perillä) viimeistään 18.11.2011 klo 12.00. Palautus tapahtuu sähköpostitse. Lähdekoodit pakataan zip-tiedostoon ja palautetaan näin syntynyt paketti liitetiedostona joko osoitteeseen teemu.heinimaki@tut.fi tai janne.lautamaki@tut.fi riippuen välipalautuksenne vastaanottaneesta assistentista. Paketin nimeksi annetaan ryhmätunnus. (Esim. 4.zip on siis (ainoa) validi palautuspaketin nimi ryhmälle 4.) Paketin koon tulisi olla alle 500 KB poistakaa siis turhat objektitiedostot yms. ennen paketointia. Projektitiedosto (.pro) ei ole tarkastuksen kannalta turha, joten se tulee luonnollisesti löytyä. Samasta hakemistosta sen kanssa tulee löytyä readme.txt-niminen tekstitiedosto, johon ryhmä voi tarpeelliseksi katsoessaan dokumentoida oleellisia asioita toteutuksestaan sekä antaa rakentavaa palautetta harjoitustyöstä. Palautussähköpostin otsikon (subject) tulee olla Grako, palautus 1, ryhma X, jossa X on korvattu ryhmätunnuksella. Sähköpostin varsinaiseen viestiosaan voi halutessaan kirjoitella terveisiä, mutta se ei ole välttämätöntä. (Mahdollisen oleellisen dokumentaation tosiaan tulee siis löytyä readme.txt:stä.) Arvostelu Harjoitustyö arvostellaan asteikolla 0 5. Arvosana 0 tarkoittaa hylättyä työtä, jollaisen tapauksessa ryhmälle annetaan tilaisuus korjata työnsä määräajassa ja saada näin se hyväksytyksi arvosanalla 1. Tosin assistenttien niin päättäessä työ voidaan hylätä myös suoraan ilman korjausmahdollisuutta. Arvostelussa kiinnitetään huomiota muiden muassa seuraaviin seikkoihin: Tunnollisuus tehtävänannon vaatimusten toteuttamisessa, Täsmällisyys ja ohjeiden seuraaminen palautettaessa, Ohjelman toiminnan virheettömyys (testiympäristössä), virhetilanteisiin varautuminen, Ohjelman (koodin) rakenne, Ohjelman käytettävyys, Välipalautusvaiheessa palautettu luokkakaavio (+ mahdollinen välipalautusbonus), Koodin luettavuus (kommentointi jne.) ja Toteutuksen tehokkuus (erityisiä optimointitarpeita ei pitäisi olla, mutta ohjelman tulee toimia sujuvasti testattaessa). Kopiointi ja lähdemateriaalin käyttö Harjoitustyöstä saa keskustella periaatteellista tarkemmalla tasolla vain ryhmän sisäisesti. Kaikki koodin luovuttaminen toisen ryhmän käyttöön on ehdottomasti kiellettyä toimintaa. Kirjallisuuden ja verkkolähteiden tutkiminen on sallittua ja suotavaakin, mutta näidenkään tapauksessa suoraa kopiointia ei hyväksytä.
Muuta Tämä työohje jättää tahallaan ottamatta kantaa moniin asioihin, jotta harjoitustyötä tehdessään pääsisi toteuttamaan itseään ja joutuisi miettimään erilaisia ratkaisuvaihtoehtoja. Ideana on, että asiat, joihin ei löydy selvää vastausta tästä työohjeesta, saa toteuttaa haluamallaan tavalla. Kannattaa kuitenkin muistaa, että tarkoitus on saada aikaan järkevä ohjelma siistillä ja käytettävällä käyttöliittymällä. On kuitenkin täysin mahdollista, että jokin tärkeä asia, johon työohjeen olisi tarkoitus ottaa kantaa, on jäänyt epähuomiossa speksaamatta. Mikäli epäilette moista, ottakaa ihmeessä yhteyttä ( grako@cs.tut.fi), jotta tällaiset virheet saadaan korjattua mielellään mahdollisimman aikaisessa vaiheessa. Sinänsä sillä, missä ohjelma kehitetään, ei ole väliä. Palautetun version tulee kuitenkin toimia luokan TC205 ympäristöä vastaavassa ympäristössä, jollaisessa testaus suoritetaan. Kannattaa siis varata aikaa asian testaamiseen ennen palautusta, jos koodaa muualla. Käyttöliittymän tulisi olla niin intuitiivinen, että asiaan perehtymätönkin osaisi käyttää ohjelmaa ja löytäisi kaikki oleelliset toiminnot vaivatta. Tarkastajienkin siis tulee osata käyttää ohjelmaa jo ennen lähdekoodien tutkimista.
Halutun ohjelman kuvaus ja vaatimukset Tässä harjoitustyössä toteutetaan editori teknologiapuiden 1 suunnitteluun, muokkaamiseen ja tallentamiseen. Ohjelmassa tulee olla pääikkuna, jossa keskeisenä elementtinä on työskentelyalue teknologiapuiden käsittelemistä varten. Työskentelyalueen koon tulee olla vähintään 5000 x 5000 pikseliä. (Koko alueen ei tarvitse mahtua näyttöön samanaikaisesti.) Pääikkunan kokoa tulee voida muuttaa. Ohjelman tulee olla käyttökelpoinen 1024 x 600 pikselin näytöllä, mutta pääasiallisen käytön voi olettaa tapahtuvan vähintään 1280 x 1024 pikselin näyttökoolla. Pääikkunan tulee avautua samaan paikkaan ja saman kokoisena kuin se oli edellisellä kerralla ohjelmaa suljettaessa. Resurssit Teknologian kehittäminen voi vaatia esitietoteknologioiden lisäksi resursseja, kuten rahaa, aikaa, tikkuja, mutaa tms. Toteutettavassa ohjelmassa resurssit esitetään sanoin ja kuvin, ts. resurssilla on nimi ja havainnollistava kuva. Editoria käynnistettäessä käytettäviksi tulevat resurssit tulee ladata alustustekstitiedostosta settings.conf, jonka tulee sijaita työskentelyhakemistossa, jonka puolestaan voi olettaa olevan projektitiedoston sisältävä hakemisto. Tiedostossa tulee olla resurssit määriteltyinä seuraavaa esimerkkiä vastaavasti. (Resources-ryhmän nimi ja käytetty formaatti pitää siis säilyttää, itse resurssit voivat vaihdella.) Tiedoston voi olettaa sisältävän vain ASCII-merkkejä, joten merkistökoodauksia ei erityisesti tarvitse miettiä. [Resources] 926\image=graphics/general_resource.png 926\name=Mud 927\image=graphics/money_resource.png 927\name=Money 928\image=graphics/time_resource.png 928\name=Time Rivit aloittavat luvut ovat resurssit yksilöiviä resurssitunnisteita, joita voi hyödyntää hyväksi katsomallaan tavalla (tai olla hyödyntämättä, jos ei katso tarpeelliseksi). Aliavaimella image viitataan (suhteelliseen) tiedostopolkuun, josta ladataan resurssille kuva, ja aliavaimella name viitataan resurssin nimeen. Ohjelman käynnistyessä siis oletusresurssit ladataan tiedostosta, mutta jotta ohjelman käyttäjän ei tarvitsisi aina käydä käsin editoimassa tiedostoa halutessaan käyttää oletuksesta poikkeavaa resurssivalikoimaa, ohjelman tulee mahdollistaa käytössä olevien resurssien lisääminen, muokkaaminen ja poistaminen graafisen käyttöliittymän kautta. Käytössä oleva resurssivalikoima tulee voida tallentaa oletukseksi (alustustiedostoon), mutta tallennuksen ei tule tapahtua automaattisesti (esim. ohjelmaa suljettaessa). (Selvennys: uusien, alustustiedostossa määrittelemättömienkin resurssien lisäyksen tulee siis onnistua. Kuvankäsittelytoiminnallisuutta resurssikuvan luomiseksi tai muokkaamiseksi ei kuitenkaan tarvitse välttämättä toteuttaa, vaan kuvankäsittelyssä voi halutessaan tukeutua ulkoisiin ohjelmiin.) 1 Tässä ohjeessa puhutaan teknologiapuista tarkoittaen riippuvuusgraafeja, joiden ei täsmällisesti ottaen tarvitse olla rakenteeltaan puita, vaan periaatteessa ne voivat olla mielivaltaisia digraafeja, joiden solmut vastaavat teknologioita ja kaaret kertovat, mistä teknologiasta voidaan edetä mihinkin (tietyillä edellytyksillä). Myös käsite teknologia tulkitaan tässä ohjeessa varsin laajasti. Työn kannalta sillä, mitä pidetään teknologiana, ei ole merkitystä.
Teknologiaelementit Ohjelman käyttäjän tulee voida luoda teknologioita kuvaavia teknologiaelementtejä (tech item, TI). Ne voidaan tulkita riippuvuusgraafin solmuiksi täydennettyinä lisäinformaatiolla. TI:t tulee esittää graafisesti editorin työskentelyalueella. Jokaisella TI:llä on nimi, joka kuvaa teknologiaa, kategoria (ks. luku Kategoriat) ja tiedot siitä, kuinka paljon mitäkin resurssia kyseisen teknologian kehittämiseen tarvitaan. Luomisen lisäksi TI:ejä tulee voida siirrellä paikasta toiseen ja poistaa. TI:ien nimien, kategorioiden ja resurssimäärien tulee olla muokattavissa myös luomisen jälkeen. Jokaiseen TI:iin voi olettaa liittyvän korkeintaan 30 eri resurssityyppiä. (Tyypillinen määrä on kuitenkin huomattavasti pienempi, mikä kannattaa huomioida TI:n graafista esitystä suunniteltaessa.) Resurssimäärien (siis yksittäisiä resursseja TI-kohtaisesti määrittävien lukujen) tulee voida liikkua kokonaislukuarvoalueella [0,X], jossa X on vähintään 99. Kategoriat Teknologia kuuluu johonkin teknologiakategoriaan. Jokaisella kategorialla on nimi ja tunnusomainen väri, jota tulee käyttää helpottamaan eri kategorioihin kuuluvien teknologioiden erottamista toisistaan. Ts. teknologiaelementtien graafisten esitysten taustaväreinä voidaan käyttää vastaavia kategoriavärejä, tai niihin voidaan piirtää kyseisen väriset tunnuskuviot, reunukset tms. Editoria käynnistettäessä käytettäviksi tulevat kategoriat tulee ladata samasta tiedostosta, josta myös resurssit luetaan (settings.conf). Kategoriat määritellään seuraavan esimerkin mukaisesti. (Categories-ryhmän nimi ja käytetty formaatti pitää siis säilyttää, itse kategoriat voivat vaihdella.) [Categories] 756\color=150, 150, 150 756\name=General 757\color=100, 100, 255 757\name=Economic 758\color=255, 100, 100 758\name=Military 759\color=100, 255, 100 759\name=Cultural 760\color=255, 170, 255 760\name=Stupid Rivin aloittavat luvut on kategoriat yksilöiviä kategoriatunnisteita, joita voi hyödyntää hyväksi katsomallaan tavalla. Aliavaimella color viitataan kategorian tunnusväriin, ja yhtäsuuruusmerkin oikealla puolella näillä riveillä luetellaan värin RGB-komponentit (vastaavassa järjestyksessä). Aliavaimella name puolestaan viitataan kategorian nimeen. Kategorioita pitää pystyä lisäämään, muokkaamaan, poistamaan ja tallentamaan vallitseva tilanne oletukseksi vastaavasti kuin resursseja koskien määrättiin. Kategoriatunnisteet tulevat olemaan testimateriaalissa järjellisen kokoisia, einegatiivisia kokonaislukuja. Muitakin tunnistetyyppejä saa toki halutessaan tukea. Sama pätee resurssitunnisteisiin. (Samaa lukua saatetaan käyttää niin resurssi- kuin kategoriatunnisteenakin.)
Riippuvuudet TI:ejä tulee voida yhdistellä toisiinsa erilaisia riippuvuuksia kuvaavilla suunnatuilla kaarilla, jotka tulee myös esittää graafisesti. Riippuvuuskaaria tulee olla ainakin neljää eri tyyppiä, jotka tulee olla visuaalisesti toisistaan erotettavissa. Tyyppien semantiikalla ei tämän työn kannalta ole merkitystä. Ehkä vain harvoin on tarkoituksenmukaista olla useita samantyyppisiä riippuvuuskaaria samaan suuntaan samojen TI:ien välillä, joten halutessaan samantyyppisten kaarten multiplisiteetin voi rajoittaa joukkoon {0,1}, mutta erityyppiset kaaret eivät saa sulkea toisiaan pois. Luodut riippuvuudet tulee myös olla poistettavissa ja niiden tyypit muutettavissa. Muita vaatimuksia ja rajoituksia Käyttöliittymän tulee sisältää vähintään Apua -valikko ( Help käy myös, jos se soveltuu paremmin käyttöliittymän kielipolitiikkaan), jonka kautta saa tehtyä valinnan Tietoja... ( About... ). Tällä tavalla tulee saada auki modaalinen dialogi, josta käy ilmi harjoitustyöryhmätunnus ryhmän jäsenten nimet, sähköpostiosoitteet ja opiskelijanumerot sekä ryhmän työn tekemiseen käyttämä kokonaistuntimäärä. 2 TI:t tulee voida sijoittaa hiiren avulla suoraan haluttuihin paikkoihin kartalle. Siirtelynkin tulee onnistua hiirellä raahaamalla. Windowsin rekisteriin ei saa kirjoittaa. TI:ien ominaisuuksia (vähintään nimi, kategoria ja vaaditut resurssimäärät) tulee voida tarkastella taulukkomuodossa (rivi/ti) ja TI:t tulee voida järjestää taulukossa halutun ominaisuuden määräämään järjestykseen. Muokattava teknologiapuu pitää pystyä tallentamaan tiedostoon ja lataamaan sieltä. Teknologiapuu pitää myös voida exportata PNG-kuvaksi niin, että kuva rajautuu tarvittavan minimitilan kokoiseksi (skaalaamatta, näyttöpikselin vastatessa kuvapikseliä) + 10 15 pikselin marginaalit joka puolelle. 2 Tuntimäärä ei vaikuta arvosanaan (ellei puutu), vaan tarkoitus on kerätä mahdollisimman oikeellista dataa sen arvioimiseksi, kuinka hyvin työn mitoitus onnistui. Vastatkaa siis mahdollisimman rehellisesti ja tarkasti.
Esimerkki Työskentelyalue voisi näyttää esimerkiksi kuvan 1 esittämän kaltaiselta. Kuva 1: Esimerkki työskentelyalueen osan graafisesta esityksestä.