tenaBroker/translatorFactory.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 2005 MaK Technologies, Inc.
 ** All rights reserved.
 *********************************************************************/
/*********************************************************************
 ** $RCSfile: translatorFactory.h,v $ $Revision: 1.6 $ $State: Exp $
 *********************************************************************/
#ifndef translatorFactory_H_
#define translatorFactory_H_


#include "objectTrans.h"
#include "interactionTrans.h"
 
#include <map>
#include <vlutil/vlPrint.h>
#include <vlutil/vlString.h>

namespace MAKVrExchange { namespace DtTenaBroker {

class DtTenaBroker;

// \brief A factory class for Translators. 
//
// DtTranslatorFactory takes on template parameter, which is the type of 
// the class produced by the creator functions.
template <typename ProducedType>
class DtTranslatorFactory
{
public:

   typedef ProducedType* (*DtObjectTranslatorCreatorFunction)(DtTenaBroker *);
   typedef ProducedType* (*DtGenericObjectTranslatorCreatorFunction)(DtTenaBroker *, const DtString &className);

public:

   // Default CTOR
   DtTranslatorFactory();

   // Default DTOR - destroys factory, not instances created by the factory.
   virtual ~DtTranslatorFactory();

private:

   // Copy CTOR not implemented - do not copy
   DtTranslatorFactory(const DtTranslatorFactory & other);

   // Assignment Operator not implemented - do not copy
   DtTranslatorFactory& operator=(const DtTranslatorFactory & other);


public:


   // Creates a generic translator using the className and broker provided.
   ProducedType *createGenericInstance(
      const DtString &className, DtTenaBroker *broker);

   // Creats an translator instance and returns it as a pointer of type ProducedType. The
   // translator is created using transName and the CTOR is passed the broker pointer.
   ProducedType *createInstance(const DtString &transName, DtTenaBroker *broker) const;


   // Removes the translator for class T using T::translatorName(). If there is no translator
   // found, no action is taken.
   template<typename T>
   void removeCreator();

   // removes the translator creator for translatorName if one is found. If not
   // no action is taken.
   void removeCreator(const DtString& translatorName);

   // Sets T as the class to create when a generic Translator is requested. The default instanceFactory 
   // is used as the creator function.
   template<typename T>
   void addGenericCreator();

   // Adds a creator for class T using the default instanceFactory Method. The creator is 
   // locked to the name in T::translatorName. If there is already a function assigned to 
   // that name, the new function replaces the old function.
   template<typename T>
   void addCreator();

   // For translator translatorName a creator function fn is used. If there is already a 
   // function assigned to that name, the new function replaces the old function.
   template<typename T>
   void addCreator(const DtString& translatorName, DtObjectTranslatorCreatorFunction fn);

   std::set<DtString> creatorNames() const;

protected:

   // A static function which can be used to create instances of type T. 
   template <typename T>
   static ProducedType *instanceFactory(DtTenaBroker *broker);

   // A static function which can be used to create instances of type T, where T takes 
   // a className in the CTOR. 
   template <typename T>
   static ProducedType *genericInstanceFactory(DtTenaBroker *broker, const DtString& className);

protected:

   typedef std::map<DtString, DtObjectTranslatorCreatorFunction> StringOtcMap;

protected:

   StringOtcMap myNamedCreatorMap;
   DtGenericObjectTranslatorCreatorFunction myGenericTranslatorCreator;

};

// A factory for object Translators
typedef DtTranslatorFactory<DtObjectTranslator> DtObjectTranslatorFactory;

// A Factory from Interaction Translators
typedef DtTranslatorFactory<DtInteractionTranslator> DtInteractionTranslatorFactory;

}}

#define translatorFactory_INL_
#include "translatorFactory.inl"
#undef translatorFactory_INL_

#endif //end #ifndef translatorFactory_H_