DataAccessor.h

Go to the documentation of this file.

/*  YAP - Yet another PWA toolkit
    Copyright 2015, Technische Universitaet Muenchen,
    Authors: Daniel Greenwald, Johannes Rauch

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */


#ifndef yap_DataAccessor_h
#define yap_DataAccessor_h

#include "fwd/DataAccessor.h"

#include "fwd/CachedValue.h"
#include "fwd/DataPoint.h"
#include "fwd/Model.h"
#include "fwd/ParticleCombination.h"

#include <memory>

namespace yap {

class DataAccessor
{
public:

    DataAccessor(const ParticleCombinationEqualTo& equal);

    const ParticleCombinationEqualTo& equal() const
    { return Equal_; }

    int index() const
    { return Index_; }

    unsigned symmetrizationIndex(const std::shared_ptr<ParticleCombination>& c) const
    { return SymmetrizationIndices_.at(c); }

    const ParticleCombinationMap<unsigned>& symmetrizationIndices() const
    { return SymmetrizationIndices_; }

    const unsigned nSymmetrizationIndices() const
    { return NIndices_; }

    void printParticleCombinations() const;

    const CachedValueSet& CachedValues() const
    { return CachedValues_; }

    const unsigned size() const
    { return Size_; }

    const bool requiresStorage() const
    { return size() > 0 and nSymmetrizationIndices() > 0; }

    bool consistent() const;

    virtual const Model* model() const = 0;

    friend Model;

    friend CachedValue;

protected:

    void virtual registerWithModel();

    void addCachedValue(std::shared_ptr<CachedValue> c);

    virtual void addParticleCombination(std::shared_ptr<ParticleCombination> pc);

    virtual void pruneSymmetrizationIndices();

    void setIndex(size_t i)
    { Index_ = i; }

private:

    void increaseSize(unsigned n)
    { Size_ += n; }

    ParticleCombinationEqualTo Equal_;

    ParticleCombinationMap<unsigned> SymmetrizationIndices_;

    unsigned NIndices_;

    CachedValueSet CachedValues_;

    unsigned Size_;

    int Index_;

};

void remove_expired(DataAccessorSet& S);

}

#endif