| Teuchos Package Browser (Single Doxygen Collection)
    Version of the Day
    | 
A Bool Condition is a Parameter Condition that evaluates whether or not a Boolean parameter is ture. More...
#include <Teuchos_StandardConditions.hpp>

| Constructors/Destructor | |
| BoolCondition (RCP< const ParameterEntry > parameter) | |
| Constructs a Bool Condition.  More... | |
| virtual | ~BoolCondition () | 
| Overridden from Condition | |
| std::string | getTypeAttributeValue () const | 
| Get the value that should be used for the condition type attribute when converting a condition to XML.  More... | |
| Overridden from ParameterCondition | |
| bool | evaluateParameter () const | 
| Additional Inherited Members | |
|  Public Types inherited from Teuchos::Condition | |
| typedef Teuchos::Array < Teuchos::RCP< Condition > > | ConditionList | 
| Convenience typedef for defining a list of conditions.  More... | |
| typedef Teuchos::Array < Teuchos::RCP< const Condition > > | ConstConditionList | 
|  Public Member Functions inherited from Teuchos::ParameterCondition | |
| ParameterCondition (RCP< const ParameterEntry > parameter) | |
| Constructs a Parameter Condition.  More... | |
| virtual | ~ParameterCondition () | 
| RCP< const ParameterEntry > | getParameter () const | 
| Gets a const pointer to the Parameter being evaluated by this ParameterCondition.  More... | |
| bool | isConditionTrue () const | 
| Determins whether or not a condition is true.  More... | |
| bool | containsAtLeasteOneParameter () const | 
| Determines whether or not the evaluation of a parameter occurs somewhere in this condition.  More... | |
| Dependency::ConstParameterEntryList | getAllParameters () const | 
| Gets all of the parameters that are evaluated in this condition.  More... | |
|  Public Member Functions inherited from Teuchos::Condition | |
| Condition () | |
| Constructs a Condition.  More... | |
| virtual | ~Condition () | 
| Destructs a condition.  More... | |
|  Public Member Functions inherited from Teuchos::Describable | |
| virtual std::string | description () const | 
| Return a simple one-line description of this object.  More... | |
| virtual void | describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const | 
| Print the object with some verbosity level to a FancyOStream.  More... | |
| void | describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const | 
| Version of describe() that takes an std::ostream instead of a FancyOStream.  More... | |
| virtual | ~Describable () | 
| Destructor (marked virtual for memory safety of derived classes).  More... | |
|  Public Member Functions inherited from Teuchos::LabeledObject | |
| LabeledObject () | |
| Construct with an empty label.  More... | |
| virtual | ~LabeledObject () | 
| virtual void | setObjectLabel (const std::string &objectLabel) | 
| Set the object label (see LabeledObject).  More... | |
| virtual std::string | getObjectLabel () const | 
| Get the object label (see LabeledObject).  More... | |
|  Static Public Member Functions inherited from Teuchos::Condition | |
| static const std::string & | getXMLTagName () | 
|  Static Public Attributes inherited from Teuchos::Describable | |
| static const EVerbosityLevel | verbLevel_default = VERB_DEFAULT | 
| Default value for the verbLevelargument of describe().  More... | |
|  Related Functions inherited from Teuchos::Describable | |
| DescribableStreamManipulatorState | describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default) | 
| Describable output stream manipulator.  More... | |
| std::ostream & | operator<< (std::ostream &os, const DescribableStreamManipulatorState &d) | 
| Output stream operator for Describable manipulator.  More... | |
A Bool Condition is a Parameter Condition that evaluates whether or not a Boolean parameter is ture.
Please see BoolConditionConverter for documenation regarding the XML representation of this condition.
Definition at line 341 of file Teuchos_StandardConditions.hpp.
| Teuchos::BoolCondition::BoolCondition | ( | RCP< const ParameterEntry > | parameter | ) | 
Constructs a Bool Condition.
| parameterName | The name of the parameter to be evaluated. | 
Definition at line 197 of file Teuchos_StandardConditions.cpp.
| 
 | inlinevirtual | 
Definition at line 355 of file Teuchos_StandardConditions.hpp.
| 
 | inlinevirtual | 
Get the value that should be used for the condition type attribute when converting a condition to XML.
Implements Teuchos::Condition.
Definition at line 362 of file Teuchos_StandardConditions.hpp.
| 
 | virtual | 
Evaluate the current condition of a parameter and return the result.
| The | result of evaluating the current condition of the parameter. | 
Implements Teuchos::ParameterCondition.
Definition at line 209 of file Teuchos_StandardConditions.cpp.
 1.8.5
 1.8.5