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::VisualDependency Class Referenceabstract

An abstract parent class for all visual dependencies. More...

#include <Teuchos_StandardDependencies.hpp>

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

Public Constant Accessors

static const bool & getShowIfDefaultValue ()
 

Constructors/Destructor

 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...
 

Attribute/Query Methods

virtual bool getDependeeState () const =0
 Get the state of the dependee in order to evaluate the dependency. 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...
 

Overridden from Dependency

void evaluate ()
 

Private Members

bool dependentVisible_
 Whether or not the dependent is currently visible. More...
 
bool showIf_
 Whether or not to show the dependent if the dependee is set to the value. 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::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 std::string getTypeAttributeValue () const =0
 Returns the string to be used for the value of the type attribute when converting the dependency to XML. 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::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
virtual void validateDep () const =0
 Validates the dependency to make sure it's valid/has been setup properly. If subclassing, this fucntion should be called in the new subclasses constructor. More...
 

Detailed Description

An abstract parent class for all visual dependencies.

IMPORTANT NOTE: If a parameter becomes hidden, it's validity will not necessarily be checked. This means that it is indeed possible for a non-valid ParameterList to occur. Make sure that you program code takes this into account.

Definition at line 38 of file Teuchos_StandardDependencies.hpp.

Constructor & Destructor Documentation

Teuchos::VisualDependency::VisualDependency ( RCP< const ParameterEntry dependee,
RCP< ParameterEntry dependent,
bool  showIf = getShowIfDefaultValue() 
)

Constructs a VisualDependency.

Parameters
dependeeThe dependee parameter.
dependentThe dependent parameter.
showIfWhen true, the depndent will be be shown if the dependee is true.

Definition at line 17 of file Teuchos_StandardDependencies.cpp.

Teuchos::VisualDependency::VisualDependency ( RCP< const ParameterEntry dependee,
ParameterEntryList  dependents,
bool  showIf = getShowIfDefaultValue() 
)

Constructs a VisualDependency.

Parameters
dependeeThe dependee parameter.
dependentsThe dependent parameters.
showIfWhen true, the depndent will be be shown if the dependee is true.

Definition at line 26 of file Teuchos_StandardDependencies.cpp.

Teuchos::VisualDependency::VisualDependency ( ConstParameterEntryList  dependees,
RCP< ParameterEntry dependent,
bool  showIf = getShowIfDefaultValue() 
)

Constructs a VisualDependency.

Parameters
dependeesThe dependees.
dependentThe dependent parameter.
showIfWhen true, the depndent will be be shown if the dependee is true.

Definition at line 35 of file Teuchos_StandardDependencies.cpp.

Teuchos::VisualDependency::VisualDependency ( ConstParameterEntryList  dependees,
ParameterEntryList  dependents,
bool  showIf = getShowIfDefaultValue() 
)

Constructs a VisualDependency.

Parameters
dependeesThe dependees.
dependentsThe dependets.
showIfWhen true, the depndent will be be shown if the dependee is true.

Definition at line 44 of file Teuchos_StandardDependencies.cpp.

Member Function Documentation

static const bool& Teuchos::VisualDependency::getShowIfDefaultValue ( )
inlinestatic

Definition at line 43 of file Teuchos_StandardDependencies.hpp.

virtual bool Teuchos::VisualDependency::getDependeeState ( ) const
pure virtual

Get the state of the dependee in order to evaluate the dependency.

Returns
The state of the dependee.

Implemented in Teuchos::NumberVisualDependency< T >, Teuchos::ConditionVisualDependency, Teuchos::BoolVisualDependency, and Teuchos::StringVisualDependency.

bool Teuchos::VisualDependency::isDependentVisible ( ) const

Determines whether or not the dependent is currently visible.

Definition at line 53 of file Teuchos_StandardDependencies.cpp.

bool Teuchos::VisualDependency::getShowIf ( ) const

Get's the value of the showIf variable.

Definition at line 57 of file Teuchos_StandardDependencies.cpp.

void Teuchos::VisualDependency::evaluate ( )
virtual

Implements Teuchos::Dependency.

Definition at line 61 of file Teuchos_StandardDependencies.cpp.

Member Data Documentation

bool Teuchos::VisualDependency::dependentVisible_
private

Whether or not the dependent is currently visible.

Definition at line 143 of file Teuchos_StandardDependencies.hpp.

bool Teuchos::VisualDependency::showIf_
private

Whether or not to show the dependent if the dependee is set to the value.

Definition at line 149 of file Teuchos_StandardDependencies.hpp.


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