IOVEditor.h

Go to the documentation of this file.

#ifndef CondCore_IOVService_IOVEditor_h
#define CondCore_IOVService_IOVEditor_h

#include "CondCore/IOVService/interface/IOVProxy.h"

#include "CondCore/DBCommon/interface/Time.h"
#include "CondFormats/Common/interface/IOVSequence.h"

//
// Package:     CondCore/IOVService
// Class  :     IOVEditor
//
//
// Author:      Zhen Xie
// Fixes and other changes: Giacomo Govi
//

namespace cond{

  class IOVElement;
  class IOVSequence;

  class IOVImportIterator {
  public:
    explicit IOVImportIterator( boost::shared_ptr<cond::IOVProxyData>& destIov );

    virtual ~IOVImportIterator();

    void setUp( cond::IOVProxy& sourceIov, cond::Time_t since, cond::Time_t till, bool outOfOrder, size_t bulkSize = 1 );

    void setUp( cond::DbSession& sourceSess, const std::string& sourceIovToken, cond::Time_t since, cond::Time_t till,
        bool outOfOrder, size_t bulkSize = 1 );

    void setUp( cond::IOVProxy& sourceIov, size_t bulkSize = 1 );

    void setUp( cond::DbSession& sourceSess, const std::string& sourceIovToken, size_t bulkSize = 1 );

    bool hasMoreElements();

    size_t importMoreElements();

    size_t importAll();

  private:
    cond::IOVProxy m_sourceIov;
    boost::shared_ptr<cond::IOVProxyData> m_destIov;
    cond::Time_t m_lastSince;
    size_t m_bulkSize;
    IOVSequence::const_iterator m_cursor;
    IOVSequence::const_iterator m_till;
  };

  class IOVEditor{
  public:

    // default constructor
    explicit IOVEditor(cond::DbSession& dbSess);

    // constructor from existing iov
    IOVEditor( cond::DbSession& dbSess, const std::string& token);
 
    ~IOVEditor();

    void reload();

    void load( const std::string& token );

    bool createIOVContainerIfNecessary();

    // create empty default sequence
    std::string create( cond::TimeType timetype );

    // create empty sequence with fixed time boundary
    std::string create(cond::TimeType timetype, cond::Time_t lastTill, const std::string& metadata );

    // ####### TO BE REOMOVED ONLY USED IN TESTS
    std::string create(cond::TimeType timetype, cond::Time_t lastTill );

    unsigned int insert( cond::Time_t tillTime, const std::string& payloadToken );

    unsigned int append(  cond::Time_t sinceTime, const std::string& payloadToken );

    unsigned int freeInsert( cond::Time_t sinceTime, const std::string& payloadToken );

    void bulkAppend( std::vector< std::pair<cond::Time_t, std::string > >& values );

    void bulkAppend(std::vector< cond::IOVElement >& values);
    
    //stamp iov
    void stamp(std::string const & icomment, bool append=false);

    void editMetadata( std::string const & metadata, bool append=false);

    void setScope( cond::IOVSequence::ScopeType scope );

    void updateClosure( cond::Time_t newtillTime );

    // remove last entry
    unsigned int truncate(bool withPayload=false);

    // delete all entries
    void deleteEntries( bool withPayload=false);

    // 
    size_t import( cond::DbSession& sourceSess, const std::string& sourceIovToken );

    // 
    boost::shared_ptr<IOVImportIterator> importIterator();

    TimeType timetype() const;

    std::string const & token() const; 

    cond::IOVProxy proxy();

  private:

    bool validTime(cond::Time_t time, cond::TimeType timetype) const;
    bool validTime(cond::Time_t time) const;

    void debugInfo(std::ostream & co) const;
    void reportError(std::string message) const;
    void reportError(std::string message, cond::Time_t time) const;

  private:

    bool m_isLoaded;
    boost::shared_ptr<cond::IOVProxyData> m_iov;
  };
}//ns cond
#endif