Main Lemma Repository
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  1. /* This file is part of Lemma, a geophysical modelling and inversion API.
  2. * More information is available at http://lemmasoftware.org
  3. */
  4. /* This Source Code Form is subject to the terms of the Mozilla Public
  5. * License, v. 2.0. If a copy of the MPL was not distributed with this
  6. * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  7. */
  8. /**
  9. * @file
  10. * @date 09/23/2013 02:31:24 PM
  11. * @version $Id$
  12. * @author Trevor Irons (ti)
  13. * @email Trevor.Irons@xri-geo.com
  14. * @copyright Copyright (c) 2013, Trevor Irons
  15. */
  16. #ifndef ASCIIPARSER_INC
  17. #define ASCIIPARSER_INC
  18. #include "LemmaObject.h"
  19. #include <fstream>
  20. namespace Lemma {
  21. /**
  22. \brief Provides ASCII input file parsing
  23. \details Able to accomodate various inputs and comment styles
  24. */
  25. class ASCIIParser : public LemmaObject {
  26. friend std::ostream &operator<<(std::ostream &stream,
  27. const ASCIIParser &ob);
  28. public:
  29. // ==================== LIFECYCLE =======================
  30. /**
  31. * Factory method for generating concrete class.
  32. * @return a std::shared_ptr of type ASCIIParser
  33. */
  34. static std::shared_ptr< ASCIIParser > NewSP();
  35. // ==================== OPERATORS =======================
  36. // ==================== OPERATIONS =======================
  37. /** Opens the file up for reading. Throws an exception if something bad happens.
  38. @param[in] fname is the filename to be parsed.
  39. */
  40. void Open (const std::string& fname);
  41. /** Closes the file. Throws an exception if something bad happens.
  42. */
  43. void Close ( );
  44. /** Reads a series of Reals.
  45. * @param[in] nr is the number of reals to read. Enter -1 for the entire file
  46. * @todo throw exception if no file is open
  47. */
  48. std::vector<Real> ReadReals( const int& nr);
  49. /** Reads a series of Reals.
  50. * @param[in] nr is the number of ints to read. Enter -1 for the entire file
  51. * @todo throw exception if no file is open
  52. */
  53. std::vector<int> ReadInts( const int& nr);
  54. /** Reads a series of space delimited strings
  55. * @param[in] nr is the number of strings to read. Enter -1 for the entire file
  56. * @todo throw exception if no file is open
  57. */
  58. std::vector< std::string > ReadStrings( const int& nr);
  59. /**
  60. * @param[in] loc is the point in the file to jump to. Uses seekg
  61. */
  62. void JumpToLocation(const int& loc);
  63. // ==================== ACCESS =======================
  64. /** Sets the comment identifier key.
  65. * @param[in] key is a string identifying comments. All text after the key will be
  66. * ignored by the parser. Default is //
  67. */
  68. void SetCommentString( const std::string& key );
  69. /** Sets the buffer size. This affects the maximum number of column in a line. Defaults
  70. * is 255.
  71. * @param[in] BufferSize is the size of the buffer to use
  72. */
  73. void SetBufferSize( const int& BufferSize);
  74. /**
  75. * @return the current position in the file, as reported by istream::tellg
  76. */
  77. int GetFileLocation();
  78. /** Returns the name of the underlying class, similiar to Python's type */
  79. virtual inline std::string GetName() const {
  80. return CName;
  81. }
  82. // ==================== INQUIRY =======================
  83. protected:
  84. // ==================== LIFECYCLE =======================
  85. /** Default protected constructor, use New */
  86. ASCIIParser ( );
  87. /** Default protected destructor, use Delete */
  88. ~ASCIIParser ();
  89. /**
  90. * @copybrief LemmaObject::Release()
  91. * @copydetails LemmaObject::Release()
  92. */
  93. void Release();
  94. private:
  95. // ==================== DATA MEMBERS =========================
  96. /** ASCII string representation of the class name */
  97. static constexpr auto CName = "ASCIIParser";
  98. /** c++ style file IO */
  99. std::fstream input;
  100. /** comment string, defaults to c++ style // */
  101. std::string CommentString;
  102. /** Buffer size, max line width supported, defaults to 255 */
  103. int BufferSize;
  104. }; // ----- end of class ASCIIParser -----
  105. } // ----- end of Lemma name -----
  106. #endif // ----- #ifndef ASCIIPARSER_INC -----