Ipopt::Journal Class Reference

Journal class (part of the Journalist implementation.). More...

#include <IpJournalist.hpp>

Inheritance diagram for Ipopt::Journal:

Public Member Functions
	Journal (const std::string &name, EJournalLevel default_level)
	Constructor.
virtual	~Journal ()
	Destructor.
virtual std::string	Name ()
	Get the name of the Journal.
virtual void	SetPrintLevel (EJournalCategory category, EJournalLevel level)
	Set the print level for a particular category.
virtual void	SetAllPrintLevels (EJournalLevel level)
	Set the print level for all category.
Journal Output Methods.
These methods are called by the Journalist who first checks if the output print level and category are acceptable. Calling the Print methods explicitly (instead of through the Journalist will output the message regardless of print level and category. You should use the Journalist to print & flush instead
virtual bool	IsAccepted (EJournalCategory category, EJournalLevel level) const
	Ask if a particular print level/category is accepted by the journal.
virtual void	Print (EJournalCategory category, EJournalLevel level, const char *str)
	Print to the designated output location.
virtual void	Printf (EJournalCategory category, EJournalLevel level, const char *pformat, va_list ap)
	Printf to the designated output location.
virtual void	FlushBuffer ()
	Flush output buffer.
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

Protected Member Functions
Implementation version of Print methods.
Derived classes should overload the Impl methods.
virtual void	PrintImpl (EJournalCategory category, EJournalLevel level, const char *str)=0
	Print to the designated output location.
virtual void	PrintfImpl (EJournalCategory category, EJournalLevel level, const char *pformat, va_list ap)=0
	Printf to the designated output location.
virtual void	FlushBufferImpl ()=0
	Flush output buffer.

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.
	Journal ()
	Default Constructor.
	Journal (const Journal &)
	Copy Constructor.
void	operator= (const Journal &)
	Default Assignment Operator.

Private Attributes
std::string	name_
	Name of the output location.
Index	print_levels_ [J_LAST_CATEGORY]
	vector of integers indicating the level for each category

Detailed Description

Journal class (part of the Journalist implementation.).

This class is the base class for all Journals. It controls the acceptance criteria for print statements etc. Derived classes like the FileJournal - output those messages to specific locations

Definition at line 283 of file IpJournalist.hpp.

Constructor & Destructor Documentation

Journal() [1/3]

Ipopt::Journal::Journal	(	const std::string &	name,
		EJournalLevel	default_level
	)

Constructor.

~Journal()

virtual Ipopt::Journal::~Journal ( )

virtual

Destructor.

Journal() [2/3]

Ipopt::Journal::Journal ( )

private

Default Constructor.

Journal() [3/3]

Ipopt::Journal::Journal ( const Journal &  )

private

Copy Constructor.

Member Function Documentation

Name()

virtual std::string Ipopt::Journal::Name ( )

virtual

Get the name of the Journal.

SetPrintLevel()

virtual void Ipopt::Journal::SetPrintLevel ( EJournalCategory  category, EJournalLevel  level  )

virtual

Set the print level for a particular category.

SetAllPrintLevels()

virtual void Ipopt::Journal::SetAllPrintLevels ( EJournalLevel  level )

virtual

Set the print level for all category.

IsAccepted()

virtual bool Ipopt::Journal::IsAccepted ( EJournalCategory  category, EJournalLevel  level  ) const

virtual

Ask if a particular print level/category is accepted by the journal.

Print()

virtual void Ipopt::Journal::Print ( EJournalCategory  category, EJournalLevel  level, const char *  str  )

inlinevirtual

Print to the designated output location.

Definition at line 326 of file IpJournalist.hpp.

Printf()

virtual void Ipopt::Journal::Printf ( EJournalCategory  category, EJournalLevel  level, const char *  pformat, va_list  ap  )

inlinevirtual

Printf to the designated output location.

Definition at line 336 of file IpJournalist.hpp.

FlushBuffer()

virtual void Ipopt::Journal::FlushBuffer ( )

inlinevirtual

Flush output buffer.

Definition at line 347 of file IpJournalist.hpp.

PrintImpl()

virtual void Ipopt::Journal::PrintImpl ( EJournalCategory  category, EJournalLevel  level, const char *  str  )

protectedpure virtual

Print to the designated output location.

Implemented in Ipopt::FileJournal, and Ipopt::StreamJournal.

PrintfImpl()

virtual void Ipopt::Journal::PrintfImpl ( EJournalCategory  category, EJournalLevel  level, const char *  pformat, va_list  ap  )

protectedpure virtual

Printf to the designated output location.

Implemented in Ipopt::FileJournal, and Ipopt::StreamJournal.

FlushBufferImpl()

virtual void Ipopt::Journal::FlushBufferImpl ( )

protectedpure virtual

Flush output buffer.

Implemented in Ipopt::FileJournal, and Ipopt::StreamJournal.

operator=()

void Ipopt::Journal::operator= ( const Journal &  )

private

Default Assignment Operator.

Member Data Documentation

name_

std::string Ipopt::Journal::name_

private

Name of the output location.

Definition at line 404 of file IpJournalist.hpp.

print_levels_

Index Ipopt::Journal::print_levels_[J_LAST_CATEGORY]

private

vector of integers indicating the level for each category

Definition at line 407 of file IpJournalist.hpp.

---

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

• src/Common/IpJournalist.hpp