Toggle a sub-group of actions within a root Action. More...
Public Member Functions | |
| OptionCurrentAction (void) | |
| Constructor. | |
| virtual string | apply (Architecture *glb, const string &p1, const string &p2, const string &p3) const |
| Apply a particular configuration option to the Architecture. More... | |
 Public Member Functions inherited from ArchOption | |
| string | getName (void) const |
| Return the name of the option. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ArchOption | |
| static bool | onOrOff (const string &p) |
| Parse an "on" or "off" string. More... | |
| Protected Attributes inherited from ArchOption | |
| string | name |
| Name of the option. | |
Detailed Description
Toggle a sub-group of actions within a root Action.
If two parameters are given, the first indicates the name of the sub-group, and the second is the toggle value, "on" or "off". The change is applied to the current root Action.
If three parameters are given, the first indicates the root Action (which will be set as current) to modify. The second and third parameters give the name of the sub-group and the toggle value.
Member Function Documentation
◆ apply()
|
virtual |
Apply a particular configuration option to the Architecture.
This method is overloaded by the different Option classes to provide possible configuration of different parts of the Architecture. The user can provide up to three optional parameters to tailor a specific type of configuration. The method returns a confirmation/failure message as feedback.
- Parameters
-
glb is the Architecture being configured p1 is the first optional configuration string p2 is the second optional configuration string p3 is the third optional configuration string
- Returns
- a confirmation/failure message
Implements ArchOption.
References Architecture::allacts, ActionDatabase::getCurrentName(), ArchOption::onOrOff(), ActionDatabase::setCurrent(), and ActionDatabase::toggleAction().
The documentation for this class was generated from the following files:
- options.hh
- options.cc
