OMKInteractorOutput.h

Go to the documentation of this file.

/************************************************************************/
/* This file is part of openMask(c) INRIA, CNRS, Universite de Rennes 1 */
/* 1993-2002, 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 _INTERACTOROUTPUTS_H_
#define _INTERACTOROUTPUTS_H_

#include <string>
#include "OMKName.h"
#include "OMKInteraction.h"
#include "OMKControlTakeOverPrm.h"
#include "OMKTracer.h"
#include "OBTPrototypeFactory.h"

namespace OMK  
{
class ConfigurationParameterDescriptor ; 
class ExtensibleSimulatedObject ;
template< typename Type > class IAttributeBaseT ;

namespace Iii 
{
//-----------------------------------------------------------------
// Predefined classes
class InteractorExtension ;

//=============================================================================
class OMKIII_API InteractorOutput
{
protected:
  InteractorOutput( const Name& id, InteractorExtension *interactor, const Name& category, const Name& type ) ;
public:
  virtual ~InteractorOutput() {}
  virtual const Name& id() const { return _id ; }
  const Name& category() const { return _category ; }
  const Name& type() const { return _type ; }
  const OMK::Type::AccessGroupLevel& getAccessGroup() const { return _accessGroup ; }
  void setAccessGroup( const OMK::Type::AccessGroupLevel& accessGroup ) ;
  static bool create( const Name& id,
                      InteractorExtension *interactor, 
                      const ConfigurationParameterDescriptor * node ) ;
  static void create( const Name& id,
                      const Name& attributeId,
                      InteractorExtension *interactor, 
                      const Name& category,
                      const OMK::Type::AccessGroupLevel& accessGroup,
                      bool setByEvent ) ;
protected:


  Name _id ;
  Name _category ;
  Name _type ;
  OMK::Type::AccessGroupLevel _accessGroup ;
  InteractorExtension* _interactor ;
} ;

//=============================================================================
class OMKIII_API InteractorOutputCreator
{
public:
  virtual ~InteractorOutputCreator() {}
  virtual InteractorOutput* operator()( const Name& id, const Name& attributeId, 
                                        InteractorExtension *interactor,
                                        const Name& category,
                                        bool setByEvent ) const
  {
    OMERROR( "Creator is not registered for \"" << id.getString() << "\"" ) ;
    throw Exception( "Creator is not registered" ) ;
    return 0 ;
  }
} ;

//-----------------------------------------------------------------------------
template <class T>
class InteractorOutputCreatorT : public InteractorOutputCreator
{
public:
  virtual InteractorOutput* operator()( const Name& id, const Name& attributeId, 
                                        InteractorExtension *interactor,
                                        const Name& category,
                                        bool setByEvent ) const
        {
                return new T( id, attributeId, interactor, category, setByEvent ) ;
        }
} ;


//=============================================================================
}// namespace Iii

typedef OBT::Singleton< OBT::PrototypeFactory< std::pair< std::string, std::string >, Iii::InteractorOutputCreator > > InteractorOutputFactory ;

//=============================================================================
}// namespace OMK
template class OMKIII_API OBT::PrototypeFactory< std::pair< std::string, std::string >, OMK::Iii::InteractorOutputCreator > ;
template class OMKIII_API OBT::Singleton< OBT::PrototypeFactory< std::pair< std::string, std::string >, OMK::Iii::InteractorOutputCreator > > ;

#endif // defined _INTERACTOROUTPUTS_H_

---