OMKAddVisualObjectPrm.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 _ADDVISUALOBJECTPRM_H_
#define _ADDVISUALOBJECTPRM_H_

#include "OMKBase.h" 
#include <string> 
#include "OMKName.h"
#include "OMKVis.h"

namespace OMK
{ 
class SimulatedObject ;
class ConfigurationParameterDescriptor ;
namespace Type
{ 

class OMKVIS_API AddVisualObjectPrm : public Base
{
public:


  AddVisualObjectPrm();
  AddVisualObjectPrm( const AddVisualObjectPrm& ref ) ;
  AddVisualObjectPrm( const Name& objectName,
                      const Name& classId,
                      const Name& VisuName,
                      const ConfigurationParameterDescriptor* configParam ) ;
  virtual ~AddVisualObjectPrm() ;


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 setObjectName( const Name& objectName ) { _objectName = objectName ; }
  const Name& getObjectName() const { return _objectName ; }

  void setClassId( const Name& classId ) { _classId = classId ; }
  const Name& getClassId() const { return _classId ; }

  void setVisuName( const Name& VisuName ) { _visuName = VisuName ; }
  const Name& getVisuName() const { return _visuName ; }

  void setConfigParam( const ConfigurationParameterDescriptor* configParam ) { _configParam = configParam ; }
  const ConfigurationParameterDescriptor* getConfigParam() const { return _configParam ; }



  bool operator == ( const AddVisualObjectPrm& ref ) const { return !( *this != ref ) ; } 
  bool operator != ( const AddVisualObjectPrm& ref ) const ;
  AddVisualObjectPrm& operator = ( const AddVisualObjectPrm& 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 PolatorNT* createPolator() ;
protected:
  void _copy( const AddVisualObjectPrm& ref ) ;
  




  Name _objectName ;
  Name _classId ;
  Name _visuName ;
  const ConfigurationParameterDescriptor* _configParam ;
} ;
} // namespace Type
} // namespace OMK
#endif // defined _ADDVISUALOBJECTPRM_H_

---