Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos::TwoDColDependencyXMLConverter< DependeeType, DependentType > Class Template Reference

A class for converting TwoDColDependencies to and from XML. More...

#include <Teuchos_StandardDependencyXMLConverters.hpp>

Inheritance diagram for Teuchos::TwoDColDependencyXMLConverter< DependeeType, DependentType >:
Inheritance graph
[legend]

List of all members.

Overridden from ArrayModifierDependency

virtual RCP
< ArrayModifierDependency
< DependeeType, DependentType > > 
getConcreteDependency (RCP< const ParameterEntry > dependee, Dependency::ParameterEntryList dependents, RCP< const SimpleFunctionObject< DependeeType > > function) const
 Obtains a concrete ArrayModifierDependency given a dependee, dependtns, and a funciton object.

Detailed Description

template<class DependeeType, class DependentType>
class Teuchos::TwoDColDependencyXMLConverter< DependeeType, DependentType >

A class for converting TwoDColDependencies to and from XML.

The valid XML representation of a TwoDColDependency is:

    <Dependency 
      type="TwoDColDependency(dependee_number_type, type_of_array_values)"
    >
      <Dependee parameterId="Id of dependee parameter"/>
      <Dependent parameterId="Id of dependent parameter"/>
      ...Any other dependent parameters...
      ...Optional Function tag...
    </Dependency>

Definition at line 982 of file Teuchos_StandardDependencyXMLConverters.hpp.


Member Function Documentation

template<class DependeeType , class DependentType >
RCP< ArrayModifierDependency< DependeeType, DependentType > > Teuchos::TwoDColDependencyXMLConverter< DependeeType, DependentType >::getConcreteDependency ( RCP< const ParameterEntry dependee,
Dependency::ParameterEntryList  dependents,
RCP< const SimpleFunctionObject< DependeeType > >  function 
) const [protected, virtual]

Obtains a concrete ArrayModifierDependency given a dependee, dependtns, and a funciton object.

Because ArrayModifierDependency is an abstact class with pure virtual methods we need to be able to get a concrete object to actually return. This is the reponsibility of any classes subclassing this one.

Parameters:
dependeeThe dependee to be used in the construction of the concrete dependency.
dependentsThe dependts to be used in the construction of the concrete dependency.
functionThe function object to be used in the construction of the concrete dependency.
Returns:
A concrete dependency object.which subclasses ArrayModifierDependency.

Implements Teuchos::ArrayModifierDependencyXMLConverter< DependeeType, DependentType >.

Definition at line 1001 of file Teuchos_StandardDependencyXMLConverters.hpp.


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