[286] | 1 | // This file is a part of Framsticks SDK. http://www.framsticks.com/ |
---|
[635] | 2 | // Copyright (C) 1999-2016 Maciej Komosinski and Szymon Ulatowski. |
---|
[286] | 3 | // See LICENSE.txt for details. |
---|
[109] | 4 | |
---|
| 5 | #ifndef _GENOTYPELOADER_H_ |
---|
| 6 | #define _GENOTYPELOADER_H_ |
---|
| 7 | |
---|
| 8 | #include <frams/util/sstring.h> |
---|
| 9 | #include <frams/param/multiparamload.h> |
---|
| 10 | |
---|
[473] | 11 | /** Defines the association between "org:" object (found in genotype files) |
---|
[635] | 12 | and the MiniGenotype fields. MiniGenotypeLoader uses this definition |
---|
| 13 | but you can also use it to make MultiParamLoader load genotype |
---|
| 14 | */ |
---|
[473] | 15 | extern ParamEntry minigenotype_paramtab[]; |
---|
| 16 | |
---|
[109] | 17 | /** Helper class, mostly useful with MultiParamLoader |
---|
[635] | 18 | or its specialized version: MiniGenotypeLoader. |
---|
| 19 | MiniGenotype stores the subset of Genotype fields (the ones normally saved in .gen files) |
---|
| 20 | */ |
---|
[109] | 21 | class MiniGenotype |
---|
| 22 | { |
---|
| 23 | public: |
---|
[635] | 24 | SString name, genotype, info, uid; |
---|
| 25 | double info_timestamp; |
---|
| 26 | SString info_author, info_email; |
---|
| 27 | paInt info_author_ispublic, info_email_ispublic, info_origin; |
---|
| 28 | SString info_how_created, info_performance; |
---|
| 29 | double energy0, lifespan, velocity, distance, vertvel, vertpos; |
---|
| 30 | paInt numparts, numjoints, numneurons, numconnections, ordnumber, generation, instances, is_valid; |
---|
| 31 | ExtValue user1, user2, user3; |
---|
| 32 | void clear() { Param p(minigenotype_paramtab, this); p.setDefault(); } |
---|
[109] | 33 | }; |
---|
| 34 | |
---|
| 35 | /** In most simple cases this is the class you would use to load a series of genotypes from |
---|
[635] | 36 | the Framsticks genotype file. |
---|
[109] | 37 | |
---|
[635] | 38 | Usage pattern: (see loader_test_geno.cpp for the working code) |
---|
[109] | 39 | |
---|
[635] | 40 | 1.Initialize |
---|
[109] | 41 | |
---|
[635] | 42 | 2.while(genotype=loadNextGenotype()) doSomethingWith(genotype); |
---|
[109] | 43 | |
---|
[635] | 44 | 3.Done! |
---|
[109] | 45 | |
---|
[635] | 46 | MiniGenotypeLoader is simply the MultiParamLoader configured to load one kind of data: "org:" objects. |
---|
| 47 | The instance of this class can also be reconfigured to recognize more objects by using MultiParamLoader |
---|
| 48 | methods, or you can use it as a guide for creating your own specialized class. |
---|
| 49 | */ |
---|
| 50 | class MiniGenotypeLoader : public MultiParamLoader |
---|
[109] | 51 | { |
---|
[635] | 52 | MiniGenotype genotype_object; |
---|
| 53 | Param genotype_param; |
---|
| 54 | bool initialized; |
---|
| 55 | void init(); |
---|
[109] | 56 | public: |
---|
[635] | 57 | MiniGenotypeLoader(); |
---|
| 58 | MiniGenotypeLoader(VirtFILE *f); |
---|
| 59 | MiniGenotypeLoader(const char* filename); |
---|
[109] | 60 | |
---|
[635] | 61 | /** @returns genotype object if one was loaded or NULL otherwise. |
---|
[109] | 62 | |
---|
[635] | 63 | Returned MiniGenotype pointer always references the the same object (MiniGenotypeLoader::genotype_object) |
---|
| 64 | which means you may need to copy the data from it before calling loadNextGenotype() again. |
---|
| 65 | In the default configuration (simple MiniGenotypeLoader) NULL is always final and should be used |
---|
| 66 | to finish processing. |
---|
[109] | 67 | |
---|
[635] | 68 | If the loader is configured to load other objects or stop on other conditions, NULL will also mean |
---|
| 69 | every condition other than "GenotypeLoaded". In such cases you need MultiParamLoader::getStatus(), |
---|
| 70 | MultiParamLoader::finished() and other methods to determine the real cause of NULL. |
---|
| 71 | */ |
---|
| 72 | MiniGenotype* loadNextGenotype(); |
---|
[109] | 73 | }; |
---|
| 74 | |
---|
| 75 | #endif |
---|