Evocosm - A C++ Framework for Evolutionary Computing

Main Index

Created by Scott Robert Ladd at Coyote Gulch Productions.


Public Member Functions | List of all members
libevocosm::listener_stdout Class Reference

An listener implementation that ignores all events. More...

#include <evocommon.h>

Inheritance diagram for libevocosm::listener_stdout:
libevocosm::listener

Public Member Functions

virtual void ping_generation_begin (size_t a_generation_number)
 Ping that a generation begins. More...
 
virtual void ping_generation_end (size_t a_generation_number)
 Ping that a generation ends. More...
 
virtual void ping_population_begin (size_t a_population_number)
 Ping that a population begins. More...
 
virtual void ping_population_end (size_t a_population_number)
 Ping that a population ends. More...
 
virtual void ping_fitness_test_begin (size_t a_organism_number)
 Ping that a test run begins. More...
 
virtual void ping_fitness_test_end (size_t a_organism_number)
 Ping that a test run ends. More...
 
virtual void report (const std::string &a_text)
 Report non-specific text. More...
 
virtual void report_error (const std::string &a_text)
 Send error message. More...
 
virtual void run_complete ()
 Evocosm is finished. More...
 
virtual void yield ()
 Yield. More...
 

Detailed Description

This listener displays information about events to stdout (standard ouput).

Member Function Documentation

virtual void libevocosm::listener_stdout::ping_fitness_test_begin ( size_t  a_organism_number)
inlinevirtual

Ping that fitness testing of an organism begins.

Parameters
a_organism_numberOne-based number of the organism

Implements libevocosm::listener.

virtual void libevocosm::listener_stdout::ping_fitness_test_end ( size_t  a_organism_number)
inlinevirtual

Ping that processing a generation has ended.

Parameters
a_organism_numberOne-based number of the organism

Implements libevocosm::listener.

virtual void libevocosm::listener_stdout::ping_generation_begin ( size_t  a_generation_number)
inlinevirtual

Ping that processing a generation begins.

Parameters
a_generation_numberOne-based number of the generation begun

Implements libevocosm::listener.

virtual void libevocosm::listener_stdout::ping_generation_end ( size_t  a_generation_number)
inlinevirtual

Ping that processing a generation has ended.

Parameters
a_generation_numberOne-based number of the generation ended

Implements libevocosm::listener.

virtual void libevocosm::listener_stdout::ping_population_begin ( size_t  a_population_number)
inlinevirtual

Ping that processing a population begins.

Parameters
a_population_numberOne-based number of the population begun

Implements libevocosm::listener.

virtual void libevocosm::listener_stdout::ping_population_end ( size_t  a_population_number)
inlinevirtual

Ping that processing a population has ended.

Parameters
a_population_numberOne-based number of the population ended

Implements libevocosm::listener.

virtual void libevocosm::listener_stdout::report ( const std::string &  a_text)
inlinevirtual

This event provide status text specific to a given type of evocosm. The base evocosm class does not call this function. The intention is that this function will be called from classes derived from evocosm to report progress, statistics, or other useful information.

Parameters
a_textApplication-specific text

Implements libevocosm::listener.

virtual void libevocosm::listener_stdout::report_error ( const std::string &  a_text)
inlinevirtual

This event provides error text specific to a given type of evocosm. The base evocosm class does not call this function. The intention is that this function will be called from classes derived from evocosm to report problems.

Parameters
a_textApplication-specific error text

Implements libevocosm::listener.

virtual void libevocosm::listener_stdout::run_complete ( )
inlinevirtual

Invoked when an evocosm finishes all processing. This way God can rest on the seventh day.

Implements libevocosm::listener.

virtual void libevocosm::listener_stdout::yield ( )
inlinevirtual

Evocosm periodically invokes this function to allow other processes to run. In most cases, this will be some sort of platform-specific sleep function, such as usleep.

Implements libevocosm::listener.


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

© 1996-2005 Scott Robert Ladd. All rights reserved.
HTML documentation generated by Dimitri van Heesch's excellent Doxygen tool.