Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
Teuchos::StringVisualDependency Class Reference

A string visual dependency says the following about the relationship between two elements in a Parameter List: Depending on whether or not the dependee has a particular value, the dependent may or may not be displayed to the user in a UI. More...

#include <Teuchos_StandardDependencies.hpp>

Inheritance diagram for Teuchos::StringVisualDependency:
Teuchos::VisualDependency Teuchos::Dependency Teuchos::Describable Teuchos::LabeledObject

Public Types

Public types
typedef Array< std::string > ValueList
 
- 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

Constructors/Destructor
 StringVisualDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, std::string value, bool showIf=true)
 Constructs a StringVisualDependency. More...
 
 StringVisualDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, const ValueList &values, bool showIf=true)
 Constructs a StringVisualDependency. More...
 
 StringVisualDependency (RCP< const ParameterEntry > dependee, Dependency::ParameterEntryList dependents, const std::string &value, bool showIf=true)
 Constructs a StringVisualDependency. More...
 
 StringVisualDependency (RCP< const ParameterEntry > dependee, Dependency::ParameterEntryList dependents, const ValueList &values, bool showIf=true)
 Constructs a StringVisualDependency. More...
 
Attribute/Query Functions
const ValueListgetValues () const
 get the List of values the dependee will be checked against. More...
 
Overridden from VisualDependency
bool getDependeeState () const
 
- 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...
 
virtual void print (std::ostream &out) const
 prints out information about the 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...
 
- 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...
 

Overridden from Dependency

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

Additional Inherited Members

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

Detailed Description

A string visual dependency says the following about the relationship between two elements in a Parameter List: Depending on whether or not the dependee has a particular value, the dependent may or may not be displayed to the user in a UI.

The dependee of a StringVisualDependency must be of type string and can't be an array. The dependent may be any type of parameter or parameter list.

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

Definition at line 210 of file Teuchos_StandardDependencies.hpp.

Member Typedef Documentation

Convience typedef representing an array of strings.

Definition at line 220 of file Teuchos_StandardDependencies.hpp.

Constructor & Destructor Documentation

Teuchos::StringVisualDependency::StringVisualDependency ( RCP< const ParameterEntry dependee,
RCP< ParameterEntry dependent,
std::string  value,
bool  showIf = true 
)

Constructs a StringVisualDependency.

Parameters
dependeeThe dependee paramter. dependent The dependent parameter.
valueThe value of the depndee that affects the visiblity of the dependent.
showIfWhen true, the depndent will be be shown if the dependee is set to the same value as specified by the value parameter. If false, the dependent will be shown only when the dependee is set to a value other than the one specified by the value parameter.

Definition at line 80 of file Teuchos_StandardDependencies.cpp.

Teuchos::StringVisualDependency::StringVisualDependency ( RCP< const ParameterEntry dependee,
RCP< ParameterEntry dependent,
const ValueList values,
bool  showIf = true 
)

Constructs a StringVisualDependency.

Parameters
dependeeThe dependee parameter.
dependentThe dependent parameter.
valuesThe values of the depndee that affect the visiblity of the dependent.
showIfWhen true, the depndent will be be shown if the dependee is set to one of the values specified by the values parameter. If false, the dependent will be shown only when the dependee is set to a value other than the ones specified by the values parameter.

Definition at line 91 of file Teuchos_StandardDependencies.cpp.

Teuchos::StringVisualDependency::StringVisualDependency ( RCP< const ParameterEntry dependee,
Dependency::ParameterEntryList  dependents,
const std::string &  value,
bool  showIf = true 
)

Constructs a StringVisualDependency.

Parameters
dependeeThe dependee parameter.
dependentsThe dependents
valueThe value of the depndee that affects the visiblity of the dependent.
showIfWhen true, the depndent will be be shown if the dependee is set to one of the values specified by the values parameter. If false, the dependent will be shown only when the dependee is set to a value other than the ones specified by the values parameter.

Definition at line 102 of file Teuchos_StandardDependencies.cpp.

Teuchos::StringVisualDependency::StringVisualDependency ( RCP< const ParameterEntry dependee,
Dependency::ParameterEntryList  dependents,
const ValueList values,
bool  showIf = true 
)

Constructs a StringVisualDependency.

Parameters
dependeeThe dependee parameter.
dependentsThe dependents
valuesThe values of the depndee that affect the visiblity of the dependent.
showIfWhen true, the depndent will be be shown if the dependee is set to one of the values specified by the values parameter. If false, the dependent will be shown only when the dependee is set to a value other than the ones specified by the values parameter.

Definition at line 113 of file Teuchos_StandardDependencies.cpp.

Member Function Documentation

const StringVisualDependency::ValueList & Teuchos::StringVisualDependency::getValues ( ) const

get the List of values the dependee will be checked against.

Definition at line 125 of file Teuchos_StandardDependencies.cpp.

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

Implements Teuchos::VisualDependency.

Definition at line 130 of file Teuchos_StandardDependencies.cpp.

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

Implements Teuchos::Dependency.

Definition at line 135 of file Teuchos_StandardDependencies.cpp.

void Teuchos::StringVisualDependency::validateDep ( ) const
protectedvirtual

Implements Teuchos::Dependency.

Definition at line 139 of file Teuchos_StandardDependencies.cpp.


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