Class for storing registered options. More...

#include <IpRegOptions.hpp>

Inheritance diagram for Ipopt::RegisteredOptions:

Public Types
enum	OutputMode { OUTPUTTEXT = 0, OUTPUTLATEX, OUTPUTDOXYGEN }
	output modes More...

typedef std::map< std::string, SmartPtr< RegisteredOption > >	RegOptionsList

typedef std::map< std::string, SmartPtr< RegisteredCategory > >	RegCategoriesList

typedef std::set< SmartPtr< RegisteredCategory >, RegisteredCategory::ComparePriority >	RegCategoriesByPriority

Public Member Functions
	DECLARE_STD_EXCEPTION (OPTION_ALREADY_REGISTERED)

virtual void	SetRegisteringCategory (const std::string &registering_category, int priority=0)
	set the registering class More...

virtual void	SetRegisteringCategory (SmartPtr< RegisteredCategory > registering_category)
	set the registering class More...

virtual SmartPtr< RegisteredCategory >	RegisteringCategory ()
	retrieve the value of the current registering category More...

virtual void	AddNumberOption (const std::string &name, const std::string &short_description, Number default_value, const std::string &long_description="", bool advanced=false)
	Add a Number option (with no restrictions) More...

virtual void	AddLowerBoundedNumberOption (const std::string &name, const std::string &short_description, Number lower, bool strict, Number default_value, const std::string &long_description="", bool advanced=false)
	Add a Number option (with a lower bound) More...

virtual void	AddUpperBoundedNumberOption (const std::string &name, const std::string &short_description, Number upper, bool strict, Number default_value, const std::string &long_description="", bool advanced=false)
	Add a Number option (with a upper bound) More...

virtual void	AddBoundedNumberOption (const std::string &name, const std::string &short_description, Number lower, bool lower_strict, Number upper, bool upper_strict, Number default_value, const std::string &long_description="", bool advanced=false)
	Add a Number option (with a both bounds) More...

virtual void	AddIntegerOption (const std::string &name, const std::string &short_description, Index default_value, const std::string &long_description="", bool advanced=false)
	Add a Integer option (with no restrictions) More...

virtual void	AddLowerBoundedIntegerOption (const std::string &name, const std::string &short_description, Index lower, Index default_value, const std::string &long_description="", bool advanced=false)
	Add a Integer option (with a lower bound) More...

virtual void	AddUpperBoundedIntegerOption (const std::string &name, const std::string &short_description, Index upper, Index default_value, const std::string &long_description="", bool advanced=false)
	Add a Integer option (with a upper bound) More...

virtual void	AddBoundedIntegerOption (const std::string &name, const std::string &short_description, Index lower, Index upper, Index default_value, const std::string &long_description="", bool advanced=false)
	Add a Integer option (with a both bounds) More...

virtual void	AddStringOption (const std::string &name, const std::string &short_description, const std::string &default_value, const std::vector< std::string > &settings, const std::vector< std::string > &descriptions, const std::string &long_description="", bool advanced=false)
	Add a String option (with no restrictions) More...

virtual void	AddStringOption1 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &long_description="", bool advanced=false)
	Methods that make adding string options with only a few entries easier. More...

virtual void	AddStringOption2 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &long_description="", bool advanced=false)

virtual void	AddStringOption3 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &long_description="", bool advanced=false)

virtual void	AddStringOption4 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &long_description="", bool advanced=false)

virtual void	AddStringOption5 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &setting5, const std::string &description5, const std::string &long_description="", bool advanced=false)

virtual void	AddStringOption6 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &setting5, const std::string &description5, const std::string &setting6, const std::string &description6, const std::string &long_description="", bool advanced=false)

virtual void	AddStringOption7 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &setting5, const std::string &description5, const std::string &setting6, const std::string &description6, const std::string &setting7, const std::string &description7, const std::string &long_description="", bool advanced=false)

virtual void	AddStringOption8 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &setting5, const std::string &description5, const std::string &setting6, const std::string &description6, const std::string &setting7, const std::string &description7, const std::string &setting8, const std::string &description8, const std::string &long_description="", bool advanced=false)

virtual void	AddStringOption9 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &setting5, const std::string &description5, const std::string &setting6, const std::string &description6, const std::string &setting7, const std::string &description7, const std::string &setting8, const std::string &description8, const std::string &setting9, const std::string &description9, const std::string &long_description="", bool advanced=false)

virtual void	AddStringOption10 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &setting5, const std::string &description5, const std::string &setting6, const std::string &description6, const std::string &setting7, const std::string &description7, const std::string &setting8, const std::string &description8, const std::string &setting9, const std::string &description9, const std::string &setting10, const std::string &description10, const std::string &long_description="", bool advanced=false)

virtual void	AddBoolOption (const std::string &name, const std::string &short_description, bool default_value, const std::string &long_description="", bool advanced=false)
	Create a string value with two possible settings: yes and no. More...

virtual SmartPtr< const RegisteredOption >	GetOption (const std::string &name)
	Get a registered option. More...

const RegOptionsList &	RegisteredOptionsList () const
	Giving access to iteratable representation of the registered options. More...

const RegCategoriesList &	RegisteredCategories () const
	Giving access to registered categories. More...

void	RegisteredCategoriesByPriority (RegCategoriesByPriority &categories) const
	Giving access to registered categories ordered by (decreasing) priority. More...

virtual void	OutputOptionDocumentation (const Journalist &jnlst, SmartPtr< OptionsList > options, int minpriority=0) const
	Output documentation. More...

virtual IPOPT_DEPRECATED void	OutputOptionDocumentation (const Journalist &jnlst, const std::list< std::string > &categories=std::list< std::string >()) const
	Output documentation in text format. More...

virtual IPOPT_DEPRECATED void	OutputLatexOptionDocumentation (const Journalist &jnlst, const std::list< std::string > &options_to_print=std::list< std::string >()) const
	Output documentation in Latex format to include in a latex file. More...

virtual IPOPT_DEPRECATED void	OutputDoxygenOptionDocumentation (const Journalist &jnlst, const std::list< std::string > &options_to_print=std::list< std::string >()) const
	Output documentation in Doxygen format to include in doxygen documentation. More...


	RegisteredOptions ()
	Constructors / Destructors. More...

virtual	~RegisteredOptions ()
	Destructor. More...

Public Member Functions inherited from Ipopt::ReferencedObject
	ReferencedObject ()

virtual	~ReferencedObject ()

Index	ReferenceCount () const

void	AddRef (const Referencer *referencer) const

void	ReleaseRef (const Referencer *referencer) const

Static Public Member Functions
static void	RegisterOptions (SmartPtr< RegisteredOptions > roptions)
	register options of RegisteredOptions class More...

Private Member Functions
void	AddOption (const SmartPtr< RegisteredOption > &option)

Private Attributes
RegOptionsList	registered_options_

RegCategoriesList	registered_categories_

Index	next_counter_

SmartPtr< RegisteredCategory >	current_registering_category_

Detailed Description

Class for storing registered options.

Used for validation and documentation.

Definition at line 683 of file IpRegOptions.hpp.

Member Typedef Documentation

◆ RegOptionsList

typedef std::map<std::string, SmartPtr<RegisteredOption> > Ipopt::RegisteredOptions::RegOptionsList

Since: 3.14.0

Definition at line 687 of file IpRegOptions.hpp.

◆ RegCategoriesList

typedef std::map<std::string, SmartPtr<RegisteredCategory> > Ipopt::RegisteredOptions::RegCategoriesList

Since: 3.14.0

Definition at line 689 of file IpRegOptions.hpp.

◆ RegCategoriesByPriority

typedef std::set<SmartPtr<RegisteredCategory>, RegisteredCategory::ComparePriority> Ipopt::RegisteredOptions::RegCategoriesByPriority

Since: 3.14.0

Definition at line 691 of file IpRegOptions.hpp.

Member Enumeration Documentation

◆ OutputMode

enum Ipopt::RegisteredOptions::OutputMode

output modes

Since: 3.14.0

Enumerator
OUTPUTTEXT
OUTPUTLATEX
OUTPUTDOXYGEN

Definition at line 696 of file IpRegOptions.hpp.

Constructor & Destructor Documentation

◆ RegisteredOptions()

Ipopt::RegisteredOptions::RegisteredOptions ( )

inline

Constructors / Destructors.

Default Constructor

Definition at line 706 of file IpRegOptions.hpp.

◆ ~RegisteredOptions()

virtual Ipopt::RegisteredOptions::~RegisteredOptions ( )

inlinevirtual

Destructor.

Definition at line 711 of file IpRegOptions.hpp.

Member Function Documentation

◆ DECLARE_STD_EXCEPTION()

Ipopt::RegisteredOptions::DECLARE_STD_EXCEPTION ( OPTION_ALREADY_REGISTERED )

◆ SetRegisteringCategory() [1/2]

virtual void Ipopt::RegisteredOptions::SetRegisteringCategory	(	const std::string &	registering_category,
		int	priority = `0`
	)

virtual

set the registering class

If nonempty name, then all subsequent options will be added with the registered category. If empty name, then all subsequent options will not be added to any registered category.

If the category doesn't exist yet, it will be created with given data. If it exists already, given priority and undocumented flag are ignored.

Parameters

registering_category	category name
priority	category priority

Since: 3.14.0

◆ SetRegisteringCategory() [2/2]

virtual void Ipopt::RegisteredOptions::SetRegisteringCategory ( SmartPtr< RegisteredCategory > registering_category )

virtual

set the registering class

If not NULL, then all subsequent options will be added with the registered category. If NULL, then all subsequent options will not be added to any registered category.

Since: 3.14.0

◆ RegisteringCategory()

virtual SmartPtr<RegisteredCategory> Ipopt::RegisteredOptions::RegisteringCategory ( )

inlinevirtual

retrieve the value of the current registering category

Since: 3.14.0

Definition at line 749 of file IpRegOptions.hpp.

◆ AddNumberOption()

virtual void Ipopt::RegisteredOptions::AddNumberOption	(	const std::string &	name,
		const std::string &	short_description,
		Number	default_value,
		const std::string &	long_description = `""`,
		bool	advanced = `false`
	)

virtual

Add a Number option (with no restrictions)

Parameters

name	option name
short_description	short description
default_value	default value
long_description	long description
advanced	whether option is for advanced users

Since: 3.14.0

◆ AddLowerBoundedNumberOption()

virtual void Ipopt::RegisteredOptions::AddLowerBoundedNumberOption	(	const std::string &	name,
		const std::string &	short_description,
		Number	lower,
		bool	strict,
		Number	default_value,
		const std::string &	long_description = `""`,
		bool	advanced = `false`
	)

virtual

Add a Number option (with a lower bound)

Parameters

name	option name
short_description	short description
lower	lower bound
strict	whether lower bound is strict
default_value	default value
long_description	long description
advanced	whether option is for advanced users

Since: 3.14.0

◆ AddUpperBoundedNumberOption()

virtual void Ipopt::RegisteredOptions::AddUpperBoundedNumberOption	(	const std::string &	name,
		const std::string &	short_description,
		Number	upper,
		bool	strict,
		Number	default_value,
		const std::string &	long_description = `""`,
		bool	advanced = `false`
	)

virtual

Add a Number option (with a upper bound)

Parameters

name	option name
short_description	short description
upper	upper bound
strict	whether upper bound is strict
default_value	default value
long_description	long description
advanced	whether option is for advanced users

Since: 3.14.0

◆ AddBoundedNumberOption()

virtual void Ipopt::RegisteredOptions::AddBoundedNumberOption	(	const std::string &	name,
		const std::string &	short_description,
		Number	lower,
		bool	lower_strict,
		Number	upper,
		bool	upper_strict,
		Number	default_value,
		const std::string &	long_description = `""`,
		bool	advanced = `false`
	)

virtual

Add a Number option (with a both bounds)

Parameters

name	option name
short_description	short description
lower	lower bound
lower_strict	whether lower bound is strict
upper	upper bound
upper_strict	whether upper bound is strict
default_value	default value
long_description	long description
advanced	whether option is for advanced users

Since: 3.14.0

◆ AddIntegerOption()

virtual void Ipopt::RegisteredOptions::AddIntegerOption	(	const std::string &	name,
		const std::string &	short_description,
		Index	default_value,
		const std::string &	long_description = `""`,
		bool	advanced = `false`
	)

virtual

Add a Integer option (with no restrictions)

Parameters

name	option name
short_description	short description
default_value	default value
long_description	long description
advanced	whether option is for advanced users

Since: 3.14.0

◆ AddLowerBoundedIntegerOption()

virtual void Ipopt::RegisteredOptions::AddLowerBoundedIntegerOption	(	const std::string &	name,
		const std::string &	short_description,
		Index	lower,
		Index	default_value,
		const std::string &	long_description = `""`,
		bool	advanced = `false`
	)

virtual

Add a Integer option (with a lower bound)

Parameters

name	option name
short_description	short description
lower	lower bound
default_value	default value
long_description	long description
advanced	whether option is for advanced users

Since: 3.14.0

◆ AddUpperBoundedIntegerOption()

virtual void Ipopt::RegisteredOptions::AddUpperBoundedIntegerOption	(	const std::string &	name,
		const std::string &	short_description,
		Index	upper,
		Index	default_value,
		const std::string &	long_description = `""`,
		bool	advanced = `false`
	)

virtual

Add a Integer option (with a upper bound)

Parameters

name	option name
short_description	short description
upper	upper bound
default_value	default value
long_description	long description
advanced	whether option is for advanced users

Since: 3.14.0

◆ AddBoundedIntegerOption()

virtual void Ipopt::RegisteredOptions::AddBoundedIntegerOption	(	const std::string &	name,
		const std::string &	short_description,
		Index	lower,
		Index	upper,
		Index	default_value,
		const std::string &	long_description = `""`,
		bool	advanced = `false`
	)

virtual

Add a Integer option (with a both bounds)

Parameters

name	option name
short_description	short description
lower	lower bound
upper	upper bound
default_value	default value
long_description	long description
advanced	whether option is for advanced users

Since: 3.14.0

◆ AddStringOption()

virtual void Ipopt::RegisteredOptions::AddStringOption	(	const std::string &	name,
		const std::string &	short_description,
		const std::string &	default_value,
		const std::vector< std::string > &	settings,
		const std::vector< std::string > &	descriptions,
		const std::string &	long_description = `""`,
		bool	advanced = `false`
	)

virtual

Add a String option (with no restrictions)

Parameters

name	option name
short_description	short description
default_value	default value
settings	possible values
descriptions	description of possible values
long_description	long description
advanced	whether option is for advanced users

Since: 3.14.0

◆ AddStringOption1()

virtual void Ipopt::RegisteredOptions::AddStringOption1	(	const std::string &	name,
		const std::string &	short_description,
		const std::string &	default_value,
		const std::string &	setting1,
		const std::string &	description1,
		const std::string &	long_description = `""`,
		bool	advanced = `false`
	)

virtual

Methods that make adding string options with only a few entries easier.

Parameters

name	option name
short_description	short description
default_value	default value
setting1	first possible value
description1	description of first possible value
long_description	long description
advanced	whether option is for advanced users

Since: 3.14.0

◆ AddStringOption2()

virtual void Ipopt::RegisteredOptions::AddStringOption2	(	const std::string &	name,
		const std::string &	short_description,
		const std::string &	default_value,
		const std::string &	setting1,
		const std::string &	description1,
		const std::string &	setting2,
		const std::string &	description2,
		const std::string &	long_description = `""`,
		bool	advanced = `false`
	)

virtual

Parameters

name	option name
short_description	short description
default_value	default value
setting1	first possible value
description1	description of first possible value
setting2	second possible value
description2	description of second possible value
long_description	long description
advanced	whether option is for advanced users

Since: 3.14.0

◆ AddStringOption3()

virtual void Ipopt::RegisteredOptions::AddStringOption3	(	const std::string &	name,
		const std::string &	short_description,
		const std::string &	default_value,
		const std::string &	setting1,
		const std::string &	description1,
		const std::string &	setting2,
		const std::string &	description2,
		const std::string &	setting3,
		const std::string &	description3,
		const std::string &	long_description = `""`,
		bool	advanced = `false`
	)

virtual

Parameters

name	option name
short_description	short description
default_value	default value
setting1	first possible value
description1	description of first possible value
setting2	second possible value
description2	description of second possible value
setting3	third possible value
description3	description of third possible value
long_description	long description
advanced	whether option is for advanced users

Since: 3.14.0

◆ AddStringOption4()

virtual void Ipopt::RegisteredOptions::AddStringOption4	(	const std::string &	name,
		const std::string &	short_description,
		const std::string &	default_value,
		const std::string &	setting1,
		const std::string &	description1,
		const std::string &	setting2,
		const std::string &	description2,
		const std::string &	setting3,
		const std::string &	description3,
		const std::string &	setting4,
		const std::string &	description4,
		const std::string &	long_description = `""`,
		bool	advanced = `false`
	)

virtual

Parameters

name	option name
short_description	short description
default_value	default value
setting1	first possible value
description1	description of first possible value
setting2	second possible value
description2	description of second possible value
setting3	third possible value
description3	description of third possible value
setting4	fourth possible value
description4	description of fourth possible value
long_description	long description
advanced	whether option is for advanced users

Since: 3.14.0

◆ AddStringOption5()

virtual void Ipopt::RegisteredOptions::AddStringOption5	(	const std::string &	name,
		const std::string &	short_description,
		const std::string &	default_value,
		const std::string &	setting1,
		const std::string &	description1,
		const std::string &	setting2,
		const std::string &	description2,
		const std::string &	setting3,
		const std::string &	description3,
		const std::string &	setting4,
		const std::string &	description4,
		const std::string &	setting5,
		const std::string &	description5,
		const std::string &	long_description = `""`,
		bool	advanced = `false`
	)

virtual

Parameters

name	option name
short_description	short description
default_value	default value
setting1	first possible value
description1	description of first possible value
setting2	second possible value
description2	description of second possible value
setting3	third possible value
description3	description of third possible value
setting4	fourth possible value
description4	description of fourth possible value
setting5	fifth possible value
description5	description of fifth possible value
long_description	long description
advanced	whether option is for advanced users

Since: 3.14.0

◆ AddStringOption6()

virtual void Ipopt::RegisteredOptions::AddStringOption6	(	const std::string &	name,
		const std::string &	short_description,
		const std::string &	default_value,
		const std::string &	setting1,
		const std::string &	description1,
		const std::string &	setting2,
		const std::string &	description2,
		const std::string &	setting3,
		const std::string &	description3,
		const std::string &	setting4,
		const std::string &	description4,
		const std::string &	setting5,
		const std::string &	description5,
		const std::string &	setting6,
		const std::string &	description6,
		const std::string &	long_description = `""`,
		bool	advanced = `false`
	)

virtual

Parameters

name	option name
short_description	short description
default_value	default value
setting1	first possible value
description1	description of first possible value
setting2	second possible value
description2	description of second possible value
setting3	third possible value
description3	description of third possible value
setting4	fourth possible value
description4	description of fourth possible value
setting5	fifth possible value
description5	description of fifth possible value
setting6	sixth possible value
description6	description of sixth possible value
long_description	long description
advanced	whether option is for advanced users

Since: 3.14.0

◆ AddStringOption7()

virtual void Ipopt::RegisteredOptions::AddStringOption7	(	const std::string &	name,
		const std::string &	short_description,
		const std::string &	default_value,
		const std::string &	setting1,
		const std::string &	description1,
		const std::string &	setting2,
		const std::string &	description2,
		const std::string &	setting3,
		const std::string &	description3,
		const std::string &	setting4,
		const std::string &	description4,
		const std::string &	setting5,
		const std::string &	description5,
		const std::string &	setting6,
		const std::string &	description6,
		const std::string &	setting7,
		const std::string &	description7,
		const std::string &	long_description = `""`,
		bool	advanced = `false`
	)

virtual

Parameters

name	option name
short_description	short description
default_value	default value
setting1	first possible value
description1	description of first possible value
setting2	second possible value
description2	description of second possible value
setting3	third possible value
description3	description of third possible value
setting4	fourth possible value
description4	description of fourth possible value
setting5	fifth possible value
description5	description of fifth possible value
setting6	sixth possible value
description6	description of sixth possible value
setting7	seventh possible value
description7	description of seventh possible value
long_description	long description
advanced	whether option is for advanced users

Since: 3.14.0

◆ AddStringOption8()

virtual void Ipopt::RegisteredOptions::AddStringOption8	(	const std::string &	name,
		const std::string &	short_description,
		const std::string &	default_value,
		const std::string &	setting1,
		const std::string &	description1,
		const std::string &	setting2,
		const std::string &	description2,
		const std::string &	setting3,
		const std::string &	description3,
		const std::string &	setting4,
		const std::string &	description4,
		const std::string &	setting5,
		const std::string &	description5,
		const std::string &	setting6,
		const std::string &	description6,
		const std::string &	setting7,
		const std::string &	description7,
		const std::string &	setting8,
		const std::string &	description8,
		const std::string &	long_description = `""`,
		bool	advanced = `false`
	)

virtual

Parameters

name	option name
short_description	short description
default_value	default value
setting1	first possible value
description1	description of first possible value
setting2	second possible value
description2	description of second possible value
setting3	third possible value
description3	description of third possible value
setting4	fourth possible value
description4	description of fourth possible value
setting5	fifth possible value
description5	description of fifth possible value
setting6	sixth possible value
description6	description of sixth possible value
setting7	seventh possible value
description7	description of seventh possible value
setting8	eighth possible value
description8	description of eighth possible value
long_description	long description
advanced	whether option is for advanced users

Since: 3.14.0

◆ AddStringOption9()

virtual void Ipopt::RegisteredOptions::AddStringOption9	(	const std::string &	name,
		const std::string &	short_description,
		const std::string &	default_value,
		const std::string &	setting1,
		const std::string &	description1,
		const std::string &	setting2,
		const std::string &	description2,
		const std::string &	setting3,
		const std::string &	description3,
		const std::string &	setting4,
		const std::string &	description4,
		const std::string &	setting5,
		const std::string &	description5,
		const std::string &	setting6,
		const std::string &	description6,
		const std::string &	setting7,
		const std::string &	description7,
		const std::string &	setting8,
		const std::string &	description8,
		const std::string &	setting9,
		const std::string &	description9,
		const std::string &	long_description = `""`,
		bool	advanced = `false`
	)

virtual

Parameters

name	option name
short_description	short description
default_value	default value
setting1	first possible value
description1	description of first possible value
setting2	second possible value
description2	description of second possible value
setting3	third possible value
description3	description of third possible value
setting4	fourth possible value
description4	description of fourth possible value
setting5	fifth possible value
description5	description of fifth possible value
setting6	sixth possible value
description6	description of sixth possible value
setting7	seventh possible value
description7	description of seventh possible value
setting8	eighth possible value
description8	description of eighth possible value
setting9	ninth possible value
description9	description of ninth possible value
long_description	long description
advanced	whether option is for advanced users

Since: 3.14.0

◆ AddStringOption10()

virtual void Ipopt::RegisteredOptions::AddStringOption10	(	const std::string &	name,
		const std::string &	short_description,
		const std::string &	default_value,
		const std::string &	setting1,
		const std::string &	description1,
		const std::string &	setting2,
		const std::string &	description2,
		const std::string &	setting3,
		const std::string &	description3,
		const std::string &	setting4,
		const std::string &	description4,
		const std::string &	setting5,
		const std::string &	description5,
		const std::string &	setting6,
		const std::string &	description6,
		const std::string &	setting7,
		const std::string &	description7,
		const std::string &	setting8,
		const std::string &	description8,
		const std::string &	setting9,
		const std::string &	description9,
		const std::string &	setting10,
		const std::string &	description10,
		const std::string &	long_description = `""`,
		bool	advanced = `false`
	)

virtual

Parameters

name	option name
short_description	short description
default_value	default value
setting1	first possible value
description1	description of first possible value
setting2	second possible value
description2	description of second possible value
setting3	third possible value
description3	description of third possible value
setting4	fourth possible value
description4	description of fourth possible value
setting5	fifth possible value
description5	description of fifth possible value
setting6	sixth possible value
description6	description of sixth possible value
setting7	seventh possible value
description7	description of seventh possible value
setting8	eighth possible value
description8	description of eighth possible value
setting9	ninth possible value
description9	description of ninth possible value
setting10	tenth possible value
description10	description of tenth possible value
long_description	long description
advanced	whether option is for advanced users

Since: 3.14.0

◆ AddBoolOption()

virtual void Ipopt::RegisteredOptions::AddBoolOption	(	const std::string &	name,
		const std::string &	short_description,
		bool	default_value,
		const std::string &	long_description = `""`,
		bool	advanced = `false`
	)

virtual

Create a string value with two possible settings: yes and no.

Since: 3.14.0

Parameters

name	option name
short_description	short description
default_value	default value
long_description	long description
advanced	whether option is for advanced users

Since: 3.14.0

◆ GetOption()

virtual SmartPtr<const RegisteredOption> Ipopt::RegisteredOptions::GetOption ( const std::string & name )

virtual

Get a registered option.

Returns: NULL, if the option does not exist

◆ RegisteredOptionsList()

const RegOptionsList& Ipopt::RegisteredOptions::RegisteredOptionsList ( ) const

inline

Giving access to iteratable representation of the registered options.

Definition at line 1060 of file IpRegOptions.hpp.

◆ RegisteredCategories()

const RegCategoriesList& Ipopt::RegisteredOptions::RegisteredCategories ( ) const

inline

Giving access to registered categories.

Since: 3.14.0

Definition at line 1068 of file IpRegOptions.hpp.

◆ RegisteredCategoriesByPriority()

void Ipopt::RegisteredOptions::RegisteredCategoriesByPriority ( RegCategoriesByPriority & categories ) const

Giving access to registered categories ordered by (decreasing) priority.

Result is stored in given set.

Since: 3.14.0

◆ OutputOptionDocumentation() [1/2]

virtual void Ipopt::RegisteredOptions::OutputOptionDocumentation	(	const Journalist &	jnlst,
		SmartPtr< OptionsList >	options,
		int	minpriority = `0`
	)		const

virtual

Output documentation.

Format is decided according to print_options_mode option. Whether to print advanced options is decided according to print_advanced_options option. All categories with priority equal or greater minpriority are printed.

Since: 3.14.0

◆ OutputOptionDocumentation() [2/2]

virtual IPOPT_DEPRECATED void Ipopt::RegisteredOptions::OutputOptionDocumentation	(	const Journalist &	jnlst,
		const std::list< std::string > &	categories = `std::list< std::string >()`
	)		const

virtual

Output documentation in text format.

If categories is empty, then all options are printed.

Deprecated:: Use other OutputOptionDocumentation() instead.

◆ OutputLatexOptionDocumentation()

virtual IPOPT_DEPRECATED void Ipopt::RegisteredOptions::OutputLatexOptionDocumentation	(	const Journalist &	jnlst,
		const std::list< std::string > &	options_to_print = `std::list< std::string >()`
	)		const

virtual

Output documentation in Latex format to include in a latex file.

If options_to_print is empty, then all options are printed.

Deprecated:: Use OutputOptionDocumentation() instead.

◆ OutputDoxygenOptionDocumentation()

virtual IPOPT_DEPRECATED void Ipopt::RegisteredOptions::OutputDoxygenOptionDocumentation	(	const Journalist &	jnlst,
		const std::list< std::string > &	options_to_print = `std::list< std::string >()`
	)		const

virtual

Output documentation in Doxygen format to include in doxygen documentation.

If options_to_print is empty, then all options are printed.

Deprecated:: Use OutputOptionDocumentation() instead.

◆ RegisterOptions()

static void Ipopt::RegisteredOptions::RegisterOptions ( SmartPtr< RegisteredOptions > roptions )

static

register options of RegisteredOptions class

Since: 3.14.0

◆ AddOption()

void Ipopt::RegisteredOptions::AddOption ( const SmartPtr< RegisteredOption > & option )

private

Member Data Documentation

◆ registered_options_

RegOptionsList Ipopt::RegisteredOptions::registered_options_

private

Definition at line 1143 of file IpRegOptions.hpp.

◆ registered_categories_

RegCategoriesList Ipopt::RegisteredOptions::registered_categories_

private

Definition at line 1144 of file IpRegOptions.hpp.

◆ next_counter_

Index Ipopt::RegisteredOptions::next_counter_

private

Definition at line 1146 of file IpRegOptions.hpp.

◆ current_registering_category_

SmartPtr<RegisteredCategory> Ipopt::RegisteredOptions::current_registering_category_

private

Definition at line 1147 of file IpRegOptions.hpp.

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

src/Common/IpRegOptions.hpp

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ RegOptionsList

◆ RegCategoriesList

◆ RegCategoriesByPriority

Member Enumeration Documentation

◆ OutputMode

Constructor & Destructor Documentation

◆ RegisteredOptions()

◆ ~RegisteredOptions()

Member Function Documentation

◆ DECLARE_STD_EXCEPTION()

◆ SetRegisteringCategory() [1/2]

◆ SetRegisteringCategory() [2/2]

◆ RegisteringCategory()

◆ AddNumberOption()

◆ AddLowerBoundedNumberOption()

◆ AddUpperBoundedNumberOption()

◆ AddBoundedNumberOption()

◆ AddIntegerOption()

◆ AddLowerBoundedIntegerOption()

◆ AddUpperBoundedIntegerOption()

◆ AddBoundedIntegerOption()

◆ AddStringOption()

◆ AddStringOption1()

◆ AddStringOption2()

◆ AddStringOption3()

◆ AddStringOption4()

◆ AddStringOption5()

◆ AddStringOption6()

◆ AddStringOption7()

◆ AddStringOption8()

◆ AddStringOption9()

◆ AddStringOption10()

◆ AddBoolOption()

◆ GetOption()

◆ RegisteredOptionsList()

◆ RegisteredCategories()

◆ RegisteredCategoriesByPriority()

◆ OutputOptionDocumentation() [1/2]

◆ OutputOptionDocumentation() [2/2]

◆ OutputLatexOptionDocumentation()

◆ OutputDoxygenOptionDocumentation()

◆ RegisterOptions()

◆ AddOption()

Member Data Documentation

◆ registered_options_

◆ registered_categories_

◆ next_counter_

◆ current_registering_category_