Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
Teuchos::ConditionVisualDependency Class Reference

A condition visual dependency says the following about the relationship between elements in a Parameter List: Depending on whether or not the dependee(s) statisfy a particual condition, the dependent may or may not be displayed to the user in a UI. More...

#include <Teuchos_StandardDependencies.hpp>

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

Constructors/Destructor

 ConditionVisualDependency (RCP< const Condition > condition, RCP< ParameterEntry > dependent, bool showIf=true)
 
 ConditionVisualDependency (RCP< const Condition > condition, Dependency::ParameterEntryList dependents, bool showIf=true)
 

Getter Functions

RCP< const ConditiongetCondition () const
 Gets the condition being used in this dependency. More...
 

Overridden from VisualDependency

bool getDependeeState () const
 

Overridden from Dependency

std::string getTypeAttributeValue () const
 
void validateDep () const
 

Private Members

RCP< const Conditioncondition_
 The Condition to determine whether or not the dependent is displayed. More...
 

Additional Inherited Members

- Public Types inherited from Teuchos::Dependency
typedef std::set< RCP
< ParameterEntry >, RCPComp
ParameterEntryList
 A list of Dependees. More...
 
typedef std::set< RCP< const
ParameterEntry >, RCPConstComp
ConstParameterEntryList
 A list of dependents. More...
 
- Public Member Functions inherited from Teuchos::VisualDependency
 VisualDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, bool showIf=getShowIfDefaultValue())
 Constructs a VisualDependency. More...
 
 VisualDependency (RCP< const ParameterEntry > dependee, ParameterEntryList dependents, bool showIf=getShowIfDefaultValue())
 Constructs a VisualDependency. More...
 
 VisualDependency (ConstParameterEntryList dependees, RCP< ParameterEntry > dependent, bool showIf=getShowIfDefaultValue())
 Constructs a VisualDependency. More...
 
 VisualDependency (ConstParameterEntryList dependees, ParameterEntryList dependents, bool showIf=getShowIfDefaultValue())
 Constructs a VisualDependency. More...
 
bool isDependentVisible () const
 Determines whether or not the dependent is currently visible. More...
 
bool getShowIf () const
 Get's the value of the showIf variable. More...
 
void evaluate ()
 
- Public Member Functions inherited from Teuchos::Dependency
 Dependency (ConstParameterEntryList dependees, ParameterEntryList dependents)
 Constructs a Dependency. More...
 
 Dependency (ConstParameterEntryList dependees, RCP< ParameterEntry > dependent)
 Constructs a Dependency. More...
 
 Dependency (RCP< const ParameterEntry > dependee, ParameterEntryList dependents)
 Constructs a Dependency. More...
 
 Dependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent)
 Constructs a Dependency. More...
 
const ConstParameterEntryListgetDependees () const
 Gets the dependees of the dependency. More...
 
ParameterEntryListgetDependents ()
 Gets the dependents of the dependency. More...
 
const ConstParameterEntryListgetDependents () const
 Gets the dependents of the dependency. More...
 
RCP< const ParameterEntrygetFirstDependee () const
 Gets the first dependee in the dependees list. This is a convience function. More...
 
template<class S >
getFirstDependeeValue () const
 Convienence function. Returns the first dependee in the list of dependees. More...
 
virtual void print (std::ostream &out) const
 prints out information about the dependency. 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...
 
- Static Public Member Functions inherited from Teuchos::VisualDependency
static const bool & getShowIfDefaultValue ()
 
- Static Public Member Functions inherited from Teuchos::Dependency
static const std::string & getXMLTagName ()
 Returns the XML tag to use when serializing Dependencies. More...
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default = VERB_DEFAULT
 Default value for the verbLevel argument of describe(). More...
 
- Protected Member Functions inherited from Teuchos::Dependency

Detailed Description

A condition visual dependency says the following about the relationship between elements in a Parameter List: Depending on whether or not the dependee(s) statisfy a particual condition, the dependent may or may not be displayed to the user in a UI.

Condition Visual Dependencies are unique in that via the Condition class, they allow for multiple dependees. The dependee(s) of a ConditionVisualDependency must be expressed as a Condition and are subject to the consquential constraints. The dependent may be any type of parameter or parameter list.

Please see ConditionVisualDependencyXMLConverter for documentation regarding the XML representation of this Dependency.

Definition at line 495 of file Teuchos_StandardDependencies.hpp.

Constructor & Destructor Documentation

Teuchos::ConditionVisualDependency::ConditionVisualDependency ( RCP< const Condition condition,
RCP< ParameterEntry dependent,
bool  showIf = true 
)

Constructs a ConditionVisualDependency.

Parameters
conditionThe condition that must be satisfied in order to display the dependent parameter.
dependentThe dependent parameter.
showIfWhen true, the depndent will be be shown if the condition is true. If false, the dependent will be shown only when the condition is false.

Definition at line 203 of file Teuchos_StandardDependencies.cpp.

Teuchos::ConditionVisualDependency::ConditionVisualDependency ( RCP< const Condition condition,
Dependency::ParameterEntryList  dependents,
bool  showIf = true 
)

Constructs a ConditionVisualDependency.

Parameters
conditionThe condition that must be satisfied in order to display the dependent parameter.
dependentsThe dependent parameters.
showIfWhen true, the depndent will be be shown if the condition is true. If false, the dependent will be shown only when the condition is false.

Definition at line 213 of file Teuchos_StandardDependencies.cpp.

Member Function Documentation

RCP< const Condition > Teuchos::ConditionVisualDependency::getCondition ( ) const

Gets the condition being used in this dependency.

Definition at line 223 of file Teuchos_StandardDependencies.cpp.

bool Teuchos::ConditionVisualDependency::getDependeeState ( ) const
virtual

Implements Teuchos::VisualDependency.

Definition at line 227 of file Teuchos_StandardDependencies.cpp.

std::string Teuchos::ConditionVisualDependency::getTypeAttributeValue ( ) const
virtual

Implements Teuchos::Dependency.

Definition at line 231 of file Teuchos_StandardDependencies.cpp.

void Teuchos::ConditionVisualDependency::validateDep ( ) const
inlineprotectedvirtual

Implements Teuchos::Dependency.

Definition at line 563 of file Teuchos_StandardDependencies.hpp.

Member Data Documentation

RCP<const Condition> Teuchos::ConditionVisualDependency::condition_
private

The Condition to determine whether or not the dependent is displayed.

Definition at line 576 of file Teuchos_StandardDependencies.hpp.


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