OMKAddVisualObjectPrm.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 "OMKAddVisualObjectPrm.h"
#include "OMKSimulatedObject.h"
#include "OMKParametersAccessor.inl"
#include "OMKMultipleConfigurationParameter.h"
#include <vector>
#include <string>
#include <iostream>

using namespace OMK ;
using namespace OMK::Type ;
//========================================================================
// Default constructor
AddVisualObjectPrm::AddVisualObjectPrm()
: Base(),
  _classId(),
  _configParam( 0 )
{
}

//========================================================================
// Copy constructor
AddVisualObjectPrm::AddVisualObjectPrm( const AddVisualObjectPrm& ref )
: Base(),
  _configParam( 0 )
{
  _copy( ref ) ;
}

//========================================================================
// Constructor with the parameters
AddVisualObjectPrm::AddVisualObjectPrm( const Name& objectName,
                                        const Name& classId,
                                        const Name& VisuName,
                                        const ConfigurationParameterDescriptor* configParam )
: Base(),
  _objectName( objectName ) ,
  _classId( classId ) ,
  _visuName( VisuName ) ,
  _configParam( configParam ? configParam->clone() : 0 ) 
{
}

//========================================================================
// Destructor
AddVisualObjectPrm::~AddVisualObjectPrm()
{
  delete _configParam ;
}

//========================================================================
// Default values for parameters
void AddVisualObjectPrm::resetDefaultValues()
{
  //=== Reset default parameters
  _classId = Name() ;
  delete _configParam ;
  _configParam = 0 ;
}
                
//========================================================================
// Configuration parameters loader
bool AddVisualObjectPrm::loadParameters( const ConfigurationParameterDescriptor * node, 
                               const std::string& prefix,
                               SimulatedObject* p )
{
  resetDefaultValues() ;
  return innerParametersLoader( node, prefix, p );
}

//========================================================================
// Configuration parameters loader
bool AddVisualObjectPrm::innerParametersLoader( const ConfigurationParameterDescriptor * node, const std::string& prefix, SimulatedObject* p )
{
  // Tests the configuration parameter node
  if( !node )
  { // No valid node => display error message and return false
    std::ostringstream txt ;
    txt << "Error in AddVisualObjectPrm::innerParametersLoader";
    if( p ) txt << " for " << OMK::debugMsg( p ) ;
    txt << std::endl << ">>> :-( Invalid node" << std::endl ; 
    OMERROR( txt.str() ) ;
    return false ;
  }
  // return value
  bool ok = true ;

  //=== The optional parameters => no test
  // Load the value of VisuName
  ParametersAccessor::get( node, prefix + "VisuName", _visuName ) ;
  // Load the value of ObjectName
  ParametersAccessor::get( node, prefix + "ObjectName", _objectName ) ;

  //=== The needed parameters => tested
  // Load the value of ClassId
  ok = ParametersAccessor::get( node, prefix + "Class", _classId, p ) && ok ;
  // save the value of ConfigParam
  _configParam = node->clone() ;

  return ok ;
}
                

//========================================================================
// != operator
bool AddVisualObjectPrm::operator != ( const AddVisualObjectPrm& ref ) const
{
  return _objectName != ref.getObjectName()
      || _classId != ref.getClassId()
      || _visuName != ref.getVisuName()
      || _configParam != ref.getConfigParam() ;
}

//========================================================================
// copy operator
AddVisualObjectPrm& AddVisualObjectPrm::operator = ( const AddVisualObjectPrm& ref )
{
  if ( this != &ref ) 
  {
    _copy( ref ) ;
  }
  return *this ;
}  

//========================================================================
// insert in stream
void AddVisualObjectPrm::insertInStream( std::ostream& out ) const 
{
  out << getObjectName() << " "
      << getClassId() << " "
      << getVisuName() << " "
      << *getConfigParam() << " " 
          << " " ;
}

//========================================================================
// extract from a stream
void AddVisualObjectPrm::extract( std::istream& in ) 
{
  in >> _objectName
     >> _classId
     >> _visuName ;
  // At this step we must retrieve the configuration parameters
  // we assume that is a MultipleConfigurationParameter
  MultipleConfigurationParameter* configParamTmp = new MultipleConfigurationParameter ;
  in >> ( *configParamTmp ) ;
  delete _configParam ;
  _configParam = configParamTmp ;
}

//========================================================================
// pack
void AddVisualObjectPrm::pack( OutgoingSynchronisationMessage& out ) const
{
  out << getObjectName()
      << getClassId()
      << getVisuName() 
          << *getConfigParam() ;
}

//========================================================================
// unpack
void AddVisualObjectPrm::unpack( IncomingSynchronisationMessage& in ) 
{
  in >> _objectName
     >> _classId
     >> _visuName ;
  // At this step we must retrieve the configuration parameters
  // we assume that is a MultipleConfigurationParameter
  MultipleConfigurationParameter* configParamTmp = new MultipleConfigurationParameter ;
  in >> ( *configParamTmp ) ;
  delete _configParam ;
  _configParam = configParamTmp ;
}

//========================================================================
// create a default polator
PolatorNT* AddVisualObjectPrm::createPolator() 
{
  return new Polator<AddVisualObjectPrm>() ;
}

//========================================================================
// Protected copy methods
void AddVisualObjectPrm::_copy( const AddVisualObjectPrm& ref )
{
  _objectName = ref.getObjectName() ; 
  _classId = ref.getClassId() ; 
  _visuName = ref.getVisuName() ; 
  delete _configParam ;
  _configParam = ref.getConfigParam() ? ref.getConfigParam()->clone() : 0 ; 
}

//========================================================================

---