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

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

#include <Teuchos_Dependency.hpp>

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

Public types

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

Constructors/Destructor

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

Attribute/Query Methods

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...
 
static const std::string & getXMLTagName ()
 Returns the XML tag to use when serializing Dependencies. More...
 

Evalutation Functions

virtual void evaluate ()=0
 Evaluates the dependency and makes any appropriate changes to the dependee based on the dependent. More...
 

I/O Functions

virtual void print (std::ostream &out) const
 prints out information about the dependency. More...
 

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

Private Members

ConstParameterEntryList dependees_
 The parameters being depended upon. More...
 
ParameterEntryList dependents_
 The dependent paramters. More...
 
ConstParameterEntryList constDependents_
 A const version dependent paramters. More...
 
 Dependency ()
 Declaring and defining the default constructor as private. More...
 
void createConstDependents ()
 creates a const version of the dependent parameters. More...
 
void checkDependeesAndDependents ()
 makes sure the none of the dependess and dependets are null. More...
 

Additional Inherited Members

- 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 Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default = VERB_DEFAULT
 Default value for the verbLevel argument of describe(). More...
 

Detailed Description

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

DependencySheet ParameterList

Definition at line 31 of file Teuchos_Dependency.hpp.

Member Typedef Documentation

A list of Dependees.

Definition at line 41 of file Teuchos_Dependency.hpp.

A list of dependents.

Definition at line 46 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 16 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 25 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 36 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 46 of file Teuchos_Dependency.cpp.

Teuchos::Dependency::Dependency ( )
inlineprivate

Declaring and defining the default constructor as private.

Definition at line 217 of file Teuchos_Dependency.hpp.

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 103 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 112 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 121 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 129 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 140 of file Teuchos_Dependency.hpp.

virtual std::string Teuchos::Dependency::getTypeAttributeValue ( ) const
pure virtual
static const std::string& Teuchos::Dependency::getXMLTagName ( )
inlinestatic

Returns the XML tag to use when serializing Dependencies.

Definition at line 154 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 67 of file Teuchos_Dependency.cpp.

virtual void Teuchos::Dependency::validateDep ( ) const
protectedpure virtual
void Teuchos::Dependency::createConstDependents ( )
private

creates a const version of the dependent parameters.

Definition at line 57 of file Teuchos_Dependency.cpp.

void Teuchos::Dependency::checkDependeesAndDependents ( )
private

makes sure the none of the dependess and dependets are null.

Definition at line 74 of file Teuchos_Dependency.cpp.

Member Data Documentation

ConstParameterEntryList Teuchos::Dependency::dependees_
private

The parameters being depended upon.

Definition at line 202 of file Teuchos_Dependency.hpp.

ParameterEntryList Teuchos::Dependency::dependents_
private

The dependent paramters.

Definition at line 207 of file Teuchos_Dependency.hpp.

ConstParameterEntryList Teuchos::Dependency::constDependents_
private

A const version dependent paramters.

Definition at line 212 of file Teuchos_Dependency.hpp.


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