Xyce  6.1
Xyce::Device::MemristorTEAM::Instance Class Reference

#include <N_DEV_MemristorTEAM.h>

Inheritance diagram for Xyce::Device::MemristorTEAM::Instance:
Collaboration diagram for Xyce::Device::MemristorTEAM::Instance:

Public Member Functions

 Instance (const Configuration &configuration, const InstanceBlock &instance_block, Model &model, const FactoryBlock &factory_block)
 
 ~Instance ()
 
ModelgetModel ()
 
virtual void registerLIDs (const std::vector< int > &intLIDVecRef, const std::vector< int > &extLIDVecRef)
 
virtual void registerStateLIDs (const std::vector< int > &staLIDVecRef)
 
virtual void registerStoreLIDs (const std::vector< int > &stoLIDVecRef)
 
virtual void registerBranchDataLIDs (const std::vector< int > &branchLIDVecRef)
 
virtual void registerJacLIDs (const std::vector< std::vector< int > > &jacLIDVec)
 
void loadNodeSymbols (Util::SymbolTable &symbol_table) const
 Populates and returns the store name map. More...
 
virtual bool processParams ()
 
virtual bool updateTemperature (const double &temp_tmp)
 
virtual bool updateIntermediateVars ()
 
virtual bool updatePrimaryState ()
 
virtual const std::vector< std::vector< int > > & jacobianStamp () const
 
virtual bool loadDAEQVector ()
 
virtual bool loadDAEFVector ()
 
virtual bool loadDAEdQdx ()
 
virtual bool loadDAEdFdx ()
 
virtual void setupPointers ()
 
- Public Member Functions inherited from Xyce::Device::DeviceInstance
 DeviceInstance (const InstanceBlock &instance_block, ParametricData< void > &parametric_data, const FactoryBlock &factory_block)
 
virtual ~DeviceInstance ()
 
virtual bool isLinearDevice () const
 
virtual std::ostream & printName (std::ostream &os) const
 
virtual void enableLeadCurrentCalc ()
 
virtual void registerGIDs (const IndexPairVector &intGIDListRef, const IndexPairVector &extGIDListRef)
 
virtual void registerStateGIDs (const IndexPairVector &staGIDListRef)
 
virtual void registerStoreGIDs (const IndexPairVector &stoGIDListRef)
 
virtual const std::vector< std::string > & getDepSolnVars ()
 
virtual void registerDepSolnGIDs (const std::vector< IdVector > &varList)
 
virtual const std::vector< std::string > & getDepStateVars ()
 
virtual void registerDepStateGIDs (const std::vector< IdVector > &varList)
 
virtual const std::vector< std::string > & getDepStoreVars ()
 
virtual void registerDepStoreGIDs (const std::vector< IdVector > &varList)
 
virtual const std::vector< std::string > & getDepLeadCurrentVars ()
 
virtual void registerDepLeadCurrentGIDs (const std::vector< IdVector > &varList)
 
virtual void registerDepSolnLIDs (const std::vector< IdVector > &depSolnLIDVecRef)
 
virtual void registerDepStateLIDs (const std::vector< IdVector > &depStaLIDVecRef)
 
virtual void registerDepStoreLIDs (const std::vector< IdVector > &depStoLIDVecRef)
 
virtual void registerGIDData (const std::vector< int > &counts, const IdVector &GIDs, const JacobianStamp &jacGIDs)
 
virtual const IdVectorgetDepSolnGIDVec ()
 
virtual const IndexPairVector & getIndexPairList ()
 
virtual bool getInstanceBreakPoints (std::vector< Util::BreakPoint > &breakPointTimes)
 
virtual bool updateSource ()
 
virtual bool processInstanceParams ()
 
virtual bool isConverged ()
 
virtual bool testDAEMatrices (const std::vector< const std::string * > &nameVec)
 
virtual bool loadTrivialDAE_FMatrixStamp ()
 
bool trivialStampLoader (Linear::Matrix *matPtr)
 
bool zeroMatrixDiagonal (Linear::Matrix *matPtr)
 
virtual bool updateSecondaryState ()
 
virtual bool setIC ()
 
virtual bool plotfileFlag ()
 
virtual void loadErrorWeightMask ()
 
virtual void acceptStep ()
 
virtual bool loadDAEBVector ()
 
virtual int getNumNoiseSources () const
 
virtual void setupNoiseSources (Xyce::Analysis::NoiseData &noiseDataVec)
 
virtual void getNoiseSources (Xyce::Analysis::NoiseData &noiseDataVec)
 
const InstanceNamegetName () const
 
int getNumIntVars () const
 
int getNumExtVars () const
 
int getNumStateVars () const
 
int getNumStoreVars () const
 
int getNumBranchDataVars () const
 
void setNumStoreVars (int num_store_vars)
 
void setNumBranchDataVars (int num_branch_data_vars)
 
virtual const std::vector< int > & getDevConMap ()
 
virtual DeviceStategetInternalState ()
 
virtual bool setInternalState (const DeviceState &state)
 
virtual bool loadDFDV (int iElectrode, Linear::Vector *dfdvPtr)
 
virtual bool calcConductance (int iElectrode, const Linear::Vector *dxdvPtr)
 
virtual bool outputPlotFiles (bool force_final_output)
 
virtual bool enablePDEContinuation (int &max_PDE_continuation_steps)
 
virtual bool disablePDEContinuation ()
 
virtual void setPDEContinuationAlpha (double alpha)
 
virtual void setPDEContinuationBeta (double beta)
 
virtual bool setInitialGuess ()
 
virtual double getMaxTimeStepSize ()
 
virtual void varTypes (std::vector< char > &varTypeVec)
 
bool getOrigFlag () const
 
void setOrigFlag (bool origFlag_local)
 
const IdVectorgetDevLIDs () const
 
const std::vector< IdVector > & getDevJacLIDs () const
 
const IdVectorgetStaLIDVec () const
 
bool getMergeRowColChecked () const
 
void setMergeRowColChecked (bool mergeRowColChecked_local)
 
const MatrixLoadDatagetMatrixLoadData () const
 
MatrixLoadDatagetMatrixLoadData ()
 
const ExternDatagetExternData () const
 
- Public Member Functions inherited from Xyce::Device::DeviceEntity
 DeviceEntity (ParametricData< void > &parametric_data, const SolverState &solver_state, const DeviceOptions &device_options, const std::string &netlist_filename, int netlist_line)
 
virtual ~DeviceEntity ()
 
virtual CompositeParamconstructComposite (const std::string &composite_name, const std::string &param_name)
 
bool setDefaultParam (double val, bool overrideOriginal=false)
 
double getDefaultParam () const
 
bool scaleParam (const std::string &paramName, double val, double val0)
 
bool scaleParam (const std::string &paramName, double val)
 
bool scaleDefaultParam (double val)
 
bool analyticSensitivityAvailable (const std::string &paramName)
 
bool analyticSensitivityAvailableDefaultParam ()
 
bool getAnalyticSensitivity (const std::string &paramName, std::vector< double > &dfdpVec, std::vector< double > &dqdpVec, std::vector< double > &dbdpVec, std::vector< int > &FindicesVec, std::vector< int > &QindicesVec, std::vector< int > &BindicesVec)
 
bool getAnalyticSensitivityDefaultParam (std::vector< double > &dfdpVec, std::vector< double > &dqdpVec, std::vector< double > &dbdpVec, std::vector< int > &FindicesVec, std::vector< int > &QindicesVec, std::vector< int > &BindicesVec)
 
bool setParam (const std::string &paramName, double val, bool overrideOriginal=false)
 
bool getParam (const std::string &paramName, double &result) const
 
bool findParam (const std::string &param_name) const
 
bool getParamBreakpoints (std::vector< Util::BreakPoint > &)
 
bool updateDependentParameters (const Linear::Vector &vars)
 
bool updateDependentParameters (double temp_tmp)
 
bool updateGlobalParameters (GlobalParameterMap &)
 
bool updateDependentParameters ()
 
double setDependentParameter (Util::Param &, double *, ParameterType::ExprAccess)
 
double setDependentParameter (Util::Param &, std::vector< double > *, int, ParameterType::ExprAccess)
 
void setDependentParameter (Util::Param &par, Depend &dependentParam, ParameterType::ExprAccess depend)
 
void setDefaultParams ()
 
void setParams (const std::vector< Param > &params)
 
bool given (const std::string &parameter_name) const
 
void setDefaultParamName (const std::string &default_param_name)
 
const std::vector< Depend > & getDependentParams ()
 
void addDependentParameter (const Depend &param)
 
const DeviceOptionsgetDeviceOptions () const
 
const SolverStategetSolverState () const
 
const NetlistLocation & netlistLocation () const
 
const ParameterMapgetParameterMap () const
 
- 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

 Instance (const Instance &)
 
Instanceoperator= (const Instance &)
 

Static Private Member Functions

static void initializeJacobianStamp ()
 

Private Attributes

Modelmodel_
 
int IVrelation
 
double G
 
double Reff
 
double dReffdvpos
 
double dReffdvneg
 
double dReffdx
 
double i0
 
double xVarFContribution
 
double dxFEqdVpos
 
double dxFEqdVneg
 
double dxFEqdx
 
int resNoiseLastUpdateStep
 
double resNoiseLastUpdateTime
 
double resNoiseNextUpdateTime
 
int resNoiseHiLoState
 
double resNoiseRfactor
 
int li_Pos
 
int li_Neg
 
int li_x
 
int li_store_R
 
int li_store_dev_i
 
int li_store_tdt
 
int li_branch_data
 
int APosEquPosNodeOffset
 
int APosEquNegNodeOffset
 
int APosEquXNodeOffset
 
int ANegEquPosNodeOffset
 
int ANegEquNegNodeOffset
 
int ANegEquXNodeOffset
 
int XEquVPosOffset
 
int XEquVNegOffset
 
int XEquXOffset
 
double * f_PosEquPosNodePtr
 
double * f_PosEquNegNodePtr
 
double * f_PosEquXNodePtr
 
double * f_NegEquPosNodePtr
 
double * f_NegEquNegNodePtr
 
double * f_NegEquXNodePtr
 
double * f_XEquPosNodePtr
 
double * f_XEquNegNodePtr
 
double * f_XEquXNodePtr
 
double * q_XEquXNodePtr
 

Static Private Attributes

static std::vector< std::vector< int > > jacStamp
 

Friends

class ParametricData< Instance >
 
class Model
 
class Traits
 
class Master
 
class memristorTEAMSensitivity
 

Additional Inherited Members

- Public Attributes inherited from Xyce::Device::DeviceInstance
std::vector< int > & cols
 
std::vector< double > & vals
 
NumericalJacobiannumJacPtr
 
bool psLoaded
 
bool ssLoaded
 
bool rhsLoaded
 
bool origFlag
 
int numIntVars
 
int numExtVars
 
int numStateVars
 
int numStoreVars
 
int numLeadCurrentVars
 
int numLeadCurrentStoreVars
 
bool loadLeadCurrent
 
int numBranchDataVars
 
int numBranchDataVarsIfAllocated
 
std::vector< int > devConMap
 
bool mergeRowColChecked
 
- Protected Member Functions inherited from Xyce::Device::DeviceInstance
void jacStampMap (const JacobianStamp &stamp_parent, IdVector &map_parent, JacobianStamp &map2_parent, JacobianStamp &stamp, IdVector &map, JacobianStamp &map2, int from, int to, int original_size)
 
void jacStampMap_fixOrder (const JacobianStamp &stamp_parent, JacobianStamp &map2_parent, JacobianStamp &stamp, JacobianStamp &map2)
 
void outputJacStamp (const JacobianStamp &jac)
 
void outputJacMaps (const std::vector< int > &jacMap, const JacobianStamp &jacMap2)
 
- Protected Attributes inherited from Xyce::Device::DeviceInstance
const ExternDataextData
 
IndexPairVector indexPairList
 
IndexPairVector intGIDList
 
IndexPairVector extGIDList
 
IndexPairVector staGIDList
 
IdVector intLIDVec
 
IdVector extLIDVec
 
IdVector staLIDVec
 
IdVector stoLIDVec
 
IdVector devLIDs
 devLIDs is a combined LID vector, containing int, ext, and expVar ID's. More...
 
JacobianStamp devJacLIDs
 
DeviceSupport devSupport
 
- Protected Attributes inherited from Xyce::Device::DeviceEntity
std::vector< int > expVarGIDs
 
std::vector< int > expVarLIDs
 
std::vector< std::string > expVarNames
 
std::vector< double > expVarVals
 
std::vector< double > eVarVals
 

Detailed Description

Definition at line 130 of file N_DEV_MemristorTEAM.h.

Constructor & Destructor Documentation

Xyce::Device::MemristorTEAM::Instance::Instance ( const Configuration configuration,
const InstanceBlock instance_block,
Model model,
const FactoryBlock factory_block 
)

Definition at line 405 of file N_DEV_MemristorTEAM.C.

Xyce::Device::MemristorTEAM::Instance::~Instance ( )
inline

Definition at line 158 of file N_DEV_MemristorTEAM.h.

Xyce::Device::MemristorTEAM::Instance::Instance ( const Instance )
private

Member Function Documentation

Model& Xyce::Device::MemristorTEAM::Instance::getModel ( )
inline

Definition at line 181 of file N_DEV_MemristorTEAM.h.

void Xyce::Device::MemristorTEAM::Instance::initializeJacobianStamp ( )
staticprivate

Definition at line 219 of file N_DEV_MemristorTEAM.C.

virtual const std::vector< std::vector<int> >& Xyce::Device::MemristorTEAM::Instance::jacobianStamp ( ) const
inlinevirtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 218 of file N_DEV_MemristorTEAM.h.

bool Xyce::Device::MemristorTEAM::Instance::loadDAEdFdx ( )
virtual

Implements Xyce::Device::DeviceInstance.

Definition at line 1094 of file N_DEV_MemristorTEAM.C.

bool Xyce::Device::MemristorTEAM::Instance::loadDAEdQdx ( )
virtual

Implements Xyce::Device::DeviceInstance.

Definition at line 1050 of file N_DEV_MemristorTEAM.C.

bool Xyce::Device::MemristorTEAM::Instance::loadDAEFVector ( )
virtual

Implements Xyce::Device::DeviceInstance.

Definition at line 1030 of file N_DEV_MemristorTEAM.C.

bool Xyce::Device::MemristorTEAM::Instance::loadDAEQVector ( )
virtual

Implements Xyce::Device::DeviceInstance.

Definition at line 976 of file N_DEV_MemristorTEAM.C.

void Xyce::Device::MemristorTEAM::Instance::loadNodeSymbols ( Util::SymbolTable &  symbol_table) const
virtual

Populates and returns the store name map.

Implements Xyce::Device::DeviceInstance.

Definition at line 657 of file N_DEV_MemristorTEAM.C.

Instance& Xyce::Device::MemristorTEAM::Instance::operator= ( const Instance )
private
bool Xyce::Device::MemristorTEAM::Instance::processParams ( )
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 509 of file N_DEV_MemristorTEAM.C.

void Xyce::Device::MemristorTEAM::Instance::registerBranchDataLIDs ( const std::vector< int > &  branchLIDVecRef)
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 637 of file N_DEV_MemristorTEAM.C.

void Xyce::Device::MemristorTEAM::Instance::registerJacLIDs ( const std::vector< std::vector< int > > &  jacLIDVec)
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 703 of file N_DEV_MemristorTEAM.C.

void Xyce::Device::MemristorTEAM::Instance::registerLIDs ( const std::vector< int > &  intLIDVecRef,
const std::vector< int > &  extLIDVecRef 
)
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 532 of file N_DEV_MemristorTEAM.C.

void Xyce::Device::MemristorTEAM::Instance::registerStateLIDs ( const std::vector< int > &  staLIDVecRef)
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 576 of file N_DEV_MemristorTEAM.C.

void Xyce::Device::MemristorTEAM::Instance::registerStoreLIDs ( const std::vector< int > &  stoLIDVecRef)
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 599 of file N_DEV_MemristorTEAM.C.

void Xyce::Device::MemristorTEAM::Instance::setupPointers ( )
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 754 of file N_DEV_MemristorTEAM.C.

bool Xyce::Device::MemristorTEAM::Instance::updateIntermediateVars ( )
virtual

Implements Xyce::Device::DeviceInstance.

Definition at line 800 of file N_DEV_MemristorTEAM.C.

bool Xyce::Device::MemristorTEAM::Instance::updatePrimaryState ( )
virtual

Implements Xyce::Device::DeviceInstance.

Definition at line 971 of file N_DEV_MemristorTEAM.C.

bool Xyce::Device::MemristorTEAM::Instance::updateTemperature ( const double &  temp_tmp)
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 1135 of file N_DEV_MemristorTEAM.C.

Friends And Related Function Documentation

friend class Master
friend

Definition at line 135 of file N_DEV_MemristorTEAM.h.

friend class memristorTEAMSensitivity
friend

Definition at line 136 of file N_DEV_MemristorTEAM.h.

friend class Model
friend

Definition at line 133 of file N_DEV_MemristorTEAM.h.

friend class ParametricData< Instance >
friend

Definition at line 132 of file N_DEV_MemristorTEAM.h.

friend class Traits
friend

Definition at line 134 of file N_DEV_MemristorTEAM.h.

Member Data Documentation

int Xyce::Device::MemristorTEAM::Instance::ANegEquNegNodeOffset
private

Definition at line 269 of file N_DEV_MemristorTEAM.h.

int Xyce::Device::MemristorTEAM::Instance::ANegEquPosNodeOffset
private

Definition at line 268 of file N_DEV_MemristorTEAM.h.

int Xyce::Device::MemristorTEAM::Instance::ANegEquXNodeOffset
private

Definition at line 270 of file N_DEV_MemristorTEAM.h.

int Xyce::Device::MemristorTEAM::Instance::APosEquNegNodeOffset
private

Definition at line 266 of file N_DEV_MemristorTEAM.h.

int Xyce::Device::MemristorTEAM::Instance::APosEquPosNodeOffset
private

Definition at line 265 of file N_DEV_MemristorTEAM.h.

int Xyce::Device::MemristorTEAM::Instance::APosEquXNodeOffset
private

Definition at line 267 of file N_DEV_MemristorTEAM.h.

double Xyce::Device::MemristorTEAM::Instance::dReffdvneg
private

Definition at line 243 of file N_DEV_MemristorTEAM.h.

double Xyce::Device::MemristorTEAM::Instance::dReffdvpos
private

Definition at line 242 of file N_DEV_MemristorTEAM.h.

double Xyce::Device::MemristorTEAM::Instance::dReffdx
private

Definition at line 244 of file N_DEV_MemristorTEAM.h.

double Xyce::Device::MemristorTEAM::Instance::dxFEqdVneg
private

Definition at line 248 of file N_DEV_MemristorTEAM.h.

double Xyce::Device::MemristorTEAM::Instance::dxFEqdVpos
private

Definition at line 247 of file N_DEV_MemristorTEAM.h.

double Xyce::Device::MemristorTEAM::Instance::dxFEqdx
private

Definition at line 249 of file N_DEV_MemristorTEAM.h.

double* Xyce::Device::MemristorTEAM::Instance::f_NegEquNegNodePtr
private

Definition at line 281 of file N_DEV_MemristorTEAM.h.

double* Xyce::Device::MemristorTEAM::Instance::f_NegEquPosNodePtr
private

Definition at line 280 of file N_DEV_MemristorTEAM.h.

double* Xyce::Device::MemristorTEAM::Instance::f_NegEquXNodePtr
private

Definition at line 282 of file N_DEV_MemristorTEAM.h.

double* Xyce::Device::MemristorTEAM::Instance::f_PosEquNegNodePtr
private

Definition at line 278 of file N_DEV_MemristorTEAM.h.

double* Xyce::Device::MemristorTEAM::Instance::f_PosEquPosNodePtr
private

Definition at line 277 of file N_DEV_MemristorTEAM.h.

double* Xyce::Device::MemristorTEAM::Instance::f_PosEquXNodePtr
private

Definition at line 279 of file N_DEV_MemristorTEAM.h.

double* Xyce::Device::MemristorTEAM::Instance::f_XEquNegNodePtr
private

Definition at line 284 of file N_DEV_MemristorTEAM.h.

double* Xyce::Device::MemristorTEAM::Instance::f_XEquPosNodePtr
private

Definition at line 283 of file N_DEV_MemristorTEAM.h.

double* Xyce::Device::MemristorTEAM::Instance::f_XEquXNodePtr
private

Definition at line 285 of file N_DEV_MemristorTEAM.h.

double Xyce::Device::MemristorTEAM::Instance::G
private

Definition at line 240 of file N_DEV_MemristorTEAM.h.

double Xyce::Device::MemristorTEAM::Instance::i0
private

Definition at line 245 of file N_DEV_MemristorTEAM.h.

int Xyce::Device::MemristorTEAM::Instance::IVrelation
private

Definition at line 237 of file N_DEV_MemristorTEAM.h.

std::vector< std::vector< int > > Xyce::Device::MemristorTEAM::Instance::jacStamp
staticprivate

Definition at line 231 of file N_DEV_MemristorTEAM.h.

int Xyce::Device::MemristorTEAM::Instance::li_branch_data
private

Definition at line 262 of file N_DEV_MemristorTEAM.h.

int Xyce::Device::MemristorTEAM::Instance::li_Neg
private

Definition at line 257 of file N_DEV_MemristorTEAM.h.

int Xyce::Device::MemristorTEAM::Instance::li_Pos
private

Definition at line 256 of file N_DEV_MemristorTEAM.h.

int Xyce::Device::MemristorTEAM::Instance::li_store_dev_i
private

Definition at line 260 of file N_DEV_MemristorTEAM.h.

int Xyce::Device::MemristorTEAM::Instance::li_store_R
private

Definition at line 259 of file N_DEV_MemristorTEAM.h.

int Xyce::Device::MemristorTEAM::Instance::li_store_tdt
private

Definition at line 261 of file N_DEV_MemristorTEAM.h.

int Xyce::Device::MemristorTEAM::Instance::li_x
private

Definition at line 258 of file N_DEV_MemristorTEAM.h.

Model& Xyce::Device::MemristorTEAM::Instance::model_
private

Definition at line 234 of file N_DEV_MemristorTEAM.h.

double* Xyce::Device::MemristorTEAM::Instance::q_XEquXNodePtr
private

Definition at line 286 of file N_DEV_MemristorTEAM.h.

double Xyce::Device::MemristorTEAM::Instance::Reff
private

Definition at line 241 of file N_DEV_MemristorTEAM.h.

int Xyce::Device::MemristorTEAM::Instance::resNoiseHiLoState
private

Definition at line 253 of file N_DEV_MemristorTEAM.h.

int Xyce::Device::MemristorTEAM::Instance::resNoiseLastUpdateStep
private

Definition at line 250 of file N_DEV_MemristorTEAM.h.

double Xyce::Device::MemristorTEAM::Instance::resNoiseLastUpdateTime
private

Definition at line 251 of file N_DEV_MemristorTEAM.h.

double Xyce::Device::MemristorTEAM::Instance::resNoiseNextUpdateTime
private

Definition at line 252 of file N_DEV_MemristorTEAM.h.

double Xyce::Device::MemristorTEAM::Instance::resNoiseRfactor
private

Definition at line 254 of file N_DEV_MemristorTEAM.h.

int Xyce::Device::MemristorTEAM::Instance::XEquVNegOffset
private

Definition at line 272 of file N_DEV_MemristorTEAM.h.

int Xyce::Device::MemristorTEAM::Instance::XEquVPosOffset
private

Definition at line 271 of file N_DEV_MemristorTEAM.h.

int Xyce::Device::MemristorTEAM::Instance::XEquXOffset
private

Definition at line 273 of file N_DEV_MemristorTEAM.h.

double Xyce::Device::MemristorTEAM::Instance::xVarFContribution
private

Definition at line 246 of file N_DEV_MemristorTEAM.h.


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