AttentionBank.h

Go to the documentation of this file.

/*
 * opencog/atomspace/AttentionBank.h
 *
 * Copyright (C) 2011 OpenCog Foundation
 * All Rights Reserved
 *
 * Written by Joel Pitt <joel@opencog.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License v3 as
 * published by the Free Software Foundation and including the exceptions
 * at http://opencog.org/wiki/Licenses
 *
 * 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 Affero General Public License
 * along with this program; if not, write to:
 * Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef _OPENCOG_ATTENTION_BANK_H
#define _OPENCOG_ATTENTION_BANK_H

#include <mutex>

#include <boost/signals2.hpp>

#include <opencog/util/recent_val.h>
#include <opencog/atomspace/AttentionValue.h>

namespace opencog
{
typedef boost::signals2::signal<void (const Handle&,
                                      const AttentionValuePtr&,
                                      const AttentionValuePtr&)> AFCHSigl;

class AtomTable;

class AttentionBank
{
    boost::signals2::connection AVChangedConnection;
    void AVChanged(Handle, AttentionValuePtr, AttentionValuePtr);

    AttentionValue::sti_t attentionalFocusBoundary;

    AFCHSigl _AddAFSignal;
    AFCHSigl _RemoveAFSignal;

    opencog::recent_val<AttentionValue::sti_t> maxSTI;
    opencog::recent_val<AttentionValue::sti_t> minSTI;

    mutable std::mutex lock_maxSTI;
    mutable std::mutex lock_minSTI;

    /* These indicate the amount importance funds available in the
     * AtomSpace */
    long fundsSTI;
    long fundsLTI;

    long startingFundsSTI;
    long startingFundsLTI;

    mutable std::mutex lock_funds;

public:
    AttentionBank(AtomTable&);
    ~AttentionBank();
    void shutdown(void);

    AFCHSigl& AddAFSignal() { return _AddAFSignal; }
    AFCHSigl& RemoveAFSignal() { return _RemoveAFSignal; }

    long getTotalSTI() const;

    long getTotalLTI() const;

    long getSTIFunds() const;

    long getLTIFunds() const;

    long updateSTIFunds(AttentionValue::sti_t diff);
    long updateLTIFunds(AttentionValue::lti_t diff);

    AttentionValue::sti_t getAttentionalFocusBoundary() const;

    AttentionValue::sti_t setAttentionalFocusBoundary(
        AttentionValue::sti_t s);

    AttentionValue::sti_t getMaxSTI(bool average=true) const;

    AttentionValue::sti_t getMinSTI(bool average=true) const;

    void updateMinSTI(AttentionValue::sti_t m);

    void updateMaxSTI(AttentionValue::sti_t m);

    //void setVLTI(AttentionValueHolderPtr avh, AttentionValue::vlti_t);

    float getNormalisedSTI(AttentionValuePtr, bool average, bool clip) const;

    float getNormalisedSTI(AttentionValuePtr) const;
    float getNormalisedZeroToOneSTI(AttentionValuePtr, bool average, bool clip) const;
};

} //namespace opencog

#endif // _OPENCOG_ATTENTION_BANK_H