RegisteredOptions Class Reference

#include <IpRegOptions.hpp>

Inheritance diagram for RegisteredOptions:

List of all members.

---

Detailed Description

Class for storing registered options.

Used for validation and documentation.

Public Member Functions
	DECLARE_STD_EXCEPTION (OPTION_ALREADY_REGISTERED)
	RegisteredOptions ()
	Constructors / Destructors.
	~RegisteredOptions ()
	Standard Destructor.
void	SetRegisteringCategory (const std::string &registering_category)
	Methods to interact with registered options.
std::string	RegisteringCategory ()
	retrieve the value of the current registering category
void	AddNumberOption (const std::string &name, const std::string &short_description, Number default_value, const std::string &long_description="")
	Add a Number option (with no restrictions).
void	AddLowerBoundedNumberOption (const std::string &name, const std::string &short_description, Number lower, bool strict, Number default_value, const std::string &long_description="")
	Add a Number option (with a lower bound).
void	AddUpperBoundedNumberOption (const std::string &name, const std::string &short_description, Number upper, bool strict, Number default_value, const std::string &long_description="")
	Add a Number option (with a upper bound).
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="")
	Add a Number option (with a both bounds).
void	AddIntegerOption (const std::string &name, const std::string &short_description, Index default_value, const std::string &long_description="")
	Add a Integer option (with no restrictions).
void	AddLowerBoundedIntegerOption (const std::string &name, const std::string &short_description, Index lower, Index default_value, const std::string &long_description="")
	Add a Integer option (with a lower bound).
void	AddUpperBoundedIntegerOption (const std::string &name, const std::string &short_description, Index upper, Index default_value, const std::string &long_description="")
	Add a Integer option (with a upper bound).
void	AddBoundedIntegerOption (const std::string &name, const std::string &short_description, Index lower, Index upper, Index default_value, const std::string &long_description="")
	Add a Integer option (with a both bounds).
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="")
	Add a String option (with no restrictions).
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="")
	Methods that make adding string options with only a few entries easier.
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="")
	Methods to interact with registered options.
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="")
	Methods to interact with registered options.
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="")
	Methods to interact with registered options.
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="")
	Methods to interact with registered options.
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="")
	Methods to interact with registered options.
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="")
	Methods to interact with registered options.
SmartPtr< const RegisteredOption >	GetOption (const std::string &name)
	Get a registered option - this will return NULL if the option does not exist.
void	OutputOptionDocumentation (const Journalist &jnlst, std::list< std::string > &categories)
	Output documentation for the options - gives a description, etc.
void	OutputLatexOptionDocumentation (const Journalist &jnlst, std::list< std::string > &categories)
	Output documentation in Latex format to include in a latex file.

---

Constructor & Destructor Documentation

RegisteredOptions

(

)

[inline]

Constructors / Destructors.

Standard Constructor

~RegisteredOptions

(

)

[inline]

Standard Destructor.

---

Member Function Documentation

DECLARE_STD_EXCEPTION

(

OPTION_ALREADY_REGISTERED

)

void SetRegisteringCategory

(

const std::string &

registering_category

)

[inline]

Methods to interact with registered options.

set the registering class. All subsequent options will be added with the registered class

std::string RegisteringCategory

(

)

[inline]

retrieve the value of the current registering category

void AddNumberOption	(	const std::string &	name,
		const std::string &	short_description,
		Number	default_value,
		const std::string &	long_description = ""
	)

Add a Number option (with no restrictions).

References ASSERT_EXCEPTION, and Ipopt::OT_Number.

void AddLowerBoundedNumberOption	(	const std::string &	name,
		const std::string &	short_description,
		Number	lower,
		bool	strict,
		Number	default_value,
		const std::string &	long_description = ""
	)

Add a Number option (with a lower bound).

References ASSERT_EXCEPTION, and Ipopt::OT_Number.

void AddUpperBoundedNumberOption	(	const std::string &	name,
		const std::string &	short_description,
		Number	upper,
		bool	strict,
		Number	default_value,
		const std::string &	long_description = ""
	)

Add a Number option (with a upper bound).

References ASSERT_EXCEPTION, and Ipopt::OT_Number.

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 = ""
	)

Add a Number option (with a both bounds).

References ASSERT_EXCEPTION, and Ipopt::OT_Number.

void AddIntegerOption	(	const std::string &	name,
		const std::string &	short_description,
		Index	default_value,
		const std::string &	long_description = ""
	)

Add a Integer option (with no restrictions).

References ASSERT_EXCEPTION, and Ipopt::OT_Integer.

void AddLowerBoundedIntegerOption	(	const std::string &	name,
		const std::string &	short_description,
		Index	lower,
		Index	default_value,
		const std::string &	long_description = ""
	)

Add a Integer option (with a lower bound).

References ASSERT_EXCEPTION, and Ipopt::OT_Integer.

void AddUpperBoundedIntegerOption	(	const std::string &	name,
		const std::string &	short_description,
		Index	upper,
		Index	default_value,
		const std::string &	long_description = ""
	)

Add a Integer option (with a upper bound).

References ASSERT_EXCEPTION, and Ipopt::OT_Integer.

void AddBoundedIntegerOption	(	const std::string &	name,
		const std::string &	short_description,
		Index	lower,
		Index	upper,
		Index	default_value,
		const std::string &	long_description = ""
	)

Add a Integer option (with a both bounds).

References ASSERT_EXCEPTION, and Ipopt::OT_Integer.

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 = ""
	)

Add a String option (with no restrictions).

References ASSERT_EXCEPTION, DBG_ASSERT, fkinkryx::i, and Ipopt::OT_String.

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 = ""
	)

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

References ASSERT_EXCEPTION, and Ipopt::OT_String.

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 = ""
	)

Methods to interact with registered options.

set the registering class. All subsequent options will be added with the registered class

References ASSERT_EXCEPTION, and Ipopt::OT_String.

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 = ""
	)

Methods to interact with registered options.

set the registering class. All subsequent options will be added with the registered class

References ASSERT_EXCEPTION, and Ipopt::OT_String.

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 = ""
	)

Methods to interact with registered options.

set the registering class. All subsequent options will be added with the registered class

References ASSERT_EXCEPTION, and Ipopt::OT_String.

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 = ""
	)

Methods to interact with registered options.

set the registering class. All subsequent options will be added with the registered class

References ASSERT_EXCEPTION, and Ipopt::OT_String.

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 = ""
	)

Methods to interact with registered options.

set the registering class. All subsequent options will be added with the registered class

References ASSERT_EXCEPTION, and Ipopt::OT_String.

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 = ""
	)

Methods to interact with registered options.

set the registering class. All subsequent options will be added with the registered class

References ASSERT_EXCEPTION, and Ipopt::OT_String.

SmartPtr< const RegisteredOption > GetOption

(

const std::string &

name

)

Get a registered option - this will return NULL if the option does not exist.

References Ipopt::ConstPtr().

void OutputOptionDocumentation	(	const Journalist &	jnlst,
		std::list< std::string > &	categories
	)

Output documentation for the options - gives a description, etc.

References fkinkryx::i, Ipopt::J_DOCUMENTATION, Ipopt::J_SUMMARY, and Journalist::Printf().

void OutputLatexOptionDocumentation	(	const Journalist &	jnlst,
		std::list< std::string > &	categories
	)

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

References DBG_ASSERT, and Ipopt::IsValid().

---

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

• IpRegOptions.hpp
• IpRegOptions.cpp