Teuchos::BoolCondition Class Reference

A Bool Condition is a Parameter Condition that evaluates whether or not a Boolean parameter is ture. More...

#include <Teuchos_StandardConditions.hpp>

Inheritance diagram for Teuchos::BoolCondition:

List of all members.

Constructors/Destructor
	BoolCondition (RCP< const ParameterEntry > parameter)
	Constructs a Bool Condition.
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.
Overridden from ParameterCondition
bool	evaluateParameter () const

---

Detailed Description

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 374 of file Teuchos_StandardConditions.hpp.

---

Constructor & Destructor Documentation

Teuchos::BoolCondition::BoolCondition

(

RCP< const ParameterEntry >

parameter

)

Constructs a Bool Condition.

Parameters:

parameterName

The name of the parameter to be evaluated.

Definition at line 231 of file Teuchos_StandardConditions.cpp.

virtual Teuchos::BoolCondition::~BoolCondition

(

)

[inline, virtual]

Definition at line 388 of file Teuchos_StandardConditions.hpp.

---

Member Function Documentation

std::string Teuchos::BoolCondition::getTypeAttributeValue

(

)

const [inline, virtual]

Get the value that should be used for the condition type attribute when converting a condition to XML.

Implements Teuchos::Condition.

Definition at line 395 of file Teuchos_StandardConditions.hpp.

bool Teuchos::BoolCondition::evaluateParameter

(

)

const [virtual]

Evaluate the current condition of a parameter and return the result.

Parameters:

The	result of evaluating the current condition of the parameter.

Implements Teuchos::ParameterCondition.

Definition at line 243 of file Teuchos_StandardConditions.cpp.

---

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

• Teuchos_StandardConditions.hpp
• Teuchos_StandardConditions.cpp