OMKIConnectors.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 _OMK_III_ICONNECTORS_H_
#define _OMK_III_ICONNECTORS_H_

#include "OMKName.h"
#include <map>
#include <list>
#include "OMKTracer.h"
#include "OBTPrototypeFactory.h"
#include "OMKInteraction.h"
#include "OMKException.h"
#include "OMKConfigurationParameterDescriptor.h"
#include "OMKIAccessRule.h"

template< typename T > class Input ;
namespace OMK  
{
  class ExtensibleSimulatedObject ;
  namespace Iii
  {

// Predefined classes
class InteractiveSimulatedObject ;
class InteractiveExtension ;

//-----------------------------------------------------------------
class OMKIII_API IConnector
{ 

protected:
  IConnector( const Name& id, const Name& category, const Name& type,
              OMK::Type::AccessLevel accessLevel, bool freezable, 
              ExtensibleSimulatedObject *owner ) ;
  IConnector( const Name& id, 
              const Name& attributeId, 
              const Name& type,
              InteractiveExtension *extension, 
              const ConfigurationParameterDescriptor* node ) ;
public:
  virtual ~IConnector() {}


public:
  virtual bool loadParameters( const ConfigurationParameterDescriptor* node ) { return true ; }
  virtual bool isConnected( const Name& interactor ) const = 0 ;
  virtual bool preConnect( const Name& interactor, const OMK::Type::AccessGroupLevel& freezeLevel, OMK::Type::AccessLevel toolLevel ) = 0 ;
  virtual bool connect( const Name& interactor, const Name& outputName ) = 0 ;
  virtual void disconnect( const Name& interactor ) = 0 ;
  virtual void disconnect() = 0 ;
  virtual void updateParameter() const = 0 ;
  virtual void sendValue( const Name& receiver ) const = 0 ;
  const Name& id() const { return _id ; }
  const Name& category() const { return _category ; }
  const Name& type() const { return _type ; }
  const IAccessRule& getAccessRule() const { return *_accessRule ; }
  IAccessRule& getAccessRule() { return *_accessRule ; }
  std::list< Name >& getToolsInUse() { return _toolsInUse ; }
  const std::list< Name >& getToolsInUse() const { return _toolsInUse ; }
  void addToolInUse( const Name& toolId ) { _toolsInUse.push_back( toolId ) ; }

protected:
  Name _id ;
  Name _attributeId ;
  Name _category ;
  Name _type ;
  IAccessRule* _accessRule ;
  std::list< Name > _toolsInUse ;
  std::list< Name > _toolsOnStandby ;
  ExtensibleSimulatedObject *_owner ;
  InteractiveExtension * _interactiveExtension ;
  void SendControlTakenBy( const Name& newInteractor ) ;
  void SendControlReleased( const Name& interactor ) ;
  void SendControlReleasedBy( const Name& oldInteractor ) ;
  void SendControlEnded( const Name& interactor ) ;
} ;
//-----------------------------------------------------------------

//-----------------------------------------------------------------------------
class OMKIII_API ConnectorCreator
{
public:
  virtual ~ConnectorCreator() {}
  virtual IConnector* operator()( const Name& id, 
                                  const Name& attributeId, 
                                  InteractiveExtension *extension,
                                  const ConfigurationParameterDescriptor* node ) const
  {
    OMERROR( "Creator is not registered for \"" << id << "\"" << std::endl << *node ) ;
    throw Exception( "Creator is not registered" ) ;
    return 0 ;
  }
} ;

//-----------------------------------------------------------------------------
template <class T>
class ConnectorCreatorT : public ConnectorCreator
{
public:
        IConnector* operator()( const Name& id, 
                          const Name& attributeId, 
                          InteractiveExtension *extension,
                          const ConfigurationParameterDescriptor* node ) const
        {
                return new T( id, attributeId, extension, node ) ;
        }
} ;



  }// namespace Iii

//-----------------------------------------------------------------------------
typedef OBT::Singleton< OBT::PrototypeFactory< OMK::Name, Iii::ConnectorCreator > > ConnectorFactory ;
}// namespace OMK

template class OMKIII_API OBT::PrototypeFactory< OMK::Name, OMK::Iii::ConnectorCreator > ;
template class OMKIII_API OBT::Singleton< OBT::PrototypeFactory< OMK::Name, OMK::Iii::ConnectorCreator > > ;

#endif // defined _OMK_III_ICONNECTORS_H_

---