Ipopt  3.12.11
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Private Attributes | List of all members
Ipopt::StreamJournal Class Reference

StreamJournal class. More...

#include <IpJournalist.hpp>

+ Inheritance diagram for Ipopt::StreamJournal:

Public Member Functions

 StreamJournal (const std::string &name, EJournalLevel default_level)
 Constructor. More...
 
virtual ~StreamJournal ()
 Destructor. More...
 
void SetOutputStream (std::ostream *os)
 Setting the output stream pointer. More...
 
- Public Member Functions inherited from Ipopt::Journal
 Journal (const std::string &name, EJournalLevel default_level)
 Constructor. More...
 
virtual ~Journal ()
 Destructor. More...
 
virtual std::string Name ()
 Get the name of the Journal. More...
 
virtual void SetPrintLevel (EJournalCategory category, EJournalLevel level)
 Set the print level for a particular category. More...
 
virtual void SetAllPrintLevels (EJournalLevel level)
 Set the print level for all category. More...
 
virtual bool IsAccepted (EJournalCategory category, EJournalLevel level) const
 Ask if a particular print level/category is accepted by the journal. More...
 
virtual void Print (EJournalCategory category, EJournalLevel level, const char *str)
 Print to the designated output location. More...
 
virtual void Printf (EJournalCategory category, EJournalLevel level, const char *pformat, va_list ap)
 Printf to the designated output location. More...
 
virtual void FlushBuffer ()
 Flush output buffer. More...
 
- 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 - Overloaded from

Journal base class.

virtual void PrintImpl (EJournalCategory category, EJournalLevel level, const char *str)
 Print to the designated output location. More...
 
virtual void PrintfImpl (EJournalCategory category, EJournalLevel level, const char *pformat, va_list ap)
 Printf to the designated output location. More...
 
virtual void FlushBufferImpl ()
 Flush output buffer. More...
 
Implementation version of Print methods. Derived classes

should overload the Impl methods.

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.

 StreamJournal ()
 Default Constructor. More...
 
 StreamJournal (const StreamJournal &)
 Copy Constructor. More...
 
void operator= (const StreamJournal &)
 Overloaded Equals Operator. More...
 

Private Attributes

std::ostream * os_
 pointer to output stream for the output destination More...
 
char buffer_ [32768]
 buffer for sprintf. More...
 

Detailed Description

StreamJournal class.

This is a particular Journal implementation that writes to a stream for output.

Definition at line 440 of file IpJournalist.hpp.

Constructor & Destructor Documentation

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

Constructor.

virtual Ipopt::StreamJournal::~StreamJournal ( )
inlinevirtual

Destructor.

Definition at line 447 of file IpJournalist.hpp.

Ipopt::StreamJournal::StreamJournal ( )
private

Default Constructor.

Ipopt::StreamJournal::StreamJournal ( const StreamJournal )
private

Copy Constructor.

Member Function Documentation

void Ipopt::StreamJournal::SetOutputStream ( std::ostream *  os)

Setting the output stream pointer.

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

Print to the designated output location.

Implements Ipopt::Journal.

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

Printf to the designated output location.

Implements Ipopt::Journal.

virtual void Ipopt::StreamJournal::FlushBufferImpl ( )
protectedvirtual

Flush output buffer.

Implements Ipopt::Journal.

void Ipopt::StreamJournal::operator= ( const StreamJournal )
private

Overloaded Equals Operator.

Member Data Documentation

std::ostream* Ipopt::StreamJournal::os_
private

pointer to output stream for the output destination

Definition at line 490 of file IpJournalist.hpp.

char Ipopt::StreamJournal::buffer_[32768]
private

buffer for sprintf.

Being generous in size here...

Definition at line 493 of file IpJournalist.hpp.


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