Changeset 1256 for cpp/frams/genetics/genoconv.h

Timestamp:

06/22/23 03:33:58 (22 months ago)

Author:

Maciej Komosinski

Message:

• reasonable field names for enabling converters
• automatically attach converter Param to GenoConvParam?

File:

• cpp/frams/genetics/genoconv.h (modified) (6 diffs)

cpp/frams/genetics/genoconv.h

@@ -1 +1 @@
 // This file is a part of Framsticks SDK.  http://www.framsticks.com/
-// Copyright (C) 1999-2020  Maciej Komosinski and Szymon Ulatowski.
+// Copyright (C) 1999-2023  Maciej Komosinski and Szymon Ulatowski.
 // See LICENSE.txt for details.
 
@@ -8 +8 @@
 #include "geno.h"
 #include <frams/param/param.h>
+#include <frams/param/paramlist.h>
 #include <frams/util/list.h>
 #include <frams/util/sstring.h>
@@ -21 +22 @@
         GenoConvManager *gcm;
         std::vector<std::string> gcnames; //stores names of converters so that these names persist and pointers to these names can be safely used externally
-        char tmp_id[20];
+        char tmp_id[20]; //id() always returns a pointer to this array, filled with the appropriate field id. The root of the problem is that Param functions return char pointers having unspecified lifetime. In contrast, name() returns individual preallocated pointers for individual items, but apparently, id() was too simple to deserve a better but more tedious implementation. Param api will not change, but what could be improved here is perhaps using ParamObject's dynamic paramtab (which did not exist when GenoConvParam was first implemented) so we don't have to care about individual pointers at all.
         void freetab();
 public:
@@ -52 +53 @@
         virtual SString convert(SString &i, MultiMap *map, bool using_checkpoints) = 0;
 
+        /// genoconverter enable/disable fields are named "genoconv_id", where id="f"+input_format+"_f"+output_format by default.
+        /// Converters should implement id() and provide unique value - required when adding more than one converter operating on the same formats.
+        virtual SString id() { return SString("f") + in_format + SString("_f") + out_format; }
+
+        /// Optional user-settable configuration for this converter which automatically gets added to GenoConvParam
+        virtual ParamInterface* getParam() { return NULL; }
+
         virtual ~GenoConverter() {}
         /// Don't forget to set public fields in your constructor
@@ -57 +65 @@
 };
 
-/// This class gathers abilities of all converters and can
-/// convert a genotype to any other one, provided there is
+/// This class gathers abilities of all converters and can convert a genotype to any other one, provided there is
 /// a path of GenoConverters between them.
-/// In most cases you don't use this class directly,
-/// Geno::getConverted(int) provides full converting functionality.
-/// Explicit GenoConvManager object is only needed for registering
-/// your GenoConverter.
+/// In most cases you don't use this class directly, Geno::getConverted(int) provides full converting functionality.
+/// Explicit GenoConvManager object is only needed for registering your GenoConverter.
 /// Use DefaultGenoConvManager to register the standard genotype converters automatically.
 class GenoConvManager
@@ -72 +77 @@
         GenoConvManager();
         ~GenoConvManager();
-        class GenoConvParam param;
+        class GenoConvParam conv_enabling_param;
+        ParamList param;
         /// make a genotype in other format. genotype will be invalid
         /// if GenoConvManager cannot convert it.