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::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 >:
Teuchos::ArrayModifierDependencyXMLConverter< DependeeType, DependentType > Teuchos::DependencyXMLConverter Teuchos::Describable Teuchos::LabeledObject

Protected Member Functions

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

Additional Inherited Members

- Public Member Functions inherited from Teuchos::ArrayModifierDependencyXMLConverter< DependeeType, DependentType >
RCP< DependencyconvertXML (const XMLObject &xmlObj, const Dependency::ConstParameterEntryList dependees, const Dependency::ParameterEntryList dependets, const XMLParameterListReader::EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap) const
 
void convertDependency (const RCP< const Dependency > dependency, XMLObject &xmlObj, const XMLParameterListWriter::EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap) const
 
- Public Member Functions inherited from Teuchos::DependencyXMLConverter
RCP< DependencyfromXMLtoDependency (const XMLObject &xmlObj, const XMLParameterListReader::EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap) const
 Converts a given XMLObject to a Dependency. More...
 
XMLObject fromDependencytoXML (const RCP< const Dependency > dependency, const XMLParameterListWriter::EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap) const
 Converters a given ParameterEntryValidator to XML. 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...
 
- Static Public Member Functions inherited from Teuchos::DependencyXMLConverter
static const std::string & getDependeeTagName ()
 Returns the string to be used for the dependee tag. More...
 
static const std::string & getDependentTagName ()
 Returns the string to be used for the dependent tag. More...
 
static const std::string & getParameterIdAttributeName ()
 Returns the string to be used for the ParameterID attribute. More...
 
static const std::string & getTypeAttributeName ()
 Returns the string to be used for the type attribute. 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

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 950 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
protectedvirtual

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 969 of file Teuchos_StandardDependencyXMLConverters.hpp.


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