OpenASIP  2.0
BinaryWriter.hh
Go to the documentation of this file.
1 /*
2  Copyright (c) 2002-2009 Tampere University.
3 
4  This file is part of TTA-Based Codesign Environment (TCE).
5 
6  Permission is hereby granted, free of charge, to any person obtaining a
7  copy of this software and associated documentation files (the "Software"),
8  to deal in the Software without restriction, including without limitation
9  the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  and/or sell copies of the Software, and to permit persons to whom the
11  Software is furnished to do so, subject to the following conditions:
12 
13  The above copyright notice and this permission notice shall be included in
14  all copies or substantial portions of the Software.
15 
16  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  DEALINGS IN THE SOFTWARE.
23  */
24 /**
25  * @file BinaryWriter.hh
26  *
27  * Declaration of BinaryWriter class.
28  *
29  * @author Mikael Lepistö 2003 (tmlepist-no.spam-cs.tut.fi)
30  * @author Pekka Jääskeläinen 2006 (pjaaskel-no.spam-cs.tut.fi)
31  *
32  * @note rating: yellow
33  */
34 
35 #ifndef TTA_BINARY_WRITER_HH
36 #define TTA_BINARY_WRITER_HH
37 
38 #include "Binary.hh"
39 #include "Section.hh"
40 
41 namespace TPEF {
42  class BinaryStream;
43 
44 /**
45  * Interface for actual binary writer classes and for clients
46  * to write binary object representation.
47  *
48  * Provides a way for calling the concrete writers with better error checking.
49  */
50 class BinaryWriter {
51 public:
52  virtual ~BinaryWriter();
53 
54  void writeBinary(BinaryStream& stream, const Binary* bin) const;
55 
56 protected:
57  BinaryWriter();
58 
59  /// Does real writing of binary.
60  virtual void actualWriteBinary(
61  BinaryStream& stream,
62  const Binary* bin) const = 0;
63 
64  void setWriter(const BinaryWriter* writer);
65 
66 private:
67  /// Contains concrete writer instance that is used for writing binary.
69 };
70 }
71 
72 #endif
TPEF::BinaryWriter::setWriter
void setWriter(const BinaryWriter *writer)
Definition: BinaryWriter.cc:131
TPEF::BinaryWriter::actualWriteBinary
virtual void actualWriteBinary(BinaryStream &stream, const Binary *bin) const =0
Does real writing of binary.
TPEF::BinaryWriter::writeBinary
void writeBinary(BinaryStream &stream, const Binary *bin) const
Definition: BinaryWriter.cc:64
TPEF::Binary
Definition: Binary.hh:49
TPEF::BinaryStream
Definition: BinaryStream.hh:59
TPEF::BinaryWriter::BinaryWriter
BinaryWriter()
Definition: BinaryWriter.cc:48
TPEF::BinaryWriter::~BinaryWriter
virtual ~BinaryWriter()
Definition: BinaryWriter.cc:54
Section.hh
TPEF::BinaryWriter
Definition: BinaryWriter.hh:50
TPEF
Definition: Assembler.hh:43
Binary.hh
TPEF::BinaryWriter::writerToUse_
const BinaryWriter * writerToUse_
Contains concrete writer instance that is used for writing binary.
Definition: BinaryWriter.hh:68