OpenASIP  2.0
FUGuardEncoding.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 FUGuardEncoding.hh
26  *
27  * Declaration of FUGuardEncoding class.
28  *
29  * @author Lasse Laasonen 2005 (lasse.laasonen-no.spam-tut.fi)
30  * @note rating: red
31  */
32 
33 #ifndef TTA_FU_GUARD_ENCODING_HH
34 #define TTA_FU_GUARD_ENCODING_HH
35 
36 #include <string>
37 
38 #include "GuardEncoding.hh"
39 #include "Exception.hh"
40 
41 /**
42  * The FUGuardEncoding class maps a guard expression with FU output port term
43  * to a control code.
44  *
45  * Instances of this class are always registered to a guard field.
46  */
48 public:
50  const std::string& fu, const std::string& port, bool inverted,
51  unsigned int encoding, GuardField& parent);
53  virtual ~FUGuardEncoding();
54 
55  std::string functionUnit() const;
56  std::string port() const;
57 
58  virtual ObjectState* saveState() const;
59 
60  /// ObjectState name for FU guard encoding.
61  static const std::string OSNAME_FU_GUARD_ENCODING;
62  /// ObjectState attribute key for the name of the function unit.
63  static const std::string OSKEY_FU_NAME;
64  /// ObjectState attribute key for the name of the port.
65  static const std::string OSKEY_PORT_NAME;
66 
67 private:
68  /// Name of the function unit.
69  std::string functionUnit_;
70  /// Name of the port.
71  std::string port_;
72 };
73 
74 #endif
FUGuardEncoding::OSKEY_PORT_NAME
static const std::string OSKEY_PORT_NAME
ObjectState attribute key for the name of the port.
Definition: FUGuardEncoding.hh:65
FUGuardEncoding::saveState
virtual ObjectState * saveState() const
Definition: FUGuardEncoding.cc:143
Exception.hh
FUGuardEncoding::~FUGuardEncoding
virtual ~FUGuardEncoding()
Definition: FUGuardEncoding.cc:107
ObjectState
Definition: ObjectState.hh:59
GuardField
Definition: GuardField.hh:55
FUGuardEncoding
Definition: FUGuardEncoding.hh:47
FUGuardEncoding::functionUnit
std::string functionUnit() const
Definition: FUGuardEncoding.cc:121
GuardEncoding.hh
GuardEncoding
Definition: GuardEncoding.hh:45
FUGuardEncoding::FUGuardEncoding
FUGuardEncoding(const std::string &fu, const std::string &port, bool inverted, unsigned int encoding, GuardField &parent)
Definition: FUGuardEncoding.cc:62
FUGuardEncoding::OSNAME_FU_GUARD_ENCODING
static const std::string OSNAME_FU_GUARD_ENCODING
ObjectState name for FU guard encoding.
Definition: FUGuardEncoding.hh:61
FUGuardEncoding::functionUnit_
std::string functionUnit_
Name of the function unit.
Definition: FUGuardEncoding.hh:69
GuardEncoding::encoding
unsigned int encoding() const
Definition: GuardEncoding.cc:112
FUGuardEncoding::port
std::string port() const
Definition: FUGuardEncoding.cc:132
FUGuardEncoding::OSKEY_FU_NAME
static const std::string OSKEY_FU_NAME
ObjectState attribute key for the name of the function unit.
Definition: FUGuardEncoding.hh:63
FUGuardEncoding::port_
std::string port_
Name of the port.
Definition: FUGuardEncoding.hh:71
GuardEncoding::parent
GuardField * parent() const
Definition: GuardEncoding.cc:90