Teuchos - Trilinos Tools Package Version of the Day
Teuchos::Dependency Class Reference

This class represents a depndency between elements in a Parameter List. More...

#include <Teuchos_Dependency.hpp>

Inheritance diagram for Teuchos::Dependency:
Teuchos::Describable Teuchos::LabeledObject Teuchos::ArrayModifierDependency< DependeeType, DependentType > Teuchos::ValidatorDependency Teuchos::VisualDependency Teuchos::NumberArrayLengthDependency< DependeeType, DependentType > Teuchos::TwoDArrayModifierDependency< DependeeType, DependentType > Teuchos::BoolValidatorDependency Teuchos::RangeValidatorDependency< T > Teuchos::StringValidatorDependency Teuchos::BoolVisualDependency Teuchos::ConditionVisualDependency Teuchos::NumberVisualDependency< T > Teuchos::StringVisualDependency

List of all members.

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.

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 ConstParameterEntryListgetDependees () const
 Gets the dependees of the dependency.
ParameterEntryListgetDependents ()
 Gets the dependents of the dependency.
const ConstParameterEntryListgetDependents () const
 Gets the dependents of the dependency.
RCP< const ParameterEntrygetFirstDependee () const
 Gets the first dependee in the dependees list. This is a convience function.
template<class 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.

Detailed Description

This class represents a depndency between elements in a Parameter List.

DependencySheet ParameterList

Definition at line 63 of file Teuchos_Dependency.hpp.


Member Typedef Documentation

A list of Dependees.

Definition at line 73 of file Teuchos_Dependency.hpp.

A list of dependents.

Definition at line 78 of file Teuchos_Dependency.hpp.


Constructor & Destructor Documentation

Teuchos::Dependency::Dependency ( ConstParameterEntryList  dependees,
ParameterEntryList  dependents 
)

Constructs a Dependency.

Parameters:
dependeesA list of all the dependees.
dependentsA 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.

Parameters:
dependeesA list of all the dependees.
dependentThe dependent parameter.

Definition at line 57 of file Teuchos_Dependency.cpp.

Teuchos::Dependency::Dependency ( RCP< const ParameterEntry dependee,
ParameterEntryList  dependents 
)

Constructs a Dependency.

Parameters:
dependeeThe dependee parameter.
dependentsA 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.

Parameters:
dependeeThe dependee parameter.
dependentThe dependent parameter.

Definition at line 78 of file Teuchos_Dependency.cpp.


Member Function Documentation

const ConstParameterEntryList& Teuchos::Dependency::getDependees ( ) const [inline]

Gets the dependees of the dependency.

Returns:
The dependees of the dependency.

Definition at line 135 of file Teuchos_Dependency.hpp.

ParameterEntryList& Teuchos::Dependency::getDependents ( ) [inline]

Gets the dependents of the dependency.

Returns:
The dependents of the dependency.

Definition at line 144 of file Teuchos_Dependency.hpp.

const ConstParameterEntryList& Teuchos::Dependency::getDependents ( ) const [inline]

Gets the dependents of the dependency.

Returns:
The dependents of the dependency.

Definition at line 153 of file Teuchos_Dependency.hpp.

RCP<const ParameterEntry> Teuchos::Dependency::getFirstDependee ( ) const [inline]

Gets the first dependee in the dependees list. This is a convience function.

Definition at line 161 of file Teuchos_Dependency.hpp.

template<class S >
S Teuchos::Dependency::getFirstDependeeValue ( ) const [inline]

Convienence function. Returns the first dependee in the list of dependees.

Returns:
The first dependee in the list of dependees.

Definition at line 172 of file Teuchos_Dependency.hpp.

virtual std::string Teuchos::Dependency::getTypeAttributeValue ( ) const [pure virtual]
static const std::string& Teuchos::Dependency::getXMLTagName ( ) [inline, static]

Returns the XML tag to use when serializing Dependencies.

Definition at line 186 of file Teuchos_Dependency.hpp.

virtual void Teuchos::Dependency::evaluate ( ) [pure virtual]
void Teuchos::Dependency::print ( std::ostream &  out) const [virtual]

prints out information about the dependency.

Definition at line 99 of file Teuchos_Dependency.cpp.

virtual void Teuchos::Dependency::validateDep ( ) const [protected, pure virtual]

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