Xyce  6.1
Xyce::Device::CompositeParam Class Referenceabstract

CompositeParam is the base class for classes that wish to only manage the processing of parameter data. More...

#include <N_DEV_CompositeParam.h>

Inheritance diagram for Xyce::Device::CompositeParam:
Collaboration diagram for Xyce::Device::CompositeParam:

Public Member Functions

 CompositeParam (ParametricData< void > &parametric_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 &parameter_name) const
 given returns true if the value was specified in the netlist (not defaulted). More...
 
const ParameterMapgetParameterMap () const
 getParameterMap returns the parameter map which describes the parameters. More...
 
- Public Member Functions inherited from Xyce::Device::ParameterBase
 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...
 
CompositeParamoperator= (const CompositeParam &)
 No assignment. More...
 

Private Attributes

ParametricData< void > & parametricData_
 Parameter data desciptions. More...
 

Detailed Description

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.

Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Wed Jan 29 17:26:35 2014

Definition at line 70 of file N_DEV_CompositeParam.h.

Constructor & Destructor Documentation

Xyce::Device::CompositeParam::CompositeParam ( ParametricData< void > &  parametric_data)
inline

CompositeParam sets the parametric data description.

Parameters
parametric_datareference to the parametric data description
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Wed Jan 29 17:33:22 2014

Definition at line 82 of file N_DEV_CompositeParam.h.

virtual Xyce::Device::CompositeParam::~CompositeParam ( )
inlinevirtual

Definition at line 86 of file N_DEV_CompositeParam.h.

Xyce::Device::CompositeParam::CompositeParam ( const CompositeParam )
private

No copying.

Member Function Documentation

const ParameterMap& Xyce::Device::CompositeParam::getParameterMap ( ) const
inline

getParameterMap returns the parameter map which describes the parameters.

Returns
reference to the parameter map
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Wed Jan 29 17:49:10 2014

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).

Parameters
parameter_nameconst reference to the name of the parameter
Returns
true if the value was specified in the netlist (was not defaulted)

Definition at line 68 of file N_DEV_CompositeParam.C.

CompositeParam& Xyce::Device::CompositeParam::operator= ( const CompositeParam )
private

No assignment.

virtual void Xyce::Device::CompositeParam::processParams ( )
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.

Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Wed Jan 29 17:34:53 2014

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.

Member Data Documentation

ParametricData<void>& Xyce::Device::CompositeParam::parametricData_
private

Parameter data desciptions.

Definition at line 120 of file N_DEV_CompositeParam.h.


The documentation for this class was generated from the following files: