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

Timestamp:

03/01/14 22:05:02 (11 years ago)

Author:

sz

Message:

Warn against missing converter, convert() caller can differentiate between conversion failure and missing converter.

File:

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

cpp/frams/genetics/genoconv.h

@@ -17 +17 @@
 class GenoConvManager;
 
-class GenoConvParam: public Param
+class GenoConvParam : public Param
 {
-GenoConvManager *gcm;
-std::vector<std::string> gcnames;
-char tmp_id[20];
-void freetab();
+        GenoConvManager *gcm;
+        std::vector<std::string> gcnames;
+        char tmp_id[20];
+        void freetab();
 public:
-GenoConvParam(GenoConvManager *g);
-~GenoConvParam();
-void *getTarget(int);
-const char* id(int i);
-void updatetab();
+        GenoConvParam(GenoConvManager *g);
+        ~GenoConvParam();
+        void *getTarget(int);
+        const char* id(int i);
+        void updatetab();
 };
 
@@ -42 +42 @@
 {
 public:
-const char *name;       //< converter name (short)
-char in_format,         //< input format, eg. '1'
-        out_format;     //< output format, eg. '0'
-const char *info;       //< detailed info about converter, format or copyright
-long enabled;   //< don't touch this! (used by configuration module)
-long mapsupport; //< set to 1 if your converter supports genotype mapping
+        const char *name;       //< converter name (short)
+        char in_format,         //< input format, eg. '1'
+                out_format;     //< output format, eg. '0'
+        const char *info;       //< detailed info about converter, format or copyright
+        long enabled;   //< don't touch this! (used by configuration module)
+        long mapsupport; //< set to 1 if your converter supports genotype mapping
 
-/// You have to reimplement this method.
-/// If your converter cannot do its job, return empty string
-/// (return SString();), any other return value is assumed
-/// to be output genotype.
-/// @param map if not null, mapping informaton is requested, converter should add conversion map to this object
-virtual SString convert(SString &i,MultiMap *map) {return SString();}
+        /// You have to reimplement this method.
+        /// If your converter cannot do its job, return empty string
+        /// (return SString();), any other return value is assumed
+        /// to be output genotype.
+        /// @param map if not null, mapping informaton is requested, converter should add conversion map to this object
+        virtual SString convert(SString &i, MultiMap *map) { return SString(); }
 
-virtual ~GenoConverter() {}
-/// Don't forget to set public fields in your constructor
-GenoConverter():name(""),in_format(-1),out_format('0'),info(""),enabled(1),mapsupport(0) {}
+        virtual ~GenoConverter() {}
+        /// Don't forget to set public fields in your constructor
+        GenoConverter() :name(""), in_format(-1), out_format('0'), info(""), enabled(1), mapsupport(0) {}
 };
 
@@ -71 +71 @@
 class GenoConvManager
 {
-friend class GenoConvParam;
-SList converters;
+        friend class GenoConvParam;
+        SList converters;
 public:
-GenoConvManager();
-~GenoConvManager();
-class GenoConvParam param;
-/// make a genotype in other format. genotype will be invalid
-/// if GenoConvManager cannot convert it.
-Geno convert(Geno &in,char format,MultiMap *map=0);
-/// register GenoConverter, the added object will be automatically deleted when GenoConvManager is destructed (call removeConverter() if this is not desirable)
-void addConverter(GenoConverter *conv);
-/// unregister GenoConverter
-void removeConverter(GenoConverter *conv);
+        GenoConvManager();
+        ~GenoConvManager();
+        class GenoConvParam param;
+        /// make a genotype in other format. genotype will be invalid
+        /// if GenoConvManager cannot convert it.
+        Geno convert(Geno &in, char format, MultiMap *map = 0, bool *converter_missing = NULL);
+        /// register GenoConverter, the added object will be automatically deleted when GenoConvManager is destructed (call removeConverter() if this is not desirable)
+        void addConverter(GenoConverter *conv);
+        /// unregister GenoConverter
+        void removeConverter(GenoConverter *conv);
 
-char *getPath(char in,char out,char *path,int maxlen,int *mapavailable=0);
-char *getFormatPath(char in,char out,char *path,int maxlen,int *mapavailable=0);
-/// returns the list of converters meeting the specified criteria
-/// pass result=0 if you only need one result (by return value)
-/// default criteria values mean "don't care", pass anything else to narrow your search
-GenoConverter *findConverters(SListTempl<GenoConverter*>* result=0,char in=-1,char out=-1,int enabled=-1,char* name=0);
+        char *getPath(char in, char out, char *path, int maxlen, int *mapavailable = 0);
+        char *getFormatPath(char in, char out, char *path, int maxlen, int *mapavailable = 0);
+        /// returns the list of converters meeting the specified criteria
+        /// pass result=0 if you only need one result (by return value)
+        /// default criteria values mean "don't care", pass anything else to narrow your search
+        GenoConverter *findConverters(SListTempl<GenoConverter*>* result = 0, char in = -1, char out = -1, int enabled = -1, char* name = 0);
 };
 
 #endif
-
-