srecord: output/file/needham.h Source File

srecord 1.65.0

Loading...
Searching...
No Matches
needham.h
Go to the documentation of this file.
1//
2// srecord - manipulate eprom load files
3// Copyright (C) 2003, 2005-2008, 2010 Peter Miller
4//
5// This program is free software; you can redistribute it and/or modify
6// it 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
8// (at your option) any later version.
9//
10// This program is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU Lesser General Public 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
17// <http://www.gnu.org/licenses/>.
18//
19
20#ifndef SRECORD_OUTPUT_FILE_NEEDHAM_H
21#define SRECORD_OUTPUT_FILE_NEEDHAM_H
22
23#include <srecord/output/file.h>
24
25namespace srecord
26{
27
28/**
29 * The srecord::output_file_needham class is used to represent
30 */
31 class output_file_needham:
32 public output_file
33{
34public:
35 /**
36 * The destructor.
37 */
38 virtual ~output_file_needham();
39
40private:
41 /**
42 * The constructor. It is private on purpose, use the #create
43 * class method instead.
44 *
45 * @param file_name
46 * The name of the file to be written. The special name "-"
47 * indicates the standard output is to be used.
48 */
49 output_file_needham(const std::string &file_name);
50
51public:
52 /**
53 * The create class method is used to create new dynamically
54 * allocated instances of this class.
55 *
56 * @param file_name
57 * The name of the file to be written.
58 */
59 static pointer create(const std::string &file_name);
60
61protected:
62 // See base class for documentation.
63 void write(const record &);
64
65 // See base class for documentation.
66 void line_length_set(int);
67
68 // See base class for documentation.
69 void address_length_set(int);
70
71 // See base class for documentation.
72 int preferred_block_size_get() const;
73
74 // See base class for documentation.
75 bool preferred_block_size_set(int nbytes);
76
77 // See base class for documentation.
78 const char *format_name() const;
79
80private:
81 /**
82 * The address instance variable is used to remember where in the
83 * file the output has reached. This is used to fill gaps.
84 */
85 unsigned long address;
86
87 /**
88 * The column instance variable is used to remember the column of
89 * the output text we have reached. This is used when calculating
90 * when to throw new lines.
91 */
92 int column;
93
94 /**
95 * The pref_block_size instance variable is used to remember The
96 * preferred line length of the output text.
97 */
98 int pref_block_size;
99
100 /**
101 * The address_length instance variable is used to remember the
102 * minimum number of bytes to use for addresses in the output text.
103 */
104 int address_length;
105
106 /**
107 * The default constructor. Do not use.
108 */
109 output_file_needham();
110
111 /**
112 * The copy constructor. Do not use.
113 */
114 output_file_needham(const output_file_needham &);
115
116 /**
117 * The assignment operator. Do not use.
118 */
119 output_file_needham &operator=(const output_file_needham &);
120};
121
122};
123
124#endif // SRECORD_OUTPUT_FILE_NEEDHAM_H
srecord::output_file_needham::preferred_block_size_get
int preferred_block_size_get() const
The preferred_block_size_get method is used to get the proferred block size of the output fformat.
srecord::output_file_needham::~output_file_needham
virtual ~output_file_needham()
The destructor.
srecord::output_file_needham::write
void write(const record &)
The write method is used to write a recordonto an output.
srecord::output_file_needham::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::output_file_needham::format_name
const char * format_name() const
The format_name method is used to obtain the name of this output format.
srecord::output_file_needham::line_length_set
void line_length_set(int)
The set_line_length method is used to set the maximum length of an output line, for those formats for...
srecord::output_file_needham::address_length_set
void address_length_set(int)
The address_length_set method is used to set the minimum number of bytes to be written for addresses ...
srecord::output_file_needham::preferred_block_size_set
bool preferred_block_size_set(int nbytes)
The preferred_block_size_set method is is to set a precific number of bytes for the preferred block s...
srecord::output_file::output_file
output_file()
The default constructor.
srecord::output::pointer
std::shared_ptr< output > pointer
Definition output.h:41
srecord::record
The srecord::record class is used to represent a data record read from a file.
Definition record.h:35
srecord
Definition adler16.h:25
file.h