DFAgent.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2010 by Olivier Stezowski                               *
 *   stezow(AT)ipnl.in2p3.fr                                               *
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 *   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 ADF_DFAgent
#define ADF_DFAgent

#ifndef ADF_FactoryItem
#include "FactoryItem.h"
#endif
#ifndef ADF_ConfAgent
#include "ConfAgent.h"
#endif
#ifndef ADF_BaseBuffer
#include "BaseBuffer.h"
#endif

#include <list>
#include <utility>

namespace ADF
{
class KeyFactory;
class FrameFactory;
class Frame;
class ConfigurationFrame;


class DFAgent : public DotConf
{       
private:
        ConfAgent::EModel fModel;    
private:
// Configurable part : value are modified in case of reconfiguration
        BaseBuffer::EEndian fEndian;
        FactoryItem fPrimaryKey;
        std::pair <FactoryItem,FactoryItem> fAutoConf;
        mutable std::list<std::pair <FactoryItem,FactoryItem> > fListOfFrames; 
        mutable std::list< FactoryItem > fListOfRequiredKeyFactories;
        mutable std::list< FactoryItem > fListOfRequiredFrameFactories;
        
private:
// Not completely configurable part : the list is not modified BUT the configuration of the factories is called. Be sure they are local in case of complex topology/multi-threading
        std::list< KeyFactory * > fListOfKeyFactories;
        std::list< FrameFactory * > fListOfFrameFactories;

private:

        void LinkFactories(Bool_t global = true);
        
protected:
        virtual Bool_t ProcessLine(const std::string &);  
                        
        void AddKnownFrame(const FactoryItem &item_key, const FactoryItem &item_frame, const Char_t opt = '+') ;
        
        KeyFactory *GetKeyFactory(const FactoryItem &item) ;
        FrameFactory *GetFrameFactory(const FactoryItem &item); 
        
public:
        DFAgent(const Char_t *rid, const Char_t *srid, Bool_t is_record = true, Bool_t global = true); 
        virtual ~DFAgent(); 
        
        const std::list<std::pair <FactoryItem,FactoryItem> > & GetListOfKnownFrames() const
        {
                return fListOfFrames;
        }
                        

        Bool_t SetKnownKeyFactory(const FactoryItem &factory_item);

        Bool_t SetKnownFrameFactory(const FactoryItem &factory_item);
        
        Bool_t SetAsCompatibleKeyItem(FactoryItem &factory_item) const;
        Bool_t SetAsCompatibleFrameItem(FactoryItem &factory_item) const;
        Bool_t SetAsCompatibleItems(FactoryItem &factory_key_item, FactoryItem &factory_frame_item) const
                { return SetAsCompatibleKeyItem(factory_key_item) && SetAsCompatibleFrameItem(factory_frame_item); }

        // endianness of the data flow 
        BaseBuffer::EEndian GetEndian() const
                { return fEndian; }
        ConfAgent::EModel GetModel() const
                { return fModel; }
        
        // change th e endian. it is applied to all the factories referenced in this agent
        void SetEndian(BaseBuffer::EEndian); 
        // io model 
        void SetModel(ConfAgent::EModel model)
                { fModel = model; }     
        
        const FactoryItem &GetPrimaryKey() const;
        
        const FactoryItem &GetAutoConfKey() const
                { return fAutoConf.first; }
        const FactoryItem &GetAutoConfFrame() const
                { return fAutoConf.second; }


        void SetPrimaryKey(const FactoryItem &item);    
        

        void AddKnownFrame(const Frame *frame, const Char_t opt = '+') ;
                

        UShort_t IsAKnownFrame 
                (const FactoryItem &kit, const FactoryItem &fit, PF_FactoryItemChange kch = ChangeOfVersion, PF_FactoryItemChange fch = ChangeOfVersion) const;
                        
        FactoryItem WhichKnownFrame  
                (const FactoryItem &kit, const FactoryItem &fit, PF_FactoryItemChange kch = ChangeOfVersion, PF_FactoryItemChange fch = ChangeOfVersion) const;
        FactoryItem WhichKnownKey
                (const FactoryItem &kit, const FactoryItem &fit, PF_FactoryItemChange kch = ChangeOfVersion, PF_FactoryItemChange fch = ChangeOfVersion) const;
        
        virtual void Reset(const Char_t *opt = "");

        virtual Bool_t DoConfigure(std::istream &in, Bool_t allow_init) 
                { return DotConf::DoConfigure(in,allow_init); }
        virtual Bool_t DoConfigure(std::ostream &);
}; 

} // namespace ADF

#endif