ModelParamDual.h

Go to the documentation of this file.

#if  !defined(_MODELPARAMDUAL_)
#define  _MODELPARAMDUAL_


#include  "ModelParam.h"


namespace KKMLL
{
  /**
   *@class  KKMLL::ModelParamDual
   ************************************************************************************************
   *                          Parameters used for the Dual Classifier.                            *
   ************************************************************************************************
   *@see  Model
   */
  class  ModelParamDual: public  ModelParam
  {
  public:
    typedef  ModelParamDual*  ModelParamDualPtr;

    enum class  ProbFusionMethod
    {
      Null,
      Or,
      And
    };


    ModelParamDual  ();

    ModelParamDual  (const KKStr&  _configFileName1,
                     const KKStr&  _configFileName2,
                     bool          _fullHierarchyMustMatch
                    );

    ModelParamDual  (const ModelParamDual&  _param);

    virtual
    ~ModelParamDual  ();

    static
      ProbFusionMethod  ProbFusionMethodFromStr (const KKStr& s);

    static
      KKStr  ProbFusionMethodToStr (ProbFusionMethod  pfm);


    const KKStr&  ConfigFileName1        () const {return configFileName1;}
    const KKStr&  ConfigFileName2        () const {return configFileName2;}
    bool          FullHierarchyMustMatch () const {return fullHierarchyMustMatch;}
    MLClassPtr    OtherClass             () const {return otherClass;}

    virtual ModelParamTypes  ModelParamType () const {return ModelParamTypes::Dual;}

    void  OtherClass (MLClassPtr  _otherClass)  {otherClass = _otherClass;}

    virtual
    ModelParamDualPtr  Duplicate () const;


    /**
     *@brief Creates a Command Line String that represents these parameters.
     *@details  All derived classes should implement this method.  They should first call this method and
     *          then append there own parameters that are specific to their implementation.
     */
    virtual
    KKStr   ToCmdLineStr ()  const;


    virtual  void  ReadXML (XmlStream&      s,
                            XmlTagConstPtr  tag,
                            VolConstBool&   cancelFlag,
                            RunLog&         log
                           );


    virtual  void  WriteXML (const KKStr&  varName,
                             ostream&      o
                            )  const;


  private:
    virtual
    void   ParseCmdLinePost (RunLog&  log);  // Will get called after the entire parameter string has been processed.

    virtual
    void  ParseCmdLineParameter (const KKStr&  parameter,
                                 const KKStr&  value,
                                 bool&         parameterUsed,
                                 RunLog&       log
                                );

    KKStr             configFileName1;
    KKStr             configFileName2;
    bool              fullHierarchyMustMatch;
    MLClassPtr        otherClass;
    ProbFusionMethod  probFusionMethod;
  };  /* ModelParamDual */


  typedef  ModelParamDual::ModelParamDualPtr   ModelParamDualPtr;

  typedef  XmlElementModelParamTemplate<ModelParamDual>  XmlElementModelParamDual;
  typedef  XmlElementModelParamDual*  XmlElementModelParamDualPtr;

}  /* namespace KKMLL */



#endif