CoinParam.hpp

Go to the documentation of this file.

/* $Id: CoinParam.hpp 2083 2019-01-06 19:38:09Z unxusr $ */
#ifndef CoinParam_H
#define CoinParam_H

/*
  Copyright (C) 2002, International Business Machines
  Corporation and others.  All Rights Reserved.

  This code is licensed under the terms of the Eclipse Public License (EPL).
*/

#include <vector>
#include <string>
#include <cstdio>

class CoinParam {

public:

  typedef enum { coinParamInvalid = 0,
    coinParamAct,
    coinParamInt,
    coinParamDbl,
    coinParamStr,
    coinParamKwd } CoinParamType;

  typedef int (*CoinParamFunc)(CoinParam *param);



  CoinParam();

  CoinParam(std::string name, std::string help,
    double lower, double upper, double dflt = 0.0,
    bool display = true);

  CoinParam(std::string name, std::string help,
    int lower, int upper, int dflt = 0,
    bool display = true);

  CoinParam(std::string name, std::string help,
    std::string firstValue, int dflt, bool display = true);

  CoinParam(std::string name, std::string help,
    std::string dflt, bool display = true);

  CoinParam(std::string name, std::string help,
    bool display = true);

  CoinParam(const CoinParam &orig);

  virtual CoinParam *clone();

  CoinParam &operator=(const CoinParam &rhs);

  virtual ~CoinParam();



  void appendKwd(std::string kwd);

  int kwdIndex(std::string kwd) const;

  std::string kwdVal() const;

  void setKwdVal(int value, bool printIt = false);

  void setKwdVal(const std::string value);

  void printKwds() const;

  void setStrVal(std::string value);

  std::string strVal() const;

  void setDblVal(double value);

  double dblVal() const;

  void setIntVal(int value);

  int intVal() const;

  inline void setShortHelp(const std::string help) { shortHelp_ = help; }

  inline std::string shortHelp() const { return (shortHelp_); }

  inline void setLongHelp(const std::string help) { longHelp_ = help; }

  inline std::string longHelp() const { return (longHelp_); }

  void printLongHelp() const;



  inline CoinParamType type() const { return (type_); }

  inline void setType(CoinParamType type) { type_ = type; }

  inline std::string name() const { return (name_); }

  inline void setName(std::string name)
  {
    name_ = name;
    processName();
  }

  int matches(std::string input) const;

  std::string matchName() const;

  inline void setDisplay(bool display) { display_ = display; }

  inline bool display() const { return (display_); }

  inline CoinParamFunc pushFunc() { return (pushFunc_); }

  inline void setPushFunc(CoinParamFunc func) { pushFunc_ = func; }

  inline CoinParamFunc pullFunc() { return (pullFunc_); }

  inline void setPullFunc(CoinParamFunc func) { pullFunc_ = func; }


private:

  void processName();


  CoinParamType type_;

  std::string name_;

  size_t lengthName_;

  size_t lengthMatch_;

  double lowerDblValue_;

  double upperDblValue_;

  double dblValue_;

  int lowerIntValue_;

  int upperIntValue_;

  int intValue_;

  std::string strValue_;

  std::vector< std::string > definedKwds_;

  int currentKwd_;

  CoinParamFunc pushFunc_;

  CoinParamFunc pullFunc_;

  std::string shortHelp_;

  std::string longHelp_;

  bool display_;
};

typedef std::vector< CoinParam * > CoinParamVec;

std::ostream &operator<<(std::ostream &s, const CoinParam &param);

/*
  Bring in the utility functions for parameter handling (CbcParamUtils).
*/

namespace CoinParamUtils {
void setInputSrc(FILE *src);

bool isCommandLine();

bool isInteractive();

std::string getStringField(int argc, const char *argv[], int *valid);

int getIntField(int argc, const char *argv[], int *valid);

double getDoubleField(int argc, const char *argv[], int *valid);

int matchParam(const CoinParamVec &paramVec, std::string name,
  int &matchNdx, int &shortCnt);

std::string getCommand(int argc, const char *argv[],
  const std::string prompt, std::string *pfx = 0);

int lookupParam(std::string name, CoinParamVec &paramVec,
  int *matchCnt = 0, int *shortCnt = 0, int *queryCnt = 0);

void printIt(const char *msg);

void shortOrHelpOne(CoinParamVec &paramVec, int matchNdx, std::string name, int numQuery);

void shortOrHelpMany(CoinParamVec &paramVec,
  std::string name, int numQuery);

void printGenericHelp();

void printHelp(CoinParamVec &paramVec, int firstParam, int lastParam,
  std::string prefix,
  bool shortHelp, bool longHelp, bool hidden);
}

#endif /* CoinParam_H */

/* vi: softtabstop=2 shiftwidth=2 expandtab tabstop=2
*/