Teuchos - Trilinos Tools Package
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
parameterlist
src
Teuchos_Dependency.cpp
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
#include "Teuchos_Dependency.hpp"
43
44
45
namespace
Teuchos
{
46
47
48
Dependency::Dependency
(
49
ConstParameterEntryList
dependees,
50
ParameterEntryList
dependents):
51
dependees_(dependees), dependents_(dependents)
52
{
53
checkDependeesAndDependents();
54
createConstDependents();
55
}
56
57
Dependency::Dependency
(
58
ConstParameterEntryList
dependees,
59
RCP<ParameterEntry>
dependent):
60
dependees_(dependees),
61
dependents_(
ParameterEntryList
(&dependent, &dependent+1))
62
{
63
checkDependeesAndDependents();
64
createConstDependents();
65
}
66
67
68
Dependency::Dependency
(
69
RCP<const ParameterEntry>
dependee,
70
ParameterEntryList
dependents):
71
dependees_(
ConstParameterEntryList
(&dependee, &dependee+1)),
72
dependents_(dependents)
73
{
74
checkDependeesAndDependents();
75
createConstDependents();
76
}
77
78
Dependency::Dependency
(
79
RCP<const ParameterEntry>
dependee,
80
RCP<ParameterEntry>
dependent):
81
dependees_(
ConstParameterEntryList
(&dependee, &dependee+1)),
82
dependents_(
ParameterEntryList
(&dependent, &dependent+1))
83
{
84
checkDependeesAndDependents();
85
createConstDependents();
86
}
87
88
89
void
Dependency::createConstDependents(){
90
for
(
91
ParameterEntryList::iterator it = dependents_.begin();
92
it != dependents_.end();
93
++it)
94
{
95
constDependents_.insert(it->getConst());
96
}
97
}
98
99
void
Dependency::print
(std::ostream& out)
const
{
100
out <<
"Type: "
<<
getTypeAttributeValue
() << std::endl;
101
out <<
"Number of dependees: "
<< dependees_.size() << std::endl;
102
out <<
"Number of dependents: "
<< dependents_.size() << std::endl;
103
104
}
105
106
void
Dependency::checkDependeesAndDependents(){
107
ConstParameterEntryList::iterator it1 = dependees_.begin();
108
for
(; it1 != dependees_.end(); ++it1){
109
TEUCHOS_TEST_FOR_EXCEPTION
((*it1).is_null(),
110
InvalidDependencyException
,
111
"Cannot have a null dependee!"
<< std::endl << std::endl);
112
}
113
114
ParameterEntryList::iterator it2 = dependents_.begin();
115
for
(; it2 != dependents_.end(); ++it2){
116
TEUCHOS_TEST_FOR_EXCEPTION
((*it2).is_null(),
117
InvalidDependencyException,
118
"Cannot have a null dependent!"
<< std::endl << std::endl);
119
}
120
}
121
122
}
//namespace Teuchos
123
Teuchos::Dependency::getTypeAttributeValue
virtual std::string getTypeAttributeValue() const =0
Returns the string to be used for the value of the type attribute when converting the dependency to X...
Teuchos::Dependency::Dependency
Dependency(ConstParameterEntryList dependees, ParameterEntryList dependents)
Constructs a Dependency.
Definition
Teuchos_Dependency.cpp:48
Teuchos::Dependency::ParameterEntryList
std::set< RCP< ParameterEntry >, RCPComp > ParameterEntryList
A list of Dependees.
Definition
Teuchos_Dependency.hpp:74
Teuchos::Dependency::print
virtual void print(std::ostream &out) const
prints out information about the dependency.
Definition
Teuchos_Dependency.cpp:99
Teuchos::Dependency::ConstParameterEntryList
std::set< RCP< const ParameterEntry >, RCPConstComp > ConstParameterEntryList
A list of dependents.
Definition
Teuchos_Dependency.hpp:79
Teuchos::InvalidDependencyException
Definition
Teuchos_InvalidDependencyException.hpp:53
Teuchos::RCP
Smart reference counting pointer class for automatic garbage collection.
Definition
Teuchos_RCPDecl.hpp:429
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:178
Teuchos
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...
Generated by
1.17.0