srecord: input/file/tektronix_extended.h Source File

srecord 1.65.0

Loading...
Searching...
No Matches
tektronix_extended.h
Go to the documentation of this file.
1//
2// srecord - manipulate eprom load files
3// Copyright (C) 2000, 2002, 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_TEKTRONIX_EXTENDED_H
20#define SRECORD_INPUT_FILE_TEKTRONIX_EXTENDED_H
21
22#include <srecord/input/file.h>
23
24namespace srecord {
25
26/**
27 * The srecord::input_file_tektronix_extended clas sis used to represent
28 * the parse state of an input file in Tektronix Extended format.
29 */
30 class input_file_tektronix_extended:
31 public input_file
32{
33public:
34 // make the code around gt_nibble more readable.
35 typedef input_file inherited;
36
37 /**
38 * The destructor.
39 */
40 virtual ~input_file_tektronix_extended();
41
42 /**
43 * The create class method is used to create new dynamically
44 * allocated instances of this class.
45 *
46 * @param file_name
47 * The name of the file to be read.
48 * @returns
49 * smart pointer to new instance
50 */
51 static pointer create(const std::string &file_name);
52
53protected:
54 // See base class for documentation.
55 bool read(record &record);
56
57 // See base class for documentation.
58 const char *get_file_format_name(void) const;
59
60 // See base class for documentation.
61 int format_option_number(void) const;
62
63 // See base class for documentation.
64 int get_nibble(void);
65
66private:
67 /**
68 * The constructor.
69 *
70 * @param file_name
71 * The name of the file to be read.
72 */
73 input_file_tektronix_extended(const std::string &file_name);
74
75 /**
76 * The data_record_count instance variable is used to remember the
77 * number of data records seen in the input so far.
78 */
79 int data_record_count;
80
81 /**
82 * The read_inner method is used to read a record of input.
83 * The read method is a wrapper around this method.
84 */
85 bool read_inner(record &);
86
87 /**
88 * The garbage_warning instance variable is used to remember
89 * whether or not a warning about garbage line in the input has
90 * been issued yet.
91 */
92 bool garbage_warning;
93
94 /**
95 * The seen_some_input instance variable is used to remember whether
96 * any data has been seen in this file yet.
97 */
98 bool seen_some_input;
99
100 /**
101 * The header_seen instance variable is used to remember whether
102 * the header record has been seen yet.
103 */
104 bool header_seen;
105
106 /**
107 * The termination_seen instance variable is used to remember
108 * whether the termination record has been seen yet.
109 */
110 bool termination_seen;
111
112 /**
113 * The nibble_sum instance variable is usd to remember the running
114 * checksum, of each nibble on the record line.
115 */
116 unsigned char nibble_sum;
117
118 /**
119 * The default constructor. Do not use.
120 */
121 input_file_tektronix_extended();
122
123 /**
124 * The copy constructor. Do not use.
125 */
126 input_file_tektronix_extended(const input_file_tektronix_extended &);
127
128 /**
129 * The assignment operator. Do not use.
130 */
131 input_file_tektronix_extended &operator=(
132 const input_file_tektronix_extended &);
133};
134
135};
136
137#endif // SRECORD_INPUT_FILE_TEKTRONIX_EXTENDED_H
138// vim: set ts=8 sw=4 et :
srecord::input_file_tektronix_extended::read
bool read(record &record)
The read method is used to read one record from the input.
srecord::input_file_tektronix_extended::inherited
input_file inherited
Definition tektronix_extended.h:35
srecord::input_file_tektronix_extended::get_nibble
int get_nibble(void)
The get_nibble method is used to fetch one hexadecimal digit from the input, via the get_char method.
srecord::input_file_tektronix_extended::format_option_number
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...
srecord::input_file_tektronix_extended::get_file_format_name
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.
srecord::input_file_tektronix_extended::~input_file_tektronix_extended
virtual ~input_file_tektronix_extended()
The destructor.
srecord::input_file_tektronix_extended::create
static pointer create(const std::string &file_name)
The create class method is used to create new dynamically allocated instances of this class.
srecord::input_file::input_file
input_file(const std::string &file_name)
The constructor.
srecord::input_file::pointer
std::shared_ptr< input_file > pointer
Definition file.h:39
srecord::record
The srecord::record class is used to represent a data record read from a file.
Definition record.h:35
file.h
srecord
Definition adler16.h:25