Teuchos Package Browser (Single Doxygen Collection)
Version of the Day
|
A Condition determines whether or not a particular set of conditions are currently occuring. More...
#include <Teuchos_Condition.hpp>
Public types | |
typedef Teuchos::Array < Teuchos::RCP< Condition > > | ConditionList |
Convenience typedef for defining a list of conditions. More... | |
typedef Teuchos::Array < Teuchos::RCP< const Condition > > | ConstConditionList |
Constructors/Destructor | |
Condition () | |
Constructs a Condition. More... | |
virtual | ~Condition () |
Destructs a condition. More... | |
virtual bool | isConditionTrue () const =0 |
Determins whether or not a condition is true. More... | |
virtual bool | containsAtLeasteOneParameter () const =0 |
Determines whether or not the evaluation of a parameter occurs somewhere in this condition. More... | |
virtual Dependency::ConstParameterEntryList | getAllParameters () const =0 |
Gets all of the parameters that are evaluated in this condition. More... | |
virtual std::string | getTypeAttributeValue () const =0 |
Get the value that should be used for the condition type attribute when converting a condition to XML. More... | |
static const std::string & | getXMLTagName () |
Additional Inherited Members | |
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 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... | |
A Condition determines whether or not a particular set of conditions are currently occuring.
Definition at line 62 of file Teuchos_Condition.hpp.
Convenience typedef for defining a list of conditions.
Definition at line 71 of file Teuchos_Condition.hpp.
typedef Teuchos::Array<Teuchos::RCP<const Condition> > Teuchos::Condition::ConstConditionList |
Definition at line 73 of file Teuchos_Condition.hpp.
|
inline |
Constructs a Condition.
Definition at line 83 of file Teuchos_Condition.hpp.
|
inlinevirtual |
Destructs a condition.
Definition at line 88 of file Teuchos_Condition.hpp.
|
pure virtual |
Determins whether or not a condition is true.
Attribute/Query Functions
Implemented in Teuchos::NotCondition, Teuchos::BoolLogicCondition, and Teuchos::ParameterCondition.
|
pure virtual |
Determines whether or not the evaluation of a parameter occurs somewhere in this condition.
Implemented in Teuchos::NotCondition, Teuchos::BoolLogicCondition, and Teuchos::ParameterCondition.
|
pure virtual |
Gets all of the parameters that are evaluated in this condition.
Implemented in Teuchos::NotCondition, Teuchos::BoolLogicCondition, and Teuchos::ParameterCondition.
|
pure virtual |
Get the value that should be used for the condition type attribute when converting a condition to XML.
Implemented in Teuchos::NotCondition, Teuchos::EqualsCondition, Teuchos::AndCondition, Teuchos::OrCondition, Teuchos::BoolCondition, Teuchos::NumberCondition< T >, and Teuchos::StringCondition.
|
inlinestatic |
Definition at line 120 of file Teuchos_Condition.hpp.