X-Git-Url: https://git.teslayout.com/public/public/public/?a=blobdiff_plain;f=include%2Fanna%2Fcore%2Futil%2FMultiRangeExpression.hpp;h=aa03b8b3a94e2a7a2086949eacecb5482958d208;hb=5a6cba5fde2b2f538a7515f8293cc0a8d9589dfa;hp=d5e51f02230fe775576150384bc04aeb14224fc3;hpb=3e258840b15577cb8bda3cdedd0b9b88e16404b3;p=anna.git

diff --git a/include/anna/core/util/MultiRangeExpression.hpp b/include/anna/core/util/MultiRangeExpression.hpp
index d5e51f0..aa03b8b 100644
--- a/include/anna/core/util/MultiRangeExpression.hpp
+++ b/include/anna/core/util/MultiRangeExpression.hpp
@@ -1,37 +1,9 @@
-// ANNA - Anna is Not Nothingness Anymore
-//
-// (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
-//
-// https://bitbucket.org/testillano/anna
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions
-// are met:
-//
-//     * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-//     * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-//     * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-//
-// Authors: eduardo.ramos.testillano@gmail.com
-//          cisco.tierra@gmail.com
+// ANNA - Anna is Not Nothingness Anymore                                                         //
+//                                                                                                //
+// (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo                         //
+//                                                                                                //
+// See project site at http://redmine.teslayout.com/projects/anna-suite                           //
+// See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
 
 
 #ifndef anna_core_util_MultiRangeExpression_hpp
@@ -54,7 +26,7 @@ class MultiRangeExpression {
   std::map < unsigned int, int/*dummy*/ > a_data; // expands literal
 
 
-  void refresh(void) throw();  // keep coherence between 'a_data' and 'a_literal'
+  void refresh(void) ;  // keep coherence between 'a_data' and 'a_literal'
 
 
 public:
@@ -63,18 +35,65 @@ public:
   ~MultiRangeExpression() {};
 
 
-  // get
-  const char * getLiteral(void) const throw() { return a_literal.c_str(); }
-  std::string getExpandedLiteral(void) const throw();
+  /**
+  * Gets the configured literal by mean #setLiteral or #addLiteral
+  *
+  * @return Literal
+  */
+  const char * getLiteral(void) const { return a_literal.c_str(); }
+
+  /**
+  * Gets expanded representation for stored literal. E.g.: '1-3,8,10' => '1,2,3,7,8,10'
+  *
+  * @return Expanded literal
+  */
+  std::string getExpandedLiteral(void) const ;
+
+  /**
+  * Simplify stored literal. E.g.: '1,1,1,2,3,7,8,10' => '1-3,8,10' and returns it.
+  *
+  * @return Simplified literal
+  */
+  const char * simplifyLiteral(void) ;
 
   // helpers
-  bool contain(const unsigned int & value) const throw() { return (a_data.find(value) != a_data.end()); }
 
-  // set
-  void setLiteral(const char * l) throw() {
+  /**
+  * Returns true if the value provided is contained in the multirange expression literal
+  *
+  * @param value Value to be tested
+  * @return True or false
+  */
+  bool contain(const unsigned int & value) const { return (a_data.find(value) != a_data.end()); }
+
+  // setters
+
+  /**
+  * Configures a new literal
+  *
+  * @param l Literal to be stored
+  */
+  void setLiteral(const char * l) {
     a_literal = l ? l : "";
     refresh();
   }
+
+  /**
+  * Accumulates the provided literal over the stored literal
+  * You could simplify with #simplifyLiteral, because perhaps there is overlapping between current literal and provided one.
+  *
+  * @param l Literal to be added
+  */
+  void addLiteral(const char * l) {
+    if(!l) return;
+
+    if(std::string(l) != "") {
+      a_literal += ",";
+      a_literal += l;
+    }
+
+    refresh();
+  }
 };
 
 };