OMKAccessibleParameterPrm.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 ACCESSIBLEPARAMETERPRM_H
#define ACCESSIBLEPARAMETERPRM_H

#include "OMKControlTakeOverPrm.h"
#include "OMKExtensibleSimulatedObject.h"
#include "OMKName.h"
#include <map>

namespace OMK
{
class OutgoingSynchronisationMessage ;
class IncomingSynchronisationMessage ;
class ConfigurationParameterDescriptor ;
namespace Type
{
class AccessibleParameterPrm ;
}
template<>
OMKIII_API bool ParametersAccessor::getValue< OMK::Type::AccessibleParameterPrm >
                    ( const ConfigurationParameterDescriptor * nodeValue, 
                      OMK::Type::AccessibleParameterPrm& value, 
                      std::string& errorStr ) ;
}
OMKIII_API std::ostream& operator << ( std::ostream& out, const OMK::Type::AccessibleParameterPrm& a ) ;

OMKIII_API std::istream& operator >> ( std::istream& in, OMK::Type::AccessibleParameterPrm& a ) ;

OMKIII_API OMK::OutgoingSynchronisationMessage& operator << 
  ( OMK::OutgoingSynchronisationMessage& out, const OMK::Type::AccessibleParameterPrm& a ) ;

OMKIII_API OMK::IncomingSynchronisationMessage& operator >> 
  ( OMK::IncomingSynchronisationMessage& in, OMK::Type::AccessibleParameterPrm& a ) ;


namespace OMK
{
namespace Iii
{
  class IConnector ;
}
namespace Type
{
class OMKIII_API AccessibleParameterPrm
{
  public:


  AccessibleParameterPrm();
  AccessibleParameterPrm( const AccessibleParameterPrm& ref ) ;
  AccessibleParameterPrm( const OMK::Iii::IConnector* connector, 
                          const AccessGroup& accessGroup ) ;
  AccessibleParameterPrm( OMK::Name id,
                          OMK::Name category,
                          OMK::Name type,
                          bool accessible,
                          const std::map< OMK::Name, int >& levels,
                          const std::list< OMK::Name >& toolsInUse ) ;
  virtual ~AccessibleParameterPrm() ;
  AccessibleParameterPrm& operator = ( const AccessibleParameterPrm& ref ) ;


public:
  OMK::Name _id ;
  OMK::Name _category ;
  OMK::Name _type ;
  bool _accessible ;
  std::map< OMK::Name, int > _levels ;
  std::list< OMK::Name > _toolsInUse ;
protected:
  void _copy( const AccessibleParameterPrm& q ) ;


  friend OMKIII_API bool operator != ( const AccessibleParameterPrm& a0, const AccessibleParameterPrm& a1 ) ;
  friend OMKIII_API bool operator == ( const AccessibleParameterPrm& a0, const AccessibleParameterPrm& a1 ) 
    { return !( a0 != a1 ) ; }

  friend class OMK::ParametersAccessor ;


  // stream operator for ostream.
  friend std::ostream& ::operator << ( std::ostream& out, const AccessibleParameterPrm& a ) ;

  // stream operator for istream.
  friend std::istream& ::operator >> ( std::istream& in, AccessibleParameterPrm& a ) ;

  // stream operator for OutgoingSynchronisationMessage.
  friend OMK::OutgoingSynchronisationMessage& ::operator << 
    ( OMK::OutgoingSynchronisationMessage& out, const AccessibleParameterPrm& a ) ;

  // stream operator for IncomingSynchronisationMessage.
  friend OMK::IncomingSynchronisationMessage& ::operator >> 
    ( OMK::IncomingSynchronisationMessage& in, AccessibleParameterPrm& a ) ;
} ;

//-----------------------------------------------------------------------------
typedef OMK::Type::SimpleTypeT< AccessibleParameterPrm > AccessibleParameterPrmType ;

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

} //namespace Type

//========================================================================
template class OMKIII_API OMK::Type::SimpleTypeT< OMK::Type::AccessibleParameterPrmType > ;

}// namespace OMK

#endif // defined ACCESSIBLEPARAMETERPRM_H

---