hiddenparam.h

Go to the documentation of this file.

#ifndef hiddenparam_h
#define hiddenparam_h

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        K. Tingdahl
 Date:          April 2011
 RCS:           $Id$
________________________________________________________________________

-*/

#include "sets.h"
#include "threadlock.h"

#include <iostream>

template <class O, class V>
mClass(Basic) HiddenParam
{
public:
                HiddenParam( const V& undefval )
                    : lock_(true)
                    , undef_(undefval)          {}
                ~HiddenParam();

    void        setParam(O* obj,const V& val);
    bool        setParamIfValueIs(O* obj,const V& curval, const V& newval );
    const V&    getParam(const O* obj) const;
    bool        hasParam(const O* obj) const;
    void        removeParam(O* obj);
    void        removeAndDeleteParam(O* obj);
    void        deleteAndZeroPtrParam(O* obj);

protected:

    ObjectSet<O>                objects_;
    TypeSet<V>                  params_;
    mutable Threads::Lock       lock_;
    V                           undef_;

};


template <class O, class V>
HiddenParam<O,V>::~HiddenParam()
{
#ifdef __debug__
    Threads::Locker locker( lock_ );
    if ( objects_.size() )
    { //Using std C++ function because we cannot use pErrMsg or BufferString
        std::cerr << "(PE) HiddenParam | Deleting a HiddenParam prematurely\n";
    }
#endif
}


template <class O, class V>
void HiddenParam<O,V>::setParam( O* obj, const V& val )
{
    Threads::Locker locker( lock_ );
    const int idx = objects_.indexOf( obj );
    if ( idx==-1 )
    {
        objects_ += obj;
        params_ += val;
        return;
    }

    params_[idx] = val;
}


template <class O, class V>
bool HiddenParam<O,V>::setParamIfValueIs( O* obj, const V& curval,
                                          const V& newval )
{
    Threads::Locker locker( lock_ );
    const int idx = objects_.indexOf( obj );
    if ( idx==-1 )
    {
        objects_ += obj;
        params_ += newval;
        return true;
    }

    if ( params_[idx]==curval )
    {
        params_[idx] = newval;
        return true;
    }

    return false;
}


template <class O, class V>
const V& HiddenParam<O,V>::getParam( const O* obj ) const
{
    Threads::Locker locker( lock_ );
    const int idx = objects_.indexOf( obj );
    if ( !objects_.validIdx(idx) )
    {
        pErrMsg("Object not found");
        return undef_;
    }

    return params_[idx];
}


template <class O, class V>
bool HiddenParam<O,V>::hasParam( const O* obj ) const
{
    Threads::Locker locker( lock_ );
    return objects_.isPresent( obj );
}


template <class O, class V>
void HiddenParam<O,V>::removeParam( O* obj )
{
    Threads::Locker locker( lock_ );
    const int idx = objects_.indexOf( obj );
    if ( idx==-1 )
        return;

    params_.removeSingle( idx );
    objects_.removeSingle( idx );
}


template <class O, class V>
void HiddenParam<O,V>::removeAndDeleteParam( O* obj )
{
    Threads::Locker locker( lock_ );
    const int idx = objects_.indexOf( obj );
    if ( idx==-1 )
    {
        pErrMsg("Object not found");
        return;
    }

    delete params_[idx];
    params_.removeSingle( idx );
    objects_.removeSingle( idx );
}


template <class O, class V>
void HiddenParam<O,V>::deleteAndZeroPtrParam( O* obj )
{
    Threads::Locker locker( lock_ );
    const int idx = objects_.indexOf( obj );
    if ( idx==-1 )
    {
        pErrMsg("Object not found");
        return;
    }

    delete params_[idx];
    params_[idx] = 0;
}

#endif