Xyce
6.1
|
Class Descriptor describes the parameters stored in the ParametricData parameter map. More...
#include <N_DEV_Pars.h>
Public Member Functions | |
Descriptor (Entry< void > *const entry) | |
Constructs Descriptor. More... | |
virtual | ~Descriptor () |
Destroy Descriptor. More... | |
template<class T > | |
bool | isType () const |
Tests entry data type. More... | |
bool | hasCompositeData () const |
Descriptor & | setOriginalValueStored (bool original_value_flag) |
Sets a boolean marking an original value having been stored. More... | |
bool | hasOriginalValueStored () const |
Returns whether an original value has been stored. More... | |
Descriptor & | setExpressionAccess (ExprAccess expression_access) |
Sets the expression access which describe the usage of the parameter. More... | |
ExprAccess | getExpressionAccess () const |
Gets the expression access which describes the usage of the paramter. More... | |
Descriptor & | setUnit (ParameterUnit unit) |
Sets the units of the parameter, only used to document the parameter. More... | |
ParameterUnit | getUnit () const |
Gets the units of the parameter, only used to document the parameter. More... | |
Descriptor & | setCategory (ParameterCategory category) |
Sets the category of the parameter, only used to document the parameter. More... | |
ParameterCategory | getCategory () const |
Gets the category of the parameter, only used to document the parameter. More... | |
Descriptor & | setDescription (const std::string &description) |
Sets the description of the parameter, only used to document the parameter. More... | |
const std::string & | getDescription () const |
Gets the description of the parameter, only used to document the parameter. More... | |
Descriptor & | setCompositeParametricData (const ParametricData< void > *composite_parametric_data) |
Sets the composite parametric. More... | |
template<class U > | |
const ParametricData< U > * | getCompositeParametricData () const |
Return the composite parameter. More... | |
Descriptor & | setVec (int index) |
sets the vector length of an vectorized parameter More... | |
int | getVec () const |
Gets the vector length of a vectorized parameter. More... | |
const Entry< void > & | getEntry () const |
Gets the entry object of the parameter. More... | |
Entry< void > & | getEntry () |
Gets the entry object of the parameter. More... | |
Descriptor & | setSerialNumber (int serial_number) |
Sets the serial number used to store and retrieve given boolean from the GivenValueMap. More... | |
int | getSerialNumber () const |
Gets the serial number used to store and retireve given boolean fromt he GivenValueMap. More... | |
template<class T > | |
const T & | value (const ParameterBase &entity) const |
Returns the value of the parameter for the entity. More... | |
template<class T > | |
T & | value (ParameterBase &entity) const |
Returns the value of the parameter for the entity. More... | |
template<class T > | |
T ParameterBase::* | getMemberPtr () const |
Returns the parameter member variable pointer of the enrtry. More... | |
bool | hasGivenMember () const |
Tests if parameter has a given data member. More... | |
template<class U > | |
Descriptor & | setGivenMember (bool U::*given) |
Sets the boolean member variable to set if the netlist provides the value. More... | |
bool | getGiven (ParameterBase &entity) const |
Tests if the parameter has been given by the netlist. More... | |
void | setGiven (ParameterBase &entity, bool value) const |
Sets the given state of the parameter to value. More... | |
Descriptor & | setAnalyticSensitivityAvailable (bool value) |
Sets a boolean to indicate if analytic sensitivities are available w.r.t. this parameter. More... | |
Descriptor & | setSensitivityFunctor (const baseSensitivity *sensPtr) |
bool | getAnalyticSensitivityAvailable () const |
returns a boolean to indicate if analytic sensitivities are available w.r.t. this parameter. More... | |
bool | getAnalyticSensitivity (const ParameterBase &entity1, const std::string &name, std::vector< double > &dfdp, std::vector< double > &dqdp, std::vector< double > &dbdp, std::vector< int > &Findices, std::vector< int > &Qindices, std::vector< int > &Bindices) const |
returns analytic sensitivity, evaluated at the most recent solve point. More... | |
Private Member Functions | |
Descriptor (const Descriptor &descriptor) | |
Descriptor & | operator= (const Descriptor &descriptor) |
Private Attributes | |
int | serialNumber_ |
Unique identifier of descriptor. More... | |
bool | originalValueFlag_ |
Flag indicating original value was stored. More... | |
int | vec_ |
If > 0 specifies a vector of params.(eg: if = 3 then IC becomes IC1, IC2, IC3) More... | |
ExprAccess | expressionAccess_ |
Flags for parameter attributes, such as whether can be input by user, may depend on time, etc. More... | |
Entry< void > *const | entry_ |
Pointer to entry which contains the value. More... | |
ParameterUnit | unit_ |
Unit designator for documentation. More... | |
ParameterCategory | category_ |
Category designator for documentation. More... | |
std::string | description_ |
Description of parameter for documentation. More... | |
const ParametricData< void > * | compositeParametricData_ |
If a composite, then this points to the ParameterData of the composite. More... | |
bool ParameterBase::* | given_ |
Pointer to given bool, usually 0. More... | |
bool | sensitivityAvailable_ |
Flag indicating that analytic sensitivity is available for this param. More... | |
const baseSensitivity * | sensPtr_ |
pointer to the sensitivity functor More... | |
Class Descriptor describes the parameters stored in the ParametricData parameter map.
The descriptor contains the Entry for the parameter member variable. Each parameter is assigned a serialNumber_ when it is created and is used by manage the given value map. The parameter may have a given member variable as well. The parameter can be marked to store its original initialized value and the serialNumber_ is used to store this value in the originalValueMap.
If the parameter is vectorized, the index to this parameter is in vec_.
The expressionAccess_ is used to indicate the parameter's usage.
The Descriptor also contains the units, catagory and description for documentation generation. serial number, its original value index if the initiazes value needs to be restored, its usage (ExprAccess), units,
Definition at line 546 of file N_DEV_Pars.h.
|
inline |
Constructs Descriptor.
entry | the parameter member variable pointer, type and default value |
Definition at line 557 of file N_DEV_Pars.h.
|
inlinevirtual |
|
private |
|
inline |
returns analytic sensitivity, evaluated at the most recent solve point.
entity | device class or device instance |
value | true if provided by netlist |
Definition at line 1028 of file N_DEV_Pars.h.
|
inline |
returns a boolean to indicate if analytic sensitivities are available w.r.t. this parameter.
entity | device class or device instance |
value | true if provided by netlist |
Definition at line 1014 of file N_DEV_Pars.h.
|
inline |
Gets the category of the parameter, only used to document the parameter.
Definition at line 712 of file N_DEV_Pars.h.
|
inline |
Return the composite parameter.
A composite parameter is a named aggregation of parameters
Definition at line 774 of file N_DEV_Pars.h.
|
inline |
Gets the description of the parameter, only used to document the parameter.
Definition at line 739 of file N_DEV_Pars.h.
|
inline |
Gets the entry object of the parameter.
Definition at line 814 of file N_DEV_Pars.h.
|
inline |
Gets the entry object of the parameter.
Definition at line 827 of file N_DEV_Pars.h.
|
inline |
Gets the expression access which describes the usage of the paramter.
Definition at line 659 of file N_DEV_Pars.h.
|
inline |
Tests if the parameter has been given by the netlist.
Definition at line 954 of file N_DEV_Pars.h.
|
inline |
Returns the parameter member variable pointer of the enrtry.
Definition at line 905 of file N_DEV_Pars.h.
|
inline |
Gets the serial number used to store and retireve given boolean fromt he GivenValueMap.
Definition at line 854 of file N_DEV_Pars.h.
|
inline |
Gets the units of the parameter, only used to document the parameter.
Definition at line 686 of file N_DEV_Pars.h.
|
inline |
Gets the vector length of a vectorized parameter.
Definition at line 801 of file N_DEV_Pars.h.
|
inline |
Definition at line 605 of file N_DEV_Pars.h.
|
inline |
Tests if parameter has a given data member.
Parameters may provide a boolean member variable that is set true if the netlist provides the value.
Definition at line 923 of file N_DEV_Pars.h.
|
inline |
Returns whether an original value has been stored.
Definition at line 632 of file N_DEV_Pars.h.
|
inline |
Tests entry data type.
Definition at line 597 of file N_DEV_Pars.h.
|
private |
|
inline |
Sets a boolean to indicate if analytic sensitivities are available w.r.t. this parameter.
entity | device class or device instance |
value | true if provided by netlist |
Definition at line 993 of file N_DEV_Pars.h.
|
inline |
Sets the category of the parameter, only used to document the parameter.
category | category of the parameter |
Definition at line 698 of file N_DEV_Pars.h.
|
inline |
Sets the composite parametric.
A composite parameter is a named aggregation of parameters
composite_parametric_data | composite parameter |
Definition at line 754 of file N_DEV_Pars.h.
|
inline |
Sets the description of the parameter, only used to document the parameter.
description | description of the parameter |
Definition at line 725 of file N_DEV_Pars.h.
|
inline |
Sets the expression access which describe the usage of the parameter.
expression_access | usage of the paraemeter |
Definition at line 645 of file N_DEV_Pars.h.
|
inline |
Sets the given state of the parameter to value.
The parameter's boolean member variable that is set true if exists and the netlist provides the value.
entity | device class or device instance |
value | true if provided by netlist |
Definition at line 976 of file N_DEV_Pars.h.
|
inline |
Sets the boolean member variable to set if the netlist provides the value.
Parameters may provide a boolean member variable that is set true if the netlist provides the value.
given | boolean member variable to be set |
Definition at line 940 of file N_DEV_Pars.h.
|
inline |
Sets a boolean marking an original value having been stored.
original_value_flag |
Definition at line 618 of file N_DEV_Pars.h.
|
inline |
Definition at line 999 of file N_DEV_Pars.h.
|
inline |
Sets the serial number used to store and retrieve given boolean from the GivenValueMap.
serial_number | serial number of the parameter in the GivenValueMap |
Definition at line 840 of file N_DEV_Pars.h.
|
inline |
Sets the units of the parameter, only used to document the parameter.
unit | units of the parameter |
Definition at line 672 of file N_DEV_Pars.h.
|
inline |
sets the vector length of an vectorized parameter
index |
Definition at line 787 of file N_DEV_Pars.h.
|
inline |
Returns the value of the parameter for the entity.
entity | device class or device instance |
Definition at line 871 of file N_DEV_Pars.h.
|
inline |
Returns the value of the parameter for the entity.
entity | device class or device instance |
Definition at line 889 of file N_DEV_Pars.h.
|
private |
Category designator for documentation.
Definition at line 1052 of file N_DEV_Pars.h.
|
private |
If a composite, then this points to the ParameterData of the composite.
Definition at line 1054 of file N_DEV_Pars.h.
|
private |
Description of parameter for documentation.
Definition at line 1053 of file N_DEV_Pars.h.
|
private |
Pointer to entry which contains the value.
Definition at line 1050 of file N_DEV_Pars.h.
|
private |
Flags for parameter attributes, such as whether can be input by user, may depend on time, etc.
Definition at line 1049 of file N_DEV_Pars.h.
|
private |
Pointer to given bool, usually 0.
Definition at line 1055 of file N_DEV_Pars.h.
|
private |
Flag indicating original value was stored.
Definition at line 1047 of file N_DEV_Pars.h.
|
private |
Flag indicating that analytic sensitivity is available for this param.
Definition at line 1056 of file N_DEV_Pars.h.
|
private |
pointer to the sensitivity functor
Definition at line 1057 of file N_DEV_Pars.h.
|
private |
Unique identifier of descriptor.
Definition at line 1046 of file N_DEV_Pars.h.
|
private |
Unit designator for documentation.
Definition at line 1051 of file N_DEV_Pars.h.
|
private |
If > 0 specifies a vector of params.(eg: if = 3 then IC becomes IC1, IC2, IC3)
Definition at line 1048 of file N_DEV_Pars.h.