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

using namespace OMK ;
using namespace OMK::Inp ;
using namespace OMK::Type ;
//========================================================================
// Default constructor
AddInputKeyPrm::AddInputKeyPrm()
: Base(),
  _key( "" ),
  _listeningObjectId()
{
}

//========================================================================
// Copy constructor
AddInputKeyPrm::AddInputKeyPrm( const AddInputKeyPrm& ref )
: Base()
{
  _copy( ref ) ;
}

//========================================================================
// Constructor with the parameters
AddInputKeyPrm::AddInputKeyPrm( const std::string& key,
                                const Name& listeningObjectId )
: Base(),
  _key( key ),
  _listeningObjectId( listeningObjectId )
{
}

//========================================================================
// Destructor
AddInputKeyPrm::~AddInputKeyPrm()
{
}

//========================================================================
// Default values for parameters
void AddInputKeyPrm::resetDefaultValues()
{
  //=== Reset default parameters
  _key = "" ;
}
                
//========================================================================
// Configuration parameters loader
bool AddInputKeyPrm::loadParameters( const ConfigurationParameterDescriptor * node, 
                               const std::string& prefix,
                               SimulatedObject* p )
{
  resetDefaultValues() ;
  return innerParametersLoader( node, prefix, p );
}

//========================================================================
// Configuration parameters loader
bool AddInputKeyPrm::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 AddInputKeyPrm::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 needed parameters => tested
  // Load the value of Key
  ok = ParametersAccessor::get( node, prefix + "Key", _key, p ) && ok ;
  // Load the value of ListeningObjectId
  ok = ParametersAccessor::get( node, prefix + "ObjectName", _listeningObjectId, p ) && ok ;

  return ok ;
}
                

//========================================================================
// != operator
bool AddInputKeyPrm::operator != ( const AddInputKeyPrm& ref ) const
{
  return _key != ref.getKey()
      || _listeningObjectId != ref.getListeningObjectId() ;
}

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

//========================================================================
// insert in stream
void AddInputKeyPrm::insertInStream( std::ostream& out ) const 
{
  out << getKey() << " "
      << getListeningObjectId() << " "
      << " " ;
}

//========================================================================
// extract from a stream
void AddInputKeyPrm::extract( std::istream& in ) 
{
  in >> _key
     >> _listeningObjectId ;
}

//========================================================================
// pack
void AddInputKeyPrm::pack( OutgoingSynchronisationMessage& out ) const
{
  out << getKey()
      << getListeningObjectId()  ;
}

//========================================================================
// unpack
void AddInputKeyPrm::unpack( IncomingSynchronisationMessage& in ) 
{
  in >> _key
     >> _listeningObjectId ;
}

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

//========================================================================
// Protected copy methods
void AddInputKeyPrm::_copy( const AddInputKeyPrm& ref )
{
  _key = ref.getKey() ; 
  _listeningObjectId = ref.getListeningObjectId() ; 
}

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

---