--- trunk/src/utils/StringTokenizer.hpp 2005/12/02 15:38:03 770 +++ trunk/src/utils/StringTokenizer.hpp 2015/03/07 23:52:07 2073 @@ -6,19 +6,10 @@ * redistribute this software in source and binary code form, provided * that the following conditions are met: * - * 1. Acknowledgement of the program authors must be made in any - * publication of scientific results based in part on use of the - * program. An acceptable form of acknowledgement is citation of - * the article in which the program was described (Matthew - * A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher - * J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented - * Parallel Simulation Engine for Molecular Dynamics," - * J. Comput. Chem. 26, pp. 252-271 (2005)) - * - * 2. Redistributions of source code must retain the above copyright + * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * - * 3. Redistributions in binary form must reproduce the above copyright + * 2. 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. @@ -37,13 +28,22 @@ * arising out of the use of or inability to use software, even if the * University of Notre Dame has been advised of the possibility of * such damages. + * + * SUPPORT OPEN SCIENCE! If you use OpenMD or its source code in your + * research, please cite the appropriate papers when you publish your + * work. Good starting points are: + * + * [1] Meineke, et al., J. Comp. Chem. 26, 252-271 (2005). + * [2] Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006). + * [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 234107 (2008). + * [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010). + * [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011). */ /** * @file StringTokenizer.hpp * @author tlin * @date 09/20/2004 - * @time 11:30am * @version 1.0 */ @@ -51,12 +51,13 @@ #define UTIL_STRINGTOKENIZER_HPP #include +#include #include +#include "config.h" +namespace OpenMD { -namespace oopse { - /** - * @class StringTokenizer.hpp "util/StringTokenizer.hpp" + * @class StringTokenizer * @brief The string tokenizer class allows an application to break a string into tokens * The set of delimiters (the characters that separate tokens) may be specified either * at creation time or on a per-token basis. @@ -88,7 +89,8 @@ namespace oopse { * @note this is still a little bit java like implementation. Pure c++ one should use TokenIterator. * Boost's tokenizer class is one of them */ - StringTokenizer(std::string::const_iterator& first, std::string::const_iterator& last, + StringTokenizer(std::string::const_iterator& first, + std::string::const_iterator& last, const std::string & delim = " ;\t\n\r"); /** @@ -124,6 +126,12 @@ namespace oopse { */ std::string nextToken(); + /** + * Skips the next token from this string tokenizer. + * @exception NoSuchElementException if there are no more tokens in this tokenizer's string + */ + void skipToken(); + //actually, nextToken Can be template function //template //ReturnType nextToken(); @@ -147,10 +155,10 @@ namespace oopse { float nextTokenAsFloat(); /** - * Returns the next token from this string tokenizer as a double. - * @return the next token from this string tokenizer as a double. + * Returns the next token from this string tokenizer as a RealType. + * @return the next token from this string tokenizer as a RealType. */ - double nextTokenAsDouble(); + RealType nextTokenAsDouble(); /** * Returns the next token without advancing the position of the StringTokenizer. @@ -179,6 +187,11 @@ namespace oopse { * @return all of the tokens */ std::vector getAllTokens(); + /** + * Returns the remaining unparsed string + * @return the remaining unparsed string + */ + std::string getRemainingString(); private: /** @@ -202,6 +215,6 @@ namespace oopse { std::string::const_iterator end_; }; -} //namespace oopse +} //namespace OpenMD #endif //UTIL_STRINGTOKENIZER_HPP