srecord: input/file/tektronix.h Source File

srecord 1.65.0

Loading...
Searching...
No Matches
tektronix.h
Go to the documentation of this file.
1//
2// srecord - manipulate eprom load files
3// Copyright (C) 1998-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_H
20#define SRECORD_INPUT_FILE_TEKTRONIX_H
21
22#include <srecord/input/file.h>
23
24namespace srecord {
25
26/**
27 * The srecord::input_file_tektronix clas sis used to represent the parse
28 * state of an input file in Tektronix (non-extended) format.
29 */
30 class input_file_tektronix:
31 public input_file
32{
33public:
34 /**
35 * The destructor.
36 */
37 virtual ~input_file_tektronix();
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.
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
60private:
61 /**
62 * The constructor.
63 *
64 * @param file_name
65 * The name of the file to be read.
66 */
67 input_file_tektronix(const std::string &file_name);
68
69 /**
70 * The get_nibble method gets a single hex-digit from input.
71 * We override the one in the base class because the checksum is
72 * nibble-based, not byte-based.
73 */
74 int get_nibble(void);
75
76 /**
77 * The get_byte method gets a two hex-digit from input and assembles
78 * them (big-endian) into a byte. We override the one in the base
79 * class because the checksum is nibble-based, not byte-based.
80 */
81 int get_byte(void);
82
83 /**
84 * The read_inner methos is used to read a single record from
85 * the input. The read method is a wrapper around this method.
86 */
87 bool read_inner(record &);
88
89 /**
90 * The data_record_count instance variable is used to remember the
91 * number of data records seen so far.
92 */
93 int data_record_count;
94
95 /**
96 * The garbage_warning instance variable is used to remember whether
97 * a warning about input line containing garbage has been issued yet.
98 */
99 bool garbage_warning;
100
101 /**
102 * The seen_some_input instance variable is used to remember wheter
103 * the file contains any data so far.
104 */
105 bool seen_some_input;
106
107 /**
108 * The termination_seen instance variable is used to remember
109 * whether the termination record has been seen yet.
110 */
111 bool termination_seen;
112
113 /**
114 * The default constructor. Do not use.
115 */
116 input_file_tektronix();
117
118 /**
119 * The copy constructor. Do not use.
120 */
121 input_file_tektronix(const input_file_tektronix &);
122
123 /**
124 * The assignment operator. Do not use.
125 */
126 input_file_tektronix &operator=(const input_file_tektronix &);
127};
128
129};
130
131#endif // SRECORD_INPUT_FILE_TEKTRONIX_H
132// vim: set ts=8 sw=4 et :
srecord::input_file_tektronix::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::~input_file_tektronix
virtual ~input_file_tektronix()
The destructor.
srecord::input_file_tektronix::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::read
bool read(record &record)
The read method is used to read one record from the input.
srecord::input_file_tektronix::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::get_nibble
virtual 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::get_byte
virtual int get_byte(void)
The get_byte method is used to fetch a byte value from the input.
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