Teuchos::StringCondition Class Reference

A String Condition is a Parameter Condition that evaluates whether or not a string parameter has taken on a particular value or set of values. More...

#include <Teuchos_StandardConditions.hpp>

Inheritance diagram for Teuchos::StringCondition:

Public Types
Public types
typedef Array< std::string >	ValueList
	Convience typedef representing an array of strings. More...
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
Constructors/Destructor
	StringCondition (RCP< const ParameterEntry > parameter, std::string value)
	Constructs a String Condition. More...
	StringCondition (RCP< const ParameterEntry > parameter, ValueList values)
	Constructs a String Condition. More...
virtual	~StringCondition ()
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
Attribute/Query Functions
const ValueList &	getValueList () const
	Returns the value list being used with this StringCondition. More...
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...

Additional Inherited Members
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 verbLevel argument 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...

Detailed Description

A String Condition is a Parameter Condition that evaluates whether or not a string parameter has taken on a particular value or set of values.

Please see StringConditionConverter for documenation regarding the XML representation of this condition.

Definition at line 111 of file Teuchos_StandardConditions.hpp.

Member Typedef Documentation

typedef Array<std::string> Teuchos::StringCondition::ValueList

Convience typedef representing an array of strings.

Definition at line 121 of file Teuchos_StandardConditions.hpp.

Constructor & Destructor Documentation

Teuchos::StringCondition::StringCondition	(	RCP< const ParameterEntry >	parameter,
		std::string	value
	)

Constructs a String Condition.

Parameters

parameter	The parameter to be evaluated. be evaluated.
value	The value to compare the parameter's value against.

Definition at line 157 of file Teuchos_StandardConditions.cpp.

Teuchos::StringCondition::StringCondition	(	RCP< const ParameterEntry >	parameter,
		ValueList	values
	)

Constructs a String Condition.

Parameters

parameter	The parameter to be evaluated.
values	The list values to compare the parameter's value against.

Definition at line 166 of file Teuchos_StandardConditions.cpp.

Member Function Documentation

std::string Teuchos::StringCondition::getTypeAttributeValue ( ) const

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

bool Teuchos::StringCondition::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 186 of file Teuchos_StandardConditions.cpp.

const ValueList& Teuchos::StringCondition::getValueList ( ) const

inline

Returns the value list being used with this StringCondition.

Definition at line 169 of file Teuchos_StandardConditions.hpp.

---

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

• Teuchos_StandardConditions.hpp
• Teuchos_StandardConditions.cpp