The SKIRT project
advanced radiative transfer for astrophysics
Public Member Functions | Protected Member Functions | List of all members
ConsoleLog Class Reference

#include <ConsoleLog.hpp>

Inheritance diagram for ConsoleLog:
Inheritance graph
[legend]

Public Member Functions

 ConsoleLog ()
 
 ConsoleLog (SimulationItem *parent)
 
- Public Member Functions inherited from Log
void error (string message, bool store=true)
 
vector< string > errorsIssued ()
 
void info (string message)
 
void infoIfElapsed (string message, size_t numDone)
 
void infoSetElapsed (size_t numTotal, int seconds=5)
 
LoglinkedLog () const
 
Level lowestLevel () const
 
bool memoryLogging () const
 
void setLinkedLog (Log *log)
 
void setLowestLevel (Level level)
 
void setMemoryLogging (bool value)
 
void setVerbose (bool value)
 
void success (string message)
 
bool verbose () const
 
void warning (string message, bool store=true)
 
vector< string > warningsIssued ()
 
- Public Member Functions inherited from SimulationItem
template<class T >
T * find (bool setup=true) const
 
template<class T >
T * interface (int levels=-999999, bool setup=true) const
 
virtual string itemName () const
 
void setup ()
 
string typeAndName () const
 
- Public Member Functions inherited from Item
 Item (const Item &)=delete
 
virtual ~Item ()
 
void addChild (Item *child)
 
const vector< Item * > & children () const
 
virtual void clearItemListProperty (const PropertyDef *property)
 
void destroyChild (Item *child)
 
virtual bool getBoolProperty (const PropertyDef *property) const
 
virtual vector< double > getDoubleListProperty (const PropertyDef *property) const
 
virtual double getDoubleProperty (const PropertyDef *property) const
 
virtual string getEnumProperty (const PropertyDef *property) const
 
virtual int getIntProperty (const PropertyDef *property) const
 
virtual vector< Item * > getItemListProperty (const PropertyDef *property) const
 
virtual ItemgetItemProperty (const PropertyDef *property) const
 
virtual string getStringProperty (const PropertyDef *property) const
 
int getUtilityProperty (string name) const
 
virtual void insertIntoItemListProperty (const PropertyDef *property, int index, Item *item)
 
Itemoperator= (const Item &)=delete
 
Itemparent () const
 
virtual void removeFromItemListProperty (const PropertyDef *property, int index)
 
virtual void setBoolProperty (const PropertyDef *property, bool value)
 
virtual void setDoubleListProperty (const PropertyDef *property, vector< double > value)
 
virtual void setDoubleProperty (const PropertyDef *property, double value)
 
virtual void setEnumProperty (const PropertyDef *property, string value)
 
virtual void setIntProperty (const PropertyDef *property, int value)
 
virtual void setItemProperty (const PropertyDef *property, Item *item)
 
virtual void setStringProperty (const PropertyDef *property, string value)
 
void setUtilityProperty (string name, int value)
 
virtual string type () const
 

Protected Member Functions

void output (string message, Level level) override
 
- Protected Member Functions inherited from Log
 Log ()
 
virtual void output (string message, Level level)=0
 
string processName ()
 
void setupSelfBefore () override
 
- Protected Member Functions inherited from SimulationItem
 SimulationItem ()
 
virtual bool offersInterface (const std::type_info &interfaceTypeInfo) const
 
virtual void setupSelfAfter ()
 
virtual void setupSelfBefore ()
 
- Protected Member Functions inherited from Item
 Item ()
 

Additional Inherited Members

- Public Types inherited from Log
enum class  Level { Info , Warning , Success , Error }
 

Detailed Description

ConsoleLog inherits from Log and implements logging to the standard console. All ConsoleLog instances share the same underlying console device. It is safe to mix multiple instances. The output() function in this class is thread-safe.

Constructor & Destructor Documentation

◆ ConsoleLog() [1/2]

ConsoleLog::ConsoleLog ( )

This constructor creates a standalone console log object that is not hooked into a simulation item hierarchy; the caller is responsible for its destruction. The setup() function is not called by this constructor. The standalone object can be used without further setup, however the generated messages will contain no multiprocessing information (such as the process rank) until after setup() has been called.

◆ ConsoleLog() [2/2]

ConsoleLog::ConsoleLog ( SimulationItem parent)
explicit

This constructor creates a console log object that is hooked up as a child to the specified parent in the simulation hierarchy, so that it will automatically be deleted. The setup() function is not called by this constructor.

Member Function Documentation

◆ output()

void ConsoleLog::output ( string  message,
Level  level 
)
overrideprotectedvirtual

This function outputs a message to the console, colored and annotated according to the specified logging level. It overrides the pure virtual function in the base class. This function is thread-safe.

Implements Log.


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