Ipopt::RegisteredCategory Class Reference

A category of registered options. More...

#include <IpRegOptions.hpp>

Inheritance diagram for Ipopt::RegisteredCategory:

Classes
class	ComparePriority

Public Member Functions
	RegisteredCategory (const std::string &name, int priority)
	Constructor.
const std::string &	Name () const
	name of category
IPOPT_DEPRECATED	operator const std::string & () const
	name of category
IPOPT_DEPRECATED bool	operator!= (const std::string &other) const
	compare with string
IPOPT_DEPRECATED bool	operator== (const std::string &other) const
	compare with string
IPOPT_DEPRECATED bool	operator< (const RegisteredCategory &other) const
	compare two categories
int	Priority () const
	priority of category
const std::list< SmartPtr< RegisteredOption > > &	RegisteredOptions () const
	gives list of options in this category
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
	RegisteredCategory ()
	unimplemented default constructor
	RegisteredCategory (const RegisteredCategory &)
	unimplemented copy constructor
RegisteredCategory &	operator= (const RegisteredCategory &)
	unimplemented assignment operator

Private Attributes
std::string	name_
	name of category
int	priority_
	priority of category (used to decide whether to print and printing order)
std::list< SmartPtr< RegisteredOption > >	regoptions_
	options of this category

Friends
class	RegisteredOptions

Detailed Description

A category of registered options.

Since

3.14.0

Definition at line 36 of file IpRegOptions.hpp.

Constructor & Destructor Documentation

RegisteredCategory() [1/3]

Ipopt::RegisteredCategory::RegisteredCategory ( const std::string &  name, int  priority  )

inline

Constructor.

Use negative value for priority to suppress it being included in documentation.

Definition at line 43 of file IpRegOptions.hpp.

RegisteredCategory() [2/3]

Ipopt::RegisteredCategory::RegisteredCategory ( )

private

unimplemented default constructor

RegisteredCategory() [3/3]

Ipopt::RegisteredCategory::RegisteredCategory ( const RegisteredCategory &  )

private

unimplemented copy constructor

Member Function Documentation

Name()

const std::string & Ipopt::RegisteredCategory::Name ( ) const

inline

name of category

Definition at line 52 of file IpRegOptions.hpp.

operator const std::string &()

IPOPT_DEPRECATED Ipopt::RegisteredCategory::operator const std::string & ( ) const

inline

name of category

This one is for backward-compatibility with previous Ipopt versions where RegisteredCategory was a string.

Deprecated:

Use Name() instead.

Definition at line 62 of file IpRegOptions.hpp.

operator!=()

IPOPT_DEPRECATED bool Ipopt::RegisteredCategory::operator!= ( const std::string &  other ) const

inline

compare with string

This one is for backward-compatibility with previous Ipopt versions where RegisteredCategory was a string.

Deprecated:

Use Name() and string comparison instead.

Definition at line 72 of file IpRegOptions.hpp.

operator==()

IPOPT_DEPRECATED bool Ipopt::RegisteredCategory::operator== ( const std::string &  other ) const

inline

compare with string

This one is for backward-compatibility with previous Ipopt versions where RegisteredCategory was a string.

Deprecated:

Use Name() and string comparison instead.

Definition at line 84 of file IpRegOptions.hpp.

operator<()

IPOPT_DEPRECATED bool Ipopt::RegisteredCategory::operator< ( const RegisteredCategory &  other ) const

inline

compare two categories

This one is for backward-compatibility with previous Ipopt versions where RegisteredCategory was a string.

Deprecated:

Use Name() and string comparison on them instead.

Definition at line 96 of file IpRegOptions.hpp.

Priority()

int Ipopt::RegisteredCategory::Priority ( ) const

inline

priority of category

Definition at line 104 of file IpRegOptions.hpp.

RegisteredOptions()

const std::list< SmartPtr< RegisteredOption > > & Ipopt::RegisteredCategory::RegisteredOptions ( ) const

inline

gives list of options in this category

Definition at line 110 of file IpRegOptions.hpp.

operator=()

RegisteredCategory & Ipopt::RegisteredCategory::operator= ( const RegisteredCategory &  )

private

unimplemented assignment operator

Friends And Related Symbol Documentation

RegisteredOptions

friend class RegisteredOptions

friend

Definition at line 38 of file IpRegOptions.hpp.

Member Data Documentation

name_

std::string Ipopt::RegisteredCategory::name_

private

name of category

Definition at line 139 of file IpRegOptions.hpp.

priority_

int Ipopt::RegisteredCategory::priority_

private

priority of category (used to decide whether to print and printing order)

Definition at line 142 of file IpRegOptions.hpp.

regoptions_

std::list<SmartPtr<RegisteredOption> > Ipopt::RegisteredCategory::regoptions_

private

options of this category

Definition at line 145 of file IpRegOptions.hpp.

---

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

• src/Common/IpRegOptions.hpp