srecord 1.65.0
 
Loading...
Searching...
No Matches
spectrum.h
Go to the documentation of this file.
1//
2// srecord - manipulate eprom load files
3// Copyright (C) 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_SPECTRUM_H
20#define SRECORD_INPUT_FILE_SPECTRUM_H
21
22#include <srecord/input/file.h>
23
24namespace srecord {
25
26/**
27 * The srecord::input_file_spectrum class is used to represent the parse
28 * state when reading from a file in Spectrum format.
29 */
30class input_file_spectrum:
31 public input_file
32{
33public:
34 /**
35 * The destructor.
36 */
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
50protected:
51 // See base class for documentation.
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
60private:
61 /**
62 * The constructor.
63 *
64 * @param file_name
65 * The name of the file to be read.
66 */
67 input_file_spectrum(const std::string &file_name);
68
69 /**
70 * The header_seen instance variable is used to remember whether
71 * the file header (the start character STX=0x02) has been seen yet.
72 */
73 bool header_seen;
74
75 /**
76 * The trailer_seen instance variable is used to remember whether
77 * the file trailer (the end character ETX=0x03) has been seen yet.
78 */
79 bool trailer_seen;
80
81 /**
82 * The file_contains_data instance variable is used to remember
83 * whether any file data has been seen yet.
84 */
85 bool file_contains_data;
86
87 /**
88 * The get_decimal method is used to get a decimal number from
89 * the input. It must have at least one digit.
90 */
91 int get_decimal(void);
92
93 /**
94 * The get_binary method is used to get a binary number from
95 * the input. It must have at least one digit.
96 */
97 int get_binary(void);
98
99 /**
100 * The default constructor. Do not use.
101 */
102 input_file_spectrum();
103
104 /**
105 * The copy constructor. Do not use.
106 */
107 input_file_spectrum(const input_file_spectrum &);
108
109 /**
110 * The assignment operator. Do not use.
111 */
112 input_file_spectrum &operator=(const input_file_spectrum &);
113};
114
115};
116
117#endif // SRECORD_INPUT_FILE_SPECTRUM_H
118// vim: set ts=8 sw=4 et :
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.
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...
virtual ~input_file_spectrum()
The destructor.
bool read(record &record)
The read method is used to read one record from the input.
static pointer create(const std::string &file_name)
The create class method is used to create new dynamically allocated instances of this class.
input_file(const std::string &file_name)
The constructor.
std::shared_ptr< input_file > pointer
Definition file.h:39
The srecord::record class is used to represent a data record read from a file.
Definition record.h:35