Documentation improvements.

[command.git] / include / parameter.h

diff --git a/include/parameter.h b/include/parameter.h
index e55a2d1e248c2fe3541fb3395177a52691c33dee..443111dbd4d0de120589ac9311a1d8d9008b57ff 100644 (file)
--- a/include/parameter.h
+++ b/include/parameter.h
@@ -8,15 +8,16 @@
 
 namespace command {
     /**
-     * Class responsible for handling commandline arguments.
-     * Arguments are required,x non-named parameters of program.
+     * Base class for all the Arguments and Options.
      *
      * Example:
      *  ./myprog ARGUMENT
      */
     class Parameter : public Descriptive {
     protected:
-        std:string userValue;
+        /** Variable indicating if current Parameter was already used or not */
+        bool used = false;
+
     public:
         typedef class Parameter Type;
         /**
@@ -24,15 +25,43 @@ namespace command {
          *
          * @param description Description of current Argument
          */
-        Parameter(std::string description)
+        Parameter(const std::string & description)
             : Descriptive(description) {
         }
-        virtual ~Parameter() {}
 
+        virtual ~Parameter() { }
+
+        /**
+         * Method used for handling method calls linked with this Parameter
+         */
         virtual void handle() = 0;
 
-        virtual void passUserValue(std::string argVal) {
-            userValue = argVal;
+        /**
+         * Method used for checking if the given user value understandable for
+         * parameter.
+         *
+         * @return true if passed value is understandable by current Parameter.
+         *      False otherwise.
+         */
+        virtual bool understand(const std::string & ) = 0;
+
+        /**
+         * Indicates if current Parameter is required
+         *
+         * @return false, as all Parameters are non-required by default. If you
+         *      want to make Parameter as required, wrap it using Required class
+         */
+        virtual bool isRequired() {
+            return false;
+        };
+
+        /**
+         * Indicates if current Parameter has been already used
+         *
+         * @return true if current Parameter has been already used. False otherwise.
+         */
+        virtual bool isUsed() {
+            return used;
         }
     };
 }