Xyce  6.1
Xyce::Device::Descriptor Class Reference

Class Descriptor describes the parameters stored in the ParametricData parameter map. More...

#include <N_DEV_Pars.h>

Collaboration diagram for Xyce::Device::Descriptor:

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
 
DescriptorsetOriginalValueStored (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...
 
DescriptorsetExpressionAccess (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...
 
DescriptorsetUnit (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...
 
DescriptorsetCategory (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...
 
DescriptorsetDescription (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...
 
DescriptorsetCompositeParametricData (const ParametricData< void > *composite_parametric_data)
 Sets the composite parametric. More...
 
template<class U >
const ParametricData< U > * getCompositeParametricData () const
 Return the composite parameter. More...
 
DescriptorsetVec (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...
 
DescriptorsetSerialNumber (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 >
DescriptorsetGivenMember (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...
 
DescriptorsetAnalyticSensitivityAvailable (bool value)
 Sets a boolean to indicate if analytic sensitivities are available w.r.t. this parameter. More...
 
DescriptorsetSensitivityFunctor (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)
 
Descriptoroperator= (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 baseSensitivitysensPtr_
 pointer to the sensitivity functor More...
 

Detailed Description

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.

Constructor & Destructor Documentation

Xyce::Device::Descriptor::Descriptor ( Entry< void > *const  entry)
inline

Constructs Descriptor.

Parameters
entrythe parameter member variable pointer, type and default value
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Wed Aug 7 11:38:43 2013

Definition at line 557 of file N_DEV_Pars.h.

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

Destroy Descriptor.

Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Wed Aug 7 15:42:55 2013

Definition at line 578 of file N_DEV_Pars.h.

Xyce::Device::Descriptor::Descriptor ( const Descriptor descriptor)
private

Member Function Documentation

bool Xyce::Device::Descriptor::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
inline

returns analytic sensitivity, evaluated at the most recent solve point.

Parameters
entitydevice class or device instance
valuetrue if provided by netlist
Author
Eric R. Keiter, Sandia National Laboratories 1355
Date
Wed Aug 7 11:09:00 2013

Definition at line 1028 of file N_DEV_Pars.h.

bool Xyce::Device::Descriptor::getAnalyticSensitivityAvailable ( ) const
inline

returns a boolean to indicate if analytic sensitivities are available w.r.t. this parameter.

Parameters
entitydevice class or device instance
valuetrue if provided by netlist
Author
Eric R. Keiter, Sandia National Laboratories 1355
Date
Wed Aug 7 11:09:00 2013

Definition at line 1014 of file N_DEV_Pars.h.

ParameterCategory Xyce::Device::Descriptor::getCategory ( ) const
inline

Gets the category of the parameter, only used to document the parameter.

Returns
categort of the parameter
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 14:45:40 2013

Definition at line 712 of file N_DEV_Pars.h.

template<class U >
const ParametricData<U>* Xyce::Device::Descriptor::getCompositeParametricData ( ) const
inline

Return the composite parameter.

A composite parameter is a named aggregation of parameters

Returns
const pointer to the composite parameter
Note
I think the template parameter is really only ever CompositeParam, though sometimes its currently void.
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 14:09:01 2013

Definition at line 774 of file N_DEV_Pars.h.

const std::string& Xyce::Device::Descriptor::getDescription ( ) const
inline

Gets the description of the parameter, only used to document the parameter.

Returns
description of the parameter
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 14:46:46 2013

Definition at line 739 of file N_DEV_Pars.h.

const Entry<void>& Xyce::Device::Descriptor::getEntry ( ) const
inline

Gets the entry object of the parameter.

Returns
const reference to the Entry<void>
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 15:29:16 2013

Definition at line 814 of file N_DEV_Pars.h.

Entry<void>& Xyce::Device::Descriptor::getEntry ( )
inline

Gets the entry object of the parameter.

Returns
reference to the Entry<void>
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 15:29:16 2013

Definition at line 827 of file N_DEV_Pars.h.

ExprAccess Xyce::Device::Descriptor::getExpressionAccess ( ) const
inline

Gets the expression access which describes the usage of the paramter.

Returns
usage of the parameter
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 14:41:26 2013

Definition at line 659 of file N_DEV_Pars.h.

bool Xyce::Device::Descriptor::getGiven ( ParameterBase entity) const
inline

Tests if the parameter has been given by the netlist.

Returns
true if the parameter was given by the netline
Date
Wed Aug 7 11:01:42 2013
Author
David G. Baur Raytheon Sandia National Laboratories 1355

Definition at line 954 of file N_DEV_Pars.h.

template<class T >
T ParameterBase::* Xyce::Device::Descriptor::getMemberPtr ( ) const
inline

Returns the parameter member variable pointer of the enrtry.

Returns
parameter member pointer of type T
Date
Wed Aug 7 10:54:58 2013
Author
David G. Baur Raytheon Sandia National Laboratories 1355

Definition at line 905 of file N_DEV_Pars.h.

int Xyce::Device::Descriptor::getSerialNumber ( ) const
inline

Gets the serial number used to store and retireve given boolean fromt he GivenValueMap.

Returns
parameter serial number
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 14:40:30 2013

Definition at line 854 of file N_DEV_Pars.h.

ParameterUnit Xyce::Device::Descriptor::getUnit ( ) const
inline

Gets the units of the parameter, only used to document the parameter.

Returns
units of the parameter
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 14:44:16 2013

Definition at line 686 of file N_DEV_Pars.h.

int Xyce::Device::Descriptor::getVec ( ) const
inline

Gets the vector length of a vectorized parameter.

Returns
length of the vectorized parameter
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 14:51:10 2013

Definition at line 801 of file N_DEV_Pars.h.

bool Xyce::Device::Descriptor::hasCompositeData ( ) const
inline

Definition at line 605 of file N_DEV_Pars.h.

bool Xyce::Device::Descriptor::hasGivenMember ( ) const
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.

Returns
true if the parameter has a boolean member variable to set if it is provided by the netlist
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Wed Aug 7 11:03:55 2013

Definition at line 923 of file N_DEV_Pars.h.

bool Xyce::Device::Descriptor::hasOriginalValueStored ( ) const
inline

Returns whether an original value has been stored.

Returns
True if original value has been stored. False otherwise.
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 14:19:59 2013

Definition at line 632 of file N_DEV_Pars.h.

template<class T >
bool Xyce::Device::Descriptor::isType ( ) const
inline

Tests entry data type.

Returns
true if entry is of type T
Date
Wed Aug 7 10:31:04 2013
Author
David G. Baur Raytheon Sandia National Laboratories 1355

Definition at line 597 of file N_DEV_Pars.h.

Descriptor& Xyce::Device::Descriptor::operator= ( const Descriptor descriptor)
private
Descriptor& Xyce::Device::Descriptor::setAnalyticSensitivityAvailable ( bool  value)
inline

Sets a boolean to indicate if analytic sensitivities are available w.r.t. this parameter.

Parameters
entitydevice class or device instance
valuetrue if provided by netlist
Author
Eric R. Keiter, Sandia National Laboratories 1355
Date
Wed Aug 7 11:09:00 2013

Definition at line 993 of file N_DEV_Pars.h.

Descriptor& Xyce::Device::Descriptor::setCategory ( ParameterCategory  category)
inline

Sets the category of the parameter, only used to document the parameter.

Parameters
categorycategory of the parameter
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 14:45:09 2013

Definition at line 698 of file N_DEV_Pars.h.

Descriptor& Xyce::Device::Descriptor::setCompositeParametricData ( const ParametricData< void > *  composite_parametric_data)
inline

Sets the composite parametric.

A composite parameter is a named aggregation of parameters

Parameters
composite_parametric_datacomposite parameter
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 14:47:19 2013

Definition at line 754 of file N_DEV_Pars.h.

Descriptor& Xyce::Device::Descriptor::setDescription ( const std::string &  description)
inline

Sets the description of the parameter, only used to document the parameter.

Parameters
descriptiondescription of the parameter
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 14:46:21 2013

Definition at line 725 of file N_DEV_Pars.h.

Descriptor& Xyce::Device::Descriptor::setExpressionAccess ( ExprAccess  expression_access)
inline

Sets the expression access which describe the usage of the parameter.

Parameters
expression_accessusage of the paraemeter
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 14:41:56 2013

Definition at line 645 of file N_DEV_Pars.h.

void Xyce::Device::Descriptor::setGiven ( ParameterBase entity,
bool  value 
) const
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.

Parameters
entitydevice class or device instance
valuetrue if provided by netlist
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Wed Aug 7 11:09:00 2013

Definition at line 976 of file N_DEV_Pars.h.

template<class U >
Descriptor& Xyce::Device::Descriptor::setGivenMember ( bool U::*  given)
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.

Parameters
givenboolean member variable to be set
Date
Wed Aug 7 11:02:38 2013
Author
David G. Baur Raytheon Sandia National Laboratories 1355

Definition at line 940 of file N_DEV_Pars.h.

Descriptor& Xyce::Device::Descriptor::setOriginalValueStored ( bool  original_value_flag)
inline

Sets a boolean marking an original value having been stored.

Parameters
original_value_flag
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 14:37:03 2013

Definition at line 618 of file N_DEV_Pars.h.

Descriptor& Xyce::Device::Descriptor::setSensitivityFunctor ( const baseSensitivity sensPtr)
inline

Definition at line 999 of file N_DEV_Pars.h.

Descriptor& Xyce::Device::Descriptor::setSerialNumber ( int  serial_number)
inline

Sets the serial number used to store and retrieve given boolean from the GivenValueMap.

Parameters
serial_numberserial number of the parameter in the GivenValueMap
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 14:38:18 2013

Definition at line 840 of file N_DEV_Pars.h.

Descriptor& Xyce::Device::Descriptor::setUnit ( ParameterUnit  unit)
inline

Sets the units of the parameter, only used to document the parameter.

Parameters
unitunits of the parameter
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 14:43:32 2013

Definition at line 672 of file N_DEV_Pars.h.

Descriptor& Xyce::Device::Descriptor::setVec ( int  index)
inline

sets the vector length of an vectorized parameter

Parameters
index
Author
David G. Baur Raytheon Sandia National Laboratories 1355
Date
Fri Aug 9 14:50:05 2013

Definition at line 787 of file N_DEV_Pars.h.

template<class T >
const T& Xyce::Device::Descriptor::value ( const ParameterBase entity) const
inline

Returns the value of the parameter for the entity.

Parameters
entitydevice class or device instance
Returns
reference to the value of the parameter for the entity
Date
Wed Aug 7 10:36:10 2013
Author
David G. Baur Raytheon Sandia National Laboratories 1355

Definition at line 871 of file N_DEV_Pars.h.

template<class T >
T& Xyce::Device::Descriptor::value ( ParameterBase entity) const
inline

Returns the value of the parameter for the entity.

Parameters
entitydevice class or device instance
Returns
reference to the value of the parameter for the entity
Date
Wed Aug 7 10:36:10 2013
Author
David G. Baur Raytheon Sandia National Laboratories 1355

Definition at line 889 of file N_DEV_Pars.h.

Member Data Documentation

ParameterCategory Xyce::Device::Descriptor::category_
private

Category designator for documentation.

Definition at line 1052 of file N_DEV_Pars.h.

const ParametricData<void>* Xyce::Device::Descriptor::compositeParametricData_
private

If a composite, then this points to the ParameterData of the composite.

Definition at line 1054 of file N_DEV_Pars.h.

std::string Xyce::Device::Descriptor::description_
private

Description of parameter for documentation.

Definition at line 1053 of file N_DEV_Pars.h.

Entry<void>* const Xyce::Device::Descriptor::entry_
private

Pointer to entry which contains the value.

Definition at line 1050 of file N_DEV_Pars.h.

ExprAccess Xyce::Device::Descriptor::expressionAccess_
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.

bool ParameterBase::* Xyce::Device::Descriptor::given_
private

Pointer to given bool, usually 0.

Definition at line 1055 of file N_DEV_Pars.h.

bool Xyce::Device::Descriptor::originalValueFlag_
private

Flag indicating original value was stored.

Definition at line 1047 of file N_DEV_Pars.h.

bool Xyce::Device::Descriptor::sensitivityAvailable_
private

Flag indicating that analytic sensitivity is available for this param.

Definition at line 1056 of file N_DEV_Pars.h.

const baseSensitivity* Xyce::Device::Descriptor::sensPtr_
private

pointer to the sensitivity functor

Definition at line 1057 of file N_DEV_Pars.h.

int Xyce::Device::Descriptor::serialNumber_
private

Unique identifier of descriptor.

Definition at line 1046 of file N_DEV_Pars.h.

ParameterUnit Xyce::Device::Descriptor::unit_
private

Unit designator for documentation.

Definition at line 1051 of file N_DEV_Pars.h.

int Xyce::Device::Descriptor::vec_
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.


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