OMKExtensionManager.cpp

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                                 */
/************************************************************************/
    
#include "OMKExtensionManager.h"
#include "OMKExtension.h"
#include "OMKIAttribute.h"
#include "OMKMultipleConfigurationParameter.h"
#include "OMKParametersAccessor.inl"
#include <vector>
#include <string>
#include <iostream>

namespace OMK  
{
//-----------------------------------------------------------------

// Default constructor
ExtensionManager::ExtensionManager()
{
}

//-----------------------------------------------------------------

// Destructor
ExtensionManager::~ExtensionManager()
{
}
//-----------------------------------------------------------------
void ExtensionManager::createExtensionsFromParameters( ExtensibleSimulatedObject* owner, const ConfigurationParameterDescriptor * node ) 
{
  // Retrieve the extension fields to create the extensions which defined a "Class"
  if( node )
  {
    int nbItems = node->getNumberOfSubItems() ;
    for( int i = 0 ; i < nbItems ; ++i )
    { 
      // Retrieves parameters sets for each extension
      Name id( static_cast<const MultipleConfigurationParameter *>( node )->getNameOfSubDescriptor( i ) ) ;
      const ConfigurationParameterDescriptor * extensionParam = node->getSubDescriptorByPosition( i ) ;
      // Try to retrieve the class id to create the extension
      std::string classId ;
      if( ParametersAccessor::get( extensionParam, "Class", classId ) )
      { // ClassId is ok => Create the extension
        createAndAddExtension( owner, classId, id ) ;
      }
    }
  }
}
//-----------------------------------------------------------------

// finish
void ExtensionManager::deleteExtensions()
{
  // Destroy every extensions
  for( ExtensionStore::iterator i = _extensions.begin() ; i != _extensions.end() ; i++ )
  { 
    delete i->second ;
  }
  _extensions.clear() ;
  _orderedExtensionsForLoadParameters.clear() ;
  _orderedExtensionsForPreCompute.clear() ;
  _orderedExtensionsForPostCompute.clear() ;
}
//-----------------------------------------------------------------

// Initialisation
void ExtensionManager::loadOrder( const ConfigurationParameterDescriptor* node,
                                  const std::string& name,
                                  ExtensionList& extensionsList )
{
  std::vector< Name > order ;
  if( ParametersAccessor::get( node, name, order ) )
  {
    OMASSERTM( extensionsList.size() == order.size(), "The list \"" << name << "\" has not the good size" ) ;
    extensionsList.clear() ;
    for( size_t i = 0 ; i < order.size() ; i++ )
    {
      ExtensionStore::const_iterator iterator = _extensions.find( order[ i ] ) ;
      OMASSERTM( iterator != _extensions.end(), "Cannot find the extension \"" << order[ i ] << "\"" ) ;
      extensionsList.push_back( iterator->second ) ;
    }
  }
}

//-----------------------------------------------------------------

void ExtensionManager::preComputeExtension()
{
  // Call the extensions which work on inputs parameters
  for( ExtensionList::iterator i = _orderedExtensionsForPreCompute.begin() ; i != _orderedExtensionsForPreCompute.end(); )
  {
    // should pass to the next extension because maybe the current extension will be self destruct !
    ExtensionList::iterator current = i ;
    i++ ;
    (*current)->preComputeParameters() ;
  }
}
//-----------------------------------------------------------------

void ExtensionManager::postComputeExtension()
{
  // Call the extensions which work on outputs parameters
  for( ExtensionList::iterator i = _orderedExtensionsForPostCompute.begin() ; i != _orderedExtensionsForPostCompute.end(); )
  {
    // should pass to the next extension because maybe the current extension will be self destruct !
    ExtensionList::iterator current = i ;
    i++ ;
    (*current)->postComputeParameters() ;
  }
}

//-----------------------------------------------------------------
bool ExtensionManager::loadFromExtensionsParameters( const ConfigurationParameterDescriptor* extensionNode ) 
{ 
  bool ok = true ;
  if( extensionNode )
  {
    // Retrieve the each extension fields to configure the extension
    for( ExtensionList::iterator i = _orderedExtensionsForLoadParameters.begin() ; i != _orderedExtensionsForLoadParameters.end(); i++ )
    {
      const ConfigurationParameterDescriptor* subExtensionNode = 0 ;
      ParametersAccessor::get( extensionNode, (*i)->getId().getCString(), subExtensionNode ) ;
      // call the extension parameter loader
      ok = (*i)->loadExtensionParameters( subExtensionNode ) && ok ;
    }
  }

  return ok ;
}
//-----------------------------------------------------------------
bool ExtensionManager::loadFromObjectParameters( const ConfigurationParameterDescriptor* node ) 
{ 
  bool ok = true ;
  // Load object parameters for the extensions
  for( ExtensionList::iterator i = _orderedExtensionsForLoadParameters.begin() ; i != _orderedExtensionsForLoadParameters.end() ; )
  {
    // should pass to the next extension because maybe the current extension will be self destruct !
    ExtensionList::iterator current = i ;
    i++ ;
    ok = (*current)->loadObjectParameters( node ) && ok ;
  }

  return ok ;
}
//-----------------------------------------------------------------
void ExtensionManager::addExtension( Extension* extension ) 
{
  // return value
  std::string errorMsg ;
  bool ok = false ;
  if( extension )
  {
    // Check for duplicate extension
    ExtensionStore::iterator i = _extensions.find( extension->getId() );
    if( i == _extensions.end() ) 
    { 
      // It is a really new item, adds it in the main list
      _extensions[ extension->getId() ] = extension ;
      _orderedExtensionsForLoadParameters.push_back( extension ) ;
      _orderedExtensionsForPreCompute    .push_back( extension ) ;
      _orderedExtensionsForPostCompute   .push_back( extension ) ;
      ok = true ;
    }
    else 
    {
      // Duplicate Item
      errorMsg = "The extension \"" ;
      errorMsg += extension->getId().getString() ;
      errorMsg += "\" is a duplicate one" ;
    }
  }
  else
  {
    errorMsg = "No extension to add" ;
  }
  // Unable to add the extension => error message
  if( !ok )
  {
    OMTRACEID( OMK_DEBUG_OMK_EXT, 
      "Error to add extension" << std::endl
      << ">>> :-( " << errorMsg << "." << std::endl ) ; 
  }
}
//-----------------------------------------------------------------
Extension* ExtensionManager::removeExtension( const Name& id ) 
{
  Extension* extension = 0 ;
  // look for the extension
  ExtensionStore::iterator i = _extensions.find( id ) ;
  if( i != _extensions.end() ) 
  { 
    extension = i->second ;
    // remove the extension
    _extensions.erase( i ) ;
    _orderedExtensionsForLoadParameters.remove( extension ) ;
    _orderedExtensionsForPreCompute.remove( extension ) ;
    _orderedExtensionsForPostCompute.remove( extension ) ;
    OMTRACEID( OMK_DEBUG_OMK_EXEC, "Information for " << debugMsg( extension, 0 ) << std::endl
      << ">>> :-) removed from object" ) ;
  }
  else 
  {
    // unknow Item
    OMTRACEID( OMK_DEBUG_OMK_EXT, 
      "Unable to remove the extension from" << std::endl
      << ">>> :-( The extension \"" << id << "\" is not an extension of this object." << std::endl ) ; 
  }
  return extension ;
}
//-----------------------------------------------------------------
Extension* ExtensionManager::getExtension( const Name& id ) 
{
  Extension* extension = 0 ;
  // look for the extension
  ExtensionStore::iterator i = _extensions.find( id ) ;
  if( i != _extensions.end() ) 
  { 
    extension = i->second ;
  }
  else 
  {
    // unknow Item
    OMTRACEID( OMK_DEBUG_OMK_EXT, 
      "Unable to find the extension" << std::endl
      << ">>> :-( The extension \"" << id << "\" is not an extension of this object." << std::endl ) ; 
  }
  return extension ;
}
//-----------------------------------------------------------------
Extension* ExtensionManager::createAndAddExtension( ExtensibleSimulatedObject* owner, const Name& classId, const Name& id ) 
{
  Extension *extension = ExtensionFactory::getInstance().create( classId )( owner, id, false ) ;
  if( extension )
  {
    addExtension( extension ) ;
    OMTRACEID( OMK_DEBUG_OMK_EXEC, "Information for " << debugMsg( extension ) << std::endl
      << ">>> :-) Created" ) ;
  }
  else
  {
    OMTRACEID( OMK_DEBUG_OMK_EXT, 
      "Error to create extension" << std::endl
      << ">>> :-( Unable to create the extension \"" << id << "\" with the class id \"" << classId << "\"." << std::endl ) ; 
  }
  return extension ;
}
//-----------------------------------------------------------------

}// namespace OMK

---