Teuchos - Trilinos Tools Package Version of the Day
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:
Teuchos::Condition Teuchos::Describable Teuchos::LabeledObject

List of all members.

Public Member Functions

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.

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

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

Constructs a Not Condition.

Parameters:
conditionThe condition to be evaluated.

Definition at line 164 of file Teuchos_StandardConditions.cpp.

virtual Teuchos::NotCondition::~NotCondition ( ) [inline, virtual]

Deconstructs a Not Condition.

Definition at line 769 of file Teuchos_StandardConditions.hpp.


Member Function Documentation

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

Retrieve the child condition.

Definition at line 777 of file Teuchos_StandardConditions.hpp.

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

Implements Teuchos::Condition.

Definition at line 179 of file Teuchos_StandardConditions.cpp.

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

Implements Teuchos::Condition.

Definition at line 183 of file Teuchos_StandardConditions.cpp.

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

Implements Teuchos::Condition.

Definition at line 187 of file Teuchos_StandardConditions.cpp.

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


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines