My Project
Public Member Functions | List of all members
OptionWarning Class Reference

Toggle whether a warning should be issued if a specific action/rule is applied. More...

Inheritance diagram for OptionWarning:
Inheritance graph
[legend]
Collaboration diagram for OptionWarning:
Collaboration graph
[legend]

Public Member Functions

 OptionWarning (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 whether a warning should be issued if a specific action/rule is applied.

The first parameter gives the name of the Action or RuleAction. The second parameter is "on" to turn on warnings, "off" to turn them off.

Member Function Documentation

◆ apply()

string OptionWarning::apply ( Architecture glb,
const string &  p1,
const string &  p2,
const string &  p3 
) const
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
glbis the Architecture being configured
p1is the first optional configuration string
p2is the second optional configuration string
p3is the third optional configuration string
Returns
a confirmation/failure message

Implements ArchOption.


The documentation for this class was generated from the following files: