Teuchos - Trilinos Tools Package  Version of the Day
Teuchos_StandardDependencies.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 
43 
44 #ifndef TEUCHOS_STANDARDDEPENDCIES_HPP_
45 #define TEUCHOS_STANDARDDEPENDCIES_HPP_
46 
51 #include "Teuchos_Dependency.hpp"
52 #include "Teuchos_StandardParameterEntryValidators.hpp"
53 #include "Teuchos_StandardConditions.hpp"
54 #include "Teuchos_StandardFunctionObjects.hpp"
55 #include "Teuchos_ScalarTraits.hpp"
56 #include "Teuchos_OrdinalTraits.hpp"
57 
58 
59 namespace Teuchos{
60 
61 
72 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT VisualDependency : public Dependency{
73 
74 public:
75 
77  static const bool& getShowIfDefaultValue(){
78  static const bool SHOW_IF_DEFAULT_VALUE = true;
79  return SHOW_IF_DEFAULT_VALUE;
80  }
81 
82 
85 
94  VisualDependency(
95  RCP<const ParameterEntry> dependee,
96  RCP<ParameterEntry> dependent,
97  bool showIf=getShowIfDefaultValue());
98 
107  VisualDependency(
108  RCP<const ParameterEntry> dependee,
109  ParameterEntryList dependents,
110  bool showIf=getShowIfDefaultValue());
111 
120  VisualDependency(
121  ConstParameterEntryList dependees,
122  RCP<ParameterEntry> dependent,
123  bool showIf=getShowIfDefaultValue());
124 
133  VisualDependency(
134  ConstParameterEntryList dependees,
135  ParameterEntryList dependents,
136  bool showIf=getShowIfDefaultValue());
137 
139 
141 
142 
149  virtual bool getDependeeState() const = 0;
150 
154  bool isDependentVisible() const;
155 
157  bool getShowIf() const;
158 
160 
163 
165  void evaluate();
166 
168 
169 private:
170 
173 
177  bool dependentVisible_;
178 
183  bool showIf_;
184 
186 
187 };
188 
192 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT ValidatorDependency : public Dependency{
193 
194 public:
195 
198 
205  ValidatorDependency(
206  RCP<const ParameterEntry> dependee,
207  RCP<ParameterEntry> dependent);
208 
215  ValidatorDependency(
216  RCP<const ParameterEntry> dependee,
217  ParameterEntryList dependents);
218 
220 
223 
225  virtual void evaluate() = 0;
226 
228 
229 };
230 
244 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT StringVisualDependency : public VisualDependency{
245 
246 public:
247 
250 
254  typedef Array<std::string> ValueList;
255 
257 
260 
274  StringVisualDependency(
275  RCP<const ParameterEntry> dependee,
276  RCP<ParameterEntry> dependent,
277  std::string value,
278  bool showIf=true);
279 
293  StringVisualDependency(
294  RCP<const ParameterEntry> dependee,
295  RCP<ParameterEntry> dependent,
296  const ValueList& values,
297  bool showIf=true);
298 
312  StringVisualDependency(
313  RCP<const ParameterEntry> dependee,
314  Dependency::ParameterEntryList dependents,
315  const std::string& value,
316  bool showIf=true);
317 
332  StringVisualDependency(
333  RCP<const ParameterEntry> dependee,
334  Dependency::ParameterEntryList dependents,
335  const ValueList& values,
336  bool showIf=true);
337 
339 
342 
344  const ValueList& getValues() const;
345 
347 
350 
352  bool getDependeeState() const;
353 
355 
358 
360  std::string getTypeAttributeValue() const;
361 
363 
364 protected:
365 
368 
370  void validateDep() const;
371 
373 
374 private:
375 
378 
382  const ValueList values_;
383 
385 
386 };
387 
388 
394 template<>
395 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT DummyObjectGetter<StringVisualDependency>{
396 
397 public:
398 
401 
405  static RCP<StringVisualDependency> getDummyObject();
406 
408 
409 };
410 
411 
425 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT BoolVisualDependency : public VisualDependency{
426 
427 public:
428 
431 
441  BoolVisualDependency(
442  RCP<const ParameterEntry> dependee,
443  RCP<ParameterEntry> dependent,
444  bool showIf=true);
445 
455  BoolVisualDependency(
456  RCP<const ParameterEntry> dependee,
457  Dependency::ParameterEntryList dependents,
458  bool showIf=true);
459 
461 
464 
466  bool getDependeeState() const;
467 
469 
472 
474  std::string getTypeAttributeValue() const;
475 
477 
478 protected:
479 
482 
484  void validateDep() const;
485 
487 
488 };
489 
490 
496 template<>
497 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT DummyObjectGetter<BoolVisualDependency>{
498 
499 public:
500 
503 
507  static RCP<BoolVisualDependency> getDummyObject();
508 
510 
511 };
512 
529 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT ConditionVisualDependency : public VisualDependency{
530 
531 public:
532 
535 
547  ConditionVisualDependency(
548  RCP<const Condition> condition,
549  RCP<ParameterEntry> dependent,
550  bool showIf=true);
551 
562  ConditionVisualDependency(
563  RCP<const Condition> condition,
564  Dependency::ParameterEntryList dependents,
565  bool showIf=true);
566 
568 
571 
573  RCP<const Condition> getCondition() const;
574 
577 
579  bool getDependeeState() const;
580 
582 
585 
587  std::string getTypeAttributeValue() const;
588 
590 
591 protected:
592 
595 
597  void validateDep() const {}
598 
600 
601 
602 private:
603 
606 
610  RCP<const Condition> condition_;
611 
613 
614 };
615 
616 
622 template<>
623 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT DummyObjectGetter<ConditionVisualDependency>{
624 
625 public:
626 
629 
632  static RCP<ConditionVisualDependency> getDummyObject();
633 
635 
636 };
637 
638 
659 template <class T>
660 class NumberVisualDependency : public VisualDependency{
661 
662 public:
663 
666 
687  NumberVisualDependency(
688  RCP<const ParameterEntry> dependee,
689  RCP<ParameterEntry> dependent,
690  bool showIf=true,
691  RCP<SimpleFunctionObject<T> > func=null);
692 
713  NumberVisualDependency(
714  RCP<const ParameterEntry> dependee,
715  ParameterEntryList dependents,
716  bool showIf=true,
717  RCP<SimpleFunctionObject<T> > func=null);
718 
720 
723 
724  bool getDependeeState() const;
725 
727 
730 
732  std::string getTypeAttributeValue() const;
733 
735 
738 
740  RCP<const SimpleFunctionObject<T> > getFunctionObject() const;
741 
743 
744 protected:
745 
748 
750  void validateDep() const;
751 
753 
754 private:
755 
758 
763  RCP<SimpleFunctionObject<T> > func_;
764 
766  //
767 };
768 
769 template<class T>
770 NumberVisualDependency<T>::NumberVisualDependency(
771  RCP<const ParameterEntry> dependee,
772  RCP<ParameterEntry> dependent,
773  bool showIf,
774  RCP<SimpleFunctionObject<T> > func)
775  :VisualDependency(dependee, dependent, showIf),
776  func_(func)
777 {
778  validateDep();
779 }
780 
781 template<class T>
782 NumberVisualDependency<T>::NumberVisualDependency(
783  RCP<const ParameterEntry> dependee,
784  ParameterEntryList dependents,
785  bool showIf,
786  RCP<SimpleFunctionObject<T> > func)
787  :VisualDependency(dependee, dependents, showIf),
788  func_(func)
789 {
790  validateDep();
791 }
792 
793 template<class T>
794 bool NumberVisualDependency<T>::getDependeeState() const{
795  T value = getFirstDependeeValue<T>();
796  if(!func_.is_null()){
797  value = func_->runFunction(value);
798  }
799  return value > ScalarTraits<T>::zero() ? true : false;
800 }
801 
802 template<class T>
803 std::string NumberVisualDependency<T>::getTypeAttributeValue() const{
804  return "NumberVisualDependency(" + TypeNameTraits<T>::name() + ")";
805 }
806 
807 template<class T>
808 RCP<const SimpleFunctionObject<T> >
809  NumberVisualDependency<T>::getFunctionObject() const
810 {
811  return func_.getConst();
812 }
813 
814 template<class T>
815 void NumberVisualDependency<T>::validateDep() const{
816  RCP<const ParameterEntry> dependee = getFirstDependee();
817  TEUCHOS_TEST_FOR_EXCEPTION(
818  !dependee->isType<T>(),
819  InvalidDependencyException,
820  "The dependee of a " <<
821  "Number Visual Dependency must the same type as the dependency's " <<
822  "template type!" << std::endl <<
823  "Type Encountered: " << dependee->getAny().typeName() << std::endl <<
824  "Template Type: " << TypeNameTraits<T>::name() << std::endl <<
825  std::endl);
826 }
827 
828 
834 template<class T>
835 class DummyObjectGetter<NumberVisualDependency<T> >{
836 
837 public:
838 
841 
845  static RCP<NumberVisualDependency<T> > getDummyObject();
846 
848 
849 };
850 
851 template<class T>
852 RCP<NumberVisualDependency<T> >
853  DummyObjectGetter<NumberVisualDependency<T> >::getDummyObject()
854 {
855  return rcp(new NumberVisualDependency<T>(
856  rcp(new ParameterEntry(ScalarTraits<T>::zero())),
857  DummyObjectGetter<ParameterEntry>::getDummyObject()));
858 }
859 
864 template<class DependeeType, class DependentType>
865 class ArrayModifierDependency : public Dependency{
866 public:
867 
870 
878  ArrayModifierDependency(
879  RCP<const ParameterEntry> dependee,
880  RCP<ParameterEntry> dependent,
881  RCP<const SimpleFunctionObject<DependeeType> > func=null);
882 
890  ArrayModifierDependency(
891  RCP<const ParameterEntry> dependee,
892  ParameterEntryList dependents,
893  RCP<const SimpleFunctionObject<DependeeType> > func=null);
894 
896 
899 
906  inline RCP<const SimpleFunctionObject<DependeeType> >
907  getFunctionObject() const
908  {
909  return func_;
910  }
911 
913 
916 
918  virtual void evaluate();
919 
920 protected:
921 
923  virtual void validateDep() const;
924 
926 
929 
937  virtual void modifyArray(
938  DependeeType newAmount,
939  RCP<ParameterEntry> dependentToModify) = 0;
940 
948  virtual std::string getBadDependentValueErrorMessage() const=0;
949 
951 private:
952 
955 
959  RCP<const SimpleFunctionObject<DependeeType> > func_;
960 
961  //}
962 };
963 
964 template<class DependeeType, class DependentType>
965 ArrayModifierDependency<DependeeType,DependentType>::ArrayModifierDependency(
966  RCP<const ParameterEntry> dependee,
967  RCP<ParameterEntry> dependent,
968  RCP<const SimpleFunctionObject<DependeeType> > func):
969  Dependency(dependee, dependent),
970  func_(func)
971 {}
972 
973 template<class DependeeType, class DependentType>
974 ArrayModifierDependency<DependeeType,DependentType>::ArrayModifierDependency(
975  RCP<const ParameterEntry> dependee,
976  ParameterEntryList dependents,
977  RCP<const SimpleFunctionObject<DependeeType> > func):
978  Dependency(dependee, dependents),
979  func_(func)
980 {}
981 
982 template<class DependeeType, class DependentType>
983 void ArrayModifierDependency<DependeeType,DependentType>::validateDep() const{
984  TEUCHOS_TEST_FOR_EXCEPTION(
985  typeid(DependeeType) != getFirstDependee()->getAny().type(),
986  InvalidDependencyException,
987  "Ay no! The dependee parameter types don't match." << std::endl <<
988  "Dependee Template Type: " << TypeNameTraits<DependeeType>::name() <<
989  std::endl <<
990  "Dependee Parameter Type: " << getFirstDependee()->getAny().typeName()
991  << std::endl << std::endl);
992 }
993 
994 template<class DependeeType, class DependentType>
995 void ArrayModifierDependency<DependeeType,DependentType>::evaluate(){
996  DependeeType newAmount = Dependency::getFirstDependeeValue<DependeeType>();
997  if(!this->getFunctionObject().is_null()){
998  newAmount = this->getFunctionObject()->runFunction(newAmount);
999  }
1000 
1001  TEUCHOS_TEST_FOR_EXCEPTION(newAmount < OrdinalTraits<DependeeType>::zero(),
1002  Exceptions::InvalidParameterValue,
1003  getBadDependentValueErrorMessage());
1004 
1005  for(
1006  Dependency::ParameterEntryList::iterator it = this->getDependents().begin();
1007  it != this->getDependents().end();
1008  ++it)
1009  {
1010  modifyArray(newAmount, *it);
1011  }
1012 }
1013 
1014 
1037 template<class DependeeType, class DependentType>
1038 class NumberArrayLengthDependency :
1039  public ArrayModifierDependency<DependeeType, DependentType>
1040 {
1041 
1042 public:
1043 
1046 
1055  NumberArrayLengthDependency(
1056  RCP<const ParameterEntry> dependee,
1057  RCP<ParameterEntry> dependent,
1058  RCP<const SimpleFunctionObject<DependeeType> > func=null);
1059 
1068  NumberArrayLengthDependency(
1069  RCP<const ParameterEntry> dependee,
1070  Dependency::ParameterEntryList dependents,
1071  RCP<const SimpleFunctionObject<DependeeType> > func=null);
1072 
1074 
1077 
1079  std::string getTypeAttributeValue() const;
1080 
1082 
1083 protected:
1084 
1087 
1088  virtual void validateDep() const;
1089 
1091  void modifyArray(
1092  DependeeType newAmount, RCP<ParameterEntry> dependentToModify);
1093 
1095  std::string getBadDependentValueErrorMessage() const;
1096 
1098 
1099 };
1100 
1101 template<class DependeeType, class DependentType>
1102 NumberArrayLengthDependency<DependeeType, DependentType>::NumberArrayLengthDependency(
1103  RCP<const ParameterEntry> dependee,
1104  RCP<ParameterEntry> dependent,
1105  RCP<const SimpleFunctionObject<DependeeType> > func):
1106  ArrayModifierDependency<DependeeType, DependentType>(dependee, dependent, func)
1107 {
1108  validateDep();
1109 }
1110 
1111 template<class DependeeType, class DependentType>
1112 NumberArrayLengthDependency<DependeeType, DependentType>::NumberArrayLengthDependency(
1113  RCP<const ParameterEntry> dependee,
1114  Dependency::ParameterEntryList dependents,
1115  RCP<const SimpleFunctionObject<DependeeType> > func):
1116  ArrayModifierDependency<DependeeType, DependentType>(dependee, dependents, func)
1117 {
1118  validateDep();
1119 }
1120 
1121 
1122 template<class DependeeType, class DependentType>
1123 std::string
1124 NumberArrayLengthDependency<DependeeType, DependentType>::getTypeAttributeValue()
1125 const
1126 {
1127  return "NumberArrayLengthDependency(" +
1128  TypeNameTraits<DependeeType>::name() + ", " +
1129  TypeNameTraits<DependentType>::name() +")";
1130 }
1131 
1132 template <class DependeeType, class DependentType>
1133 void
1134 NumberArrayLengthDependency<DependeeType, DependentType>::modifyArray(
1135  DependeeType newAmount, RCP<ParameterEntry> dependentToModify)
1136 {
1137  const Array<DependentType> originalArray =
1138  any_cast<Array<DependentType> >(dependentToModify->getAny());
1139  Array<DependentType> newArray(newAmount);
1140  DependeeType i;
1141  for(
1142  i=OrdinalTraits<DependeeType>::zero();
1143  i<originalArray.size() && i<newAmount;
1144  ++i)
1145  {
1146  newArray[i] = originalArray[i];
1147  }
1148 
1149  dependentToModify->setValue(newArray,
1150  false, dependentToModify->docString(), dependentToModify->validator());
1151 }
1152 
1153 template<class DependeeType, class DependentType>
1154 std::string
1155 NumberArrayLengthDependency<DependeeType, DependentType>::getBadDependentValueErrorMessage() const{
1156  std::ostringstream os;
1157  os <<
1158  "Ruh Roh Shaggy! Looks like a dependency tried to set the length "
1159  "of the Array(s) to a negative number. Silly. You can't have "
1160  "an Array with a negative length!" << std::endl << std::endl <<
1161  "Error:" << std::endl <<
1162  "An attempt was made to set the length of an Array to a negative "
1163  "number by a NumberArrayLengthDependency" << std::endl << std::endl;
1164  return os.str();
1165 }
1166 
1167 template<class DependeeType, class DependentType>
1168 void
1169 NumberArrayLengthDependency<DependeeType, DependentType>::validateDep()
1170  const
1171 {
1172  ArrayModifierDependency<DependeeType, DependentType>::validateDep();
1173  for(
1174  Dependency::ConstParameterEntryList::const_iterator it =
1175  this->getDependents().begin();
1176  it != this->getDependents().end();
1177  ++it)
1178  {
1179  TEUCHOS_TEST_FOR_EXCEPTION(
1180  typeid(Teuchos::Array<DependentType>) != (*it)->getAny().type(),
1181  InvalidDependencyException,
1182  "Ay no! The dependent parameter types don't match." << std::endl <<
1183  "Dependent Template Type: " <<
1184  TypeNameTraits<DependentType>::name() << std::endl <<
1185  "Dependent Parameter Type: " <<
1186  (*it)->getAny().typeName() << std::endl << std::endl);
1187  }
1188 }
1189 
1195 template<class DependeeType, class DependentType>
1196 class DummyObjectGetter<NumberArrayLengthDependency<DependeeType, DependentType> >{
1197 
1198 public:
1199 
1202 
1206  static RCP<NumberArrayLengthDependency<DependeeType, DependentType> >
1207  getDummyObject();
1208 
1210 
1211 };
1212 
1213 template<class DependeeType, class DependentType>
1214 RCP<NumberArrayLengthDependency<DependeeType, DependentType> >
1215  DummyObjectGetter<NumberArrayLengthDependency<DependeeType, DependentType> >::getDummyObject()
1216 {
1217  return rcp(
1218  new NumberArrayLengthDependency<DependeeType, DependentType>(
1219  rcp(new ParameterEntry(ScalarTraits<DependeeType>::zero())),
1220  rcp(new ParameterEntry(Array<DependentType>(1)))));
1221 }
1222 
1247 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT StringValidatorDependency : public ValidatorDependency{
1248 
1249 public:
1250 
1253 
1257  typedef std::map<std::string, RCP<const ParameterEntryValidator> >
1258  ValueToValidatorMap;
1259 
1263  typedef std::pair<std::string, RCP<const ParameterEntryValidator> >
1264  ValueToValidatorPair;
1265 
1267 
1270 
1284  StringValidatorDependency(
1285  RCP<const ParameterEntry> dependee,
1286  RCP<ParameterEntry> dependent,
1287  ValueToValidatorMap valuesAndValidators,
1288  RCP<ParameterEntryValidator> defaultValidator=null);
1289 
1303  StringValidatorDependency(
1304  RCP<const ParameterEntry> dependee,
1305  Dependency::ParameterEntryList dependents,
1306  ValueToValidatorMap valuesAndValidators,
1307  RCP<ParameterEntryValidator> defaultValidator = null);
1308 
1310 
1313 
1316  const ValueToValidatorMap& getValuesAndValidators() const;
1317 
1319  RCP<const ParameterEntryValidator> getDefaultValidator() const;
1320 
1322 
1325 
1327  void evaluate();
1328 
1330 
1333 
1335  std::string getTypeAttributeValue() const;
1336 
1338 
1339 protected:
1340 
1343 
1344  void validateDep() const;
1345 
1347 
1348 private:
1349 
1352 
1357  ValueToValidatorMap valuesAndValidators_;
1358 
1364  RCP<ParameterEntryValidator> defaultValidator_;
1365 
1367 
1368 };
1369 
1370 
1376 template<>
1377 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT DummyObjectGetter<StringValidatorDependency>{
1378 
1379 public:
1380 
1383 
1386  static RCP<StringValidatorDependency > getDummyObject();
1387 
1389 
1390 };
1391 
1407 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT BoolValidatorDependency : public ValidatorDependency{
1408 
1409 public:
1410 
1413 
1424  BoolValidatorDependency(
1425  RCP<const ParameterEntry> dependee,
1426  RCP<ParameterEntry> dependent,
1427  RCP<const ParameterEntryValidator> trueValidator,
1428  RCP<const ParameterEntryValidator> falseValidator=null);
1429 
1440  BoolValidatorDependency(
1441  RCP<const ParameterEntry> dependee,
1442  Dependency::ParameterEntryList dependents,
1443  RCP<const ParameterEntryValidator> trueValidator,
1444  RCP<const ParameterEntryValidator> falseValidator=null);
1445 
1447 
1450 
1451  void evaluate();
1452 
1454 
1457 
1459  RCP<const ParameterEntryValidator> getTrueValidator() const;
1460 
1462  RCP<const ParameterEntryValidator> getFalseValidator() const;
1463 
1465 
1468 
1470  std::string getTypeAttributeValue() const;
1471 
1473 
1474 protected:
1475 
1478 
1479  void validateDep() const;
1480 
1482 
1483 private:
1484 
1487 
1492  RCP<const ParameterEntryValidator> trueValidator_, falseValidator_;
1493 
1495 
1496 };
1497 
1503 template<>
1504 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT DummyObjectGetter<BoolValidatorDependency>{
1505 
1506 public:
1507 
1510 
1512  static RCP<BoolValidatorDependency > getDummyObject();
1513 
1515 
1516 };
1517 
1547 template<class T>
1548 class RangeValidatorDependency : public ValidatorDependency{
1549 
1550 public:
1551 
1554 
1558  typedef std::pair<T,T> Range;
1559 
1563  typedef std::map<Range, RCP<const ParameterEntryValidator> >
1564  RangeToValidatorMap;
1565 
1569  typedef std::pair<Range, RCP<const ParameterEntryValidator> >
1570  RangeValidatorPair;
1571 
1573 
1576 
1590  RangeValidatorDependency(
1591  RCP<const ParameterEntry> dependee,
1592  RCP<ParameterEntry> dependent,
1593  RangeToValidatorMap rangesAndValidators,
1594  RCP<const ParameterEntryValidator> defaultValidator=null);
1595 
1609  RangeValidatorDependency(
1610  RCP<const ParameterEntry> dependee,
1611  Dependency::ParameterEntryList dependents,
1612  RangeToValidatorMap rangesAndValidators,
1613  RCP<const ParameterEntryValidator> defaultValidator=null);
1614 
1616 
1619 
1621  const RangeToValidatorMap& getRangeToValidatorMap() const{
1622  return rangesAndValidators_;
1623  }
1624 
1626  RCP<const ParameterEntryValidator> getDefaultValidator() const{
1627  return defaultValidator_;
1628  }
1629 
1631 
1634 
1636  void evaluate();
1637 
1639 
1642 
1644  std::string getTypeAttributeValue() const;
1645 
1647 
1648 protected:
1649 
1652 
1654  void validateDep() const;
1655 
1657 
1658 
1659 private:
1660 
1663 
1667  RangeToValidatorMap rangesAndValidators_;
1668 
1669  void setDependentsToValidator(RCP<const ParameterEntryValidator> toSet);
1670 
1671  RCP<const ParameterEntryValidator> defaultValidator_;
1672 
1674 
1675 };
1676 
1677 template<class T>
1678 RangeValidatorDependency<T>::RangeValidatorDependency(
1679  RCP<const ParameterEntry> dependee,
1680  RCP<ParameterEntry> dependent,
1681  RangeToValidatorMap rangesAndValidators,
1682  RCP<const ParameterEntryValidator> defaultValidator)
1683  :ValidatorDependency(dependee, dependent),
1684  rangesAndValidators_(rangesAndValidators),
1685  defaultValidator_(defaultValidator)
1686 {
1687  validateDep();
1688 }
1689 
1690 template<class T>
1691 RangeValidatorDependency<T>::RangeValidatorDependency(
1692  RCP<const ParameterEntry> dependee,
1693  Dependency::ParameterEntryList dependents,
1694  RangeToValidatorMap rangesAndValidators,
1695  RCP<const ParameterEntryValidator> defaultValidator)
1696  :ValidatorDependency(dependee, dependents),
1697  rangesAndValidators_(rangesAndValidators),
1698  defaultValidator_(defaultValidator)
1699 {
1700  validateDep();
1701 }
1702 
1703 template<class T>
1704 std::string RangeValidatorDependency<T>::getTypeAttributeValue() const
1705 {
1706  return "RangeValidatorDependency(" + TypeNameTraits<T>::name() + ")";
1707 }
1708 
1709 
1710 template<class T>
1711 void RangeValidatorDependency<T>::evaluate(){
1712  typename RangeToValidatorMap::const_iterator it;
1713  T dependeeValue = getFirstDependeeValue<T>();
1714  for(
1715  it = rangesAndValidators_.begin();
1716  it != rangesAndValidators_.end();
1717  ++it)
1718  {
1719  T min = it->first.first;
1720  T max = it->first.second;
1721  if(dependeeValue >= min && dependeeValue <max){
1722  setDependentsToValidator(it->second);
1723  return;
1724  }
1725  }
1726  setDependentsToValidator(defaultValidator_);
1727 }
1728 
1729 template<class T>
1730 void RangeValidatorDependency<T>::validateDep() const{
1731  RCP<const ParameterEntry> dependee = getFirstDependee();
1732  TEUCHOS_TEST_FOR_EXCEPTION(dependee->getAny().type() != typeid(T),
1733  InvalidDependencyException,
1734  "The dependee of a RangeValidatorDependency must be the same type as " <<
1735  "The RangeValidatorDependency template type!" << std::endl <<
1736  "Dependee Type: " << dependee->getAny().typeName() << std::endl <<
1737  "Templated Type: " << TypeNameTraits<T>::name() << std::endl << std::endl);
1738 
1739  TEUCHOS_TEST_FOR_EXCEPTION(
1740  rangesAndValidators_.size() < 1,
1741  InvalidDependencyException,
1742  "The rangesAndValidators map RangeValidatorDependency "
1743  "must have at least one entry!" << std::endl << std::endl);
1744 
1745  typename RangeToValidatorMap::const_iterator it =
1746  rangesAndValidators_.begin();
1747  RCP<const ParameterEntryValidator> firstValidator = it->second;
1748  // getting the raw pointer avoids a Clang warning about side effects in typeid
1749  const ParameterEntryValidator* rawValidatorPtr = firstValidator.get();
1750  ++it;
1751  for(; it!=rangesAndValidators_.end(); ++it){
1752  TEUCHOS_TEST_FOR_EXCEPTION( typeid(*rawValidatorPtr) != typeid(*(it->second)),
1753  InvalidDependencyException,
1754  "Ay no! All of the validators in a RangeValidatorDependency "
1755  "must have the same type.");
1756  TEUCHOS_TEST_FOR_EXCEPTION(
1757  it->first.first > it->first.second,
1758  InvalidDependencyException,
1759  "The Range " << it->first.first << " to " << it->first.second <<
1760  " is invalid. The min can't be greater than the max, you silly goose!"
1761  );
1762  }
1763 
1764  TEUCHOS_TEST_FOR_EXCEPTION(
1765  nonnull(defaultValidator_)
1766  &&
1767  typeid(*rawValidatorPtr) != typeid(*defaultValidator_),
1768  InvalidDependencyException,
1769  "Ay no! The default validator of a RangeValidatorDependency "
1770  "must have the same type as the validators in rangesAndValidators map."
1771  );
1772 
1773 }
1774 
1775 template<class T>
1776 void RangeValidatorDependency<T>::setDependentsToValidator(
1777  RCP<const ParameterEntryValidator> toSet)
1778 {
1779  typename ParameterEntryList::const_iterator it;
1780  for(
1781  it = getDependents().begin();
1782  it != getDependents().end();
1783  ++it)
1784  {
1785  (*it)->setValidator(toSet);
1786  }
1787 }
1788 
1794 template<class T>
1795 class DummyObjectGetter<RangeValidatorDependency<T> >{
1796 
1797 public:
1798 
1801 
1805  static RCP<RangeValidatorDependency<T> > getDummyObject();
1806 
1808 
1809 };
1810 
1811 template<class T>
1812 RCP<RangeValidatorDependency<T> >
1813  DummyObjectGetter<RangeValidatorDependency<T> >::getDummyObject()
1814 {
1815  typename RangeValidatorDependency<T>::RangeToValidatorMap dummyMap;
1816  typename RangeValidatorDependency<T>::Range dummyRange(
1817  ScalarTraits<T>::zero(), ScalarTraits<T>::one());
1818  RCP<FileNameValidator> dummyValidator =
1819  DummyObjectGetter<FileNameValidator>::getDummyObject();
1820  dummyMap.insert(typename RangeValidatorDependency<T>::RangeValidatorPair(
1821  dummyRange, dummyValidator));
1822  return rcp(new RangeValidatorDependency<T>(
1823  rcp(new ParameterEntry(ScalarTraits<T>::zero())),
1824  DummyObjectGetter<ParameterEntry>::getDummyObject(),
1825  dummyMap));
1826 }
1827 
1832 template<class DependeeType, class DependentType>
1833 class TwoDArrayModifierDependency :
1834  public ArrayModifierDependency<DependeeType, DependentType>
1835 {
1836 
1837 public:
1838 
1841 
1850  TwoDArrayModifierDependency(
1851  RCP<const ParameterEntry> dependee,
1852  RCP<ParameterEntry> dependent,
1853  RCP<const SimpleFunctionObject<DependeeType> > func=null):
1854  ArrayModifierDependency<DependeeType, DependentType>(
1855  dependee,
1856  dependent,
1857  func)
1858  {}
1859 
1860 
1869  TwoDArrayModifierDependency(
1870  RCP<const ParameterEntry> dependee,
1871  Dependency::ParameterEntryList dependents,
1872  RCP<const SimpleFunctionObject<DependeeType> > func=null):
1873  ArrayModifierDependency<DependeeType, DependentType>(
1874  dependee,
1875  dependents,
1876  func)
1877  {}
1878 
1880 
1881 protected:
1882 
1885 
1886  virtual void validateDep() const;
1887 
1889 
1890 };
1891 
1892 template<class DependeeType, class DependentType>
1893 void
1894 TwoDArrayModifierDependency<DependeeType, DependentType>::validateDep()
1895  const
1896 {
1897  ArrayModifierDependency<DependeeType, DependentType>::validateDep();
1898  for(
1899  Dependency::ConstParameterEntryList::const_iterator it =
1900  this->getDependents().begin();
1901  it != this->getDependents().end();
1902  ++it)
1903  {
1904  TEUCHOS_TEST_FOR_EXCEPTION(
1905  typeid(Teuchos::TwoDArray<DependentType>) != (*it)->getAny().type(),
1906  InvalidDependencyException,
1907  "Ay no! The dependent parameter types don't match." << std::endl <<
1908  "Dependent Template Type: " <<
1909  TypeNameTraits<DependentType>::name() << std::endl <<
1910  "Dependent Parameter Type: " <<
1911  (*it)->getAny().typeName() << std::endl << std::endl);
1912  }
1913 }
1914 
1915 
1923 template<class DependeeType, class DependentType>
1924 class TwoDRowDependency :
1925  public TwoDArrayModifierDependency<DependeeType, DependentType>
1926 {
1927 
1928 public:
1929 
1932 
1941  TwoDRowDependency(
1942  RCP<const ParameterEntry> dependee,
1943  RCP<ParameterEntry> dependent,
1944  RCP<const SimpleFunctionObject<DependeeType> > func=null);
1945 
1946 
1955  TwoDRowDependency(
1956  RCP<const ParameterEntry> dependee,
1957  Dependency::ParameterEntryList dependents,
1958  RCP<const SimpleFunctionObject<DependeeType> > func=null);
1959 
1961 
1964 
1966  std::string getTypeAttributeValue() const;
1967 
1969 
1970 protected:
1971 
1974 
1976  void modifyArray(
1977  DependeeType newAmount, RCP<ParameterEntry> dependentToModify);
1978 
1980  std::string getBadDependentValueErrorMessage() const;
1982 
1983 };
1984 
1985 template<class DependeeType, class DependentType>
1986 TwoDRowDependency<DependeeType, DependentType>::TwoDRowDependency(
1987  RCP<const ParameterEntry> dependee,
1988  RCP<ParameterEntry> dependent,
1989  RCP<const SimpleFunctionObject<DependeeType> > func):
1990  TwoDArrayModifierDependency<DependeeType, DependentType>(
1991  dependee, dependent, func)
1992 {
1993  this->validateDep();
1994 }
1995 
1996 template<class DependeeType, class DependentType>
1997 TwoDRowDependency<DependeeType, DependentType>::TwoDRowDependency(
1998  RCP<const ParameterEntry> dependee,
1999  Dependency::ParameterEntryList dependents,
2000  RCP<const SimpleFunctionObject<DependeeType> > func):
2001  TwoDArrayModifierDependency<DependeeType, DependentType>(
2002  dependee, dependents, func)
2003 {
2004  this->validateDep();
2005 }
2006 
2007 
2008 template<class DependeeType, class DependentType>
2009 std::string
2010 TwoDRowDependency<DependeeType, DependentType>::getTypeAttributeValue()
2011 const
2012 {
2013  return "TwoDRowDependency(" +
2014  TypeNameTraits<DependeeType>::name() + ", " +
2015  TypeNameTraits<DependentType>::name() +")";
2016 }
2017 
2018 template <class DependeeType, class DependentType>
2019 void
2020 TwoDRowDependency<DependeeType, DependentType>::modifyArray(
2021  DependeeType newAmount,
2022  RCP<ParameterEntry> dependentToModify)
2023 {
2024  TwoDArray<DependentType> originalArray =
2025  any_cast<TwoDArray<DependentType> >(dependentToModify->getAny());
2026  originalArray.resizeRows(newAmount);
2027  dependentToModify->setValue(originalArray,
2028  false, dependentToModify->docString(), dependentToModify->validator());
2029 }
2030 
2031 template<class DependeeType, class DependentType>
2032 std::string
2033 TwoDRowDependency<DependeeType, DependentType>::getBadDependentValueErrorMessage() const{
2034  std::ostringstream os;
2035  os <<
2036  "Ruh Roh Shaggy! Looks like a dependency tried to set the number of "
2037  "rows in TwoDArray(s) to a negative number. Silly. You can't have "
2038  "a TwoDArray with a negative number of rows!" << std::endl << std::endl <<
2039  "Error:" << std::endl <<
2040  "An attempt was made to set the number of rows of a TwoDArray to a negative "
2041  "number by a TwoDRowDependency" << std::endl << std::endl;
2042  return os.str();
2043 }
2044 
2050 template<class DependeeType, class DependentType>
2051 class DummyObjectGetter<TwoDRowDependency<DependeeType, DependentType> >{
2052 
2053 public:
2054 
2057 
2061  static RCP<TwoDRowDependency<DependeeType, DependentType> >
2062  getDummyObject();
2063 
2065 
2066 };
2067 
2068 template<class DependeeType, class DependentType>
2069 RCP<TwoDRowDependency<DependeeType, DependentType> >
2070  DummyObjectGetter<TwoDRowDependency<DependeeType, DependentType> >::getDummyObject()
2071 {
2072  return rcp(
2073  new TwoDRowDependency<DependeeType, DependentType>(
2074  rcp(new ParameterEntry(ScalarTraits<DependeeType>::zero())),
2075  rcp(new ParameterEntry(TwoDArray<DependentType>(1,1)))));
2076 }
2077 
2078 
2086 template<class DependeeType, class DependentType>
2087 class TwoDColDependency :
2088  public TwoDArrayModifierDependency<DependeeType, DependentType>
2089 {
2090 
2091 public:
2092 
2095 
2104  TwoDColDependency(
2105  RCP<const ParameterEntry> dependee,
2106  RCP<ParameterEntry> dependent,
2107  RCP<const SimpleFunctionObject<DependeeType> > func=null);
2108 
2109 
2118  TwoDColDependency(
2119  RCP<const ParameterEntry> dependee,
2120  Dependency::ParameterEntryList dependents,
2121  RCP<const SimpleFunctionObject<DependeeType> > func=null);
2122 
2124 
2127 
2129  std::string getTypeAttributeValue() const;
2130 
2132 
2133 protected:
2134 
2137 
2139  void modifyArray(
2140  DependeeType newAmount, RCP<ParameterEntry> dependentToModify);
2141 
2143  std::string getBadDependentValueErrorMessage() const;
2145 
2146 };
2147 
2148 template<class DependeeType, class DependentType>
2149 TwoDColDependency<DependeeType, DependentType>::TwoDColDependency(
2150  RCP<const ParameterEntry> dependee,
2151  RCP<ParameterEntry> dependent,
2152  RCP<const SimpleFunctionObject<DependeeType> > func):
2153  TwoDArrayModifierDependency<DependeeType, DependentType>(
2154  dependee, dependent, func)
2155 {
2156  this->validateDep();
2157 }
2158 
2159 template<class DependeeType, class DependentType>
2160 TwoDColDependency<DependeeType, DependentType>::TwoDColDependency(
2161  RCP<const ParameterEntry> dependee,
2162  Dependency::ParameterEntryList dependents,
2163  RCP<const SimpleFunctionObject<DependeeType> > func):
2164  TwoDArrayModifierDependency<DependeeType, DependentType>(
2165  dependee, dependents, func)
2166 {
2167  this->validateDep();
2168 }
2169 
2170 
2171 template<class DependeeType, class DependentType>
2172 std::string
2173 TwoDColDependency<DependeeType, DependentType>::getTypeAttributeValue()
2174 const
2175 {
2176  return "TwoDColDependency(" +
2177  TypeNameTraits<DependeeType>::name() + ", " +
2178  TypeNameTraits<DependentType>::name() +")";
2179 }
2180 
2181 template <class DependeeType, class DependentType>
2182 void
2183 TwoDColDependency<DependeeType, DependentType>::modifyArray(
2184  DependeeType newAmount,
2185  RCP<ParameterEntry> dependentToModify)
2186 {
2187  TwoDArray<DependentType> originalArray =
2188  any_cast<TwoDArray<DependentType> >(dependentToModify->getAny());
2189  originalArray.resizeCols(newAmount);
2190  dependentToModify->setValue(originalArray,
2191  false, dependentToModify->docString(), dependentToModify->validator());
2192 }
2193 
2194 template<class DependeeType, class DependentType>
2195 std::string
2196 TwoDColDependency<DependeeType, DependentType>::getBadDependentValueErrorMessage() const{
2197  std::ostringstream os;
2198  os <<
2199  "Ruh Roh Shaggy! Looks like a dependency tried to set the number of "
2200  "cols in TwoDArray(s) to a negative number. Silly. You can't have "
2201  "a TwoDArray with a negative number of cols!" << std::endl << std::endl <<
2202  "Error:" << std::endl <<
2203  "An attempt was made to set the number of columns of a TwoDArrayArray to a negative "
2204  "number by a TwoDColDependency" << std::endl << std::endl;
2205  return os.str();
2206 }
2207 
2213 template<class DependeeType, class DependentType>
2214 class DummyObjectGetter<TwoDColDependency<DependeeType, DependentType> >{
2215 
2216 public:
2217 
2220 
2224  static RCP<TwoDColDependency<DependeeType, DependentType> >
2225  getDummyObject();
2226 
2228 
2229 };
2230 
2231 template<class DependeeType, class DependentType>
2232 RCP<TwoDColDependency<DependeeType, DependentType> >
2233  DummyObjectGetter<TwoDColDependency<DependeeType, DependentType> >::getDummyObject()
2234 {
2235  return rcp(
2236  new TwoDColDependency<DependeeType, DependentType>(
2237  rcp(new ParameterEntry(ScalarTraits<DependeeType>::zero())),
2238  rcp(new ParameterEntry(TwoDArray<DependentType>(1,1)))));
2239 }
2240 
2241 
2242 
2243 } //namespace Teuchos
2244 #endif //TEUCHOS_STANDARDDEPENDCIES_HPP_
Teuchos::TwoDRowDependency::TwoDRowDependency
TwoDRowDependency(RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, RCP< const SimpleFunctionObject< DependeeType > > func=null)
Constructs a TwoDRowDependency.
Definition: Teuchos_StandardDependencies.hpp:1986
Teuchos::DummyObjectGetter::getDummyObject
static RCP< T > getDummyObject()
Retrieves a dummy object of type T.
Definition: Teuchos_DummyObjectGetter.hpp:60
Teuchos::TypeNameTraits::name
static std::string name()
Definition: Teuchos_TypeNameTraits.hpp:88
Teuchos::TwoDArray
A thin wrapper around the Array class which causes it to be interpreted as a 2D Array.
Definition: Teuchos_TwoDArray.hpp:68
Teuchos::TwoDColDependency::modifyArray
void modifyArray(DependeeType newAmount, RCP< ParameterEntry > dependentToModify)
Definition: Teuchos_StandardDependencies.hpp:2183
Teuchos::Array::size
size_type size() const
Definition: Teuchos_Array.hpp:1017
Teuchos::NumberVisualDependency::validateDep
void validateDep() const
Definition: Teuchos_StandardDependencies.hpp:815
Teuchos::NumberArrayLengthDependency
A NumberArrayLengthDependency says the following about the relationship between two parameters: The l...
Definition: Teuchos_StandardDependencies.hpp:1038
Teuchos::NumberVisualDependency::NumberVisualDependency
NumberVisualDependency(RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, bool showIf=true, RCP< SimpleFunctionObject< T > > func=null)
Constructs a NumberVisualDependency.
Definition: Teuchos_StandardDependencies.hpp:770
Teuchos::StringValidatorDependency::ValueToValidatorPair
std::pair< std::string, RCP< const ParameterEntryValidator > > ValueToValidatorPair
Conveniece typedef.
Definition: Teuchos_StandardDependencies.hpp:1264
Teuchos::ScalarTraits::zero
static T zero()
Returns representation of zero for this scalar type.
Definition: Teuchos_ScalarTraitsDecl.hpp:132
Teuchos::RangeValidatorDependency::getTypeAttributeValue
std::string getTypeAttributeValue() const
Definition: Teuchos_StandardDependencies.hpp:1704
Teuchos::StringVisualDependency
A string visual depdencies says the following about the relationship between two elements in a Parame...
Definition: Teuchos_StandardDependencies.hpp:244
Teuchos::TwoDArrayModifierDependency::TwoDArrayModifierDependency
TwoDArrayModifierDependency(RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, RCP< const SimpleFunctionObject< DependeeType > > func=null)
Constructs a TwoDArrayModifierDependency.
Definition: Teuchos_StandardDependencies.hpp:1850
Teuchos::TwoDColDependency::TwoDColDependency
TwoDColDependency(RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, RCP< const SimpleFunctionObject< DependeeType > > func=null)
Constructs a TwoDColDependency.
Definition: Teuchos_StandardDependencies.hpp:2149
Teuchos_OrdinalTraits.hpp
Defines basic traits for the ordinal field type.
Teuchos::ParameterEntry::validator
RCP< const ParameterEntryValidator > validator() const
Return the (optional) validator object.
Definition: Teuchos_ParameterEntry.hpp:402
Teuchos::RangeValidatorDependency::RangeToValidatorMap
std::map< Range, RCP< const ParameterEntryValidator > > RangeToValidatorMap
Convenience typedef.
Definition: Teuchos_StandardDependencies.hpp:1564
Teuchos::NumberArrayLengthDependency::validateDep
virtual void validateDep() const
Definition: Teuchos_StandardDependencies.hpp:1169
Teuchos::TwoDRowDependency::getTypeAttributeValue
std::string getTypeAttributeValue() const
Definition: Teuchos_StandardDependencies.hpp:2010
Teuchos::ParameterEntryValidator
Abstract interface for an object that can validate a ParameterEntry's value.
Definition: Teuchos_ParameterEntryValidator.hpp:64
Teuchos::NumberArrayLengthDependency::modifyArray
void modifyArray(DependeeType newAmount, RCP< ParameterEntry > dependentToModify)
Definition: Teuchos_StandardDependencies.hpp:1134
Teuchos::RangeValidatorDependency
A RangeValidatorDependency says the following about the relationship between two parameters: Dependen...
Definition: Teuchos_StandardDependencies.hpp:1548
Teuchos::OrdinalTraits
This structure defines some basic traits for the ordinal field type.
Definition: Teuchos_OrdinalTraits.hpp:81
Teuchos::TypeNameTraits
Default traits class that just returns typeid(T).name().
Definition: Teuchos_TypeNameTraits.hpp:85
Teuchos::VisualDependency
An abstract parent class for all visual dependencies.
Definition: Teuchos_StandardDependencies.hpp:72
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
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Deprecated.
Definition: Teuchos_RCPDecl.hpp:1224
Teuchos::ArrayModifierDependency::getBadDependentValueErrorMessage
virtual std::string getBadDependentValueErrorMessage() const =0
Returns the error message that should be displayed if the dependent has taken on a value that,...
Teuchos::RangeValidatorDependency::getRangeToValidatorMap
const RangeToValidatorMap & getRangeToValidatorMap() const
Definition: Teuchos_StandardDependencies.hpp:1621
Teuchos::TwoDArrayModifierDependency::validateDep
virtual void validateDep() const
Definition: Teuchos_StandardDependencies.hpp:1894
Teuchos::typeName
std::string typeName(const T &t)
Template function for returning the concrete type name of a passed-in object.
Definition: Teuchos_TypeNameTraits.hpp:115
Teuchos::NumberArrayLengthDependency::getBadDependentValueErrorMessage
std::string getBadDependentValueErrorMessage() const
Definition: Teuchos_StandardDependencies.hpp:1155
Teuchos::TwoDColDependency::getBadDependentValueErrorMessage
std::string getBadDependentValueErrorMessage() const
Definition: Teuchos_StandardDependencies.hpp:2196
Teuchos::any::type
const std::type_info & type() const
Return the type of value being stored.
Definition: Teuchos_any.hpp:208
Teuchos::RCP
Smart reference counting pointer class for automatic garbage collection.
Definition: Teuchos_RCPDecl.hpp:429
Teuchos::NumberArrayLengthDependency::getTypeAttributeValue
std::string getTypeAttributeValue() const
Definition: Teuchos_StandardDependencies.hpp:1124
Teuchos::StringValidatorDependency::ValueToValidatorMap
std::map< std::string, RCP< const ParameterEntryValidator > > ValueToValidatorMap
Conveniece typedef.
Definition: Teuchos_StandardDependencies.hpp:1258
Teuchos::Array< std::string >
Teuchos::RangeValidatorDependency::evaluate
void evaluate()
Definition: Teuchos_StandardDependencies.hpp:1711
Teuchos::InvalidDependencyException
Definition: Teuchos_InvalidDependencyException.hpp:53
Teuchos::ParameterEntry::setValue
void setValue(T value, bool isDefault=false, const std::string &docString="", RCP< const ParameterEntryValidator > const &validator=null)
Templated set method that uses the input value type to determine the type of parameter.
Definition: Teuchos_ParameterEntry.hpp:337
Teuchos::Dependency::ParameterEntryList
std::set< RCP< ParameterEntry >, RCPComp > ParameterEntryList
A list of Dependees.
Definition: Teuchos_Dependency.hpp:74
Teuchos::Dependency
This class represents a depndency between elements in a Parameter List.
Definition: Teuchos_Dependency.hpp:64
Teuchos::StringValidatorDependency
A StringValidatorDependency says the following about the relationship between two parameters: Depende...
Definition: Teuchos_StandardDependencies.hpp:1247
Teuchos::RangeValidatorDependency::getDefaultValidator
RCP< const ParameterEntryValidator > getDefaultValidator() const
Definition: Teuchos_StandardDependencies.hpp:1626
Teuchos::ParameterEntry::isType
bool isType() const
Test the type of the data being contained.
Definition: Teuchos_ParameterEntry.hpp:389
Teuchos::TwoDArray::resizeCols
void resizeCols(size_type numberOfCols)
Changes the number of rows in the matrix.
Definition: Teuchos_TwoDArray.hpp:281
Teuchos::ParameterEntry::getAny
any & getAny(bool activeQry=true)
Direct access to the Teuchos::any data value underlying this object. The bool argument activeQry (def...
Definition: Teuchos_ParameterEntry.hpp:364
Teuchos::ScalarTraits
This structure defines some basic traits for a scalar field type.
Definition: Teuchos_ScalarTraitsDecl.hpp:90
Teuchos::ArrayModifierDependency
An abstract base class for all dependencies which modify the dimensional attributes of an Array param...
Definition: Teuchos_StandardDependencies.hpp:865
Teuchos::SimpleFunctionObject< T >
Teuchos::DummyObjectGetter
Class for retrieving a dummy object of type T.
Definition: Teuchos_DummyObjectGetter.hpp:55
Teuchos::TwoDArrayModifierDependency
A dependency in which some attribute of a TwoDArray in a parameter depends on the value of another pa...
Definition: Teuchos_StandardDependencies.hpp:1833
Teuchos::RangeValidatorDependency::RangeValidatorPair
std::pair< Range, RCP< const ParameterEntryValidator > > RangeValidatorPair
Convenience typedef.
Definition: Teuchos_StandardDependencies.hpp:1570
Teuchos::Dependency::ConstParameterEntryList
std::set< RCP< const ParameterEntry >, RCPConstComp > ConstParameterEntryList
A list of dependents.
Definition: Teuchos_Dependency.hpp:79
Teuchos::StringVisualDependency::ValueList
Array< std::string > ValueList
Definition: Teuchos_StandardDependencies.hpp:254
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:2087
Teuchos::TwoDArray::resizeRows
void resizeRows(size_type numberOfRows)
Changes the number of rows in the matrix.
Definition: Teuchos_TwoDArray.hpp:274
Teuchos::BoolVisualDependency
A bool visual dependency says the following about the relationship between two elements in a Paramete...
Definition: Teuchos_StandardDependencies.hpp:425
Teuchos::ConditionVisualDependency::validateDep
void validateDep() const
Definition: Teuchos_StandardDependencies.hpp:597
Teuchos::ArrayModifierDependency::evaluate
virtual void evaluate()
Definition: Teuchos_StandardDependencies.hpp:995
Teuchos::TwoDRowDependency::modifyArray
void modifyArray(DependeeType newAmount, RCP< ParameterEntry > dependentToModify)
Definition: Teuchos_StandardDependencies.hpp:2020
Teuchos::RangeValidatorDependency::Range
std::pair< T, T > Range
Convenience typedef.
Definition: Teuchos_StandardDependencies.hpp:1558
Teuchos::NumberVisualDependency::getFunctionObject
RCP< const SimpleFunctionObject< T > > getFunctionObject() const
Const version of function getter.
Definition: Teuchos_StandardDependencies.hpp:809
Teuchos::Exceptions::InvalidParameterValue
Definition: Teuchos_ParameterListExceptions.hpp:79
Teuchos::ArrayModifierDependency::ArrayModifierDependency
ArrayModifierDependency(RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, RCP< const SimpleFunctionObject< DependeeType > > func=null)
Constructs an ArrayModifierDependency.
Definition: Teuchos_StandardDependencies.hpp:965
Teuchos::any::typeName
std::string typeName() const
Return the name of the type.
Definition: Teuchos_any.hpp:214
Teuchos::TwoDRowDependency::getBadDependentValueErrorMessage
std::string getBadDependentValueErrorMessage() const
Definition: Teuchos_StandardDependencies.hpp:2033
Teuchos::ValidatorDependency
An abstract base class for all validator dependencies.
Definition: Teuchos_StandardDependencies.hpp:192
Teuchos::NumberVisualDependency::getTypeAttributeValue
std::string getTypeAttributeValue() const
Definition: Teuchos_StandardDependencies.hpp:803
Teuchos::NumberVisualDependency::getDependeeState
bool getDependeeState() const
Get the state of the dependee in order to evaluate the dependency.
Definition: Teuchos_StandardDependencies.hpp:794
Teuchos::TwoDArrayModifierDependency::TwoDArrayModifierDependency
TwoDArrayModifierDependency(RCP< const ParameterEntry > dependee, Dependency::ParameterEntryList dependents, RCP< const SimpleFunctionObject< DependeeType > > func=null)
Constructs a TwoDArrayModifierDependency.
Definition: Teuchos_StandardDependencies.hpp:1869
Teuchos::BoolValidatorDependency
A BoolValidatorDependency says the following about the relationship between two parameters: Dependeni...
Definition: Teuchos_StandardDependencies.hpp:1407
Teuchos::RCP::get
T * get() const
Get the raw C++ pointer to the underlying object.
Definition: Teuchos_RCP.hpp:363
Teuchos::ArrayModifierDependency::validateDep
virtual void validateDep() const
Definition: Teuchos_StandardDependencies.hpp:983
Teuchos::nonnull
bool nonnull(const std::shared_ptr< T > &p)
Returns true if p.get()!=NULL.
Definition: Teuchos_RCPStdSharedPtrConversionsDecl.hpp:159
Teuchos::ArrayModifierDependency::getFunctionObject
RCP< const SimpleFunctionObject< DependeeType > > getFunctionObject() const
Retrieves the function being used to calculate the amount by which an arrays dimensional attribute sh...
Definition: Teuchos_StandardDependencies.hpp:907
Teuchos_ScalarTraits.hpp
Defines basic traits for the scalar field type.
Teuchos
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...
Teuchos::ConditionVisualDependency
A condition visual dependency says the following about the relationship between elements in a Paramet...
Definition: Teuchos_StandardDependencies.hpp:529
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:1924
Teuchos::RangeValidatorDependency::validateDep
void validateDep() const
Definition: Teuchos_StandardDependencies.hpp:1730
Teuchos::RangeValidatorDependency::RangeValidatorDependency
RangeValidatorDependency(RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, RangeToValidatorMap rangesAndValidators, RCP< const ParameterEntryValidator > defaultValidator=null)
Constructs a RangeValidatorDependency.
Definition: Teuchos_StandardDependencies.hpp:1678
Teuchos::ParameterEntry
This object is held as the "value" in the Teuchos::ParameterList std::map.
Definition: Teuchos_ParameterEntry.hpp:67
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::ArrayModifierDependency::modifyArray
virtual void modifyArray(DependeeType newAmount, RCP< ParameterEntry > dependentToModify)=0
Modifies a particular attribute of the array according to the specific semantics of the dependency.
Teuchos::NumberArrayLengthDependency::NumberArrayLengthDependency
NumberArrayLengthDependency(RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, RCP< const SimpleFunctionObject< DependeeType > > func=null)
Constructs a NumberArrayLengthDependency.
Definition: Teuchos_StandardDependencies.hpp:1102
Teuchos::is_null
bool is_null(const std::shared_ptr< T > &p)
Returns true if p.get()==NULL.
Definition: Teuchos_RCPStdSharedPtrConversionsDecl.hpp:148
Teuchos::ParameterEntry::docString
std::string docString() const
Return the (optional) documentation std::string.
Definition: Teuchos_ParameterEntry.hpp:397
Teuchos::TwoDColDependency::getTypeAttributeValue
std::string getTypeAttributeValue() const
Definition: Teuchos_StandardDependencies.hpp:2173
Teuchos_StandardConditions.hpp
Standard Conditions to be used.
Generated by   doxygen 1.8.17