OpenASIP  2.0
GuardEncoding.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 GuardEncoding.hh
26  *
27  * Declaration of GuardEncoding class.
28  *
29  * @author Lasse Laasonen 2005 (lasse.laasonen-no.spam-tut.fi)
30  * @note rating: red
31  */
32 
33 #ifndef TTA_GUARD_ENCODING_HH
34 #define TTA_GUARD_ENCODING_HH
35 
36 #include "Exception.hh"
37 
38 class GuardField;
39 class ObjectState;
40 
41 /**
42  * GuardEncoding class captures the properties shared by all types of guard
43  * encoding.
44  */
46 public:
47  virtual ~GuardEncoding();
48 
49  GuardField* parent() const;
50  bool isGuardInverted() const;
51  unsigned int encoding() const;
52 
53  virtual ObjectState* saveState() const;
54 
55  /// ObjectState name for guard encoding.
56  static const std::string OSNAME_GUARD_ENCODING;
57  /// ObjectState attribute key for invert flag.
58  static const std::string OSKEY_INVERTED;
59  /// ObjectState attribute key for encoding.
60  static const std::string OSKEY_ENCODING;
61 
62 protected:
63  GuardEncoding(bool inverted, unsigned int encoding);
64  GuardEncoding(const ObjectState* state);
66 
67 private:
68  /// The "invert" flag.
69  bool inverted_;
70  /// The encoding.
71  unsigned int encoding_;
72  /// The parent guard field.
74 };
75 
76 #endif
Exception.hh
GuardEncoding::isGuardInverted
bool isGuardInverted() const
Definition: GuardEncoding.cc:101
ObjectState
Definition: ObjectState.hh:59
GuardField
Definition: GuardField.hh:55
GuardEncoding::OSKEY_INVERTED
static const std::string OSKEY_INVERTED
ObjectState attribute key for invert flag.
Definition: GuardEncoding.hh:58
GuardEncoding::setParent
void setParent(GuardField *parent)
Definition: GuardEncoding.cc:137
GuardEncoding
Definition: GuardEncoding.hh:45
GuardEncoding::encoding_
unsigned int encoding_
The encoding.
Definition: GuardEncoding.hh:71
GuardEncoding::parent_
GuardField * parent_
The parent guard field.
Definition: GuardEncoding.hh:73
GuardEncoding::encoding
unsigned int encoding() const
Definition: GuardEncoding.cc:112
GuardEncoding::GuardEncoding
GuardEncoding(bool inverted, unsigned int encoding)
Definition: GuardEncoding.cc:51
GuardEncoding::OSNAME_GUARD_ENCODING
static const std::string OSNAME_GUARD_ENCODING
ObjectState name for guard encoding.
Definition: GuardEncoding.hh:56
GuardEncoding::~GuardEncoding
virtual ~GuardEncoding()
Definition: GuardEncoding.cc:80
GuardEncoding::inverted_
bool inverted_
The "invert" flag.
Definition: GuardEncoding.hh:69
GuardEncoding::OSKEY_ENCODING
static const std::string OSKEY_ENCODING
ObjectState attribute key for encoding.
Definition: GuardEncoding.hh:60
GuardEncoding::saveState
virtual ObjectState * saveState() const
Definition: GuardEncoding.cc:123
GuardEncoding::parent
GuardField * parent() const
Definition: GuardEncoding.cc:90