LogEntry.h

Go to the documentation of this file.

#ifndef LOGENTRY_H_
#define LOGENTRY_H_

#include "io/InStream.h"
#include "io/OutStream.h"
#include "logger/Logger.h"
#include "utils/Str.h"
#include "utils/Timestamp.h"

class Logger;
class Unit;

class LogEntry
{
public:

    typedef enum
    {
        NOT_LOG_ENTRY =  -1,
        EVENT_LOG_ENTRY =  0,
        DIRECTORY_LOG_ENTRY =  1,
        DATA_LOG_ENTRY =   2,
        SYSLOG_LOG_ENTRY = 3,
    } Type;

    static const int TYPE_MASK = 0x0003;

    virtual ~LogEntry();

    static LogEntry* Read( Timestamp& timeBase, Timespan& timeAdjust, InStream &inStream, Logger& logger );

    virtual unsigned int write( Timestamp& timeBase, OutStream& logStream ) const = 0;

    virtual Str toString( const Unit* unit = NULL ) const = 0;

    const Timestamp& getTimestamp( void ) const
    {
        return timestamp_;
    };

    // Techically I shouldn't allow this but it is needed for the
    // log unserialization
    const Timestamp& setTimestamp( const Timestamp &newTime )
    {
        timestamp_ = newTime;
        return timestamp_;
    };
    const Timestamp& setTimestamp( const double newTime )
    {
        timestamp_ = newTime;
        return timestamp_;
    };

    Type getType( void ) const
    {
        return type_;
    };

    static const char *TypeToString( Type theType );

protected:

    LogEntry( Type myType, const Timestamp& timestamp = Timestamp::NOT_SET_TIME );

    static bool ReadTimestamp( Timestamp& timestamp, bool& changed, InStream& inStream, Logger& logger, Logger::TimePrecisionType timePrecision );

    unsigned int writeTimestamp( const Timestamp& timeBase, bool changed, OutStream & logStream, Logger::TimePrecisionType timePrecision ) const;


    Type type_;

    Timestamp timestamp_;

    static const Str UNKNOWN;

private:
    // Note that the copy constructor below is private and not given a body.
    // Any attempt to call it will return a compiler error.
    LogEntry( const LogEntry& old ); // disallow copy constructor


};

#endif /*LOGENTRY_H_*/