Changeset 9313 in orxonox.OLD

Timestamp:

Jul 18, 2006, 1:43:21 AM (18 years ago)

Author:

bensch

Message:

orxonox/proxy: new substring functions

Location:

branches/proxy/src/lib/util

Files:

• substring.cc (modified) (1 diff)
• substring.h (modified) (3 diffs)

branches/proxy/src/lib/util/substring.cc

@@ -27 +27 @@
 
 #include "substring.h"
-#include <cassert>
-
 
 /**

branches/proxy/src/lib/util/substring.h

@@ -2 +2 @@
  * @file substring.h
  * @brief a small class to get the parts of a string separated by commas
+ *
+ * This class is also identified as a Tokenizer. It splits up one long
+ * String into multiple small ones by a designated Delimiter.
+ *
+ * Substring is Advanced, and it is possible, to split a string by ','
+ * but also removing leading and trailing spaces around the comma.
+ *
+ * @example
+ * Split the String std::string st = "1345, The new empire   , is , orxonox"
+ * is splitted with:
+ * SubString(st, ',', " \n\t")
+ * into
+ * "1345", "The new empire", "is", "orxonox"
+ * As you can see, the useless spaces around ',' were removed.
  */
 
-#ifndef _SUBSTRING_H
-#define _SUBSTRING_H
+#ifndef __SUBSTRING_H__
+#define __SUBSTRING_H__
 
 #include <vector>
@@ -73 +87 @@
   /** @param i the i'th String @returns the i'th string from the subset of Strings */
   inline const std::string& getString(unsigned int i) const { return (*this)[i]; };
+  /** @returns the front of the StringList. */
+  inline const std::string& front() const { return this->strings.front(); };
+  /** @returns the back of the StringList. */
+  inline const std::string& back() const { return this->strings.back(); };
 
   // the almighty algorithm.
@@ -97 +115 @@
 };
 
-#endif /* _SUBSTRING_H */
+#endif /* __SUBSTRING_H__ */