source: rtems-testing/rtems-coverage/TraceWriterBase.h @ 2a95fde

4.11
Last change on this file since 2a95fde was 2a95fde, checked in by Jennifer Averett <Jennifer.Averett@…>, on Apr 23, 2010 at 6:57:18 PM

2010-04-23 Jennifer Averett <Jennifer.Averett@…

  • Property mode set to 100644
File size: 1.1 KB
Line 
1/*
2 *  $Id$
3 */
4
5/*! @file TraceWiterBase.h
6 *  @brief TraceWriterBase Specification
7 *
8 *  This file contains the specification of the TraceWriterBase class.
9 */
10
11#ifndef __TRACE_WRITER_BASE_H__
12#define __TRACE_WRITER_BASE_H__
13
14#include <stdint.h>
15#include "TraceReaderBase.h"
16
17namespace Trace {
18
19  /*! @class TraceWriterBase
20   *
21   *  This is the specification of the TraceWriter base class.
22   *  All TraceWriter implementations inherit from this class.
23   */
24  class TraceWriterBase {
25
26  public:
27
28    /*!
29     *  This method constructs a TraceWriterBase instance.
30     */
31    TraceWriterBase();
32
33    /*!
34     *  This method destructs a TraceWriterBase instance.
35     */
36    virtual ~TraceWriterBase();
37
38    /*!
39     *  This method writes the specified @a trace file.
40     *
41     *  @param[in] file specifies the name of the file to write
42     *  @param[in] log structure where the trace data was read into
43     *
44     *  @return Returns TRUE if the method succeeded and FALSE if it failed.
45     */
46     virtual bool writeFile(
47       const char* const          file,
48       Trace::TraceReaderBase    *log
49     ) =  0;
50  };
51
52}
53#endif
Note: See TracBrowser for help on using the repository browser.