OMKAddInputKeyPrm.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_INP_ADDINPUTKEYPRM_H
#define OMK_INP_ADDINPUTKEYPRM_H

#include <string> 
#include "OMKName.h"
#include "OMKInputs.h"

namespace OMK
{
class SimulatedObject ;
class ConfigurationParameterDescriptor ;
namespace Inp
{

class OMKINPUTS_API AddInputKeyPrm : public OMK::Type::Base
{
public:


  AddInputKeyPrm();
  AddInputKeyPrm( const AddInputKeyPrm& ref ) ;
  AddInputKeyPrm( const std::string& key,
                  const Name& listeningObjectId ) ;
  virtual ~AddInputKeyPrm() ;


public:
  virtual void resetDefaultValues() ;
  virtual bool loadParameters( const ConfigurationParameterDescriptor * node, 
                               const std::string& prefix = "", 
                               SimulatedObject* p = 0 ) ;
protected:
  bool innerParametersLoader( const ConfigurationParameterDescriptor * node, 
                              const std::string& prefix = "", 
                              SimulatedObject* p = 0 ) ;


public:
  void setListeningObjectId( const Name& listeningObjectId ) { _listeningObjectId = listeningObjectId ; }
  const Name& getListeningObjectId() const { return _listeningObjectId ; }

  void setKey( const std::string& key ) { _key = key ; }
  const std::string& getKey() const { return _key ; }



  bool operator == ( const AddInputKeyPrm& ref ) const { return !( *this != ref ) ; } 
  bool operator != ( const AddInputKeyPrm& ref ) const ;
  AddInputKeyPrm& operator = ( const AddInputKeyPrm& ref ) ;
  

public:
  virtual void insertInStream( std::ostream& = std::cout ) const ;
  virtual void extract       ( std::istream& = std::cin  ) ;

  virtual void pack  ( OutgoingSynchronisationMessage& out ) const ;
  virtual void unpack( IncomingSynchronisationMessage& in  ) ;

  virtual OMK::Type::PolatorNT* createPolator() ;
protected:
  void _copy( const AddInputKeyPrm& ref ) ;
  




  std::string _key ;
  Name _listeningObjectId ;
} ;
    } // namespace Inp
} // namespace OMK
#endif // defined OMK_INP_ADDINPUTKEYPRM_H

---