EasyLocal++ Documentation


 
Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

easylocal::OutputManager Class Template Reference

#include <EasyLocal.h>

Collaboration diagram for easylocal::OutputManager:

Collaboration graph
[legend]
List of all members.

Public Methods

  • virtual void OutputState (const State &st, Output &out) const=0
  • virtual void InputState (State &st, const Output &out) const=0
  • virtual void ReadState (State &st, std::istream &is) const
  • virtual void WriteState (const State &st, std::ostream &os) const
  • virtual void Check () const
  • void SetInput (Input *in)
  • Input* GetInput ()

Protected Methods

Protected Attributes


Detailed Description

template<class Input, class Output, class State> class easylocal::OutputManager

The Output Manager is responsible for translating between elements of the search space and output solutions. It also delivers other output information of the search, and stores and retrieves solutions from files. This is the only helper that deals with the Output class. All other helpers work only on the State class, which represents the elements of the search space used by the algorithms.

Definition at line 159 of file EasyLocal.h.


Constructor & Destructor Documentation

template<class Input, class Output, class State>
easylocal::OutputManager<Input, Output, State>::OutputManager<Input, Output, State> ( StateManager< Input, State > * sm,
Input * in = NULL ) [inline, protected]
 

Constructs an output manager by providing it a state manager and an input object.

Parameters:
sm   a pointer to a state manager
in   a pointer to an input object

Definition at line 181 of file EasyLocal.h.


Member Function Documentation

template<class Input, class Output, class State>
void easylocal::OutputManager< Input, Output, State >::Check ( ) const [virtual]
 

Checks wether the object state is consistent with all the related objects.

Definition at line 234 of file EasyLocalTemplates.cpp.

template<class Input, class Output, class State>
Input * easylocal::OutputManager< Input, Output, State >::GetInput ( )
 

Returns the input pointer which the object is attached to.

Returns:
the pointer to the input.

Definition at line 226 of file EasyLocalTemplates.cpp.

template<class Input, class Output, class State>
void easylocal::OutputManager<Input, Output, State>::InputState ( State & st,
const Output & out ) const [pure virtual]
 

Transforms an output object in a state object.

Parameters:
st   the resulting state
out   the output object to transform

Referenced by ReadState().

template<class Input, class Output, class State>
void easylocal::OutputManager<Input, Output, State>::OutputState ( const State & st,
Output & out ) const [pure virtual]
 

Transforms the given state in an output object.

Parameters:
st   the state to transform
out   the corresponding output object.

Referenced by WriteState().

template<class Input, class Output, class State>
void easylocal::OutputManager< Input, Output, State >::ReadState ( State & st,
std::istream & is ) const [virtual]
 

Reads a state from an input stream.

Parameters:
st   the state to be read
is   the input stream

Definition at line 190 of file EasyLocalTemplates.cpp.

template<class Input, class Output, class State>
void easylocal::OutputManager< Input, Output, State >::SetInput ( Input * in )
 

Sets the internal input pointer to the new value passed as parameter.

Parameters:
in   the new input.

Definition at line 217 of file EasyLocalTemplates.cpp.

template<class Input, class Output, class State>
void easylocal::OutputManager< Input, Output, State >::WriteState ( const State & st,
std::ostream & os ) const [virtual]
 

Writes a state on an output stream.

Parameters:
st   the state to be written,
os   the output stream

Definition at line 204 of file EasyLocalTemplates.cpp.


Member Data Documentation

template<class Input, class Output, class State>
Input * easylocal::OutputManager<Input, Output, State>::p_in [protected]
 

A pointer to an input object.

Definition at line 185 of file EasyLocal.h.

template<class Input, class Output, class State>
StateManager< Input, State > * easylocal::OutputManager<Input, Output, State>::p_sm [protected]
 

A pointer to an attached state manager.

Definition at line 183 of file EasyLocal.h.


The documentation for this class was generated from the following files:
 
Go to: the Main Page of the documentation.