DynamicParam.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/exec/DynamicParam.h#13 $
// Fennel is a library of data storage and processing components.
// Copyright (C) 2005-2009 The Eigenbase Project
// Copyright (C) 2004-2009 SQLstream, Inc.
// Copyright (C) 2004-2009 LucidEra, Inc.
// Portions Copyright (C) 1999-2009 John V. Sichi
//
// 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 2 of the License, or (at your option)
// any later version approved by The Eigenbase Project.
//
// 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, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef Fennel_DynamicParam_Included
#define Fennel_DynamicParam_Included

#include "fennel/common/SharedTypes.h"
#include "fennel/tuple/TupleData.h"
#include "fennel/tuple/TupleDescriptor.h"
#include "fennel/synch/SynchObj.h"

#include <map>
#include <boost/scoped_array.hpp>


FENNEL_BEGIN_NAMESPACE

class FENNEL_EXEC_EXPORT DynamicParam
{
    friend class DynamicParamManager;

    boost::scoped_array<FixedBuffer> pBuffer;
    TupleAttributeDescriptor desc;
    TupleDatum datum;
    bool isCounter;

public:
    explicit DynamicParam(
        TupleAttributeDescriptor const &desc,
        bool isCounter = false);
    inline TupleDatum const &getDatum() const;
    inline TupleAttributeDescriptor const &getDesc() const;
};

class FENNEL_EXEC_EXPORT DynamicParamManager
{
    typedef std::map<DynamicParamId, SharedDynamicParam> ParamMap;
    typedef ParamMap::const_iterator ParamMapConstIter;

    StrictMutex mutex;

    ParamMap paramMap;

    DynamicParam &getParamInternal(DynamicParamId dynamicParamId);

    void createParam(
        DynamicParamId dynamicParamId,
        SharedDynamicParam param,
        bool failIfExists);
public:
    void createParam(
        DynamicParamId dynamicParamId,
        const TupleAttributeDescriptor &attrDesc,
        bool failIfExists = true);

    void createCounterParam(
        DynamicParamId dynamicParamId,
        bool failIfExists = true);

    void deleteParam(DynamicParamId dynamicParamId);

    void writeParam(DynamicParamId dynamicParamId, const TupleDatum &src);

    DynamicParam const &getParam(DynamicParamId dynamicParamId);

    void readParam(DynamicParamId dynamicParamId, TupleDatum &dest);

    void incrementCounterParam(DynamicParamId dynamicParamId);

    void decrementCounterParam(DynamicParamId dynamicParamId);

    void deleteAllParams();
};

inline TupleDatum const &DynamicParam::getDatum() const
{
    return datum;
}

inline TupleAttributeDescriptor const &DynamicParam::getDesc() const
{
    return desc;
}

FENNEL_END_NAMESPACE

#endif

// End DynamicParam.h

---