factoryTemplate.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2012 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/



#pragma once

#include <vrfutil/vrfutilDefines.h>
#include <map>

#include <vlutil/vlString.h>

template <typename T_CreationObject, typename T_Key>
class DtFactoryTemplate
{
public:
   DtFactoryTemplate();

private:
   DtFactoryTemplate(const DtFactoryTemplate& orig);
   const DtFactoryTemplate& operator=(const DtFactoryTemplate& 
      orig);

public:
   typedef T_CreationObject* (*DtCreatorFcn)();

   struct DtFactoryTemplateEntry {
      T_Key myTypeToCreate;
      DtCreatorFcn myCreatorFcn;
   };

   typedef std::map<T_Key, DtFactoryTemplateEntry> DtCreatorMapType;

   virtual ~DtFactoryTemplate();

   virtual void addCreatorFcn(const T_Key& key, DtCreatorFcn fcn);

   virtual bool removeCreatorFcn(const T_Key& key);


   virtual T_CreationObject* createNew(const T_Key& key) const;

   virtual bool isKeyRegistered(const T_Key& key) const;

   static DtFactoryTemplate<T_CreationObject, T_Key>* create();

   virtual DtString creationObjectName() const;

   virtual const DtCreatorMapType& creatorMap() const;

   virtual void setAlwaysWarnOnlyOnce(bool);
   bool alwaysWarnOnlyOnce() const;

protected:
   
   DtCreatorMapType myCreatorMap;
   bool myAlwaysWarnOnlyOnce;
   mutable std::map<T_Key, bool> myMessageWarningFilters;
};


template <typename T_CreationObject, typename T_Key, typename T_Arg>
class DtSingleArgFactoryTemplate
{
public:
   DtSingleArgFactoryTemplate();

private:
   DtSingleArgFactoryTemplate(const DtSingleArgFactoryTemplate& orig);
   const DtSingleArgFactoryTemplate& operator=(const DtSingleArgFactoryTemplate& 
      orig);

public:
   typedef T_CreationObject* (*DtCreatorFcn)(T_Arg);

   struct DtSingleArgFactoryTemplateEntry {
      T_Key myTypeToCreate;
      DtCreatorFcn myCreatorFcn;
   };

   typedef std::map<T_Key, DtSingleArgFactoryTemplateEntry> DtCreatorMapType;

   virtual ~DtSingleArgFactoryTemplate();

   virtual void addCreatorFcn(const T_Key& key, DtCreatorFcn fcn);

   virtual bool removeCreatorFcn(const T_Key& key);


   virtual T_CreationObject* createNew(const T_Key& key, T_Arg arg) const;

   virtual bool isKeyRegistered(const T_Key& key) const;

   static DtSingleArgFactoryTemplate<T_CreationObject, T_Key, T_Arg>* create();

   virtual DtString creationObjectName() const;

   virtual const DtCreatorMapType& creatorMap() const;

   virtual void setAlwaysWarnOnlyOnce(bool);
   bool alwaysWarnOnlyOnce() const;

protected:

   DtCreatorMapType myCreatorMap;
   bool myAlwaysWarnOnlyOnce;
   mutable std::map<T_Key, bool> myMessageWarningFilters;
};

#define factoryTemplate_inl_
#include "vrfutil/factoryTemplate.inl"
#undef factoryTemplate_inl_