Teuchos - Trilinos Tools Package Version of the Day
|
This class represents a depndency between elements in a Parameter List. More...
#include <Teuchos_Dependency.hpp>
Public Types | |
Public types | |
typedef std::set< RCP< ParameterEntry >, RCPComp > | ParameterEntryList |
A list of Dependees. | |
typedef std::set< RCP< const ParameterEntry >, RCPConstComp > | ConstParameterEntryList |
A list of dependents. | |
Public Member Functions | |
Constructors/Destructor | |
Dependency (ConstParameterEntryList dependees, ParameterEntryList dependents) | |
Constructs a Dependency. | |
Dependency (ConstParameterEntryList dependees, RCP< ParameterEntry > dependent) | |
Constructs a Dependency. | |
Dependency (RCP< const ParameterEntry > dependee, ParameterEntryList dependents) | |
Constructs a Dependency. | |
Dependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent) | |
Constructs a Dependency. | |
Evalutation Functions | |
virtual void | evaluate ()=0 |
Evaluates the dependency and makes any appropriate changes to the dependee based on the dependent. | |
I/O Functions | |
virtual void | print (std::ostream &out) const |
prints out information about the dependency. | |
![]() | |
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). | |
![]() | |
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). | |
Protected Member Functions | |
Validation Functions | |
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. | |
Attribute/Query Methods | |
const ConstParameterEntryList & | getDependees () const |
Gets the dependees of the dependency. | |
ParameterEntryList & | getDependents () |
Gets the dependents of the dependency. | |
const ConstParameterEntryList & | getDependents () const |
Gets the dependents of the dependency. | |
RCP< const ParameterEntry > | getFirstDependee () const |
Gets the first dependee in the dependees list. This is a convience function. | |
template<class S > | |
S | getFirstDependeeValue () const |
Convienence function. Returns the first dependee in the list of dependees. | |
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. | |
static const std::string & | getXMLTagName () |
Returns the XML tag to use when serializing Dependencies. | |
Additional Inherited Members | |
![]() | |
static const EVerbosityLevel | verbLevel_default = VERB_DEFAULT |
Default value for the verbLevel argument of describe(). | |
![]() | |
DescribableStreamManipulatorState | describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default) |
Describable output stream manipulator. | |
std::ostream & | operator<< (std::ostream &os, const DescribableStreamManipulatorState &d) |
Output stream operator for Describable manipulator. | |
This class represents a depndency between elements in a Parameter List.
\reference DependencySheet \reference ParameterList
Definition at line 64 of file Teuchos_Dependency.hpp.
A list of Dependees.
Definition at line 74 of file Teuchos_Dependency.hpp.
typedef std::set<RCP<const ParameterEntry>, RCPConstComp > Teuchos::Dependency::ConstParameterEntryList |
A list of dependents.
Definition at line 79 of file Teuchos_Dependency.hpp.
Teuchos::Dependency::Dependency | ( | ConstParameterEntryList | dependees, |
ParameterEntryList | dependents ) |
Constructs a Dependency.
dependees | A list of all the dependees. |
dependents | A list of all the dependents. |
Definition at line 48 of file Teuchos_Dependency.cpp.
Teuchos::Dependency::Dependency | ( | ConstParameterEntryList | dependees, |
RCP< ParameterEntry > | dependent ) |
Constructs a Dependency.
dependees | A list of all the dependees. |
dependent | The dependent parameter. |
Definition at line 57 of file Teuchos_Dependency.cpp.
Teuchos::Dependency::Dependency | ( | RCP< const ParameterEntry > | dependee, |
ParameterEntryList | dependents ) |
Constructs a Dependency.
dependee | The dependee parameter. |
dependents | A List of all the dependents. |
Definition at line 68 of file Teuchos_Dependency.cpp.
Teuchos::Dependency::Dependency | ( | RCP< const ParameterEntry > | dependee, |
RCP< ParameterEntry > | dependent ) |
Constructs a Dependency.
dependee | The dependee parameter. |
dependent | The dependent parameter. |
Definition at line 78 of file Teuchos_Dependency.cpp.
|
inline |
Gets the dependees of the dependency.
Definition at line 136 of file Teuchos_Dependency.hpp.
|
inline |
Gets the dependents of the dependency.
Definition at line 145 of file Teuchos_Dependency.hpp.
|
inline |
Gets the dependents of the dependency.
Definition at line 154 of file Teuchos_Dependency.hpp.
|
inline |
Gets the first dependee in the dependees list. This is a convience function.
Definition at line 162 of file Teuchos_Dependency.hpp.
Convienence function. Returns the first dependee in the list of dependees.
Definition at line 173 of file Teuchos_Dependency.hpp.
|
pure virtual |
Returns the string to be used for the value of the type attribute when converting the dependency to XML.
Implemented in Teuchos::StringVisualDependency, Teuchos::BoolVisualDependency, Teuchos::ConditionVisualDependency, Teuchos::NumberVisualDependency< T >, Teuchos::NumberArrayLengthDependency< DependeeType, DependentType >, Teuchos::StringValidatorDependency, Teuchos::BoolValidatorDependency, Teuchos::RangeValidatorDependency< T >, Teuchos::TwoDRowDependency< DependeeType, DependentType >, and Teuchos::TwoDColDependency< DependeeType, DependentType >.
Returns the XML tag to use when serializing Dependencies.
Definition at line 187 of file Teuchos_Dependency.hpp.
Evaluates the dependency and makes any appropriate changes to the dependee based on the dependent.
Implemented in Teuchos::VisualDependency, Teuchos::ArrayModifierDependency< DependeeType, DependentType >, Teuchos::StringValidatorDependency, Teuchos::BoolValidatorDependency, Teuchos::RangeValidatorDependency< T >, and Teuchos::ValidatorDependency.
|
virtual |
prints out information about the dependency.
Definition at line 99 of file Teuchos_Dependency.cpp.
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.
Implemented in Teuchos::StringVisualDependency, Teuchos::BoolVisualDependency, Teuchos::ConditionVisualDependency, Teuchos::NumberVisualDependency< T >, Teuchos::ArrayModifierDependency< DependeeType, DependentType >, Teuchos::NumberArrayLengthDependency< DependeeType, DependentType >, Teuchos::StringValidatorDependency, Teuchos::BoolValidatorDependency, Teuchos::RangeValidatorDependency< T >, and Teuchos::TwoDArrayModifierDependency< DependeeType, DependentType >.