Ipopt Documentation  
 
Loading...
Searching...
No Matches
Ipopt::AmplOptionsList::AmplOption Class Reference

Ampl Option class containing name, type and description for an AMPL option. More...

#include <AmplTNLP.hpp>

+ Inheritance diagram for Ipopt::AmplOptionsList::AmplOption:

Public Member Functions

 AmplOption (const std::string &ipopt_option_name, AmplOptionType type, const std::string &description)
 
 ~AmplOption ()
 
const std::string & IpoptOptionName () const
 
AmplOptionType Type () const
 
charDescription () const
 
- 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
 

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.

 AmplOption ()
 Default Constructor.
 
 AmplOption (const AmplOption &)
 Copy Constructor.
 
void operator= (const AmplOption &)
 Default Assignment Operator.
 

Private Attributes

const std::string ipopt_option_name_
 
const AmplOptionType type_
 
chardescription_
 

Detailed Description

Ampl Option class containing name, type and description for an AMPL option.

Definition at line 139 of file AmplTNLP.hpp.

Constructor & Destructor Documentation

◆ AmplOption() [1/3]

Ipopt::AmplOptionsList::AmplOption::AmplOption ( const std::string &  ipopt_option_name,
AmplOptionType  type,
const std::string &  description 
)

◆ ~AmplOption()

Ipopt::AmplOptionsList::AmplOption::~AmplOption ( )
inline

Definition at line 147 of file AmplTNLP.hpp.

◆ AmplOption() [2/3]

Ipopt::AmplOptionsList::AmplOption::AmplOption ( )
private

Default Constructor.

◆ AmplOption() [3/3]

Ipopt::AmplOptionsList::AmplOption::AmplOption ( const AmplOption )
private

Copy Constructor.

Member Function Documentation

◆ IpoptOptionName()

const std::string & Ipopt::AmplOptionsList::AmplOption::IpoptOptionName ( ) const
inline

Definition at line 152 of file AmplTNLP.hpp.

◆ Type()

AmplOptionType Ipopt::AmplOptionsList::AmplOption::Type ( ) const
inline

Definition at line 156 of file AmplTNLP.hpp.

◆ Description()

char * Ipopt::AmplOptionsList::AmplOption::Description ( ) const
inline

Definition at line 160 of file AmplTNLP.hpp.

◆ operator=()

void Ipopt::AmplOptionsList::AmplOption::operator= ( const AmplOption )
private

Default Assignment Operator.

Member Data Documentation

◆ ipopt_option_name_

const std::string Ipopt::AmplOptionsList::AmplOption::ipopt_option_name_
private

Definition at line 187 of file AmplTNLP.hpp.

◆ type_

const AmplOptionType Ipopt::AmplOptionsList::AmplOption::type_
private

Definition at line 188 of file AmplTNLP.hpp.

◆ description_

char* Ipopt::AmplOptionsList::AmplOption::description_
private

Definition at line 189 of file AmplTNLP.hpp.


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