OpenASIP  2.0
CostFunctionPlugin.cc
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 CostFunctionPlugin.cc
26  *
27  * Implementation of CostFunctionPlugin class.
28  *
29  * @author Pekka Jääskeläinen 2005 (pekka.jaaskelainen-no.spam-tut.fi)
30  * @note rating: red
31  */
32 
33 #include "CostFunctionPlugin.hh"
34 
35 namespace HDB {
36 
37 /**
38  * Constructor.
39  *
40  * @param pluginFilePath Path of the plugin.
41  */
43  int id,
44  const std::string& description,
45  const std::string& name,
46  const std::string& pluginFilePath,
48  id_(id), description_(description), name_(name),
49  pluginFilePath_(pluginFilePath), type_(type) {
50 }
51 
52 /**
53  * Destructor.
54  */
56 }
57 
58 /**
59  * Returns the id of the plugin.
60  *
61  * @return Id of the plugin.
62  */
63 int
65  return id_;
66 }
67 
68 /**
69  * Returns the description of the plugin.
70  *
71  * @return Description of the plugin.
72  */
73 std::string
75  return description_;
76 }
77 
78 /**
79  * Returns the (class) name of the plugin.
80  *
81  * @return Name of the plugin.
82  */
83 std::string
85  return name_;
86 }
87 
88 /**
89  * Returns the path of the plugin file.
90  *
91  * @return Path of the plugin.
92  */
93 std::string
95  return pluginFilePath_;
96 }
97 
98 /**
99  * Returns the type of the plugin.
100  *
101  * @return Description of the plugin.
102  */
105  return type_;
106 }
107 
108 }
HDB::CostFunctionPlugin::CostFunctionPluginType
CostFunctionPluginType
all supported cost function plugin types
Definition: CostFunctionPlugin.hh:46
HDB::CostFunctionPlugin::CostFunctionPlugin
CostFunctionPlugin(int id, const std::string &description, const std::string &name, const std::string &pluginFilePath, CostFunctionPluginType type)
Definition: CostFunctionPlugin.cc:42
HDB
Definition: CostDatabase.hh:49
HDB::CostFunctionPlugin::description
std::string description() const
Definition: CostFunctionPlugin.cc:74
HDB::CostFunctionPlugin::pluginFilePath_
std::string pluginFilePath_
the path in the file system of the plugin
Definition: CostFunctionPlugin.hh:75
HDB::CostFunctionPlugin::id
int id() const
Definition: CostFunctionPlugin.cc:64
HDB::CostFunctionPlugin::~CostFunctionPlugin
virtual ~CostFunctionPlugin()
Definition: CostFunctionPlugin.cc:55
HDB::CostFunctionPlugin::description_
std::string description_
description of the plugin HDB
Definition: CostFunctionPlugin.hh:71
HDB::CostFunctionPlugin::name_
std::string name_
(the class) name of the plugin
Definition: CostFunctionPlugin.hh:73
HDB::CostFunctionPlugin::type_
CostFunctionPluginType type_
the type of the plugin
Definition: CostFunctionPlugin.hh:77
HDB::CostFunctionPlugin::pluginFilePath
std::string pluginFilePath() const
Definition: CostFunctionPlugin.cc:94
CostFunctionPlugin.hh
HDB::CostFunctionPlugin::type
CostFunctionPluginType type() const
Definition: CostFunctionPlugin.cc:104
HDB::CostFunctionPlugin::name
std::string name() const
Definition: CostFunctionPlugin.cc:84
HDB::CostFunctionPlugin::id_
int id_
id of the plugin in HDB
Definition: CostFunctionPlugin.hh:69