srecord  1.65.0
emon52.h
Go to the documentation of this file.
1 //
2 // srecord - manipulate eprom load files
3 // Copyright (C) 2001, 2003, 2006-2008, 2010, 2011, 2013 Peter Miller
4 //
5 // This program is free software; you can redistribute it and/or modify it
6 // under the terms of the GNU Lesser General Public License as published by
7 // the Free Software Foundation; either version 3 of the License, or (at your
8 // option) any later version.
9 //
10 // This program is distributed in the hope that it will be useful, but WITHOUT
11 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 // FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
13 // License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public License
16 // along with this program. If not, see <http://www.gnu.org/licenses/>.
17 //
18 
19 #ifndef SRECORD_INPUT_FILE_EMON52_H
20 #define SRECORD_INPUT_FILE_EMON52_H
21 
22 #include <srecord/input/file.h>
23 
24 namespace srecord {
25 
26 /**
27  * The srecord::input_file_emon52 class is used to parse an EMON52
28  * formatted file (Elektor Monitor, dunno what the 52 is for).
29  */
31  public input_file
32 {
33 public:
34  /**
35  * The destructor.
36  */
37  virtual ~input_file_emon52();
38 
39  /**
40  * The create class method is used to create new dynamically
41  * allocated instances of this class.
42  *
43  * @param file_name
44  * The name of the file to be read.
45  * @returns
46  * smart pointer to new instance
47  */
48  static pointer create(const std::string &file_name);
49 
50 protected:
51  // See base class for documentation.
52  bool read(record &record);
53 
54  // See base class for documentation.
55  const char *get_file_format_name(void) const;
56 
57  // See base class for documentation.
58  int format_option_number(void) const;
59 
60 private:
61  /**
62  * A constructor. The input is read from the named file (or
63  * the standard input if the file anme is "-").
64  *
65  * @param file_name
66  * The name of the file to be read.
67  */
68  input_file_emon52(const std::string &file_name);
69 
70  /**
71  * The skip_white_space method is used to skip space characters.
72  * The format requires spaces in some locations, this method
73  * skips the space of present.
74  */
75  void skip_white_space(void);
76 
77  /**
78  * The default constructor. Do not use.
79  */
81 
82  /**
83  * The copy constructor. Do not use.
84  */
86 
87  /**
88  * The assignment operator. Do not use.
89  */
90  input_file_emon52 &operator=(const input_file_emon52 &);
91 };
92 
93 };
94 
95 #endif // SRECORD_INPUT_FILE_EMON52_H
96 // vim: set ts=8 sw=4 et :
The srecord::input_file_emon52 class is used to parse an EMON52 formatted file (Elektor Monitor,...
Definition: emon52.h:32
static pointer create(const std::string &file_name)
The create class method is used to create new dynamically allocated instances of this class.
virtual ~input_file_emon52()
The destructor.
int format_option_number(void) const
The format_option_number method is used to obtain the option number, which can then be turned into te...
bool read(record &record)
The read method is used to read one record from the input.
const char * get_file_format_name(void) const
The get_file_format_name method is used to find out the name of the file format being read.
The srecord::input_file class is used to represent an generic input file.
Definition: file.h:37
std::shared_ptr< input > pointer
Definition: input.h:41
The srecord::record class is used to represent a data record read from a file.
Definition: record.h:35