Mantid
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
MantidQt::MantidWidgets::IFunctionModel Class Referenceabstract

#include <IFunctionModel.h>

Inheritance diagram for MantidQt::MantidWidgets::IFunctionModel:
MantidQt::MantidWidgets::FunctionModel MantidQt::MantidWidgets::ConvolutionFunctionModel

Public Member Functions

virtual void addConstraint (const QString &functionIndex, const QString &constraint)=0
 
virtual void addFunction (const QString &prefix, const QString &funStr)=0
 
virtual void changeTie (const QString &paramName, const QString &tie)=0
 
void clear ()
 
virtual int currentDomainIndex () const =0
 
virtual IFunction_sptr getCurrentFunction () const =0
 
virtual QStringList getDatasetDomainNames () const =0
 
virtual QStringList getDatasetNames () const =0
 
virtual IFunction_sptr getFitFunction () const =0
 
QString getFitFunctionString () const
 
QString getFunctionString () const
 
virtual QStringList getGlobalParameters () const =0
 
virtual QString getLocalParameterConstraint (const QString &parName, int i) const =0
 
virtual QStringList getLocalParameters () const =0
 
virtual QString getLocalParameterTie (const QString &parName, int i) const =0
 
virtual double getLocalParameterValue (const QString &parName, int i) const =0
 
virtual int getNumberDomains () const =0
 
int getNumberLocalFunctions () const
 
virtual double getParameter (const QString &paramName) const =0
 
virtual QString getParameterDescription (const QString &paramName) const =0
 
virtual double getParameterError (const QString &paramName) const =0
 
virtual QStringList getParameterNames () const =0
 
virtual IFunction_sptr getSingleFunction (int index) const =0
 
virtual bool hasFunction () const =0
 
virtual bool isGlobal (const QString &parName) const =0
 
virtual bool isLocalParameterFixed (const QString &parName, int i) const =0
 
virtual void removeConstraint (const QString &paramName)=0
 
virtual void removeFunction (const QString &functionIndex)=0
 
virtual QString setBackgroundA0 (double value)=0
 
virtual void setCurrentDomainIndex (int)=0
 
virtual void setDatasets (const QList< FunctionModelDataset > &datasets)=0
 
virtual void setFunction (IFunction_sptr fun)=0
 
void setFunctionString (const QString &funStr)
 
virtual void setGlobalParameters (const QStringList &globals)=0
 
virtual void setGlobalParameterValue (const QString &paramName, double value)=0
 
virtual void setLocalParameterConstraint (const QString &parName, int i, const QString &constraint)=0
 
virtual void setLocalParameterFixed (const QString &parName, int i, bool fixed)=0
 
virtual void setLocalParameterTie (const QString &parName, int i, const QString &tie)=0
 
virtual void setLocalParameterValue (const QString &parName, int i, double value)=0
 
virtual void setLocalParameterValue (const QString &parName, int i, double value, double error)=0
 
virtual void setNumberDomains (int)=0
 
virtual void setParameter (const QString &paramName, double value)=0
 
virtual void setParameterError (const QString &paramName, double value)=0
 
virtual void updateMultiDatasetParameters (const IFunction &fun)=0
 
virtual void updateParameters (const IFunction &fun)=0
 
virtual ~IFunctionModel ()=default
 

Protected Member Functions

void copyParametersAndErrorsToAllLocalFunctions (const IFunction &fun)
 

Static Protected Member Functions

static void copyParametersAndErrors (const IFunction &funFrom, IFunction &funTo)
 

Detailed Description

Definition at line 24 of file IFunctionModel.h.

Constructor & Destructor Documentation

◆ ~IFunctionModel()

virtual MantidQt::MantidWidgets::IFunctionModel::~IFunctionModel ( )
virtualdefault

Member Function Documentation

◆ addConstraint()

virtual void MantidQt::MantidWidgets::IFunctionModel::addConstraint ( const QString &  functionIndex,
const QString &  constraint 
)
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ addFunction()

virtual void MantidQt::MantidWidgets::IFunctionModel::addFunction ( const QString &  prefix,
const QString &  funStr 
)
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ changeTie()

virtual void MantidQt::MantidWidgets::IFunctionModel::changeTie ( const QString &  paramName,
const QString &  tie 
)
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ clear()

void MantidQt::MantidWidgets::IFunctionModel::clear ( )

Definition at line 37 of file IFunctionModel.cpp.

References setFunction().

Referenced by MantidQt::MantidWidgets::FunctionModel::removeFunction(), and setFunctionString().

◆ copyParametersAndErrors()

void MantidQt::MantidWidgets::IFunctionModel::copyParametersAndErrors ( const IFunction &  funFrom,
IFunction &  funTo 
)
staticprotected

Definition at line 44 of file IFunctionModel.cpp.

References Mantid::API::IFunction::getError(), Mantid::API::IFunction::getParameter(), Mantid::API::IFunction::nParams(), Mantid::API::IFunction::setError(), and Mantid::API::IFunction::setParameter().

Referenced by copyParametersAndErrorsToAllLocalFunctions(), MantidQt::MantidWidgets::FunctionModel::updateMultiDatasetParameters(), and MantidQt::MantidWidgets::FunctionModel::updateParameters().

◆ copyParametersAndErrorsToAllLocalFunctions()

void MantidQt::MantidWidgets::IFunctionModel::copyParametersAndErrorsToAllLocalFunctions ( const IFunction &  fun)
protected

Definition at line 53 of file IFunctionModel.cpp.

References copyParametersAndErrors(), getNumberLocalFunctions(), and getSingleFunction().

◆ currentDomainIndex()

virtual int MantidQt::MantidWidgets::IFunctionModel::currentDomainIndex ( ) const
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ getCurrentFunction()

virtual IFunction_sptr MantidQt::MantidWidgets::IFunctionModel::getCurrentFunction ( ) const
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

Referenced by getFunctionString().

◆ getDatasetDomainNames()

virtual QStringList MantidQt::MantidWidgets::IFunctionModel::getDatasetDomainNames ( ) const
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ getDatasetNames()

virtual QStringList MantidQt::MantidWidgets::IFunctionModel::getDatasetNames ( ) const
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ getFitFunction()

virtual IFunction_sptr MantidQt::MantidWidgets::IFunctionModel::getFitFunction ( ) const
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

Referenced by getFitFunctionString().

◆ getFitFunctionString()

QString MantidQt::MantidWidgets::IFunctionModel::getFitFunctionString ( ) const

Definition at line 30 of file IFunctionModel.cpp.

References getFitFunction().

◆ getFunctionString()

QString MantidQt::MantidWidgets::IFunctionModel::getFunctionString ( ) const

Definition at line 23 of file IFunctionModel.cpp.

References getCurrentFunction().

Referenced by MantidQt::MantidWidgets::FunctionModel::addFunction().

◆ getGlobalParameters()

virtual QStringList MantidQt::MantidWidgets::IFunctionModel::getGlobalParameters ( ) const
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ getLocalParameterConstraint()

virtual QString MantidQt::MantidWidgets::IFunctionModel::getLocalParameterConstraint ( const QString &  parName,
int  i 
) const
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ getLocalParameters()

virtual QStringList MantidQt::MantidWidgets::IFunctionModel::getLocalParameters ( ) const
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ getLocalParameterTie()

virtual QString MantidQt::MantidWidgets::IFunctionModel::getLocalParameterTie ( const QString &  parName,
int  i 
) const
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ getLocalParameterValue()

virtual double MantidQt::MantidWidgets::IFunctionModel::getLocalParameterValue ( const QString &  parName,
int  i 
) const
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ getNumberDomains()

virtual int MantidQt::MantidWidgets::IFunctionModel::getNumberDomains ( ) const
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

Referenced by getNumberLocalFunctions().

◆ getNumberLocalFunctions()

int MantidQt::MantidWidgets::IFunctionModel::getNumberLocalFunctions ( ) const

Definition at line 39 of file IFunctionModel.cpp.

References getNumberDomains(), and n.

Referenced by copyParametersAndErrorsToAllLocalFunctions().

◆ getParameter()

virtual double MantidQt::MantidWidgets::IFunctionModel::getParameter ( const QString &  paramName) const
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ getParameterDescription()

virtual QString MantidQt::MantidWidgets::IFunctionModel::getParameterDescription ( const QString &  paramName) const
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ getParameterError()

virtual double MantidQt::MantidWidgets::IFunctionModel::getParameterError ( const QString &  paramName) const
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ getParameterNames()

virtual QStringList MantidQt::MantidWidgets::IFunctionModel::getParameterNames ( ) const
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ getSingleFunction()

virtual IFunction_sptr MantidQt::MantidWidgets::IFunctionModel::getSingleFunction ( int  index) const
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

Referenced by copyParametersAndErrorsToAllLocalFunctions().

◆ hasFunction()

virtual bool MantidQt::MantidWidgets::IFunctionModel::hasFunction ( ) const
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ isGlobal()

virtual bool MantidQt::MantidWidgets::IFunctionModel::isGlobal ( const QString &  parName) const
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ isLocalParameterFixed()

virtual bool MantidQt::MantidWidgets::IFunctionModel::isLocalParameterFixed ( const QString &  parName,
int  i 
) const
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ removeConstraint()

virtual void MantidQt::MantidWidgets::IFunctionModel::removeConstraint ( const QString &  paramName)
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ removeFunction()

virtual void MantidQt::MantidWidgets::IFunctionModel::removeFunction ( const QString &  functionIndex)
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ setBackgroundA0()

virtual QString MantidQt::MantidWidgets::IFunctionModel::setBackgroundA0 ( double  value)
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ setCurrentDomainIndex()

virtual void MantidQt::MantidWidgets::IFunctionModel::setCurrentDomainIndex ( int  )
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ setDatasets()

virtual void MantidQt::MantidWidgets::IFunctionModel::setDatasets ( const QList< FunctionModelDataset > &  datasets)
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ setFunction()

virtual void MantidQt::MantidWidgets::IFunctionModel::setFunction ( IFunction_sptr  fun)
pure virtual

Implemented in MantidQt::MantidWidgets::ConvolutionFunctionModel, and MantidQt::MantidWidgets::FunctionModel.

Referenced by clear(), and setFunctionString().

◆ setFunctionString()

void MantidQt::MantidWidgets::IFunctionModel::setFunctionString ( const QString &  funStr)

Definition at line 15 of file IFunctionModel.cpp.

References clear(), Mantid::Kernel::SingletonHolder< T >::Instance(), and setFunction().

Referenced by MantidQt::MantidWidgets::FunctionModel::addFunction().

◆ setGlobalParameters()

virtual void MantidQt::MantidWidgets::IFunctionModel::setGlobalParameters ( const QStringList &  globals)
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ setGlobalParameterValue()

virtual void MantidQt::MantidWidgets::IFunctionModel::setGlobalParameterValue ( const QString &  paramName,
double  value 
)
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ setLocalParameterConstraint()

virtual void MantidQt::MantidWidgets::IFunctionModel::setLocalParameterConstraint ( const QString &  parName,
int  i,
const QString &  constraint 
)
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ setLocalParameterFixed()

virtual void MantidQt::MantidWidgets::IFunctionModel::setLocalParameterFixed ( const QString &  parName,
int  i,
bool  fixed 
)
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ setLocalParameterTie()

virtual void MantidQt::MantidWidgets::IFunctionModel::setLocalParameterTie ( const QString &  parName,
int  i,
const QString &  tie 
)
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ setLocalParameterValue() [1/2]

virtual void MantidQt::MantidWidgets::IFunctionModel::setLocalParameterValue ( const QString &  parName,
int  i,
double  value 
)
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ setLocalParameterValue() [2/2]

virtual void MantidQt::MantidWidgets::IFunctionModel::setLocalParameterValue ( const QString &  parName,
int  i,
double  value,
double  error 
)
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ setNumberDomains()

virtual void MantidQt::MantidWidgets::IFunctionModel::setNumberDomains ( int  )
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ setParameter()

virtual void MantidQt::MantidWidgets::IFunctionModel::setParameter ( const QString &  paramName,
double  value 
)
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ setParameterError()

virtual void MantidQt::MantidWidgets::IFunctionModel::setParameterError ( const QString &  paramName,
double  value 
)
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ updateMultiDatasetParameters()

virtual void MantidQt::MantidWidgets::IFunctionModel::updateMultiDatasetParameters ( const IFunction &  fun)
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

◆ updateParameters()

virtual void MantidQt::MantidWidgets::IFunctionModel::updateParameters ( const IFunction &  fun)
pure virtual

Implemented in MantidQt::MantidWidgets::FunctionModel.

The documentation for this class was generated from the following files:
Generated on Tue Jan 3 2023 12:00:52 for Mantid by doxygen 1.9.5