srecord: output/file/brecord.h Source File

srecord 1.65.0

Loading...
Searching...
No Matches
brecord.h
Go to the documentation of this file.
1//
2// srecord - The "srecord" program.
3// Copyright (C) 2007, 2008, 2010, 2011 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_BRECORD_H
21#define SRECORD_OUTPUT_FILE_BRECORD_H
22
23#include <srecord/output/file.h>
24
25namespace srecord
26{
27
28/**
29 * The srecord::output_file_brecord class is used to represent an output
30 * files in Motorola MC68EZ328 bootstrap b-record format.
31 */
32 class output_file_brecord:
33 public output_file
34{
35public:
36 /**
37 * The destructor.
38 */
39 virtual ~output_file_brecord();
40
41private:
42 /**
43 * The constructor.
44 *
45 * @param file_name
46 * The name of the file to write the output to.
47 * The string "-" is understood to mean the standard output.
48 */
49 output_file_brecord(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 file name to open to write data to.
58 * The name "-" is understood to mean the standard output.
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 enum { BUFFER_MAXIMUM_MAXIMUM = 31 };
83 unsigned block_size;
84
85 /**
86 * The default constructor. Do not use.
87 */
88 output_file_brecord();
89
90 /**
91 * The copy constructor. Do not use.
92 */
93 output_file_brecord(const output_file_brecord &);
94
95 /**
96 * The assignment operator. Do not use.
97 */
98 output_file_brecord &operator=(const output_file_brecord &);
99};
100
101};
102
103// vim: set ts=8 sw=4 et :
104#endif // SRECORD_OUTPUT_FILE_BRECORD_H
srecord::output_file_brecord
The srecord::output_file_brecord class is used to represent an output files in Motorola MC68EZ328 boo...
Definition brecord.h:34
srecord::output_file_brecord::format_name
const char * format_name() const
The format_name method is used to obtain the name of this output format.
srecord::output_file_brecord::~output_file_brecord
virtual ~output_file_brecord()
The destructor.
srecord::output_file_brecord::write
void write(const record &)
The write method is used to write a recordonto an output.
srecord::output_file_brecord::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_brecord::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_brecord::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_brecord::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_brecord::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::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