srecord: input/file/ti_tagged_16.h Source File

srecord 1.65.0

Loading...
Searching...
No Matches
ti_tagged_16.h
Go to the documentation of this file.
1//
2// srecord - manipulate eprom load files
3// Copyright (C) 2007, 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_TI_TAGGED_16_H
20#define SRECORD_INPUT_FILE_TI_TAGGED_16_H
21
22#include <srecord/input/file.h>
23
24namespace srecord {
25
26/**
27 * The srecord::input_file_ti_tagged_16 class is used to represent the
28 * parse state of an input file in Texas Instruments SDSMAC 320 format.
29 */
30 class input_file_ti_tagged_16:
31 public input_file
32{
33public:
34 /**
35 * The destructor.
36 */
37 virtual ~input_file_ti_tagged_16();
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 /**
58 * The get_char method is used to get a character from the input.
59 * We override because the checksum is character based, not byte
60 * based.
61 */
62 int get_char(void);
63
64 // See base class for documentation.
65 int format_option_number(void) const;
66
67private:
68 /**
69 * The constructor.
70 *
71 * @param file_name
72 * The name of the file to be read.
73 */
74 input_file_ti_tagged_16(const std::string &file_name);
75
76 typedef input_file inherited;
77
78 /**
79 * The read_inner method is used to read a single line of input.
80 * the raed method is a wrapper around this method.
81 */
82 bool read_inner(record &);
83
84 /**
85 * The address instance variable is used to remember where we are
86 * up to in the input file.
87 */
88 unsigned long address;
89
90 /**
91 * The csum instance variable is used to remember the running
92 * checksum.
93 */
94 int csum;
95
96 /**
97 * The default constructor. Do not use.
98 */
99 input_file_ti_tagged_16();
100
101 /**
102 * The copy constructor. Do not use.
103 */
104 input_file_ti_tagged_16(const input_file_ti_tagged_16 &);
105
106 /**
107 * The assignment operator. Do not use.
108 */
109 input_file_ti_tagged_16 &operator=(const input_file_ti_tagged_16 &);
110};
111
112};
113
114#endif // SRECORD_INPUT_FILE_TI_TAGGED_16_H
115// vim: set ts=8 sw=4 et :
srecord::input_file_ti_tagged_16::get_char
int get_char(void)
The get_char method is used to get a character from the input.
srecord::input_file_ti_tagged_16::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_ti_tagged_16::read
bool read(record &record)
The read method is used to read one record from the input.
srecord::input_file_ti_tagged_16::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_ti_tagged_16::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_ti_tagged_16::~input_file_ti_tagged_16
virtual ~input_file_ti_tagged_16()
The destructor.
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