OpenASIP 2.2
|
#include <ExplorerPluginParameter.hh>
Public Member Functions | |
ExplorerPluginParameter (const std::string &name, ExplorerPluginParameterType type, bool compulsory, const TCEString value, const TCEString description="") | |
virtual | ~ExplorerPluginParameter () |
TCEString | name () const |
TCEString | value () const |
TCEString | description () const |
void | setValue (const std::string &value) |
ExplorerPluginParameterType | type () const |
TCEString | typeAsString () const |
bool | isCompulsory () const |
bool | isSet () const |
Private Attributes | |
TCEString | name_ |
Parameter name. | |
ExplorerPluginParameterType | type_ |
Parameter type. | |
bool | compulsory_ |
Is parameter compulsory. | |
TCEString | value_ |
The value of the parameter as a string, empty if none set. | |
TCEString | description_ |
The description (help text). | |
Explorer plugin parameter class. Represents a parameter that an explorer plugin can have.
Definition at line 46 of file ExplorerPluginParameter.hh.
ExplorerPluginParameter::ExplorerPluginParameter | ( | const std::string & | name, |
ExplorerPluginParameterType | type, | ||
bool | compulsory, | ||
const TCEString | value, | ||
const TCEString | description = "" |
||
) |
The constructor.
Definition at line 43 of file ExplorerPluginParameter.cc.
|
virtual |
|
inline |
bool ExplorerPluginParameter::isCompulsory | ( | ) | const |
Returns boolean indicating if the parameter is always needed.
Definition at line 135 of file ExplorerPluginParameter.cc.
References compulsory_.
bool ExplorerPluginParameter::isSet | ( | ) | const |
Returns boolean indicating if the parameter is always needed.
Definition at line 146 of file ExplorerPluginParameter.cc.
TCEString ExplorerPluginParameter::name | ( | ) | const |
Returns the parameter name.
Definition at line 86 of file ExplorerPluginParameter.cc.
References name_.
Referenced by CallExplorerPluginWindow::doEdit(), EditParameterDialog::setTexts(), and CallExplorerPluginWindow::updateParameterList().
void ExplorerPluginParameter::setValue | ( | const std::string & | value | ) |
Sets the value of the parameter.
value | The value to be set for the parameter as a string. |
Definition at line 74 of file ExplorerPluginParameter.cc.
References value(), and value_.
Referenced by EditParameterDialog::onOk().
ExplorerPluginParameterType ExplorerPluginParameter::type | ( | ) | const |
Returns enum for parameter type.
Definition at line 97 of file ExplorerPluginParameter.cc.
References type_.
TCEString ExplorerPluginParameter::typeAsString | ( | ) | const |
Returns string describing the parameter type.
Definition at line 108 of file ExplorerPluginParameter.cc.
References BOOL, INT, STRING, type_, and UINT.
Referenced by EditParameterDialog::setTexts(), and CallExplorerPluginWindow::updateParameterList().
TCEString ExplorerPluginParameter::value | ( | ) | const |
Definition at line 63 of file ExplorerPluginParameter.cc.
References value_.
Referenced by CallExplorerPluginWindow::doEdit(), EditParameterDialog::setTexts(), setValue(), and CallExplorerPluginWindow::updateParameterList().
|
private |
Is parameter compulsory.
Definition at line 74 of file ExplorerPluginParameter.hh.
Referenced by isCompulsory().
|
private |
The description (help text).
Definition at line 78 of file ExplorerPluginParameter.hh.
Referenced by description().
|
private |
|
private |
Parameter type.
Definition at line 72 of file ExplorerPluginParameter.hh.
Referenced by type(), and typeAsString().
|
private |
The value of the parameter as a string, empty if none set.
Definition at line 76 of file ExplorerPluginParameter.hh.
Referenced by isSet(), setValue(), and value().