OMKConfigurationParameterDescriptor.h

Go to the documentation of this file.

 /*
 * This file is part of openMask © 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 Université de Rennes 1 
 * for the software may use this file in accordance with that specific license 
 *
 */
#ifndef OMKCONFIGURATIONPARAMETERDESCRIPTORHEADER
#define OMKCONFIGURATIONPARAMETERDESCRIPTORHEADER

#include <string>

#include "OMKFlowable.h"

namespace OMK
{

class OMK_API ConfigurationParameterDescriptor : public Flowable
{
public: 
   ConfigurationParameterDescriptor() ;

   ConfigurationParameterDescriptor(const ConfigurationParameterDescriptor &) ;

   virtual ~ConfigurationParameterDescriptor() ;

   virtual const std::string & getAssociatedString () const = 0 ; 

   virtual const ConfigurationParameterDescriptor * getSubDescriptorByName (const std::string & descriptorName ) const = 0;
   
   virtual const ConfigurationParameterDescriptor * getSubDescriptorByPosition (int descriptorPosition) const = 0;

   virtual ConfigurationParameterDescriptor * getSubDescriptorByName (const std::string & descriptorName ) = 0;
   
   virtual ConfigurationParameterDescriptor * getSubDescriptorByPosition (int descriptorPosition) = 0;

   virtual int getNumberOfSubItems () const = 0;

   virtual int appendSubDescriptor(ConfigurationParameterDescriptor * subDescriptor ) = 0 ;


   virtual int appendSubDescriptorNamed (const std::string & descriptorName, ConfigurationParameterDescriptor * subDescriptor )  = 0 ;

   virtual ConfigurationParameterDescriptor * clone () const = 0 ;

   virtual void extract (std::istream & = std::cin) = 0 ;

   virtual void insertInStream (std::ostream & = std::cout) const = 0 ;

   virtual void printToStream (std::ostream & out, int offset ) const = 0 ;

   virtual void unpack (IncomingSynchronisationMessage &) = 0 ;
   
   virtual void pack (OutgoingSynchronisationMessage &) const = 0 ;

};

void printTabToStream (std::ostream & out, int nbSpaces) ;
} // namespace OMK

#endif // OMKCONFIGURATIONPARAMETERDESCRIPTORHEADER

---