OpenASIP  2.0
ExternalPort.hh
Go to the documentation of this file.
1 /*
2  Copyright (c) 2002-2014 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 ExternalPort.hh
26  *
27  * Declaration of ExternalPort class.
28  *
29  * @author Henry Linjamäki 2014 (henry.linjamaki-no.spam-tut.fi)
30  * @note rating: red
31  */
32 
33 #ifndef TTA_EXTERNALPORT_HH_
34 #define TTA_EXTERNALPORT_HH_
35 
36 #include <string>
37 #include <vector>
38 
39 #include "HDBTypes.hh"
40 #include "Exception.hh"
41 
42 namespace HDB {
43 
44 /**
45  * Represents base class for a non-architectural port of an implementation
46  * in HDB.
47  */
48 class ExternalPort {
49 public:
51  const std::string& name,
53  const std::string& widthFormula,
54  const std::string& description);
55  virtual ~ExternalPort();
56 
57  void setName(const std::string& name);
58  std::string name() const;
60  Direction direction() const;
61  void setWidthFormula(const std::string& widthFormula);
62  std::string widthFormula() const;
63  void setDescription(const std::string& description);
64  std::string description() const;
65 
66  bool setParameterDependency(const std::string& parameter);
67  bool unsetParameterDependency(const std::string& parameter);
68  int parameterDependencyCount() const;
69  std::string parameterDependency(int index) const;
70 
71 private:
72  /// Typedef for string vector.
73  typedef std::vector<std::string> ParameterTable;
74 
75  /// Name of the port.
76  std::string name_;
77  /// Direction of the port.
79  /// The formula for the width of the port.
80  std::string widthFormula_;
81  /// Description of the port.
82  std::string description_;
84 };
85 
86 }
87 
88 #endif
HDB::ExternalPort::parameterDeps_
ParameterTable parameterDeps_
Definition: ExternalPort.hh:83
HDB::ExternalPort::setDescription
void setDescription(const std::string &description)
Definition: ExternalPort.cc:139
HDBTypes.hh
HDB
Definition: CostDatabase.hh:49
Exception.hh
HDB::ExternalPort::widthFormula_
std::string widthFormula_
The formula for the width of the port.
Definition: ExternalPort.hh:80
HDB::ExternalPort::setParameterDependency
bool setParameterDependency(const std::string &parameter)
Definition: ExternalPort.cc:162
HDB::ExternalPort::direction_
Direction direction_
Direction of the port.
Definition: ExternalPort.hh:78
HDB::ExternalPort::unsetParameterDependency
bool unsetParameterDependency(const std::string &parameter)
Definition: ExternalPort.cc:178
HDB::ExternalPort
Definition: ExternalPort.hh:48
HDB::ExternalPort::~ExternalPort
virtual ~ExternalPort()
Definition: ExternalPort.cc:63
HDB::ExternalPort::ExternalPort
ExternalPort(const std::string &name, Direction direction, const std::string &widthFormula, const std::string &description)
Definition: ExternalPort.cc:49
HDB::ExternalPort::setName
void setName(const std::string &name)
Definition: ExternalPort.cc:73
HDB::ExternalPort::parameterDependency
std::string parameterDependency(int index) const
Definition: ExternalPort.cc:203
HDB::Direction
Direction
Direction of port.
Definition: HDBTypes.hh:40
HDB::ExternalPort::setWidthFormula
void setWidthFormula(const std::string &widthFormula)
Definition: ExternalPort.cc:117
HDB::ExternalPort::name_
std::string name_
Name of the port.
Definition: ExternalPort.hh:76
HDB::ExternalPort::description_
std::string description_
Description of the port.
Definition: ExternalPort.hh:82
HDB::ExternalPort::setDirection
void setDirection(Direction direction)
Definition: ExternalPort.cc:95
HDB::ExternalPort::ParameterTable
std::vector< std::string > ParameterTable
Typedef for string vector.
Definition: ExternalPort.hh:73
HDB::ExternalPort::description
std::string description() const
Definition: ExternalPort.cc:150
HDB::ExternalPort::name
std::string name() const
Definition: ExternalPort.cc:84
HDB::ExternalPort::direction
Direction direction() const
Definition: ExternalPort.cc:106
HDB::ExternalPort::widthFormula
std::string widthFormula() const
Definition: ExternalPort.cc:128
HDB::ExternalPort::parameterDependencyCount
int parameterDependencyCount() const
Definition: ExternalPort.cc:189