text.hh revision 4085 
1/*
2 * Copyright (c) 2004-2005 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Nathan Binkert
29 */
30
31#ifndef __BASE_STATS_TEXT_HH__
32#define __BASE_STATS_TEXT_HH__
33
34#include <iosfwd>
35#include <string>
36
37#include "base/output.hh"
38#include "base/stats/output.hh"
39
40namespace Stats {
41
42class Text : public Output
43{
44  protected:
45    bool mystream;
46    std::ostream *stream;
47
48  protected:
49    bool noOutput(const StatData &data);
50
51  public:
52    bool compat;
53    bool descriptions;
54
55  public:
56    Text();
57    Text(std::ostream &stream);
58    Text(const std::string &file);
59    ~Text();
60
61    void open(std::ostream &stream);
62    void open(const std::string &file);
63
64    // Implement Visit
65    virtual void visit(const ScalarData &data);
66    virtual void visit(const VectorData &data);
67    virtual void visit(const DistData &data);
68    virtual void visit(const VectorDistData &data);
69    virtual void visit(const Vector2dData &data);
70    virtual void visit(const FormulaData &data);
71
72    // Implement Output
73    virtual bool valid() const;
74    virtual void output();
75
76    // Implement Event Output
77    virtual void event(const std::string &event) {}
78};
79
80bool initText(const std::string &filename, bool desc=true, bool compat=true);
81
82/* namespace Stats */ }
83
84#endif // __BASE_STATS_TEXT_HH__
85