OpenASIP  2.0
ExplorerPluginParameter.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 ExplorerPluginParameter.hh
26  *
27  * Declaration of ExplorerPluginParameter class.
28  *
29  * @author Esa Määttä 2008 (esa.maatta-no.spam-tut.fi)
30  * @note rating: red
31  */
32 
33 #ifndef TTA_EXPLORER_PLUGIN_PARAMETER_HH
34 #define TTA_EXPLORER_PLUGIN_PARAMETER_HH
35 
36 
37 #include "TCEString.hh"
38 #include "Exception.hh"
39 
41 
42 /**
43  * Explorer plugin parameter class. Represents a parameter that an explorer
44  * plugin can have.
45  */
47 public:
49  const std::string& name,
51  bool compulsory,
52  const TCEString value,
53  const TCEString description="");
54 
55  virtual ~ExplorerPluginParameter();
56 
57  TCEString name() const;
58  TCEString value() const;
59  TCEString description() const { return description_; }
60  void setValue(const std::string& value);
61 
63  TCEString typeAsString() const;
64 
65  bool isCompulsory() const;
66  bool isSet() const;
67 
68 private:
69  /// Parameter name
71  /// Parameter type
73  /// Is parameter compulsory
75  /// The value of the parameter as a string, empty if none set.
77  /// The description (help text).
79 };
80 
81 #endif
ExplorerPluginParameterType
ExplorerPluginParameterType
Definition: ExplorerPluginParameter.hh:40
ExplorerPluginParameter::isSet
bool isSet() const
Definition: ExplorerPluginParameter.cc:146
Exception.hh
UINT
@ UINT
Definition: ExplorerPluginParameter.hh:40
ExplorerPluginParameter::typeAsString
TCEString typeAsString() const
Definition: ExplorerPluginParameter.cc:108
ExplorerPluginParameter::name_
TCEString name_
Parameter name.
Definition: ExplorerPluginParameter.hh:70
ExplorerPluginParameter::name
TCEString name() const
Definition: ExplorerPluginParameter.cc:86
ExplorerPluginParameter::~ExplorerPluginParameter
virtual ~ExplorerPluginParameter()
Definition: ExplorerPluginParameter.cc:58
BOOL
@ BOOL
Definition: ExplorerPluginParameter.hh:40
ExplorerPluginParameter::value
TCEString value() const
Definition: ExplorerPluginParameter.cc:63
TCEString.hh
ExplorerPluginParameter::description
TCEString description() const
Definition: ExplorerPluginParameter.hh:59
STRING
@ STRING
Definition: ExplorerPluginParameter.hh:40
ExplorerPluginParameter
Definition: ExplorerPluginParameter.hh:46
ExplorerPluginParameter::type_
ExplorerPluginParameterType type_
Parameter type.
Definition: ExplorerPluginParameter.hh:72
INT
@ INT
Definition: ExplorerPluginParameter.hh:40
ExplorerPluginParameter::type
ExplorerPluginParameterType type() const
Definition: ExplorerPluginParameter.cc:97
ExplorerPluginParameter::setValue
void setValue(const std::string &value)
Definition: ExplorerPluginParameter.cc:74
ExplorerPluginParameter::value_
TCEString value_
The value of the parameter as a string, empty if none set.
Definition: ExplorerPluginParameter.hh:76
ExplorerPluginParameter::isCompulsory
bool isCompulsory() const
Definition: ExplorerPluginParameter.cc:135
TCEString
Definition: TCEString.hh:53
ExplorerPluginParameter::compulsory_
bool compulsory_
Is parameter compulsory.
Definition: ExplorerPluginParameter.hh:74
ExplorerPluginParameter::description_
TCEString description_
The description (help text).
Definition: ExplorerPluginParameter.hh:78
ExplorerPluginParameter::ExplorerPluginParameter
ExplorerPluginParameter(const std::string &name, ExplorerPluginParameterType type, bool compulsory, const TCEString value, const TCEString description="")
Definition: ExplorerPluginParameter.cc:44