diff options
Diffstat (limited to 'tester/covoar/TraceWriterBase.h')
-rw-r--r-- | tester/covoar/TraceWriterBase.h | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/tester/covoar/TraceWriterBase.h b/tester/covoar/TraceWriterBase.h new file mode 100644 index 0000000..2d27d04 --- /dev/null +++ b/tester/covoar/TraceWriterBase.h @@ -0,0 +1,49 @@ +/*! @file TraceWriterBase.h + * @brief TraceWriterBase Specification + * + * This file contains the specification of the TraceWriterBase class. + */ + +#ifndef __TRACE_WRITER_BASE_H__ +#define __TRACE_WRITER_BASE_H__ + +#include <stdint.h> +#include "TraceReaderBase.h" + +namespace Trace { + + /*! @class TraceWriterBase + * + * This is the specification of the TraceWriter base class. + * All TraceWriter implementations inherit from this class. + */ + class TraceWriterBase { + + public: + + /*! + * This method constructs a TraceWriterBase instance. + */ + TraceWriterBase(); + + /*! + * This method destructs a TraceWriterBase instance. + */ + virtual ~TraceWriterBase(); + + /*! + * This method writes the specified @a trace file. + * + * @param[in] file specifies the name of the file to write + * @param[in] log structure where the trace data was read into + * + * @return Returns TRUE if the method succeeded and FALSE if it failed. + */ + virtual bool writeFile( + const char* const file, + Trace::TraceReaderBase *log + ) = 0; + }; + +} +#endif |