Ipopt::AmplOptionsList Class Reference

Class for storing a number of AMPL options that should be registered to the AMPL Solver library interface. More...

#include <AmplTNLP.hpp>

Inheritance diagram for Ipopt::AmplOptionsList:

[legend]

Collaboration diagram for Ipopt::AmplOptionsList:

[legend]

List of all members.

Classes
class	AmplOption
	Ampl Option class, contains name, type and description for an AMPL option. More...
class	PrivatInfo
Public Types
enum	AmplOptionType {   String_Option, Number_Option, Integer_Option, WS_Option,   HaltOnError_Option }
Public Member Functions
	AmplOptionsList ()
	Default Constructor.
	~AmplOptionsList ()
	Destructor.
void	AddAmplOption (const std::string ampl_option_name, const std::string ipopt_option_name, AmplOptionsList::AmplOptionType type, const std::string description)
	Adding a new AMPL Option.
Index	NumberOfAmplOptions ()
	Number of AMPL Options.
void *	Keywords (const SmartPtr< OptionsList > &options, SmartPtr< const Journalist > jnlst, void **nerror)
	ASL keywords list for the stored options.
Private Member Functions
Default Compiler Generated Methods
(Hidden to avoid implicit creation/calling). These methods are not implemented and we do not want the compiler to implement them for us, so we declare them private and do not define them. This ensures that they will not be implicitly created/called.
	AmplOptionsList (const AmplOptionsList &)
	Default Constructor.
void	operator= (const AmplOptionsList &)
	Overloaded Equals Operator.
Private Attributes
std::map< std::string, SmartPtr< const AmplOption > >	ampl_options_map_
	map for storing registered AMPL options
void *	keywds_
	pointer to the keywords
Index	nkeywds_
	Number of entries stored in keywds_.

---

Detailed Description

Class for storing a number of AMPL options that should be registered to the AMPL Solver library interface.

Definition at line 109 of file AmplTNLP.hpp.

---

Member Enumeration Documentation

enum Ipopt::AmplOptionsList::AmplOptionType

Enumerator:

String_Option
Number_Option
Integer_Option
WS_Option
HaltOnError_Option

Definition at line 112 of file AmplTNLP.hpp.

---

Constructor & Destructor Documentation

Ipopt::AmplOptionsList::AmplOptionsList

(

)

[inline]

Default Constructor.

Definition at line 215 of file AmplTNLP.hpp.

Ipopt::AmplOptionsList::~AmplOptionsList

(

)

Destructor.

Ipopt::AmplOptionsList::AmplOptionsList

(

const AmplOptionsList &

)

[private]

Default Constructor.

Copy Constructor

---

Member Function Documentation

void Ipopt::AmplOptionsList::AddAmplOption	(	const std::string	ampl_option_name,
		const std::string	ipopt_option_name,
		AmplOptionsList::AmplOptionType	type,
		const std::string	description
	)			[inline]

Adding a new AMPL Option.

Definition at line 225 of file AmplTNLP.hpp.

Index Ipopt::AmplOptionsList::NumberOfAmplOptions

(

)

[inline]

Number of AMPL Options.

Definition at line 236 of file AmplTNLP.hpp.

void* Ipopt::AmplOptionsList::Keywords	(	const SmartPtr< OptionsList > &	options,
		SmartPtr< const Journalist >	jnlst,
		void **	nerror
	)

ASL keywords list for the stored options.

void Ipopt::AmplOptionsList::operator=

(

const AmplOptionsList &

)

[private]

Overloaded Equals Operator.

---

Member Data Documentation

std::map<std::string, SmartPtr<const AmplOption> > Ipopt::AmplOptionsList::ampl_options_map_ [private]

map for storing registered AMPL options

Definition at line 266 of file AmplTNLP.hpp.

void* Ipopt::AmplOptionsList::keywds_ [private]

pointer to the keywords

Definition at line 272 of file AmplTNLP.hpp.

Index Ipopt::AmplOptionsList::nkeywds_ [private]

Number of entries stored in keywds_.

Definition at line 275 of file AmplTNLP.hpp.

---

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

• /home/coin/svn-release/OptimizationSuite-1.1.0/Ipopt/src/Apps/AmplSolver/AmplTNLP.hpp