srecord 1.65.0
 
Loading...
Searching...
No Matches
binary.h
Go to the documentation of this file.
1//
2// srecord - manipulate eprom load files
3// Copyright (C) 1998, 1999, 2001, 2002, 2005-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_BINARY_H
21#define SRECORD_OUTPUT_FILE_BINARY_H
22
23#include <srecord/output/file.h>
24
25namespace srecord
26{
27
28/**
29 * The srecord::output_file_binary class is used to represent an output
30 * file in raw binary format.
31 */
32class output_file_binary:
33 public output_file
34{
35public:
36 /**
37 * The destructor.
38 */
40
41private:
42 /**
43 * The constructor.
44 *
45 * @param file_name
46 * The file name to open and write output to.
47 */
48 output_file_binary(const std::string &file_name);
49
50public:
51 /**
52 * The create class method is used to create new dynamically
53 * allocated instances of this class.
54 *
55 * @param file_name
56 * The file name to open to write data to. The name "-" is
57 * understood to mean the standard output.
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.
70
71 // See base class for documentation.
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
80 // See base class for documentation.
81 bool is_binary(void) const;
82
83private:
84 /**
85 * The default constructor. Do not use.
86 */
87 output_file_binary();
88
89 /**
90 * The copy constructor. Do not use.
91 */
92 output_file_binary(const output_file_binary &);
93
94 /**
95 * The copy constructor. Do not use.
96 */
97 output_file_binary &operator=(const output_file_binary &);
98};
99
100};
101
102#endif // SRECORD_OUTPUT_FILE_BINARY_H
static pointer create(const std::string &file_name)
The create class method is used to create new dynamically allocated instances of this class.
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...
const char * format_name() const
The format_name method is used to obtain the name of this output format.
bool is_binary(void) const
The is_binary method is used to to determine whether or not a file format is binary (true) of text (f...
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...
virtual ~output_file_binary()
The destructor.
int preferred_block_size_get() const
The preferred_block_size_get method is used to get the proferred block size of the output fformat.
void address_length_set(int)
The address_length_set method is used to set the minimum number of bytes to be written for addresses ...
void write(const record &)
The write method is used to write a recordonto an output.
output_file()
The default constructor.
std::shared_ptr< output > pointer
Definition output.h:41
The srecord::record class is used to represent a data record read from a file.
Definition record.h:35