---

CdbHistoryEvent.hh

Go to the documentation of this file.

#ifndef CDB_HISTORY_EVENT_HH
#define CDB_HISTORY_EVENT_HH

// File and Version Information:
//      $Id: CdbHistoryEvent.hh,v 1.4 2004/08/06 05:54:14 bartoldu Exp $

#include "BdbTime/BdbTime.hh"

#include "CdbBase/CdbCPtrBase.hh"
#include "CdbBase/CdbHistoryEventPtrFwd.hh"

#include <iostream>

#include <string>

/// The transient interface to history events
/**
  * The constructors of this class are hidden to prevent creating these
  * objects on their own. Only subclasses can call use these methods.
  */
class CdbHistoryEvent {

friend class CdbCPtrBase< CdbHistoryEvent >;   // Who destroys me.

private:

  /// The default constructor (NOT IMPLEMENTED)

    CdbHistoryEvent( );

protected:

  /// The normal constructor.
  /**
    * Initialize local context with specified parameters.
    *
    * @see BdbTime
    */
    CdbHistoryEvent( const BdbTime&     theTimeStamp,   /**< the timestamp when this even happened */
                     const std::string& theTypeName     /**< the name of the event */
                   );

  /// The copy constructor

    CdbHistoryEvent( const CdbHistoryEvent& theEvent );

  /// The assignment operator

    CdbHistoryEvent& operator=( const CdbHistoryEvent& theEvent );

public:

  /// The destructor.

    virtual ~CdbHistoryEvent( );

  /// Return the timestamp when this even happened
  /**
    * @see BdbTime
    */
    BdbTime timeStamp( ) const { return _timestamp; }

  /// Return the type name of the event

    std::string typeName( ) const { return _typeName; }

  /// Dump the contents of an event onto specified stream
  /**
    * This operation will dump the local context of objects of this class.
    * It can be ovverriden by the subclasses.
    * The dump is followed by the end of line.
    */
    virtual void dump( std::ostream& theStream ) const;

private:

    BdbTime     _timestamp;
    std::string _typeName;

};

#endif  // CDB_HISTORY_EVENT_HH

---