srecord: output/file/emon52.h Source File

srecord 1.65.0

Loading...
Searching...
No Matches
emon52.h
Go to the documentation of this file.
1//
2// srecord - manipulate eprom load files
3// Copyright (C) 2001, 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_EMON52_H
21#define SRECORD_OUTPUT_FILE_EMON52_H
22
23#include <srecord/output/file.h>
24
25namespace srecord
26{
27
28/**
29 * The srecord::output_file_emon52 class is used to write an EMON52 formatted
30 * file (Elektor Monitor, dunno what the 52 is for).
31 */
32 class output_file_emon52:
33 public output_file
34{
35public:
36 /**
37 * The destructor.
38 */
39 virtual ~output_file_emon52();
40
41private:
42 /**
43 * A constructor. The input will be read from the named file (or
44 * the standard input if the file name is "-"). It is private on
45 * purpose, use the create class method instead.
46 *
47 * @param file_name
48 * The name of the file to be written.
49 */
50 output_file_emon52(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. The input will be read from
56 * the named file (or the standard input if the file name is "-").
57 *
58 * @param file_name
59 * The name of the file to be written.
60 */
61 static pointer create(const std::string &file_name);
62
63protected:
64 // See base class for documentation.
65 void write(const record &);
66
67 // See base class for documentation.
68 void line_length_set(int);
69
70 // See base class for documentation.
71 void address_length_set(int);
72
73 // See base class for documentation.
74 int preferred_block_size_get() const;
75
76 // See base class for documentation.
77 bool preferred_block_size_set(int nbytes);
78
79 // See base class for documentation.
80 const char *format_name() const;
81
82private:
83 /**
84 * The pref_block_size is used to remember the preferred block
85 * size. Set by the line_length_set() method. Read by the
86 * preferred_block_size_get() method.
87 */
88 int pref_block_size;
89
90 /**
91 * The write_inner method is used to write a single line (record)
92 * to the file. Use by the write() method.
93 */
94 void write_inner(int type, unsigned long addr, int addr_len,
95 const void *data, int data_len);
96
97 /**
98 * The default constructor. Do not use.
99 */
100 output_file_emon52();
101
102 /**
103 * The copy constructor. Do not use.
104 */
105 output_file_emon52(const output_file_emon52 &);
106
107 /**
108 * The assignment operator. Do not use.
109 */
110 output_file_emon52 &operator=(const output_file_emon52 &);
111};
112
113};
114
115#endif // SRECORD_OUTPUT_FILE_EMON52_H
srecord::output_file_emon52::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_emon52::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_emon52::~output_file_emon52
virtual ~output_file_emon52()
The destructor.
srecord::output_file_emon52::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_emon52::write
void write(const record &)
The write method is used to write a recordonto an output.
srecord::output_file_emon52::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_emon52::format_name
const char * format_name() const
The format_name method is used to obtain the name of this output format.
srecord::output_file_emon52::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