OMKExtension.h

Go to the documentation of this file.

/************************************************************************/
/* This file is part of openMask(c) INRIA, CNRS, Universite de Rennes 1 */
/* 1993-2007, thereinafter the Software                                 */
/*                                                                      */
/* The Software has been developped within the Siames Project.          */
/* INRIA, the University of Rennes 1 and CNRS jointly hold intellectual */
/* property rights                                                      */
/*                                                                      */
/* The Software has been registered with the Agence pour la Protection  */
/* des Programmes (APP) under registration number                       */
/* IDDN.FR.001.510008.00.S.P.2001.000.41200                             */
/*                                                                      */
/* This file may be distributed under the terms of the Q Public License */
/* version 1.0 as defined by Trolltech AS of Norway and appearing in    */
/* the file LICENSE.QPL included in the packaging of this file.         */
/*                                                                      */
/* Licensees holding valid specific licenses issued by INRIA, CNRS or   */
/* Universite Rennes 1 for the software may use this file in            */
/* acordance with that specific license                                 */
/************************************************************************/
                
#if !defined OMK_EXTENSION_H
#define OMK_EXTENSION_H

#include "OMKSimulatedObject.h"
#include "OBTPrototypeFactory.h"

#define DECLARE_EXTENSION_FACTORY( ExtensionClass ) \
public: \
 \
  friend class OMK::ExtensionCreatorT< ExtensionClass > ; \
 \
  static OMK::Name OMK_CLASS_ID ; \
 \
  static const bool REGISTERED_IN_EXTENSION_FACTORY ; \
protected: \
 \
   ExtensionClass( OMK::ExtensibleSimulatedObject* owner, const OMK::Name& id, bool registerExtension = true ) ; \
public: \
        virtual ~ExtensionClass() 
  
#define DECLARE_TEMPLATE_EXTENSION_FACTORY( ExtensionClass, Type ) \
public: \
 \
  friend class OMK::ExtensionCreatorT< ExtensionClass< Type > > ; \
 \
  static OMK::Name OMK_CLASS_ID ; \
 \
  static const bool REGISTERED_IN_EXTENSION_FACTORY ; \
protected: \
 \
   ExtensionClass( OMK::ExtensibleSimulatedObject* owner, const OMK::Name& id, bool registerExtension = true ) ; \
public: \
  virtual ~ExtensionClass() 

#define REGISTER_EXTENSION_FACTORY( ExtensionClass, Id )\
  /* Factory */ \
  Name ExtensionClass::OMK_CLASS_ID( Id ) ; \
  const bool ExtensionClass::REGISTERED_IN_EXTENSION_FACTORY( OMK::ExtensionFactory::getInstance().registerCreator< OMK::ExtensionCreatorT< ExtensionClass > >( Id ) )  

#define REGISTER_TEMPLATE_EXTENSION_FACTORY( ExtensionClass, Id )\
  /* Factory */ \
  template <> Name ExtensionClass::OMK_CLASS_ID( Id ) ; \
  template <> const bool ExtensionClass::REGISTERED_IN_EXTENSION_FACTORY( OMK::ExtensionFactory::getInstance().registerCreator< OMK::ExtensionCreatorT< ExtensionClass > >( Id ) )


namespace OMK  
{
// Predefined classes
class ExtensibleSimulatedObject ;
//-------------------------------------------------------------------------

class OMK_API Extension
{

protected:
  Extension( ExtensibleSimulatedObject* owner, const Name& id, bool registerExtension = true ) ;
public:
  virtual ~Extension() {}
public:


  const Name& getId() const { return _id ; }










  virtual bool loadObjectParameters( const ConfigurationParameterDescriptor * node ) ;
  virtual bool loadExtensionParameters( const ConfigurationParameterDescriptor * node ) ;













  virtual void preComputeParameters() {}
  virtual void postComputeParameters() {}

  Name _id ;
} ;

//-----------------------------------------------------------------------------
template< class SimulatedObjectType >
class ExtensionT : public Extension
{

protected:
        ExtensionT( ExtensibleSimulatedObject* owner, const Name& id, bool registerExtension = true ) ;
public:
  virtual ~ExtensionT() {}

protected:
  SimulatedObjectType* _owner ;
public:
  SimulatedObjectType* getOwner() const { return _owner ; }
} ;

//-----------------------------------------------------------------------------
class ExtensionCreator
{
public:
  virtual ~ExtensionCreator(){}
  virtual Extension* operator()( ExtensibleSimulatedObject* owner, const Name& id, bool registerExtension = true ) const
  {
    OMERROR( "Creator is not registered for \"" << id << "\"" ) ;
    throw Exception( "Creator is not registered" ) ;
    return 0 ;
  }
} ;

//-----------------------------------------------------------------------------
template <class T>
class ExtensionCreatorT : public ExtensionCreator
{
public:

        typedef T object_to_create ;
  virtual ~ExtensionCreatorT(){}
  Extension* operator()( ExtensibleSimulatedObject* owner, const Name& id, bool registerExtension = true ) const
        {
                return new T( owner, id, registerExtension ) ;
        }
} ;
}// namespace OMK

#include "OMKExtension.inl"
namespace OMK
{
//-----------------------------------------------------------------------------
typedef OBT::Singleton< OBT::PrototypeFactory< OMK::Name, ExtensionCreator > > ExtensionFactory ;
}// namespace OMK

template class OMK_API OBT::PrototypeFactory< OMK::Name, OMK::ExtensionCreator > ;
template class OMK_API OBT::Singleton< OBT::PrototypeFactory< OMK::Name, OMK::ExtensionCreator > > ;

#endif // defined OMK_EXTENSION_H

---