OMKSessionPrm.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 _SESSIONPRM_H_
#define _SESSIONPRM_H_

#include "OMKInteractiveEventId.h"
#include "OMKTracer.h"
#include <map>
#include <vector>
#include "OMKName.h"
namespace OMK  
{
  namespace Iii 
  {
// Predefined classes
    class InteractorExtension ;

//-----------------------------------------------------------------
class OMKIII_API SessionPrm
{
protected:
  SessionPrm( InteractorExtension* owner, const Name& interactiveObject ) ;
public:
  static SessionPrm* create( InteractorExtension* owner, const Name& interactiveObject ) ;
  virtual ~SessionPrm() ;
  virtual bool isInitialized() const { return !_links.empty() ; }
  virtual void init( const InteractorOutputsMap& interactorOutputsMap, const Type::AccessibleParametersListPrm& connectors ) ;
  const Name& getInteractiveObject() const { return _interactiveObject ; }


  SessionPrm& c( SessionPrm& (*f)( SessionPrm& ) ) 
  {
    return (*f)( *this ); 
  }
  class Functor
  {
  public:
    Functor() {}
    virtual ~Functor() {}
  protected:
    friend class SessionPrm ;
    virtual SessionPrm& func( SessionPrm& ) const = 0 ;
  } ;
  template< class TheFunctor >
  SessionPrm& c( const TheFunctor& theFunctor )
  {
    return theFunctor.func( *this ); 
  }
  virtual SessionPrm& c( const Name& interactiveObjectId ) 
  { 
    _ids.push_back( interactiveObjectId ) ;
    return *this; 
  }
public:


  enum OutputStates {
    EUnknow,           
    EIsNotControlled,  
    EWaitingForAnswer, 

    EIsUnderControl    
  } ;
  virtual void addControlledConnector( const Type::ControlTakenOfParameterPrm& prm ) ;
  virtual void removeControlledConnector( const Name& id ) ;
  std::list< Name > getActiveOutputs() const ;
  OutputStates outputState( const Name& id ) const ;
  bool isActiveOutput( const Name& id ) const ;



  Name getOutputId( const Name& connectorId ) const ;
protected:
  struct Link
  {
    Link( const Name& connectorId, InteractorOutput* output ) 
    : _connector( connectorId ), 
      _output( output ),
      _state( EIsNotControlled )
    {
      OMASSERTM( output, "Must be a valid pointer" ) ;
    }
    Name _connector ;
    InteractorOutput* _output ;
    OutputStates _state;
  } ;
  std::map< Name, Link > _links ;
  Name _interactiveObject ;
  InteractorExtension *_owner ;




  std::vector< Name > _ids ;
  virtual void selfGetAccessibleParameters() ;
  virtual void selfControlTakeOverAndGetCurrentValues() ;
  virtual void selfControlRelease() ;
  virtual void selfControlFreeze() ;
  virtual void selfControlUnfreeze() ;











  inline friend SessionPrm& getAccessibleParameters( SessionPrm & s ) ;
  inline friend SessionPrm& controlTakeOverAndGetCurrentValues( SessionPrm & s ) ;
  inline friend SessionPrm& controlRelease( SessionPrm & s ) ;
  inline friend SessionPrm& controlFreeze( SessionPrm & s ) ;
  inline friend SessionPrm& controlUnfreeze( SessionPrm & s ) ;
} ;
//-----------------------------------------------------------------
inline SessionPrm& getAccessibleParameters( SessionPrm & s )
{
  s.selfGetAccessibleParameters() ;
  return s ;
}
//-----------------------------------------------------------------
inline SessionPrm& controlTakeOverAndGetCurrentValues( SessionPrm & s )
{
  s.selfControlTakeOverAndGetCurrentValues() ;
  return s ;
}
//-----------------------------------------------------------------
inline SessionPrm& controlRelease( SessionPrm & s )
{
  s.selfControlRelease() ;
  return s ;
}
//-----------------------------------------------------------------
inline SessionPrm& controlFreeze( SessionPrm & s )
{
  s.selfControlFreeze() ;
  return s ;
}
//-----------------------------------------------------------------
inline SessionPrm& controlUnfreeze( SessionPrm & s )
{
  s.selfControlUnfreeze() ;
  return s ;
}

  }// namespace Iii
}// namespace OMK

#endif // defined _SESSIONPRM_H_

---