#include <SolverSettings.hxx>

Collaboration diagram for sc::SolverSettings:

Public Member Functions
	SolverSettings (ScTable &pTable)

SC_DLLPUBLIC OUString	GetParameter (SolverParameter eParam)

SC_DLLPUBLIC void	SetParameter (SolverParameter eParam, OUString sValue)

SC_DLLPUBLIC ObjectiveType	GetObjectiveType ()

SC_DLLPUBLIC void	SetObjectiveType (ObjectiveType eType)

SC_DLLPUBLIC void	GetEngineOptions (css::uno::Sequence< css::beans::PropertyValue > &aOptions)

SC_DLLPUBLIC void	SetEngineOptions (css::uno::Sequence< css::beans::PropertyValue > &aOptions)

SC_DLLPUBLIC std::vector< ModelConstraint >	GetConstraints ()

SC_DLLPUBLIC void	SetConstraints (std::vector< ModelConstraint > aConstraints)

SC_DLLPUBLIC void	SaveSolverSettings ()

SC_DLLPUBLIC void	ResetToDefaults ()

Private Types
typedef std::vector< std::variant< OUString, SolverParameter > >	TParamInfo

Private Member Functions
void	Initialize ()

bool	ReadParamValue (SolverParameter eParam, OUString &rValue, bool bRemoveQuotes=false)

void	WriteParamValue (SolverParameter eParam, OUString sValue, bool bQuoted=false)

void	ReadConstraints ()

void	WriteConstraints ()

bool	ReadConstraintPart (ConstraintPart ePart, tools::Long nIndex, OUString &rValue)

void	WriteConstraintPart (ConstraintPart ePart, tools::Long nIndex, OUString sValue)

void	ReadEngine ()

void	WriteEngine ()

void	DeleteAllNamedRanges ()

Private Attributes
ScTable &	m_rTable

ScDocument &	m_rDoc

ScDocShell *	m_pDocShell

ScRangeName *	m_pRangeName

OUString	m_sObjCell

ObjectiveType	m_eObjType

OUString	m_sObjVal

OUString	m_sVariableCells

OUString	m_sLOEngineName

OUString	m_sMSEngineId

OUString	m_sInteger

OUString	m_sNonNegative

OUString	m_sEpsilonLevel

OUString	m_sLimitBBDepth

OUString	m_sTimeout

OUString	m_sAlgorithm

css::uno::Sequence< css::beans::PropertyValue >	m_aEngineOptions

std::vector< ModelConstraint >	m_aConstraints

std::map< SolverParameter, OUString >	m_mNamedRanges

std::map< OUString, OUString >	SolverNamesToExcelEngines

std::map< OUString, OUString >	SolverCodesToLOEngines

std::map< OUString, TParamInfo >	SolverParamNames

std::vector< OUString >	m_aConstraintParts { "solver_lhs", "solver_rel", "solver_rhs" }

Detailed Description

Definition at line 102 of file SolverSettings.hxx.

Member Typedef Documentation

◆ TParamInfo

typedef std::vector<std::variant<OUString, SolverParameter> > sc::SolverSettings::TParamInfo

private

Definition at line 176 of file SolverSettings.hxx.

Constructor & Destructor Documentation

◆ SolverSettings()

sc::SolverSettings::SolverSettings ( ScTable & pTable )

Definition at line 20 of file SolverSettings.cxx.

References ScTable::GetName(), ScDocument::GetRangeNameMap(), Initialize(), m_pRangeName, m_rDoc, m_rDoc, m_rTable, and m_rTable.

Member Function Documentation

◆ DeleteAllNamedRanges()

void sc::SolverSettings::DeleteAllNamedRanges ( )

private

Definition at line 460 of file SolverSettings.cxx.

References ScRangeName::erase(), ScRangeName::findByIndex(), i, m_pRangeName, pData, and ScRangeName::size().

Referenced by SaveSolverSettings().

◆ GetConstraints()

SC_DLLPUBLIC std::vector< ModelConstraint > sc::SolverSettings::GetConstraints ( )

inline

Definition at line 200 of file SolverSettings.hxx.

References m_aConstraints.

◆ GetEngineOptions()

void sc::SolverSettings::GetEngineOptions ( css::uno::Sequence< css::beans::PropertyValue > & aOptions )

Definition at line 374 of file SolverSettings.cxx.

References GetParameter(), i, nValue, and SolverParamNames.

◆ GetObjectiveType()

SC_DLLPUBLIC ObjectiveType sc::SolverSettings::GetObjectiveType ( )

inline

Definition at line 196 of file SolverSettings.hxx.

References m_eObjType.

◆ GetParameter()

OUString sc::SolverSettings::GetParameter ( SolverParameter eParam )

Definition at line 79 of file SolverSettings.cxx.

References m_aConstraints, m_eObjType, m_sAlgorithm, m_sEpsilonLevel, m_sInteger, m_sLimitBBDepth, m_sLOEngineName, m_sMSEngineId, m_sNonNegative, m_sObjCell, m_sObjVal, m_sTimeout, m_sVariableCells, sc::SP_ALGORITHM, sc::SP_CONSTR_COUNT, sc::SP_EPSILON_LEVEL, sc::SP_INTEGER, sc::SP_LIMIT_BBDEPTH, sc::SP_LO_ENGINE, sc::SP_MS_ENGINE, sc::SP_NON_NEGATIVE, sc::SP_OBJ_CELL, sc::SP_OBJ_TYPE, sc::SP_OBJ_VAL, sc::SP_TIMEOUT, and sc::SP_VAR_CELLS.

Referenced by GetEngineOptions().

◆ Initialize()

void sc::SolverSettings::Initialize ( )

private

Definition at line 33 of file SolverSettings.cxx.

References m_eObjType, m_sAlgorithm, m_sEpsilonLevel, m_sInteger, m_sLimitBBDepth, m_sNonNegative, m_sObjCell, m_sObjVal, m_sTimeout, m_sVariableCells, sc::OT_MAXIMIZE, sc::OT_MINIMIZE, sc::OT_VALUE, ReadConstraints(), ReadEngine(), ReadParamValue(), ResetToDefaults(), sc::SP_ALGORITHM, sc::SP_EPSILON_LEVEL, sc::SP_INTEGER, sc::SP_LIMIT_BBDEPTH, sc::SP_NON_NEGATIVE, sc::SP_OBJ_CELL, sc::SP_OBJ_TYPE, sc::SP_OBJ_VAL, sc::SP_TIMEOUT, and sc::SP_VAR_CELLS.

Referenced by SolverSettings().

◆ ReadConstraintPart()

bool sc::SolverSettings::ReadConstraintPart	(	ConstraintPart	ePart,
		tools::Long	nIndex,
		OUString &	rValue
	)

private

Definition at line 258 of file SolverSettings.cxx.

References ScRangeName::findByUpperName(), ScGlobal::getCharClass(), ScRangeData::GetSymbol(), m_aConstraintParts, m_pRangeName, and nIndex.

Referenced by ReadConstraints().

◆ ReadConstraints()

void sc::SolverSettings::ReadConstraints ( )

private

Definition at line 199 of file SolverSettings.cxx.

References sc::ModelConstraint::aLeftStr, sc::ModelConstraint::aRightStr, sc::CP_LEFT_HAND_SIDE, sc::CP_OPERATOR, sc::CP_RIGHT_HAND_SIDE, m_aConstraints, sc::ModelConstraint::nOperator, and ReadConstraintPart().

Referenced by Initialize().

◆ ReadEngine()

void sc::SolverSettings::ReadEngine ( )

private

Definition at line 274 of file SolverSettings.cxx.

References m_sLOEngineName, m_sMSEngineId, ReadParamValue(), SolverNamesToExcelEngines, and sc::SP_LO_ENGINE.

Referenced by Initialize().

◆ ReadParamValue()

bool sc::SolverSettings::ReadParamValue	(	SolverParameter	eParam,
		OUString &	rValue,
		bool	bRemoveQuotes = `false`
	)

private

Definition at line 340 of file SolverSettings.cxx.

References ScGlobal::EraseQuotes(), ScRangeName::findByUpperName(), ScGlobal::getCharClass(), ScRangeData::GetSymbol(), m_mNamedRanges, and m_pRangeName.

Referenced by Initialize(), and ReadEngine().

◆ ResetToDefaults()

void sc::SolverSettings::ResetToDefaults ( )

Definition at line 480 of file SolverSettings.cxx.

References ScSolverUtil::GetDefaults(), ScSolverUtil::GetImplementations(), m_aConstraints, m_aEngineOptions, m_eObjType, m_sLOEngineName, m_sMSEngineId, m_sObjCell, m_sObjVal, m_sVariableCells, sc::OT_MAXIMIZE, and SetEngineOptions().

Referenced by Initialize().

◆ SaveSolverSettings()

void sc::SolverSettings::SaveSolverSettings ( )

◆ SetConstraints()

void sc::SolverSettings::SetConstraints ( std::vector< ModelConstraint > aConstraints )

Definition at line 302 of file SolverSettings.cxx.

References m_aConstraints.

◆ SetEngineOptions()

void sc::SolverSettings::SetEngineOptions ( css::uno::Sequence< css::beans::PropertyValue > & aOptions )

Definition at line 416 of file SolverSettings.cxx.

References i, nValue, SetParameter(), and SolverParamNames.

Referenced by ResetToDefaults().

◆ SetObjectiveType()

void sc::SolverSettings::SetObjectiveType ( ObjectiveType eType )

Definition at line 196 of file SolverSettings.cxx.

References eType, and m_eObjType.

◆ SetParameter()

void sc::SolverSettings::SetParameter	(	SolverParameter	eParam,
		OUString	sValue
	)

Definition at line 128 of file SolverSettings.cxx.

References m_eObjType, m_sAlgorithm, m_sEpsilonLevel, m_sInteger, m_sLimitBBDepth, m_sLOEngineName, m_sNonNegative, m_sObjCell, m_sObjVal, m_sTimeout, m_sVariableCells, sc::OT_MAXIMIZE, sc::OT_MINIMIZE, sc::OT_VALUE, sc::SP_ALGORITHM, sc::SP_EPSILON_LEVEL, sc::SP_INTEGER, sc::SP_LIMIT_BBDEPTH, sc::SP_LO_ENGINE, sc::SP_NON_NEGATIVE, sc::SP_OBJ_CELL, sc::SP_OBJ_TYPE, sc::SP_OBJ_VAL, sc::SP_TIMEOUT, and sc::SP_VAR_CELLS.

Referenced by SetEngineOptions().

◆ WriteConstraintPart()

void sc::SolverSettings::WriteConstraintPart	(	ConstraintPart	ePart,
		tools::Long	nIndex,
		OUString	sValue
	)

private

Definition at line 245 of file SolverSettings.cxx.

References ScRangeName::insert(), m_aConstraintParts, m_pRangeName, m_rDoc, and nIndex.

Referenced by WriteConstraints().

◆ WriteConstraints()

void sc::SolverSettings::WriteConstraints ( )

private

Definition at line 227 of file SolverSettings.cxx.

References sc::CP_LEFT_HAND_SIDE, sc::CP_OPERATOR, sc::CP_RIGHT_HAND_SIDE, m_aConstraints, and WriteConstraintPart().

Referenced by SaveSolverSettings().

◆ WriteEngine()

void sc::SolverSettings::WriteEngine ( )

private

Definition at line 290 of file SolverSettings.cxx.

References m_sLOEngineName, m_sMSEngineId, SolverNamesToExcelEngines, sc::SP_LO_ENGINE, sc::SP_MS_ENGINE, and WriteParamValue().

Referenced by SaveSolverSettings().

◆ WriteParamValue()

void sc::SolverSettings::WriteParamValue	(	SolverParameter	eParam,
		OUString	sValue,
		bool	bQuoted = `false`
	)

private

Definition at line 359 of file SolverSettings.cxx.

References ScGlobal::AddQuotes(), ScRangeName::insert(), m_mNamedRanges, m_pRangeName, and m_rDoc.

Referenced by SaveSolverSettings(), and WriteEngine().

Member Data Documentation

◆ m_aConstraintParts

std::vector<OUString> sc::SolverSettings::m_aConstraintParts { "solver_lhs", "solver_rel", "solver_rhs" }

private

Definition at line 187 of file SolverSettings.hxx.

Referenced by ReadConstraintPart(), and WriteConstraintPart().

◆ m_aConstraints

std::vector<ModelConstraint> sc::SolverSettings::m_aConstraints

private

Definition at line 128 of file SolverSettings.hxx.

Referenced by GetConstraints(), GetParameter(), ReadConstraints(), ResetToDefaults(), SaveSolverSettings(), SetConstraints(), and WriteConstraints().

◆ m_aEngineOptions

css::uno::Sequence<css::beans::PropertyValue> sc::SolverSettings::m_aEngineOptions

private

Definition at line 126 of file SolverSettings.hxx.

Referenced by ResetToDefaults().

◆ m_eObjType

ObjectiveType sc::SolverSettings::m_eObjType

private

Definition at line 113 of file SolverSettings.hxx.

Referenced by GetObjectiveType(), GetParameter(), Initialize(), ResetToDefaults(), SaveSolverSettings(), SetObjectiveType(), and SetParameter().

◆ m_mNamedRanges

std::map<SolverParameter, OUString> sc::SolverSettings::m_mNamedRanges

private

Initial value:

= { { SP_OBJ_CELL, "solver_opt" },      { SP_OBJ_TYPE, "solver_typ" },
            { SP_OBJ_VAL, "solver_val" },       { SP_VAR_CELLS, "solver_adj" },
            { SP_CONSTR_COUNT, "solver_num" },  { SP_LO_ENGINE, "solver_lo_eng" },
            { SP_MS_ENGINE, "solver_eng" },     { SP_INTEGER, "solver_int" },
            { SP_NON_NEGATIVE, "solver_neg" },  { SP_EPSILON_LEVEL, "solver_eps" },
            { SP_LIMIT_BBDEPTH, "solver_bbd" }, { SP_TIMEOUT, "solver_tim" },
            { SP_ALGORITHM, "solver_alg" } }

Definition at line 151 of file SolverSettings.hxx.

Referenced by ReadParamValue(), and WriteParamValue().

◆ m_pDocShell

ScDocShell* sc::SolverSettings::m_pDocShell

private

Definition at line 107 of file SolverSettings.hxx.

Referenced by SaveSolverSettings().

◆ m_pRangeName

ScRangeName* sc::SolverSettings::m_pRangeName

private

Definition at line 110 of file SolverSettings.hxx.

Referenced by DeleteAllNamedRanges(), ReadConstraintPart(), ReadParamValue(), SolverSettings(), WriteConstraintPart(), and WriteParamValue().

◆ m_rDoc

ScDocument& sc::SolverSettings::m_rDoc

private

Definition at line 106 of file SolverSettings.hxx.

Referenced by SolverSettings(), WriteConstraintPart(), and WriteParamValue().

◆ m_rTable

ScTable& sc::SolverSettings::m_rTable

private

Definition at line 105 of file SolverSettings.hxx.

Referenced by SolverSettings().

◆ m_sAlgorithm

OUString sc::SolverSettings::m_sAlgorithm

private

Definition at line 125 of file SolverSettings.hxx.

Referenced by GetParameter(), Initialize(), SaveSolverSettings(), and SetParameter().

◆ m_sEpsilonLevel

OUString sc::SolverSettings::m_sEpsilonLevel

private

Definition at line 122 of file SolverSettings.hxx.

Referenced by GetParameter(), Initialize(), SaveSolverSettings(), and SetParameter().

◆ m_sInteger

OUString sc::SolverSettings::m_sInteger

private

Definition at line 120 of file SolverSettings.hxx.

Referenced by GetParameter(), Initialize(), SaveSolverSettings(), and SetParameter().

◆ m_sLimitBBDepth

OUString sc::SolverSettings::m_sLimitBBDepth

private

Definition at line 123 of file SolverSettings.hxx.

Referenced by GetParameter(), Initialize(), SaveSolverSettings(), and SetParameter().

◆ m_sLOEngineName

OUString sc::SolverSettings::m_sLOEngineName

private

Definition at line 116 of file SolverSettings.hxx.

Referenced by GetParameter(), ReadEngine(), ResetToDefaults(), SetParameter(), and WriteEngine().

◆ m_sMSEngineId

OUString sc::SolverSettings::m_sMSEngineId

private

Definition at line 117 of file SolverSettings.hxx.

Referenced by GetParameter(), ReadEngine(), ResetToDefaults(), and WriteEngine().

◆ m_sNonNegative

OUString sc::SolverSettings::m_sNonNegative

private

Definition at line 121 of file SolverSettings.hxx.

Referenced by GetParameter(), Initialize(), SaveSolverSettings(), and SetParameter().

◆ m_sObjCell

OUString sc::SolverSettings::m_sObjCell

private

Definition at line 112 of file SolverSettings.hxx.

Referenced by GetParameter(), Initialize(), ResetToDefaults(), SaveSolverSettings(), and SetParameter().

◆ m_sObjVal

OUString sc::SolverSettings::m_sObjVal

private

Definition at line 114 of file SolverSettings.hxx.

Referenced by GetParameter(), Initialize(), ResetToDefaults(), SaveSolverSettings(), and SetParameter().

◆ m_sTimeout

OUString sc::SolverSettings::m_sTimeout

private

Definition at line 124 of file SolverSettings.hxx.

Referenced by GetParameter(), Initialize(), SaveSolverSettings(), and SetParameter().

◆ m_sVariableCells

OUString sc::SolverSettings::m_sVariableCells

private

Definition at line 115 of file SolverSettings.hxx.

Referenced by GetParameter(), Initialize(), ResetToDefaults(), SaveSolverSettings(), and SetParameter().

◆ SolverCodesToLOEngines

std::map<OUString, OUString> sc::SolverSettings::SolverCodesToLOEngines

private

Initial value:

= {
        { "1", "com.sun.star.comp.Calc.SwarmSolver" }, 
        { "2", "com.sun.star.comp.Calc.CoinMPSolver" }, 
        { "3", "com.sun.star.comp.Calc.SwarmSolver" } 
    }

Definition at line 168 of file SolverSettings.hxx.

◆ SolverNamesToExcelEngines

std::map<OUString, OUString> sc::SolverSettings::SolverNamesToExcelEngines

private

Initial value:

= {
        { "com.sun.star.comp.Calc.CoinMPSolver", "2" }, 
        { "com.sun.star.comp.Calc.LpsolveSolver", "2" }, 
        { "com.sun.star.comp.Calc.SwarmSolver", "1" } 
    }

Definition at line 161 of file SolverSettings.hxx.

Referenced by ReadEngine(), and WriteEngine().

◆ SolverParamNames

std::map<OUString, TParamInfo> sc::SolverSettings::SolverParamNames

private

Initial value:

= { { "Integer", { SP_INTEGER, "solver_int", "bool" } },
            { "NonNegative", { SP_NON_NEGATIVE, "solver_neg", "bool" } },
            { "EpsilonLevel", { SP_EPSILON_LEVEL, "solver_eps", "int" } },
            { "LimitBBDepth", { SP_LIMIT_BBDEPTH, "solver_bbd", "bool" } },
            { "Timeout", { SP_TIMEOUT, "solver_tim", "int" } },
            { "Algorithm", { SP_ALGORITHM, "solver_alg", "int" } } }

Definition at line 177 of file SolverSettings.hxx.

Referenced by GetEngineOptions(), and SetEngineOptions().

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

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ TParamInfo

Constructor & Destructor Documentation

◆ SolverSettings()

Member Function Documentation

◆ DeleteAllNamedRanges()

◆ GetConstraints()

◆ GetEngineOptions()

◆ GetObjectiveType()

◆ GetParameter()

◆ Initialize()

◆ ReadConstraintPart()

◆ ReadConstraints()

◆ ReadEngine()

◆ ReadParamValue()

◆ ResetToDefaults()

◆ SaveSolverSettings()

◆ SetConstraints()

◆ SetEngineOptions()

◆ SetObjectiveType()

◆ SetParameter()

◆ WriteConstraintPart()

◆ WriteConstraints()

◆ WriteEngine()

◆ WriteParamValue()

Member Data Documentation

◆ m_aConstraintParts

◆ m_aConstraints

◆ m_aEngineOptions

◆ m_eObjType

◆ m_mNamedRanges

◆ m_pDocShell

◆ m_pRangeName

◆ m_rDoc

◆ m_rTable

◆ m_sAlgorithm

◆ m_sEpsilonLevel

◆ m_sInteger

◆ m_sLimitBBDepth

◆ m_sLOEngineName

◆ m_sMSEngineId

◆ m_sNonNegative

◆ m_sObjCell

◆ m_sObjVal

◆ m_sTimeout

◆ m_sVariableCells

◆ SolverCodesToLOEngines

◆ SolverNamesToExcelEngines

◆ SolverParamNames