OptionsFromStreamPack::SetOptionsFromStreamNode Class Reference

Node class for setting options from a stream. More...

#include <OptionsFromStreamPack_SetOptionsFromStreamNode.hpp>

Inheritance diagram for OptionsFromStreamPack::SetOptionsFromStreamNode:

Public Member Functions
	SetOptionsFromStreamNode (const std::string &options_group, int num_options, const char *option_names[], bool exists_optional=true)
	Constructs with the name of the options group and the names of the options. More...
void	set_options (const OptionsFromStream &options)
	Overridden from SetOptionsFromStream and calls setOption(...). More...
Public Member Functions inherited from OptionsFromStreamPack::SetOptionsFromStream
virtual	~SetOptionsFromStream ()

Protected Member Functions
virtual void	setOption (int option_num, const std::string &option_value)=0
	To be overridden by the subclass to set an option given its integer position and the option value. More...

Private Attributes
StringToIntMap	name_map_
bool	exists_optional_

Detailed Description

Node class for setting options from a stream.

This class uses the template method pattern to delegate the setting of options.

Definition at line 55 of file OptionsFromStreamPack_SetOptionsFromStreamNode.hpp.

Constructor & Destructor Documentation

OptionsFromStreamPack::SetOptionsFromStreamNode::SetOptionsFromStreamNode	(	const std::string &	options_group,
		int	num_options,
		const char *	option_names[],
		bool	exists_optional = true
	)

Constructs with the name of the options group and the names of the options.

Parameters

options_group	The name of the options group to access
num_options	The number of options in the opitons group.
option_name	An array (length num_options) containing the names of the options.
exists_optional	Specifies if the options group must exist.

Definition at line 50 of file OptionsFromStreamPack_SetOptionsFromStreamNode.cpp.

Member Function Documentation

void OptionsFromStreamPack::SetOptionsFromStreamNode::set_options ( const OptionsFromStream &  options )

virtual

Overridden from SetOptionsFromStream and calls setOption(...).

The options group options_group# is used. If this options group does not exist and #exists_optional# == false then an #std::invalid_argument# exception will be thrown.

Implements OptionsFromStreamPack::SetOptionsFromStream.

Definition at line 56 of file OptionsFromStreamPack_SetOptionsFromStreamNode.cpp.

virtual void OptionsFromStreamPack::SetOptionsFromStreamNode::setOption ( int  option_num, const std::string &  option_value  )

protectedpure virtual

To be overridden by the subclass to set an option given its integer position and the option value.

The integer possition returned is the possition of the option in option_names[option_num] that was passed to the constructor.

Implemented in MoochoPack::CheckConvergence_StrategySetOptions, MoochoPack::UpdateBarrierParameter_StepSetOptions, MoochoPack::UpdateReducedSigma_StepSetOptions, MoochoPack::PreEvalNewPointBarrier_StepSetOptions, MoochoPack::LineSearch2ndOrderCorrect_StepSetOptions, MoochoPack::PreProcessBarrierLineSearch_StepSetOptions, ConstrainedOptPack::QPSolverRelaxedQPSchurSetOptions, ConstrainedOptPack::DirectLineSearchArmQuad_StrategySetOptions, MoochoPack::InitFinDiffReducedHessian_StepSetOptions, MoochoPack::CheckConvergenceStd_AddedStepSetOptions, MoochoPack::MeritFunc_ModifiedL1LargerSteps_AddedStepSetOptions, ConstrainedOptPack::DecompositionSystemTesterSetOptions, MoochoPack::EvalNewPointTailoredApproach_StepSetOptions, MoochoPack::MeritFunc_PenaltyParamUpdate_AddedStepSetOptions, NLPInterfacePack::CalcFiniteDiffProdSetOptions, AbstractLinAlgPack::BasisSystemTesterSetOptions, MoochoPack::NLPSolverClientInterfaceSetOptions, AbstractLinAlgPack::VectorSpaceTesterSetOptions, NLPInterfacePack::NLPDirectTesterSetOptions, AbstractLinAlgPack::DirectSparseSolverMA28SetOptions, MoochoPack::BFGSUpdate_StrategySetOptions, MoochoPack::ReducedHessianSecantUpdateBFGSProjected_StrategySetOptions, MoochoPack::FeasibilityStepReducedStd_StrategySetOptions, MoochoPack::LineSearchWatchDog_StepSetOptions, MoochoPack::ReducedHessianSecantUpdateLPBFGS_StrategySetOptions, ConstrainedOptPack::QPSolverRelaxedTesterSetOptions, MoochoPack::TangentialStepWithInequStd_StepSetOptions, NLPInterfacePack::NLPFirstDerivTesterSetOptions, MoochoPack::CheckSkipBFGSUpdateStd_StepSetOptions, ConstrainedOptPack::VariableBoundsTesterSetOptions, NLPInterfacePack::NLPTesterSetOptions, and IterationPack::AlgorithmSetOptions.

Member Data Documentation

StringToIntMap OptionsFromStreamPack::SetOptionsFromStreamNode::name_map_

private

Definition at line 91 of file OptionsFromStreamPack_SetOptionsFromStreamNode.hpp.

bool OptionsFromStreamPack::SetOptionsFromStreamNode::exists_optional_

private

Definition at line 92 of file OptionsFromStreamPack_SetOptionsFromStreamNode.hpp.

---

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

• OptionsFromStreamPack_SetOptionsFromStreamNode.hpp
• OptionsFromStreamPack_SetOptionsFromStreamNode.cpp