Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
List of all members
Teuchos::NotCondition Class Reference

A Not condition returns the result of performing a logical NOT on a given condition. More...

#include <Teuchos_StandardConditions.hpp>

Inheritance diagram for Teuchos::NotCondition:
Inheritance graph
[legend]

Private Members

RCP< const ConditionchildCondition_
 

Constructors/Destructor

 NotCondition (RCP< const Condition > condition)
 Constructs a Not Condition.
 
virtual ~NotCondition ()
 Deconstructs a Not Condition.
 

Attribute/Query Functions

RCP< const ConditiongetChildCondition () const
 Retrieve the child condition.
 

Overridden from Condition

bool isConditionTrue () const
 
bool containsAtLeasteOneParameter () const
 
Dependency::ConstParameterEntryList getAllParameters () const
 
std::string getTypeAttributeValue () const
 Get the value that should be used for the condition type attribute when converting a condition to XML.
 

Additional Inherited Members

- Public Types inherited from Teuchos::Condition
typedef Teuchos::Array< Teuchos::RCP< Condition > > ConditionList
 Convenience typedef for defining a list of conditions.
 
typedef Teuchos::Array< Teuchos::RCP< const Condition > > ConstConditionList
 
- Public Member Functions inherited from Teuchos::Condition
 Condition ()
 Constructs a Condition.
 
virtual ~Condition ()
 Destructs a condition.
 
- Public Member Functions inherited from Teuchos::Describable
virtual std::string description () const
 Return a simple one-line description of this object.
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Print the object with some verbosity level to a FancyOStream.
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Version of describe() that takes an std::ostream instead of a FancyOStream.
 
virtual ~Describable ()
 Destructor (marked virtual for memory safety of derived classes).
 
- Public Member Functions inherited from Teuchos::LabeledObject
 LabeledObject ()
 Construct with an empty label.
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 Set the object label (see LabeledObject).
 
virtual std::string getObjectLabel () const
 Get the object label (see LabeledObject).
 
- 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().
 

Detailed Description

A Not condition returns the result of performing a logical NOT on a given condition.

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

Definition at line 752 of file Teuchos_StandardConditions.hpp.

Constructor & Destructor Documentation

◆ NotCondition()

Teuchos::NotCondition::NotCondition ( RCP< const Condition condition)

Constructs a Not Condition.

Parameters
conditionThe condition to be evaluated.

Definition at line 159 of file Teuchos_StandardConditions.cpp.

◆ ~NotCondition()

virtual Teuchos::NotCondition::~NotCondition ( )
inlinevirtual

Deconstructs a Not Condition.

Definition at line 769 of file Teuchos_StandardConditions.hpp.

Member Function Documentation

◆ getChildCondition()

RCP< const Condition > Teuchos::NotCondition::getChildCondition ( ) const
inline

Retrieve the child condition.

Definition at line 777 of file Teuchos_StandardConditions.hpp.

◆ isConditionTrue()

bool Teuchos::NotCondition::isConditionTrue ( ) const
virtual

Implements Teuchos::Condition.

Definition at line 174 of file Teuchos_StandardConditions.cpp.

◆ containsAtLeasteOneParameter()

bool Teuchos::NotCondition::containsAtLeasteOneParameter ( ) const
virtual

Implements Teuchos::Condition.

Definition at line 178 of file Teuchos_StandardConditions.cpp.

◆ getAllParameters()

Dependency::ConstParameterEntryList Teuchos::NotCondition::getAllParameters ( ) const
virtual

Implements Teuchos::Condition.

Definition at line 182 of file Teuchos_StandardConditions.cpp.

◆ getTypeAttributeValue()

std::string Teuchos::NotCondition::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 795 of file Teuchos_StandardConditions.hpp.

Member Data Documentation

◆ childCondition_

RCP<const Condition> Teuchos::NotCondition::childCondition_
private

The condition on which to perfrom the logical NOT.

Definition at line 809 of file Teuchos_StandardConditions.hpp.


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