optionDescription.h

Go to the documentation of this file.

#ifndef _DLRUTILITIES_OPTIONDESCRIPTION_H_
#define _DLRUTILITIES_OPTIONDESCRIPTION_H_

#include <ostream>
#include <string>

namespace dlr {

  namespace utilities {
    
    class OptionDescription {
    public:

      OptionDescription();

      
      OptionDescription(const std::string& name,
                        const std::string& shortAppearance,
                        const std::string& longAppearance,
                        bool requiresValue,
                        bool allowPartialMatch,
                        const std::string& docString,
                        const std::string& defaultValue = "");

      
      ~OptionDescription();


      const std::string&
      getDefaultValue() const {return m_defaultValue;}

      
      const std::string&
      getName() const {return m_name;}


      size_t
      getMatchLength(const std::string& argument,
                     bool& isShortMatch) const;

      
      std::string
      getOptionDoc() const;
      

      bool
      isMatch(const std::string& argument) const;
      
      
      bool
      requiresValue() const {return m_requiresValue;}

    private:

      std::string m_name;
      std::string m_shortAppearance;
      std::string m_longAppearance;
      bool m_requiresValue;
      bool m_allowPartialMatch;
      std::string m_docString;
      std::string m_defaultValue;
    };


    std::ostream&
    operator<<(std::ostream& stream,
               const OptionDescription& optionDescription);

    
  } // namespace utilities

} // namespace dlr

#endif // #ifndef _DLRUTILITES_OPTIONDESCRIPTION_H_

---