docs/teuchos/Teuchos__StandardDependencyXMLConverters_8hpp_source.html

// @HEADER

// *****************************************************************************

//                    Teuchos: Common Tools Package

//

// Copyright 2004 NTESS and the Teuchos contributors.

// SPDX-License-Identifier: BSD-3-Clause

// *****************************************************************************

// @HEADER


#ifndef TEUCHOS_STANDARDDEPENDENCYXMLCONVERTERS_HPP

#define TEUCHOS_STANDARDDEPENDENCYXMLCONVERTERS_HPP


#include "Teuchos_DependencyXMLConverter.hpp"

#include "Teuchos_StandardDependencies.hpp"

#include "Teuchos_XMLDependencyExceptions.hpp"

#include "Teuchos_FunctionObjectXMLConverterDB.hpp"


namespace Teuchos {


class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT VisualDependencyXMLConverter : public DependencyXMLConverter{


public:


  virtual void convertSpecialVisualAttributes(

    RCP<const VisualDependency> dependency,

    XMLObject& xmlObj,

    const XMLParameterListWriter::EntryIDsMap& entryIDsMap) const = 0;


  virtual RCP<VisualDependency> convertSpecialVisualAttributes(

    const XMLObject& xmlObj,

    const Dependency::ConstParameterEntryList dependees,

    const Dependency::ParameterEntryList dependets,

    bool showIf,

    const XMLParameterListReader::EntryIDsMap& entryIDsMap) const = 0;


  RCP<Dependency> convertXML(

    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;


private:


  static const std::string& getShowIfAttributeName(){

    static const std::string showIfAttributeName = "showIf";

    return showIfAttributeName;

  }


};


class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT ValidatorDependencyXMLConverter : public DependencyXMLConverter{


public:


  virtual void convertSpecialValidatorAttributes(

    RCP<const ValidatorDependency> dependency,

    XMLObject& xmlObj,

    ValidatortoIDMap& validatorIDsMap) const = 0;


  virtual RCP<ValidatorDependency> convertSpecialValidatorAttributes(

    const XMLObject& xmlObj,

    RCP<const ParameterEntry> dependee,

    const Dependency::ParameterEntryList dependents,

    const IDtoValidatorMap& validatorIDsMap) const = 0;


  RCP<Dependency> convertXML(

    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;


};


class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT StringVisualDependencyXMLConverter : public VisualDependencyXMLConverter{


public:


  void convertSpecialVisualAttributes(

    RCP<const VisualDependency> dependency,

    XMLObject& xmlObj,

    const XMLParameterListWriter::EntryIDsMap& entryIDsMap) const;


  RCP<VisualDependency> convertSpecialVisualAttributes(

    const XMLObject& xmlObj,

    const Dependency::ConstParameterEntryList dependees,

    const Dependency::ParameterEntryList dependets,

    bool showIf,

    const XMLParameterListReader::EntryIDsMap& entryIDsMap) const;


  static const std::string& getStringValuesTagName(){

    static const std::string stringValuesTagName = "StringValues";

    return stringValuesTagName;

  }


private:


  static const std::string& getStringTagName(){

    static const std::string stringTagName = "String";

    return stringTagName;

  }


  static const std::string& getValueAttributeName(){

    static const std::string valueAttributeName = "value";

    return valueAttributeName;

  }


};


class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT BoolVisualDependencyXMLConverter : public VisualDependencyXMLConverter{


public:


  void convertSpecialVisualAttributes(

    RCP<const VisualDependency> dependency,

    XMLObject& xmlObj,

    const XMLParameterListWriter::EntryIDsMap& entryIDsMap) const;


  RCP<VisualDependency> convertSpecialVisualAttributes(

    const XMLObject& xmlObj,

    const Dependency::ConstParameterEntryList dependees,

    const Dependency::ParameterEntryList dependets,

    bool showIf,

    const XMLParameterListReader::EntryIDsMap& entryIDsMap) const;


};


template<class T>


class NumberVisualDependencyXMLConverter : public VisualDependencyXMLConverter{


public:


  void convertSpecialVisualAttributes(

    RCP<const VisualDependency> dependency,

    XMLObject& xmlObj,

    const XMLParameterListWriter::EntryIDsMap& entryIDsMap) const;


  RCP<VisualDependency> convertSpecialVisualAttributes(

    const XMLObject& xmlObj,

    const Dependency::ConstParameterEntryList dependees,

    const Dependency::ParameterEntryList dependets,

    bool showIf,

    const XMLParameterListReader::EntryIDsMap& entryIDsMap) const;


};


template<class T>


void NumberVisualDependencyXMLConverter<T>::convertSpecialVisualAttributes(

  RCP<const VisualDependency> dependency,

  XMLObject& xmlObj,

  const XMLParameterListWriter::EntryIDsMap& /* entryIDsMap */) const

{

  RCP<const NumberVisualDependency<T> > castedDependency =

    rcp_dynamic_cast<const NumberVisualDependency<T> >(dependency);

  RCP<const SimpleFunctionObject<T> > functionObject =

    castedDependency->getFunctionObject();


  if(functionObject != null){

    XMLObject functionXML =

      FunctionObjectXMLConverterDB::convertFunctionObject(functionObject);

    xmlObj.addChild(functionXML);

  }


}


template<class T>

RCP<VisualDependency>


NumberVisualDependencyXMLConverter<T>::convertSpecialVisualAttributes(

  const XMLObject& xmlObj,

  const Dependency::ConstParameterEntryList dependees,

  const Dependency::ParameterEntryList dependents,

  bool showIf,

  const XMLParameterListReader::EntryIDsMap& /* entryIDsMap */) const

{

  TEUCHOS_TEST_FOR_EXCEPTION(dependees.size() > 1,

    TooManyDependeesException,

    "A NumberVisualDependency can only have 1 dependee!" <<

    std::endl << std::endl);

  int functionIndex = xmlObj.findFirstChild(FunctionObject::getXMLTagName());

  RCP<SimpleFunctionObject<T> > functionObject = null;

  if(functionIndex != -1){

    functionObject = rcp_dynamic_cast<SimpleFunctionObject<T> >(

      FunctionObjectXMLConverterDB::convertXML(xmlObj.getChild(functionIndex)));

  }

  return rcp(new NumberVisualDependency<T>(

    *(dependees.begin()), dependents, showIf, functionObject));


}


class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT ConditionVisualDependencyXMLConverter :

  public VisualDependencyXMLConverter

{


public:


  void convertSpecialVisualAttributes(

    RCP<const VisualDependency> dependency,

    XMLObject& xmlObj,

    const XMLParameterListWriter::EntryIDsMap& entryIDsMap) const;


  RCP<VisualDependency> convertSpecialVisualAttributes(

    const XMLObject& xmlObj,

    const Dependency::ConstParameterEntryList dependees,

    const Dependency::ParameterEntryList dependets,

    bool showIf,

    const XMLParameterListReader::EntryIDsMap& entryIDsMap) const;


};


class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT StringValidatorDependencyXMLConverter :

  public ValidatorDependencyXMLConverter{


public:


  void convertSpecialValidatorAttributes(

    RCP<const ValidatorDependency> dependency,

    XMLObject& xmlObj,

    ValidatortoIDMap& validatorIDsMap) const;


  RCP<ValidatorDependency> convertSpecialValidatorAttributes(

    const XMLObject& xmlObj,

    RCP<const ParameterEntry> dependee,

    const Dependency::ParameterEntryList dependents,

    const IDtoValidatorMap& validatorIDsMap) const;


  static const std::string& getValuesAndValidatorsTag(){

    static const std::string valuesAndValidatorsTag = "ValuesAndValidators";

    return valuesAndValidatorsTag;

  }


private:


  static const std::string& getPairTag(){

    static const std::string pairTag = "Pair";

    return pairTag;

  }


  static const std::string& getValueAttributeName(){

    static const std::string valueAttributeName = "value";

    return valueAttributeName;

  }


  static const std::string& getValidatorIdAttributeName(){

    static const std::string validatorIDAttributeName = "validatorId";

    return validatorIDAttributeName;

  }


  static const std::string& getDefaultValidatorIdAttributeName(){

    static const std::string defaultValidatorIdAttributeName =

      "defaultValidatorId";

    return defaultValidatorIdAttributeName;

  }


};


class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT BoolValidatorDependencyXMLConverter : public ValidatorDependencyXMLConverter{


public:


  void convertSpecialValidatorAttributes(

    RCP<const ValidatorDependency> dependency,

    XMLObject& xmlObj,

    ValidatortoIDMap& validatorIDsMap) const;


  RCP<ValidatorDependency> convertSpecialValidatorAttributes(

    const XMLObject& xmlObj,

    RCP<const ParameterEntry> dependee,

    const Dependency::ParameterEntryList dependents,

    const IDtoValidatorMap& validatorIDsMap) const;


private:


    static const std::string& getFalseValidatorIdAttributeName(){

      static const std::string falseValidatorIdAttributeName =

        "falseValidatorId";

      return falseValidatorIdAttributeName;

    }


    static const std::string& getTrueValidatorIdAttributeName(){

      static const std::string trueValidatorIdAttributeName =

        "trueValidatorId";

      return trueValidatorIdAttributeName;

    }


};


template<class T>


class RangeValidatorDependencyXMLConverter :

  public ValidatorDependencyXMLConverter{


public:


  void convertSpecialValidatorAttributes(

    RCP<const ValidatorDependency> dependency,

    XMLObject& xmlObj,

    ValidatortoIDMap& validatorIDsMap) const;


  RCP<ValidatorDependency> convertSpecialValidatorAttributes(

    const XMLObject& xmlObj,

    RCP<const ParameterEntry> dependee,

    const Dependency::ParameterEntryList dependents,

    const IDtoValidatorMap& validatorIDsMap) const;


  static const std::string& getRangesAndValidatorsTag(){

    static const std::string rangesAndValidatorsTag = "RangesAndValidators";

    return rangesAndValidatorsTag;

  }


private:


  static const std::string& getPairTag(){

    static const std::string pairTag = "Pair";

    return pairTag;

  }


  static const std::string& getMinAttributeName(){

    static const std::string minAttributeName = "min";

    return minAttributeName;

  }


  static const std::string& getMaxAttributeName(){

    static const std::string maxAttributeName = "max";

    return maxAttributeName;

  }


  static const std::string& getValidatorIdAttributeName(){

    static const std::string validatorIdAttributeName = "validatorId";

    return validatorIdAttributeName;

  }


  static const std::string& getDefaultValidatorIdAttributeName(){

    static const std::string defaultValidatorIdAttributeName =

      "defaultValidatorId";

    return defaultValidatorIdAttributeName;

  }


};


template<class T>

void


RangeValidatorDependencyXMLConverter<T>::convertSpecialValidatorAttributes(

  RCP<const ValidatorDependency> dependency,

  XMLObject& xmlObj,

  ValidatortoIDMap& validatorIDsMap) const

{

  RCP<const RangeValidatorDependency<T> > castedDependency =

    rcp_dynamic_cast<const RangeValidatorDependency<T> >(dependency, true);


  XMLObject rangesAndValidatorsTag(getRangesAndValidatorsTag());


  castedDependency->getRangeToValidatorMap();

  for(

    typename RangeValidatorDependency<T>::RangeToValidatorMap::const_iterator

      it = castedDependency->getRangeToValidatorMap().begin();

    it != castedDependency->getRangeToValidatorMap().end();

    ++it)

  {

    T min = it->first.first;

    T max = it->first.second;

    if(validatorIDsMap.find(it->second) == validatorIDsMap.end()){

      validatorIDsMap.insert(it->second);

    }

    ParameterEntryValidator::ValidatorID validatorID =

      validatorIDsMap.find(it->second)->second;

    XMLObject pairTag(getPairTag());

    pairTag.addAttribute(getMinAttributeName(), min);

    pairTag.addAttribute(getMaxAttributeName(), max);

    pairTag.addAttribute(getValidatorIdAttributeName(), validatorID);

    rangesAndValidatorsTag.addChild(pairTag);

  }

  xmlObj.addChild(rangesAndValidatorsTag);

  RCP<const ParameterEntryValidator> defaultValidator =

    castedDependency->getDefaultValidator();

  if(nonnull(defaultValidator)){

    if(validatorIDsMap.find(defaultValidator) == validatorIDsMap.end()){

      validatorIDsMap.insert(defaultValidator);

    }

    xmlObj.addAttribute(

      getDefaultValidatorIdAttributeName(),

      validatorIDsMap.find(defaultValidator)->second);

  }

}


template<class T>

RCP<ValidatorDependency>


RangeValidatorDependencyXMLConverter<T>::convertSpecialValidatorAttributes(

  const XMLObject& xmlObj,

  RCP<const ParameterEntry> dependee,

  const Dependency::ParameterEntryList dependents,

  const IDtoValidatorMap& validatorIDsMap) const

{


  int result = xmlObj.findFirstChild(getRangesAndValidatorsTag());

  TEUCHOS_TEST_FOR_EXCEPTION(result == -1,

    MissingRangesAndValidatorsTagException,

    "Error: All RangeValidatorDependencies must have a " <<

    getRangesAndValidatorsTag() << " tag!" << std::endl << std::endl);


  XMLObject rangesAndValidatorsTag = xmlObj.getChild(result);


  typename RangeValidatorDependency<T>::RangeToValidatorMap

    rangesAndValidators;

  for(int i = 0 ; i < rangesAndValidatorsTag.numChildren(); ++i){

    XMLObject child = rangesAndValidatorsTag.getChild(i);

    T min = child.getRequired<T>(getMinAttributeName());

    T max = child.getRequired<T>(getMaxAttributeName());

    ParameterEntryValidator::ValidatorID currentID =

      child.getRequired<ParameterEntryValidator::ValidatorID>(

          getValidatorIdAttributeName());


    TEUCHOS_TEST_FOR_EXCEPTION(

      validatorIDsMap.find(currentID) == validatorIDsMap.end(),

      MissingValidatorException,

      "Could not find validator in given ValidatorIDsMap! " << std::endl <<

      std::endl);

    RCP<ParameterEntryValidator> validator =

      validatorIDsMap.find(currentID)->second;


    rangesAndValidators.insert(

      typename RangeValidatorDependency<T>::RangeValidatorPair(

        typename RangeValidatorDependency<T>::Range(min, max), validator));

  }


  RCP<ParameterEntryValidator> defaultValidator = null;

  if(xmlObj.hasAttribute(getDefaultValidatorIdAttributeName())){

    ParameterEntryValidator::ValidatorID defaultValiID =

      xmlObj.getRequired<ParameterEntryValidator::ValidatorID>(

        getDefaultValidatorIdAttributeName());

    TEUCHOS_TEST_FOR_EXCEPTION(

      validatorIDsMap.find(defaultValiID) == validatorIDsMap.end(),

      MissingValidatorException,

      "Could not find a validator (for the default validator) " <<

      "corresponding to the ID " << defaultValiID <<

      " in the given validatorIDsMap!" << std::endl << std::endl);

    defaultValidator = validatorIDsMap.find(defaultValiID)->second;

  }


  return rcp(new RangeValidatorDependency<T>(

    dependee, dependents, rangesAndValidators, defaultValidator));

}


template<class DependeeType, class DependentType>


class ArrayModifierDependencyXMLConverter : public DependencyXMLConverter{


public:


  RCP<Dependency> convertXML(

    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;


protected:


  virtual RCP<ArrayModifierDependency<DependeeType, DependentType> >

  getConcreteDependency(

    RCP<const ParameterEntry> dependee,

    Dependency::ParameterEntryList dependents,

    RCP<const SimpleFunctionObject<DependeeType> > function) const = 0;


};


template<class DependeeType, class DependentType>

RCP<Dependency>


ArrayModifierDependencyXMLConverter<DependeeType, DependentType>::convertXML(

  const XMLObject& xmlObj,

  const Dependency::ConstParameterEntryList dependees,

  const Dependency::ParameterEntryList dependents,

  const XMLParameterListReader::EntryIDsMap& /* entryIDsMap */,

  const IDtoValidatorMap& /* validatorIDsMap */) const

{

  TEUCHOS_TEST_FOR_EXCEPTION(dependees.size() > 1,

    TooManyDependeesException,

    "A ArrayModifierDependency can only have 1 dependee!" <<

    std::endl << std::endl);

  RCP<SimpleFunctionObject<DependeeType> > functionObject = null;

  int functionIndex = xmlObj.findFirstChild(FunctionObject::getXMLTagName());

  if(functionIndex != -1){

    functionObject = rcp_dynamic_cast<SimpleFunctionObject<DependeeType> >(

      FunctionObjectXMLConverterDB::convertXML(xmlObj.getChild(functionIndex)));

  }

  return

    getConcreteDependency(*(dependees.begin()), dependents, functionObject);

}


template<class DependeeType, class DependentType>

void


ArrayModifierDependencyXMLConverter<DependeeType, DependentType>::convertDependency(

    const RCP<const Dependency> dependency,

    XMLObject& xmlObj,

    const XMLParameterListWriter::EntryIDsMap& /* entryIDsMap */,

    ValidatortoIDMap& /* validatorIDsMap */) const

{

  RCP<const ArrayModifierDependency<DependeeType, DependentType> > castedDep =

    rcp_dynamic_cast<const ArrayModifierDependency<DependeeType, DependentType> >(

      dependency);

  RCP<const SimpleFunctionObject<DependeeType> > functionObject =

    castedDep->getFunctionObject();

  if(functionObject != null){

    XMLObject functionXML = FunctionObjectXMLConverterDB::convertFunctionObject(

      functionObject);

    xmlObj.addChild(functionXML);

  }

}


template<class DependeeType, class DependentType>


class NumberArrayLengthDependencyXMLConverter :

  public ArrayModifierDependencyXMLConverter<DependeeType, DependentType>{


protected:


  virtual RCP<ArrayModifierDependency<DependeeType, DependentType> >

  getConcreteDependency(

    RCP<const ParameterEntry> dependee,

    Dependency::ParameterEntryList dependents,

    RCP<const SimpleFunctionObject<DependeeType> > function) const;


};


template<class DependeeType, class DependentType>

RCP<ArrayModifierDependency<DependeeType, DependentType> >


NumberArrayLengthDependencyXMLConverter<DependeeType, DependentType>::getConcreteDependency(

  RCP<const ParameterEntry> dependee,

  Dependency::ParameterEntryList dependents,

  RCP<const SimpleFunctionObject<DependeeType> > function) const

{

return rcp(

    new NumberArrayLengthDependency<DependeeType, DependentType>(

      dependee, dependents, function));

}


template<class DependeeType, class DependentType>


class TwoDRowDependencyXMLConverter :

  public ArrayModifierDependencyXMLConverter<DependeeType, DependentType>

{


protected:


  virtual RCP<ArrayModifierDependency<DependeeType, DependentType> >

  getConcreteDependency(

    RCP<const ParameterEntry> dependee,

    Dependency::ParameterEntryList dependents,

    RCP<const SimpleFunctionObject<DependeeType> > function) const;


};


template<class DependeeType, class DependentType>

RCP<ArrayModifierDependency<DependeeType, DependentType> >


TwoDRowDependencyXMLConverter<DependeeType, DependentType>::getConcreteDependency(

  RCP<const ParameterEntry> dependee,

  Dependency::ParameterEntryList dependents,

  RCP<const SimpleFunctionObject<DependeeType> > function) const

{

return rcp(

    new TwoDRowDependency<DependeeType, DependentType>(

      dependee, dependents, function));

}


template<class DependeeType, class DependentType>


class TwoDColDependencyXMLConverter :

  public ArrayModifierDependencyXMLConverter<DependeeType, DependentType>

{


protected:


  virtual RCP<ArrayModifierDependency<DependeeType, DependentType> >

  getConcreteDependency(

    RCP<const ParameterEntry> dependee,

    Dependency::ParameterEntryList dependents,

    RCP<const SimpleFunctionObject<DependeeType> > function) const;


};


template<class DependeeType, class DependentType>

RCP<ArrayModifierDependency<DependeeType, DependentType> >


TwoDColDependencyXMLConverter<DependeeType, DependentType>::getConcreteDependency(

  RCP<const ParameterEntry> dependee,

  Dependency::ParameterEntryList dependents,

  RCP<const SimpleFunctionObject<DependeeType> > function) const

{

return rcp(

    new TwoDColDependency<DependeeType, DependentType>(

      dependee, dependents, function));

}


} // namespace Teuchos


#endif // TEUCHOS_STANDARDDEPENDENCYXMLCONVERTERS_HPP

Teuchos_DependencyXMLConverter.hpp
Converts back and forth between XML and Dependencies.

Teuchos_FunctionObjectXMLConverterDB.hpp
A database for FunctionObjectXMLConverters.

Teuchos_StandardDependencies.hpp
A collection of standard dependencies.

Teuchos_XMLDependencyExceptions.hpp
A collection of Exceptions thrown when converting Dependencys to and from XML.

Teuchos::ArrayModifierDependencyXMLConverter
A converter used to convert ArrayModifierDepdencies to and from xml.
Definition Teuchos_StandardDependencyXMLConverters.hpp:748

Teuchos::ArrayModifierDependencyXMLConverter::convertDependency
void convertDependency(const RCP< const Dependency > dependency, XMLObject &xmlObj, const XMLParameterListWriter::EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap) const
Definition Teuchos_StandardDependencyXMLConverters.hpp:824

Teuchos::ArrayModifierDependencyXMLConverter::convertXML
RCP< Dependency > convertXML(const XMLObject &xmlObj, const Dependency::ConstParameterEntryList dependees, const Dependency::ParameterEntryList dependets, const XMLParameterListReader::EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap) const
Definition Teuchos_StandardDependencyXMLConverters.hpp:801

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

Teuchos::BoolValidatorDependencyXMLConverter
An xml converter for BoolValidatorDependencies.
Definition Teuchos_StandardDependencyXMLConverters.hpp:502

Teuchos::BoolVisualDependencyXMLConverter
An xml converter for BoolVisualDepenencies.
Definition Teuchos_StandardDependencyXMLConverters.hpp:251

Teuchos::ConditionVisualDependencyXMLConverter
An xml converter for ConditionVisualDependencies.
Definition Teuchos_StandardDependencyXMLConverters.hpp:379

Teuchos::DependencyXMLConverter
An abstract base class for converting Dependencies to and from XML.
Definition Teuchos_DependencyXMLConverter.hpp:31

Teuchos::Dependency::ParameterEntryList
std::set< RCP< ParameterEntry >, RCPComp > ParameterEntryList
A list of Dependees.
Definition Teuchos_Dependency.hpp:41

Teuchos::Dependency::ConstParameterEntryList
std::set< RCP< const ParameterEntry >, RCPConstComp > ConstParameterEntryList
A list of dependents.
Definition Teuchos_Dependency.hpp:46

Teuchos::FunctionObjectXMLConverterDB::convertFunctionObject
static XMLObject convertFunctionObject(RCP< const FunctionObject > function)
Given a FunctionObject, converts the FunctionObject to XML.
Definition Teuchos_FunctionObjectXMLConverterDB.cpp:56

Teuchos::FunctionObjectXMLConverterDB::convertXML
static RCP< FunctionObject > convertXML(const XMLObject &xmlObject)
Given an XMLObject, converts the XMLObject to a FunctionObject.
Definition Teuchos_FunctionObjectXMLConverterDB.cpp:62

Teuchos::FunctionObject::getXMLTagName
static const std::string & getXMLTagName()
Returns the name of the XML tag used to indicate a funciton object.
Definition Teuchos_FunctionObject.hpp:42

Teuchos::IDtoValidatorMap
Maps Validators to integers.
Definition Teuchos_ValidatorMaps.hpp:24

Teuchos::MissingRangesAndValidatorsTagException
Thrown when the rangesAndValidators tag for the RangeValidatorDepencyConverter can't be found.
Definition Teuchos_XMLDependencyExceptions.hpp:127

Teuchos::MissingValidatorException
Thrown when converting a dependency that has validaotrs to and from XML. This excetpion indicates tha...
Definition Teuchos_XMLDependencyExceptions.hpp:179

Teuchos::NumberArrayLengthDependencyXMLConverter
An xml converter for NumberArrayLengthDependencies.
Definition Teuchos_StandardDependencyXMLConverters.hpp:859

Teuchos::NumberArrayLengthDependencyXMLConverter::getConcreteDependency
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.
Definition Teuchos_StandardDependencyXMLConverters.hpp:876

Teuchos::NumberVisualDependencyXMLConverter
An xml converter for NumberVisualDependencies.
Definition Teuchos_StandardDependencyXMLConverters.hpp:293

Teuchos::NumberVisualDependencyXMLConverter::convertSpecialVisualAttributes
void convertSpecialVisualAttributes(RCP< const VisualDependency > dependency, XMLObject &xmlObj, const XMLParameterListWriter::EntryIDsMap &entryIDsMap) const
Definition Teuchos_StandardDependencyXMLConverters.hpp:319

Teuchos::RCP
Smart reference counting pointer class for automatic garbage collection.
Definition Teuchos_RCPDecl.hpp:397

Teuchos::RCP::rcp
RCP< T > rcp(const boost::shared_ptr< T > &sptr)
Conversion function that takes in a boost::shared_ptr object and spits out a Teuchos::RCP object.

Teuchos::RCP::nonnull
bool nonnull(const RCP< T > &p)
Returns true if p.get()!=NULL.

Teuchos::RangeValidatorDependencyXMLConverter
An xml converter for RangeValidatorDependencies.
Definition Teuchos_StandardDependencyXMLConverters.hpp:571

Teuchos::RangeValidatorDependencyXMLConverter::convertSpecialValidatorAttributes
void convertSpecialValidatorAttributes(RCP< const ValidatorDependency > dependency, XMLObject &xmlObj, ValidatortoIDMap &validatorIDsMap) const
Definition Teuchos_StandardDependencyXMLConverters.hpp:642

Teuchos::RangeValidatorDependencyXMLConverter::getRangesAndValidatorsTag
static const std::string & getRangesAndValidatorsTag()
Definition Teuchos_StandardDependencyXMLConverters.hpp:592

Teuchos::RangeValidatorDependency
A RangeValidatorDependency says the following about the relationship between two parameters: Dependen...
Definition Teuchos_StandardDependencies.hpp:1514

Teuchos::RangeValidatorDependency::RangeValidatorPair
std::pair< Range, RCP< const ParameterEntryValidator > > RangeValidatorPair
Convenience typedef.
Definition Teuchos_StandardDependencies.hpp:1536

Teuchos::RangeValidatorDependency::RangeToValidatorMap
std::map< Range, RCP< const ParameterEntryValidator > > RangeToValidatorMap
Convenience typedef.
Definition Teuchos_StandardDependencies.hpp:1530

Teuchos::RangeValidatorDependency::Range
std::pair< T, T > Range
Convenience typedef.
Definition Teuchos_StandardDependencies.hpp:1524

Teuchos::StringValidatorDependencyXMLConverter
An xml converter for StringValidatorDependencies.
Definition Teuchos_StandardDependencyXMLConverters.hpp:425

Teuchos::StringValidatorDependencyXMLConverter::getValuesAndValidatorsTag
static const std::string & getValuesAndValidatorsTag()
Definition Teuchos_StandardDependencyXMLConverters.hpp:446

Teuchos::StringVisualDependencyXMLConverter
An xml converter for StringVisualDepenencies.
Definition Teuchos_StandardDependencyXMLConverters.hpp:188

Teuchos::StringVisualDependencyXMLConverter::getStringValuesTagName
static const std::string & getStringValuesTagName()
Gets the StringValues Tag.
Definition Teuchos_StandardDependencyXMLConverters.hpp:210

Teuchos::TooManyDependeesException
Thrown when a Dependency has too many dependees specified in its XML.
Definition Teuchos_XMLDependencyExceptions.hpp:93

Teuchos::TwoDColDependencyXMLConverter
A class for converting TwoDColDependencies to and from XML.
Definition Teuchos_StandardDependencyXMLConverters.hpp:952

Teuchos::TwoDColDependencyXMLConverter::getConcreteDependency
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.
Definition Teuchos_StandardDependencyXMLConverters.hpp:969

Teuchos::TwoDRowDependencyXMLConverter
A class for converting TwoDRowDependencies to and from XML.
Definition Teuchos_StandardDependencyXMLConverters.hpp:906

Teuchos::TwoDRowDependencyXMLConverter::getConcreteDependency
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.
Definition Teuchos_StandardDependencyXMLConverters.hpp:923

Teuchos::ValidatorDependencyXMLConverter
An xml converter for ValidatorDependencies.
Definition Teuchos_StandardDependencyXMLConverters.hpp:108

Teuchos::ValidatorDependencyXMLConverter::convertSpecialValidatorAttributes
virtual RCP< ValidatorDependency > convertSpecialValidatorAttributes(const XMLObject &xmlObj, RCP< const ParameterEntry > dependee, const Dependency::ParameterEntryList dependents, const IDtoValidatorMap &validatorIDsMap) const =0
Converts any special aspects of a specific validator dependency from xml.

Teuchos::ValidatorDependencyXMLConverter::convertSpecialValidatorAttributes
virtual void convertSpecialValidatorAttributes(RCP< const ValidatorDependency > dependency, XMLObject &xmlObj, ValidatortoIDMap &validatorIDsMap) const =0
Converts any special aspects of a specific validator dependency to xml.

Teuchos::ValidatortoIDMap
A class for mapping validators to integers.
Definition Teuchos_ValidatorMaps.hpp:71

Teuchos::VisualDependencyXMLConverter
An xml converter for VisualDepenencies.
Definition Teuchos_StandardDependencyXMLConverters.hpp:29

Teuchos::VisualDependencyXMLConverter::convertSpecialVisualAttributes
virtual void convertSpecialVisualAttributes(RCP< const VisualDependency > dependency, XMLObject &xmlObj, const XMLParameterListWriter::EntryIDsMap &entryIDsMap) const =0
Converts any special aspects of a specific visual dependency to xml.

Teuchos::VisualDependencyXMLConverter::convertSpecialVisualAttributes
virtual RCP< VisualDependency > convertSpecialVisualAttributes(const XMLObject &xmlObj, const Dependency::ConstParameterEntryList dependees, const Dependency::ParameterEntryList dependets, bool showIf, const XMLParameterListReader::EntryIDsMap &entryIDsMap) const =0
Converts any special aspects of a specific visual dependency from xml.

Teuchos::XMLObject
Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object,...
Definition Teuchos_XMLObject.hpp:30

Teuchos::XMLParameterListReader::EntryIDsMap
std::map< ParameterEntry::ParameterEntryID, RCP< ParameterEntry > > EntryIDsMap
Convenience typedef.
Definition Teuchos_XMLParameterListReader.hpp:40

Teuchos::XMLParameterListWriter::EntryIDsMap
std::map< RCP< const ParameterEntry >, ParameterEntry::ParameterEntryID, RCPConstComp > EntryIDsMap
Definition Teuchos_XMLParameterListWriter.hpp:41

TEUCHOS_TEST_FOR_EXCEPTION
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Macro for throwing an exception with breakpointing to ease debugging.
Definition Teuchos_TestForException.hpp:146

Teuchos
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...