Teuchos - Trilinos Tools Package  Version of the Day
Teuchos_StandardDependencyXMLConverters.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef TEUCHOS_STANDARDDEPENDENCYXMLCONVERTERS_HPP
43 #define TEUCHOS_STANDARDDEPENDENCYXMLCONVERTERS_HPP
44 
50 #include "Teuchos_DependencyXMLConverter.hpp"
51 #include "Teuchos_StandardDependencies.hpp"
52 #include "Teuchos_XMLDependencyExceptions.hpp"
53 #include "Teuchos_FunctionObjectXMLConverterDB.hpp"
54 
55 
56 namespace Teuchos {
57 
58 
61 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT VisualDependencyXMLConverter : public DependencyXMLConverter{
62 
63 public:
64 
67 
78  virtual void convertSpecialVisualAttributes(
79  RCP<const VisualDependency> dependency,
80  XMLObject& xmlObj,
81  const XMLParameterListWriter::EntryIDsMap& entryIDsMap) const = 0;
82 
94  virtual RCP<VisualDependency> convertSpecialVisualAttributes(
95  const XMLObject& xmlObj,
96  const Dependency::ConstParameterEntryList dependees,
97  const Dependency::ParameterEntryList dependets,
98  bool showIf,
99  const XMLParameterListReader::EntryIDsMap& entryIDsMap) const = 0;
100 
102 
105 
107  RCP<Dependency> convertXML(
108  const XMLObject& xmlObj,
109  const Dependency::ConstParameterEntryList dependees,
110  const Dependency::ParameterEntryList dependets,
111  const XMLParameterListReader::EntryIDsMap& entryIDsMap,
112  const IDtoValidatorMap& validatorIDsMap) const;
113 
115  void convertDependency(
116  const RCP<const Dependency> dependency,
117  XMLObject& xmlObj,
118  const XMLParameterListWriter::EntryIDsMap& entryIDsMap,
119  ValidatortoIDMap& validatorIDsMap) const;
120 
122 
123 private:
124 
127 
129  static const std::string& getShowIfAttributeName(){
130  static const std::string showIfAttributeName = "showIf";
131  return showIfAttributeName;
132  }
133 
135 
136 };
137 
140 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT ValidatorDependencyXMLConverter : public DependencyXMLConverter{
141 
142 public:
143 
146 
157  virtual void convertSpecialValidatorAttributes(
158  RCP<const ValidatorDependency> dependency,
159  XMLObject& xmlObj,
160  ValidatortoIDMap& validatorIDsMap) const = 0;
161 
172  virtual RCP<ValidatorDependency> convertSpecialValidatorAttributes(
173  const XMLObject& xmlObj,
174  RCP<const ParameterEntry> dependee,
175  const Dependency::ParameterEntryList dependents,
176  const IDtoValidatorMap& validatorIDsMap) const = 0;
177 
179 
182 
184  RCP<Dependency> convertXML(
185  const XMLObject& xmlObj,
186  const Dependency::ConstParameterEntryList dependees,
187  const Dependency::ParameterEntryList dependets,
188  const XMLParameterListReader::EntryIDsMap& entryIDsMap,
189  const IDtoValidatorMap& validatorIDsMap) const;
190 
192  void convertDependency(
193  const RCP<const Dependency> dependency,
194  XMLObject& xmlObj,
195  const XMLParameterListWriter::EntryIDsMap& entryIDsMap,
196  ValidatortoIDMap& validatorIDsMap) const;
197 
199 
200 };
201 
220 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT StringVisualDependencyXMLConverter : public VisualDependencyXMLConverter{
221 
222 public:
223 
226 
228  void convertSpecialVisualAttributes(
229  RCP<const VisualDependency> dependency,
230  XMLObject& xmlObj,
231  const XMLParameterListWriter::EntryIDsMap& entryIDsMap) const;
232 
234  RCP<VisualDependency> convertSpecialVisualAttributes(
235  const XMLObject& xmlObj,
236  const Dependency::ConstParameterEntryList dependees,
237  const Dependency::ParameterEntryList dependets,
238  bool showIf,
239  const XMLParameterListReader::EntryIDsMap& entryIDsMap) const;
240 
242  static const std::string& getStringValuesTagName(){
243  static const std::string stringValuesTagName = "StringValues";
244  return stringValuesTagName;
245  }
246 
248 
249 private:
250 
253 
255  static const std::string& getStringTagName(){
256  static const std::string stringTagName = "String";
257  return stringTagName;
258  }
259 
261  static const std::string& getValueAttributeName(){
262  static const std::string valueAttributeName = "value";
263  return valueAttributeName;
264  }
265 
267 
268 };
269 
283 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT BoolVisualDependencyXMLConverter : public VisualDependencyXMLConverter{
284 
285 public:
286 
289 
291  void convertSpecialVisualAttributes(
292  RCP<const VisualDependency> dependency,
293  XMLObject& xmlObj,
294  const XMLParameterListWriter::EntryIDsMap& entryIDsMap) const;
295 
297  RCP<VisualDependency> convertSpecialVisualAttributes(
298  const XMLObject& xmlObj,
299  const Dependency::ConstParameterEntryList dependees,
300  const Dependency::ParameterEntryList dependets,
301  bool showIf,
302  const XMLParameterListReader::EntryIDsMap& entryIDsMap) const;
303 
305 
306 };
307 
324 template<class T>
325 class NumberVisualDependencyXMLConverter : public VisualDependencyXMLConverter{
326 
327 public:
328 
331 
333  void convertSpecialVisualAttributes(
334  RCP<const VisualDependency> dependency,
335  XMLObject& xmlObj,
336  const XMLParameterListWriter::EntryIDsMap& entryIDsMap) const;
337 
339  RCP<VisualDependency> convertSpecialVisualAttributes(
340  const XMLObject& xmlObj,
341  const Dependency::ConstParameterEntryList dependees,
342  const Dependency::ParameterEntryList dependets,
343  bool showIf,
344  const XMLParameterListReader::EntryIDsMap& entryIDsMap) const;
345 
347 
348 };
349 
350 template<class T>
351 void NumberVisualDependencyXMLConverter<T>::convertSpecialVisualAttributes(
352  RCP<const VisualDependency> dependency,
353  XMLObject& xmlObj,
354  const XMLParameterListWriter::EntryIDsMap& /* entryIDsMap */) const
355 {
356  RCP<const NumberVisualDependency<T> > castedDependency =
357  rcp_dynamic_cast<const NumberVisualDependency<T> >(dependency);
358  RCP<const SimpleFunctionObject<T> > functionObject =
359  castedDependency->getFunctionObject();
360 
361  if(functionObject != null){
362  XMLObject functionXML =
363  FunctionObjectXMLConverterDB::convertFunctionObject(functionObject);
364  xmlObj.addChild(functionXML);
365  }
366 
367 }
368 
369 template<class T>
370 RCP<VisualDependency>
371 NumberVisualDependencyXMLConverter<T>::convertSpecialVisualAttributes(
372  const XMLObject& xmlObj,
373  const Dependency::ConstParameterEntryList dependees,
374  const Dependency::ParameterEntryList dependents,
375  bool showIf,
376  const XMLParameterListReader::EntryIDsMap& /* entryIDsMap */) const
377 {
378  TEUCHOS_TEST_FOR_EXCEPTION(dependees.size() > 1,
379  TooManyDependeesException,
380  "A NumberVisualDependency can only have 1 dependee!" <<
381  std::endl << std::endl);
382  int functionIndex = xmlObj.findFirstChild(FunctionObject::getXMLTagName());
383  RCP<SimpleFunctionObject<T> > functionObject = null;
384  if(functionIndex != -1){
385  functionObject = rcp_dynamic_cast<SimpleFunctionObject<T> >(
386  FunctionObjectXMLConverterDB::convertXML(xmlObj.getChild(functionIndex)));
387  }
388  return rcp(new NumberVisualDependency<T>(
389  *(dependees.begin()), dependents, showIf, functionObject));
390 
391 }
392 
409 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT ConditionVisualDependencyXMLConverter :
410  public VisualDependencyXMLConverter
411 {
412 
413 public:
414 
417 
419  void convertSpecialVisualAttributes(
420  RCP<const VisualDependency> dependency,
421  XMLObject& xmlObj,
422  const XMLParameterListWriter::EntryIDsMap& entryIDsMap) const;
423 
425  RCP<VisualDependency> convertSpecialVisualAttributes(
426  const XMLObject& xmlObj,
427  const Dependency::ConstParameterEntryList dependees,
428  const Dependency::ParameterEntryList dependets,
429  bool showIf,
430  const XMLParameterListReader::EntryIDsMap& entryIDsMap) const;
431 
433 
434 };
435 
436 
456 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT StringValidatorDependencyXMLConverter :
457  public ValidatorDependencyXMLConverter{
458 
459 public:
460 
463 
465  void convertSpecialValidatorAttributes(
466  RCP<const ValidatorDependency> dependency,
467  XMLObject& xmlObj,
468  ValidatortoIDMap& validatorIDsMap) const;
469 
471  RCP<ValidatorDependency> convertSpecialValidatorAttributes(
472  const XMLObject& xmlObj,
473  RCP<const ParameterEntry> dependee,
474  const Dependency::ParameterEntryList dependents,
475  const IDtoValidatorMap& validatorIDsMap) const;
476 
478  static const std::string& getValuesAndValidatorsTag(){
479  static const std::string valuesAndValidatorsTag = "ValuesAndValidators";
480  return valuesAndValidatorsTag;
481  }
482 
484 
485 private:
488 
490  static const std::string& getPairTag(){
491  static const std::string pairTag = "Pair";
492  return pairTag;
493  }
494 
496  static const std::string& getValueAttributeName(){
497  static const std::string valueAttributeName = "value";
498  return valueAttributeName;
499  }
500 
502  static const std::string& getValidatorIdAttributeName(){
503  static const std::string validatorIDAttributeName = "validatorId";
504  return validatorIDAttributeName;
505  }
506 
508  static const std::string& getDefaultValidatorIdAttributeName(){
509  static const std::string defaultValidatorIdAttributeName =
510  "defaultValidatorId";
511  return defaultValidatorIdAttributeName;
512  }
513 
515 
516 };
517 
534 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT BoolValidatorDependencyXMLConverter : public ValidatorDependencyXMLConverter{
535 
536 public:
537 
540 
542  void convertSpecialValidatorAttributes(
543  RCP<const ValidatorDependency> dependency,
544  XMLObject& xmlObj,
545  ValidatortoIDMap& validatorIDsMap) const;
546 
548  RCP<ValidatorDependency> convertSpecialValidatorAttributes(
549  const XMLObject& xmlObj,
550  RCP<const ParameterEntry> dependee,
551  const Dependency::ParameterEntryList dependents,
552  const IDtoValidatorMap& validatorIDsMap) const;
553 
555 
556 private:
557 
560 
562  static const std::string& getFalseValidatorIdAttributeName(){
563  static const std::string falseValidatorIdAttributeName =
564  "falseValidatorId";
565  return falseValidatorIdAttributeName;
566  }
567 
569  static const std::string& getTrueValidatorIdAttributeName(){
570  static const std::string trueValidatorIdAttributeName =
571  "trueValidatorId";
572  return trueValidatorIdAttributeName;
573  }
574 
576 
577 };
578 
601 template<class T>
602 class RangeValidatorDependencyXMLConverter :
603  public ValidatorDependencyXMLConverter{
604 
605 public:
606 
609 
611  void convertSpecialValidatorAttributes(
612  RCP<const ValidatorDependency> dependency,
613  XMLObject& xmlObj,
614  ValidatortoIDMap& validatorIDsMap) const;
615 
617  RCP<ValidatorDependency> convertSpecialValidatorAttributes(
618  const XMLObject& xmlObj,
619  RCP<const ParameterEntry> dependee,
620  const Dependency::ParameterEntryList dependents,
621  const IDtoValidatorMap& validatorIDsMap) const;
622 
624  static const std::string& getRangesAndValidatorsTag(){
625  static const std::string rangesAndValidatorsTag = "RangesAndValidators";
626  return rangesAndValidatorsTag;
627  }
628 
630 
631 private:
634 
635 
637  static const std::string& getPairTag(){
638  static const std::string pairTag = "Pair";
639  return pairTag;
640  }
641 
643  static const std::string& getMinAttributeName(){
644  static const std::string minAttributeName = "min";
645  return minAttributeName;
646  }
647 
649  static const std::string& getMaxAttributeName(){
650  static const std::string maxAttributeName = "max";
651  return maxAttributeName;
652  }
653 
654 
656  static const std::string& getValidatorIdAttributeName(){
657  static const std::string validatorIdAttributeName = "validatorId";
658  return validatorIdAttributeName;
659  }
660 
662  static const std::string& getDefaultValidatorIdAttributeName(){
663  static const std::string defaultValidatorIdAttributeName =
664  "defaultValidatorId";
665  return defaultValidatorIdAttributeName;
666  }
667 
669 
670 };
671 
672 template<class T>
673 void
674 RangeValidatorDependencyXMLConverter<T>::convertSpecialValidatorAttributes(
675  RCP<const ValidatorDependency> dependency,
676  XMLObject& xmlObj,
677  ValidatortoIDMap& validatorIDsMap) const
678 {
679  RCP<const RangeValidatorDependency<T> > castedDependency =
680  rcp_dynamic_cast<const RangeValidatorDependency<T> >(dependency, true);
681 
682  XMLObject rangesAndValidatorsTag(getRangesAndValidatorsTag());
683 
684  castedDependency->getRangeToValidatorMap();
685  for(
686  typename RangeValidatorDependency<T>::RangeToValidatorMap::const_iterator
687  it = castedDependency->getRangeToValidatorMap().begin();
688  it != castedDependency->getRangeToValidatorMap().end();
689  ++it)
690  {
691  T min = it->first.first;
692  T max = it->first.second;
693  if(validatorIDsMap.find(it->second) == validatorIDsMap.end()){
694  validatorIDsMap.insert(it->second);
695  }
696  ParameterEntryValidator::ValidatorID validatorID =
697  validatorIDsMap.find(it->second)->second;
698  XMLObject pairTag(getPairTag());
699  pairTag.addAttribute(getMinAttributeName(), min);
700  pairTag.addAttribute(getMaxAttributeName(), max);
701  pairTag.addAttribute(getValidatorIdAttributeName(), validatorID);
702  rangesAndValidatorsTag.addChild(pairTag);
703  }
704  xmlObj.addChild(rangesAndValidatorsTag);
705  RCP<const ParameterEntryValidator> defaultValidator =
706  castedDependency->getDefaultValidator();
707  if(nonnull(defaultValidator)){
708  if(validatorIDsMap.find(defaultValidator) == validatorIDsMap.end()){
709  validatorIDsMap.insert(defaultValidator);
710  }
711  xmlObj.addAttribute(
712  getDefaultValidatorIdAttributeName(),
713  validatorIDsMap.find(defaultValidator)->second);
714  }
715 }
716 
717 template<class T>
718 RCP<ValidatorDependency>
719 RangeValidatorDependencyXMLConverter<T>::convertSpecialValidatorAttributes(
720  const XMLObject& xmlObj,
721  RCP<const ParameterEntry> dependee,
722  const Dependency::ParameterEntryList dependents,
723  const IDtoValidatorMap& validatorIDsMap) const
724 {
725 
726  int result = xmlObj.findFirstChild(getRangesAndValidatorsTag());
727  TEUCHOS_TEST_FOR_EXCEPTION(result == -1,
728  MissingRangesAndValidatorsTagException,
729  "Error: All RangeValidatorDependencies must have a " <<
730  getRangesAndValidatorsTag() << " tag!" << std::endl << std::endl);
731 
732  XMLObject rangesAndValidatorsTag = xmlObj.getChild(result);
733 
734  typename RangeValidatorDependency<T>::RangeToValidatorMap
735  rangesAndValidators;
736  for(int i = 0 ; i < rangesAndValidatorsTag.numChildren(); ++i){
737  XMLObject child = rangesAndValidatorsTag.getChild(i);
738  T min = child.getRequired<T>(getMinAttributeName());
739  T max = child.getRequired<T>(getMaxAttributeName());
740  ParameterEntryValidator::ValidatorID currentID =
741  child.getRequired<ParameterEntryValidator::ValidatorID>(
742  getValidatorIdAttributeName());
743 
744  TEUCHOS_TEST_FOR_EXCEPTION(
745  validatorIDsMap.find(currentID) == validatorIDsMap.end(),
746  MissingValidatorException,
747  "Could not find validator in given ValidatorIDsMap! " << std::endl <<
748  std::endl);
749  RCP<ParameterEntryValidator> validator =
750  validatorIDsMap.find(currentID)->second;
751 
752  rangesAndValidators.insert(
753  typename RangeValidatorDependency<T>::RangeValidatorPair(
754  typename RangeValidatorDependency<T>::Range(min, max), validator));
755  }
756 
757  RCP<ParameterEntryValidator> defaultValidator = null;
758  if(xmlObj.hasAttribute(getDefaultValidatorIdAttributeName())){
759  ParameterEntryValidator::ValidatorID defaultValiID =
760  xmlObj.getRequired<ParameterEntryValidator::ValidatorID>(
761  getDefaultValidatorIdAttributeName());
762  TEUCHOS_TEST_FOR_EXCEPTION(
763  validatorIDsMap.find(defaultValiID) == validatorIDsMap.end(),
764  MissingValidatorException,
765  "Could not find a validator (for the default validator) " <<
766  "corresponding to the ID " << defaultValiID <<
767  " in the given validatorIDsMap!" << std::endl << std::endl);
768  defaultValidator = validatorIDsMap.find(defaultValiID)->second;
769  }
770 
771  return rcp(new RangeValidatorDependency<T>(
772  dependee, dependents, rangesAndValidators, defaultValidator));
773 }
774 
779 template<class DependeeType, class DependentType>
780 class ArrayModifierDependencyXMLConverter : public DependencyXMLConverter{
781 
782 public:
783 
786 
788  RCP<Dependency> convertXML(
789  const XMLObject& xmlObj,
790  const Dependency::ConstParameterEntryList dependees,
791  const Dependency::ParameterEntryList dependets,
792  const XMLParameterListReader::EntryIDsMap& entryIDsMap,
793  const IDtoValidatorMap& validatorIDsMap) const;
794 
796  void convertDependency(
797  const RCP<const Dependency> dependency,
798  XMLObject& xmlObj,
799  const XMLParameterListWriter::EntryIDsMap& entryIDsMap,
800  ValidatortoIDMap& validatorIDsMap) const;
801 
803 
804 protected:
805 
823  virtual RCP<ArrayModifierDependency<DependeeType, DependentType> >
824  getConcreteDependency(
825  RCP<const ParameterEntry> dependee,
826  Dependency::ParameterEntryList dependents,
827  RCP<const SimpleFunctionObject<DependeeType> > function) const = 0;
828 
829 };
830 
831 template<class DependeeType, class DependentType>
832 RCP<Dependency>
833 ArrayModifierDependencyXMLConverter<DependeeType, DependentType>::convertXML(
834  const XMLObject& xmlObj,
835  const Dependency::ConstParameterEntryList dependees,
836  const Dependency::ParameterEntryList dependents,
837  const XMLParameterListReader::EntryIDsMap& /* entryIDsMap */,
838  const IDtoValidatorMap& /* validatorIDsMap */) const
839 {
840  TEUCHOS_TEST_FOR_EXCEPTION(dependees.size() > 1,
841  TooManyDependeesException,
842  "A ArrayModifierDependency can only have 1 dependee!" <<
843  std::endl << std::endl);
844  RCP<SimpleFunctionObject<DependeeType> > functionObject = null;
845  int functionIndex = xmlObj.findFirstChild(FunctionObject::getXMLTagName());
846  if(functionIndex != -1){
847  functionObject = rcp_dynamic_cast<SimpleFunctionObject<DependeeType> >(
848  FunctionObjectXMLConverterDB::convertXML(xmlObj.getChild(functionIndex)));
849  }
850  return
851  getConcreteDependency(*(dependees.begin()), dependents, functionObject);
852 }
853 
854 template<class DependeeType, class DependentType>
855 void
856 ArrayModifierDependencyXMLConverter<DependeeType, DependentType>::convertDependency(
857  const RCP<const Dependency> dependency,
858  XMLObject& xmlObj,
859  const XMLParameterListWriter::EntryIDsMap& /* entryIDsMap */,
860  ValidatortoIDMap& /* validatorIDsMap */) const
861 {
862  RCP<const ArrayModifierDependency<DependeeType, DependentType> > castedDep =
863  rcp_dynamic_cast<const ArrayModifierDependency<DependeeType, DependentType> >(
864  dependency);
865  RCP<const SimpleFunctionObject<DependeeType> > functionObject =
866  castedDep->getFunctionObject();
867  if(functionObject != null){
868  XMLObject functionXML = FunctionObjectXMLConverterDB::convertFunctionObject(
869  functionObject);
870  xmlObj.addChild(functionXML);
871  }
872 }
873 
874 
889 template<class DependeeType, class DependentType>
890 class NumberArrayLengthDependencyXMLConverter :
891  public ArrayModifierDependencyXMLConverter<DependeeType, DependentType>{
892 
893 protected:
894 
897  virtual RCP<ArrayModifierDependency<DependeeType, DependentType> >
898  getConcreteDependency(
899  RCP<const ParameterEntry> dependee,
900  Dependency::ParameterEntryList dependents,
901  RCP<const SimpleFunctionObject<DependeeType> > function) const;
903 
904 };
905 
906 template<class DependeeType, class DependentType>
907 RCP<ArrayModifierDependency<DependeeType, DependentType> >
908 NumberArrayLengthDependencyXMLConverter<DependeeType, DependentType>::getConcreteDependency(
909  RCP<const ParameterEntry> dependee,
910  Dependency::ParameterEntryList dependents,
911  RCP<const SimpleFunctionObject<DependeeType> > function) const
912 {
913 return rcp(
914  new NumberArrayLengthDependency<DependeeType, DependentType>(
915  dependee, dependents, function));
916 }
917 
918 
935 template<class DependeeType, class DependentType>
936 class TwoDRowDependencyXMLConverter :
937  public ArrayModifierDependencyXMLConverter<DependeeType, DependentType>
938 {
939 
940 protected:
941 
944  virtual RCP<ArrayModifierDependency<DependeeType, DependentType> >
945  getConcreteDependency(
946  RCP<const ParameterEntry> dependee,
947  Dependency::ParameterEntryList dependents,
948  RCP<const SimpleFunctionObject<DependeeType> > function) const;
950 
951 };
952 
953 template<class DependeeType, class DependentType>
954 RCP<ArrayModifierDependency<DependeeType, DependentType> >
955 TwoDRowDependencyXMLConverter<DependeeType, DependentType>::getConcreteDependency(
956  RCP<const ParameterEntry> dependee,
957  Dependency::ParameterEntryList dependents,
958  RCP<const SimpleFunctionObject<DependeeType> > function) const
959 {
960 return rcp(
961  new TwoDRowDependency<DependeeType, DependentType>(
962  dependee, dependents, function));
963 }
964 
981 template<class DependeeType, class DependentType>
982 class TwoDColDependencyXMLConverter :
983  public ArrayModifierDependencyXMLConverter<DependeeType, DependentType>
984 {
985 
986 protected:
987 
990  virtual RCP<ArrayModifierDependency<DependeeType, DependentType> >
991  getConcreteDependency(
992  RCP<const ParameterEntry> dependee,
993  Dependency::ParameterEntryList dependents,
994  RCP<const SimpleFunctionObject<DependeeType> > function) const;
996 
997 };
998 
999 template<class DependeeType, class DependentType>
1000 RCP<ArrayModifierDependency<DependeeType, DependentType> >
1001 TwoDColDependencyXMLConverter<DependeeType, DependentType>::getConcreteDependency(
1002  RCP<const ParameterEntry> dependee,
1003  Dependency::ParameterEntryList dependents,
1004  RCP<const SimpleFunctionObject<DependeeType> > function) const
1005 {
1006 return rcp(
1007  new TwoDColDependency<DependeeType, DependentType>(
1008  dependee, dependents, function));
1009 }
1010 
1011 
1012 
1013 } // namespace Teuchos
1014 
1015 
1016 #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:780
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::ArrayModifierDependencyXMLConverter::convertDependency
void convertDependency(const RCP< const Dependency > dependency, XMLObject &xmlObj, const XMLParameterListWriter::EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap) const
Definition: Teuchos_StandardDependencyXMLConverters.hpp:856
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:833
Teuchos::DependencyXMLConverter
An abstract base class for converting Dependencies to and from XML.
Definition: Teuchos_DependencyXMLConverter.hpp:63
Teuchos::Dependency::ParameterEntryList
std::set< RCP< ParameterEntry >, RCPComp > ParameterEntryList
A list of Dependees.
Definition: Teuchos_Dependency.hpp:74
Teuchos::Dependency::ConstParameterEntryList
std::set< RCP< const ParameterEntry >, RCPConstComp > ConstParameterEntryList
A list of dependents.
Definition: Teuchos_Dependency.hpp:79
Teuchos::FunctionObjectXMLConverterDB::convertFunctionObject
static XMLObject convertFunctionObject(RCP< const FunctionObject > function)
Given a FunctionObject, converts the FunctionObject to XML.
Definition: Teuchos_FunctionObjectXMLConverterDB.cpp:88
Teuchos::FunctionObjectXMLConverterDB::convertXML
static RCP< FunctionObject > convertXML(const XMLObject &xmlObject)
Given an XMLObject, converts the XMLObject to a FunctionObject.
Definition: Teuchos_FunctionObjectXMLConverterDB.cpp:94
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:74
Teuchos::IDtoValidatorMap
Maps Validators to integers.
Definition: Teuchos_ValidatorMaps.hpp:57
Teuchos::IDtoValidatorMap::end
const_iterator end() const
Returns a const_reference to the end of the map.
Definition: Teuchos_ValidatorMaps.cpp:65
Teuchos::IDtoValidatorMap::find
const_iterator find(int id) const
Retrieves and iterator to a validator and id based on the id given.
Definition: Teuchos_ValidatorMaps.cpp:53
Teuchos::MissingRangesAndValidatorsTagException
Thrown when the rangesAndValidators tag for the RangeValidatorDepencyConverter can't be found.
Definition: Teuchos_XMLDependencyExceptions.hpp:160
Teuchos::MissingValidatorException
Thrown when converting a dependency that has validaotrs to and from XML. This excetpion indicates tha...
Definition: Teuchos_XMLDependencyExceptions.hpp:212
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:908
Teuchos::NumberArrayLengthDependency
A NumberArrayLengthDependency says the following about the relationship between two parameters: The l...
Definition: Teuchos_StandardDependencies.hpp:1040
Teuchos::NumberVisualDependencyXMLConverter::convertSpecialVisualAttributes
void convertSpecialVisualAttributes(RCP< const VisualDependency > dependency, XMLObject &xmlObj, const XMLParameterListWriter::EntryIDsMap &entryIDsMap) const
Definition: Teuchos_StandardDependencyXMLConverters.hpp:351
Teuchos::NumberVisualDependency
A number visual dependency says the following about the relationship between two elements in a Parame...
Definition: Teuchos_StandardDependencies.hpp:660
Teuchos::RCP
Smart reference counting pointer class for automatic garbage collection.
Definition: Teuchos_RCPDecl.hpp:429
Teuchos::RangeValidatorDependencyXMLConverter::convertSpecialValidatorAttributes
void convertSpecialValidatorAttributes(RCP< const ValidatorDependency > dependency, XMLObject &xmlObj, ValidatortoIDMap &validatorIDsMap) const
Definition: Teuchos_StandardDependencyXMLConverters.hpp:674
Teuchos::RangeValidatorDependency
A RangeValidatorDependency says the following about the relationship between two parameters: Dependen...
Definition: Teuchos_StandardDependencies.hpp:1548
Teuchos::RangeValidatorDependency::RangeValidatorPair
std::pair< Range, RCP< const ParameterEntryValidator > > RangeValidatorPair
Convenience typedef.
Definition: Teuchos_StandardDependencies.hpp:1570
Teuchos::RangeValidatorDependency::RangeToValidatorMap
std::map< Range, RCP< const ParameterEntryValidator > > RangeToValidatorMap
Convenience typedef.
Definition: Teuchos_StandardDependencies.hpp:1564
Teuchos::RangeValidatorDependency::Range
std::pair< T, T > Range
Convenience typedef.
Definition: Teuchos_StandardDependencies.hpp:1558
Teuchos::SimpleFunctionObject
A simple function object that applies a given operand to a spcified arguement using a specific operat...
Definition: Teuchos_StandardFunctionObjects.hpp:60
Teuchos::StringVisualDependencyXMLConverter::getStringValuesTagName
static const std::string & getStringValuesTagName()
Gets the StringValues Tag.
Definition: Teuchos_StandardDependencyXMLConverters.hpp:242
Teuchos::TooManyDependeesException
Thrown when a Dependency has too many dependees specified in its XML.
Definition: Teuchos_XMLDependencyExceptions.hpp:126
Teuchos::TwoDColDependencyXMLConverter
A class for converting TwoDColDependencies to and from XML.
Definition: Teuchos_StandardDependencyXMLConverters.hpp:984
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:1001
Teuchos::TwoDColDependency
A dependency in which the number of rows in a parameter with a TwoDArray depends on the value of anot...
Definition: Teuchos_StandardDependencies.hpp:2089
Teuchos::TwoDRowDependencyXMLConverter
A class for converting TwoDRowDependencies to and from XML.
Definition: Teuchos_StandardDependencyXMLConverters.hpp:938
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:955
Teuchos::TwoDRowDependency
A dependency in which the number of rows in a parameter with a TwoDArray depends on the value of anot...
Definition: Teuchos_StandardDependencies.hpp:1926
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:104
Teuchos::ValidatortoIDMap::end
const_iterator end() const
Returns a const_reference to the end of the map.
Definition: Teuchos_ValidatorMaps.cpp:97
Teuchos::ValidatortoIDMap::insert
void insert(RCP< const ParameterEntryValidator > toInsert)
inserts an IDValidatorPair into the map.
Definition: Teuchos_ValidatorMaps.cpp:74
Teuchos::ValidatortoIDMap::find
const_iterator find(const RCP< const ParameterEntryValidator > validator) const
Returns an iterator to the validator and id specified by the validator.
Definition: Teuchos_ValidatorMaps.cpp:84
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::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::XMLObject
Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object,...
Definition: Teuchos_XMLObject.hpp:62
Teuchos::XMLObject::addChild
void addChild(const XMLObject &child)
Add a child node to the node.
Definition: Teuchos_XMLObject.cpp:255
Teuchos::XMLObject::getRequired
const std::string & getRequired(const std::string &name) const
Get an attribute, throwing an std::exception if it is not found.
Definition: Teuchos_XMLObject.cpp:93
Teuchos::XMLObject::addAttribute
void addAttribute(const std::string &name, T value)
Lookup whether or not Doubles are allowed.
Definition: Teuchos_XMLObject.hpp:193
Teuchos::XMLObject::getChild
const XMLObject & getChild(int i) const
Return the i-th child node.
Definition: Teuchos_XMLObject.cpp:172
Teuchos::XMLObject::hasAttribute
bool hasAttribute(const std::string &name) const
Find out if the current node has an attribute of the specified name.
Definition: Teuchos_XMLObject.cpp:77
Teuchos::XMLObject::findFirstChild
int findFirstChild(std::string tagName) const
Returns the index of the first child found with the given tag name. Returns -1 if no child is found.
Definition: Teuchos_XMLObject.cpp:179
Teuchos::XMLObject::numChildren
int numChildren() const
Return the number of child nodes owned by this node.
Definition: Teuchos_XMLObject.cpp:164
Teuchos::XMLParameterListReader::EntryIDsMap
std::map< ParameterEntry::ParameterEntryID, RCP< ParameterEntry > > EntryIDsMap
Convenience typedef.
Definition: Teuchos_XMLParameterListReader.hpp:72
Teuchos::XMLParameterListWriter::EntryIDsMap
std::map< RCP< const ParameterEntry >, ParameterEntry::ParameterEntryID, RCPConstComp > EntryIDsMap
Definition: Teuchos_XMLParameterListWriter.hpp:73
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:170
Teuchos::nonnull
bool nonnull(const std::shared_ptr< T > &p)
Returns true if p.get()!=NULL.
Definition: Teuchos_RCPStdSharedPtrConversionsDecl.hpp:159
Teuchos
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...
Teuchos::rcp
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Deprecated.
Definition: Teuchos_RCPDecl.hpp:1242
Generated by doxygen 1.9.1