srecord: output/file/mos_tech.h Source File

srecord 1.65.0

Loading...
Searching...
No Matches
mos_tech.h
Go to the documentation of this file.
1//
2// srecord - manipulate eprom load files
3// Copyright (C) 2000-2002, 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_MOS_TECH_H
21#define SRECORD_OUTPUT_FILE_MOS_TECH_H
22
23#include <srecord/output/file.h>
24
25namespace srecord
26{
27
28/**
29 * The srecord::output_file_mos_tech class is used to write a MOS Technology
30 * formatted file.
31 */
32 class output_file_mos_tech:
33 public output_file
34{
35public:
36 /**
37 * The destructor.
38 */
39 virtual ~output_file_mos_tech();
40
41private:
42 /**
43 * The constructor. It is private on purpose, use the #create
44 * class method instead.
45 *
46 * @param file_name
47 * The name of the file to be written. The special name "-"
48 * indicates the standard output is to be used.
49 */
50 output_file_mos_tech(const std::string &file_name);
51
52public:
53 /**
54 * The create class method is used to create new dynamically
55 * allocated instances of this class.
56 *
57 * @param file_name
58 * The name of the file to be written.
59 */
60 static pointer create(const std::string &file_name);
61
62protected:
63 // See base class for documentation.
64 void write(const record &);
65
66 // See base class for documentation.
67 void line_length_set(int);
68
69 // See base class for documentation.
70 void address_length_set(int);
71
72 // See base class for documentation.
73 int preferred_block_size_get() const;
74
75 // See base class for documentation.
76 bool preferred_block_size_set(int nbytes);
77
78 // See base class for documentation.
79 const char *format_name() const;
80
81private:
82 /**
83 * The pref_block_size is used to remember the preferred block
84 * size. Set by the line_length_set() method. Read by the
85 * preferred_block_size_get() method.
86 */
87 int pref_block_size;
88
89 /**
90 * The data_record_count instance variable is used to remember the
91 * number of data records priesent in the output. This is used
92 * when writing the end-of-file record.
93 */
94 int data_record_count;
95
96 /**
97 * The write_inner method is used to write a single line (record)
98 * to the file. Use by the write() method.
99 */
100 void write_inner(int type, unsigned long addr, int addr_len,
101 const void *data, int data_len);
102
103 /**
104 * The default constructor. Do not use.
105 */
106 output_file_mos_tech();
107
108 /**
109 * The copy constructor. Do not use.
110 */
111 output_file_mos_tech(const output_file_mos_tech &);
112
113 /**
114 * The assignment operator. Do not use.
115 */
116 output_file_mos_tech &operator=(const output_file_mos_tech &);
117};
118
119};
120
121#endif // SRECORD_OUTPUT_FILE_MOS_TECH_H
srecord::output_file_mos_tech::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_mos_tech::format_name
const char * format_name() const
The format_name method is used to obtain the name of this output format.
srecord::output_file_mos_tech::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_mos_tech::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_mos_tech::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_mos_tech::~output_file_mos_tech
virtual ~output_file_mos_tech()
The destructor.
srecord::output_file_mos_tech::write
void write(const record &)
The write method is used to write a recordonto an output.
srecord::output_file_mos_tech::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::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