Xyce  6.1
N_DEV_CompositeParam.C
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 // Copyright Notice
3 //
4 // Copyright 2002 Sandia Corporation. Under the terms
5 // of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S.
6 // Government retains certain rights in this software.
7 //
8 // Xyce(TM) Parallel Electrical Simulator
9 // Copyright(C) 2002-2015 Sandia Corporation
10 //
11 // This program is free software: you can redistribute it and/or modify
12 // it under the terms of the GNU General Public License as published by
13 // the Free Software Foundation, either version 3 of the License, or
14 // (at your option) any later version.
15 //
16 // This program is distributed in the hope that it will be useful,
17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 // GNU General Public License for more details.
20 //
21 // You should have received a copy of the GNU General Public License
22 // along with this program. If not, see <http://www.gnu.org/licenses/>.
23 //-----------------------------------------------------------------------------
24 
25 //-------------------------------------------------------------------------
26 // Filename : $RCSfile: N_DEV_CompositeParam.C,v $
27 //
28 // Purpose :
29 //
30 // Special Notes :
31 //
32 // Creator : Dave Shirley, PSSI
33 //
34 // Creation Date : 05/05/05
35 //
36 // Revision Information:
37 // ---------------------
38 //
39 // Revision Number: $Revision: 1.28.4.1 $
40 //
41 // Revision Date : $Date: 2015/04/02 18:20:09 $
42 //
43 // Current Owner : $Author: tvrusso $
44 //-------------------------------------------------------------------------
45 
46 #include <Xyce_config.h>
47 
48 #include <N_DEV_CompositeParam.h>
49 #include <N_ERH_Message.h>
50 
51 namespace Xyce {
52 namespace Device {
53 
54 //-----------------------------------------------------------------------------
55 // Function : CompositeParam::given
56 // Purpose : Return whether param was given
57 // Special Notes :
58 // Scope : public
59 // Creator : Dave Baur, Raytheon
60 // Creation Date : 1/29/2014
61 //-----------------------------------------------------------------------------
62 ///
63 /// given returns true if the value was specified in the netlist (not defaulted).
64 ///
65 /// @param parameter_name const reference to the name of the parameter
66 ///
67 /// @return true if the value was specified in the netlist (was not defaulted)
68 bool CompositeParam::given(const std::string &parameter_name ) const
69 {
70  ParameterMap::const_iterator it = getParameterMap().find(parameter_name);
71 
72  if (it == getParameterMap().end())
73  Report::DevelFatal0() << "CompositeParam::Given: unrecognized param: " << parameter_name;
74 
75  return Xyce::Device::wasValueGiven(*this, (*it).second->getSerialNumber());
76 }
77 
78 } // namespace Device
79 } // namespace Xyce
Pure virtual class to augment a linear system.
bool given(const std::string &parameter_name) const
given returns true if the value was specified in the netlist (not defaulted).
bool wasValueGiven(const ParameterBase &parameter_base, int serial_number)
Return true if a value was provided for the device.
Definition: N_DEV_Pars.h:1674
const ParameterMap & getParameterMap() const
getParameterMap returns the parameter map which describes the parameters.