Xyce
6.1
|
CompositeParam is the base class for classes that wish to only manage the processing of parameter data. More...
#include <N_DEV_CompositeParam.h>
Public Member Functions | |
CompositeParam (ParametricData< void > ¶metric_data) | |
CompositeParam sets the parametric data description. More... | |
virtual | ~CompositeParam () |
virtual void | processParams ()=0 |
processParams post processes the parameters that have been set in the object of the derived class. More... | |
bool | given (const std::string ¶meter_name) const |
given returns true if the value was specified in the netlist (not defaulted). More... | |
const ParameterMap & | getParameterMap () const |
getParameterMap returns the parameter map which describes the parameters. More... | |
![]() | |
ParameterBase () | |
virtual | ~ParameterBase () |
double | getOriginalValue (int serial_number) |
void | setOriginalValue (int serial_number, double value) |
bool | wasValueGiven (int serial_number) const |
void | setValueGiven (int serial_number, bool value) |
Private Member Functions | |
CompositeParam (const CompositeParam &) | |
No copying. More... | |
CompositeParam & | operator= (const CompositeParam &) |
No assignment. More... | |
Private Attributes | |
ParametricData< void > & | parametricData_ |
Parameter data desciptions. More... | |
CompositeParam is the base class for classes that wish to only manage the processing of parameter data.
The DeviceEntity class is vary similar, except that it manages a device as well as the device's parameter data. During DeviceEntity's processing of parameters, it may create several object of classes derived from CompositeParam which hold the processes parametric data. The parametricData_ member holds the parameter descriptions the Device::setParameters() function populates the values in the object of the derived class while the processParams() virtual function can handle any additional processing of the parameters after they have been set. parametricData_ object.
See Device::populateParams() and Device::setParameters() in the DeviceEntity implementation file.
Definition at line 70 of file N_DEV_CompositeParam.h.
|
inline |
CompositeParam sets the parametric data description.
parametric_data | reference to the parametric data description |
Definition at line 82 of file N_DEV_CompositeParam.h.
|
inlinevirtual |
Definition at line 86 of file N_DEV_CompositeParam.h.
|
private |
No copying.
|
inline |
getParameterMap returns the parameter map which describes the parameters.
Definition at line 114 of file N_DEV_CompositeParam.h.
bool Xyce::Device::CompositeParam::given | ( | const std::string & | parameter_name | ) | const |
given returns true if the value was specified in the netlist (not defaulted).
parameter_name | const reference to the name of the parameter |
Definition at line 68 of file N_DEV_CompositeParam.C.
|
private |
No assignment.
|
pure virtual |
processParams post processes the parameters that have been set in the object of the derived class.
See Device::populateParams() and Device::setParameters() in the DeviceEntity implementation file.
Implemented in Xyce::Device::PDE_2DElectrode, Xyce::Device::MaterialLayer, Xyce::Device::PDE_1DElectrode, Xyce::Device::PDE_Electrode, Xyce::Device::RegionData, Xyce::Device::XygraCoilData, Xyce::Device::SpecieSource, and Xyce::Device::DopeInfo.
|
private |
Parameter data desciptions.
Definition at line 120 of file N_DEV_CompositeParam.h.