summaryrefslogtreecommitdiff
path: root/SA_POP/LogScreenOut.h
blob: 9ae7322e0ab092a82ff4cef2c87bdcad40ce1e59 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
// -*- C++ -*-
// $Id$

//=============================================================================
/**
 * @file  LogScreenOut.h
 *
 * This file contains the LogScreenOut class definition for the output adapter
 * that displays plan changes on the screen as they occur.
 *
 * @author  John S. Kinnebrew <john.s.kinnebrew@vanderbilt.edu>
 */
//=============================================================================

#ifndef SA_POP_LOG_SCREEN_OUT_H_
#define SA_POP_LOG_SCREEN_OUT_H_

#include <iostream>
#include "OutAdapter.h"

namespace SA_POP {

  /**
   * @class LogScreenOut
   *
   * @brief Output adapter that displays plan changes on the screen as they
   *        occur.
   */
  class LogScreenOut : public OutAdapter {
  public:
    /// Constructor.
    /**
     * @param strm  Output stream to log to.
     */
    LogScreenOut (std::ostream &out);

    /// Destructor.
    virtual ~LogScreenOut (void);

    /// Notify about task future expected utility changes.
    /**
     * @param planner  Planner for which changes have occurred.
     */
    virtual void notify_eu (SA_POP::Planner *planner);

    /// Notify about plan changes.
    /**
     * @param planner  Planner for which changes have occurred.
     */
    virtual void notify_plan (SA_POP::Planner *planner);

  protected:
    /// Output stream to log to.
    std::ostream &out_;
  };

};  /* SA_POP namespace */

#endif /* SA_POP_LOG_SCREEN_OUT_H_ */