Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Xyce::Device::ParametricData< void > Class Template Reference

Class ParametricData<void> manages the configuration information and the parameter binding map. More...

#include <N_DEV_Pars.h>

Public Member Functions

 ParametricData ()
 Constructs a ParametricData object. More...
 
virtual ~ParametricData ()
 Destroys a ParametricData object. More...
 
ParameterMapgetMap ()
 Gets the parameter binding map map. More...
 
const ParameterMapgetMap () const
 Returns the parameter binding map. More...
 

Protected Member Functions

void addDescriptor (const std::string &name, Descriptor *descriptor, const std::type_info &parameter_data_class)
 Adds the parameter to the parameter binding map. More...
 

Protected Attributes

ParameterMap map_
 Mapping from parameter name to descriptor. More...
 

Private Member Functions

 ParametricData (const ParametricData &parametric_data)
 No copying. More...
 
ParametricDataoperator= (const ParametricData &parametric_data)
 No assignment. More...
 

Detailed Description

template<>
class Xyce::Device::ParametricData< void >

Class ParametricData<void> manages the configuration information and the parameter binding map.

Parametric data associated with a device instance, device model or composite parameter

The Parametric data class manages the mapping of parameter string names to descriptors and the general configuration information associated with a device model.

To restore original values during perturbation, the originalValueCount_ and serialNumber_ members maintain counts of original values to be stored and of parameters declared.

Date
Tue Aug 6 13:10:21 2013
Author
David G. Baur Raytheon Sandia National Laboratories 1355

Definition at line 1206 of file N_DEV_Pars.h.

Constructor & Destructor Documentation

Constructs a ParametricData object.

Date
Tue Aug 6 13:10:21 2013
Author
David G. Baur Raytheon Sandia National Laboratories 1355

Definition at line 1215 of file N_DEV_Pars.h.

virtual Xyce::Device::ParametricData< void >::~ParametricData ( )
inlinevirtual

Destroys a ParametricData object.

Date
Tue Aug 6 13:13:47 2013
Author
David G. Baur Raytheon Sandia National Laboratories 1355

Definition at line 1225 of file N_DEV_Pars.h.

Xyce::Device::ParametricData< void >::ParametricData ( const ParametricData< void > &  parametric_data)
private

No copying.

Member Function Documentation

void Xyce::Device::ParametricData< void >::addDescriptor ( const std::string &  name,
Descriptor descriptor,
const std::type_info &  parameter_data_class 
)
protected

Adds the parameter to the parameter binding map.

Adds an entry to descriptor map.

Parameters
nameparameter name
descriptordescriptor created for the parameter
parameter_data_classtypeinfo to get the class name for diagnostics
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 16:23:45 2013

The serial number of the parameter is set in the descriptor.

Invariant
descriptor serial number is unique for each descriptor
parameter descriptor has unique name
Parameters
nameName or parameter to declare
descriptorType information of parameter
parameter_data_classTypeinfo to display name of class on error

Definition at line 194 of file N_DEV_Pars.C.

ParameterMap& Xyce::Device::ParametricData< void >::getMap ( )
inline

Gets the parameter binding map map.

Returns
reference to the parameter binding map
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 15:50:06 2013

Definition at line 1244 of file N_DEV_Pars.h.

const ParameterMap& Xyce::Device::ParametricData< void >::getMap ( ) const
inline

Returns the parameter binding map.

Returns
const reference to the parameter binding map
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 15:50:06 2013

Definition at line 1257 of file N_DEV_Pars.h.

ParametricData& Xyce::Device::ParametricData< void >::operator= ( const ParametricData< void > &  parametric_data)
private

No assignment.

Member Data Documentation

ParameterMap Xyce::Device::ParametricData< void >::map_
protected

Mapping from parameter name to descriptor.

Definition at line 1276 of file N_DEV_Pars.h.


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