IOVSequence.h

Go to the documentation of this file.

#ifndef Cond_IOVSequence_h
#define Cond_IOVSequence_h

#include "CondFormats/Common/interface/UpdateStamp.h"
#include "CondFormats/Common/interface/IOVElement.h"
#include "CondFormats/Common/interface/Time.h"
#include "CondFormats/Common/interface/IOVProvenance.h"
#include "CondFormats/Common/interface/IOVDescription.h"
#include "CondFormats/Common/interface/IOVUserMetaData.h"

#include "CondCore/ORA/interface/QueryableVector.h"

#include <vector>
#include <string>
#include <set>

namespace cond {

  class IOVSequence : public  UpdateStamp{
  public:
    typedef cond::IOVElement Item;
    typedef ora::QueryableVector<Item> Container;
    typedef Container::iterator iterator;
    typedef Container::const_iterator const_iterator;
    typedef enum { Unknown=-1, Obsolete, Tag, TagInGT, ChildTag, ChildTagInGT } ScopeType;

    IOVSequence();

    // the real default constructor...
    explicit IOVSequence( cond::TimeType ttype );

    // constructor for the editor
    IOVSequence(int type, cond::Time_t till, std::string const& imetadata);

    ~IOVSequence();

    IOVSequence(IOVSequence const & rh);
    IOVSequence & operator=(IOVSequence const & rh);

    // append a new item, return position of last inserted entry
    size_t add(cond::Time_t time, std::string const & token, std::string const& payloadClassName );

    // remove last entry, return position of last entry still valid
    size_t truncate();
    
    // find IOV for which time is valid (this is not STANDARD std::find!)
    const_iterator find(cond::Time_t time) const;

    // find IOV with a given since  (this is not STANDARD std::find!)
    const_iterator findSince(cond::Time_t time) const;

    // true if an iov with since==time already exists
    bool exist(cond::Time_t time) const;

    cond::TimeType timeType() const { return cond::timeTypeSpecs[m_timetype].type;}

    // FIXME shall we cache it?
    cond::Time_t firstSince() const { return  iovs().front().sinceTime();}

    cond::Time_t lastTill() const { return  m_lastTill;}

    void updateLastTill(cond::Time_t till) { m_lastTill=till;}

    void updateMetadata( const std::string& metadata, bool append=true );

    void setScope( ScopeType type ) { m_scope = type;}

  public:
    Container const & iovs() const;

    // if true the "sorted" sequence is not guaranted to be the same as in previous version
    bool notOrdered() const { return m_notOrdered;}

    std::string const & metadata() const { return m_metadata;}

    std::set<std::string> const& payloadClasses() const { return m_payloadClasses; }
    
    ScopeType scope() const { return m_scope;}
 
    void loadAll() const;

  public:

    // the real persistent container...
    Container & piovs() { 
      m_iovs.load();
      return m_iovs;
    }
    Container const & piovs() const { 
      m_iovs.load();
      return m_iovs;
    }

    void swapTokens( ora::ITokenParser& parser ) const;
    void swapOIds( ora::ITokenWriter& writer ) const;

  private:
    
    // iovs is not in order: take action!
    void disorder();

    // sort the container in m_sorted
    Container const & sortMe() const;
    
  private:

    Container m_iovs;
    int m_timetype;
    cond::Time_t m_lastTill;
    bool m_notOrdered;
    std::string m_metadata; // FIXME not used???
    std::set<std::string> m_payloadClasses;
    ScopeType m_scope;
    
    mutable Container * m_sorted;

};

}//ns cond
#endif