lib/maracasVisuLib/src/kernel/marObject.h

   1 /*# ---------------------------------------------------------------------
   2 #
   3 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   4 #                        pour la Sant�)
   5 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   6 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
   7 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
   8 #
   9 #  This software is governed by the CeCILL-B license under French law and
  10 #  abiding by the rules of distribution of free software. You can  use,
  11 #  modify and/ or redistribute the software under the terms of the CeCILL-B
  12 #  license as circulated by CEA, CNRS and INRIA at the following URL
  13 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  14 #  or in the file LICENSE.txt.
  15 #
  16 #  As a counterpart to the access to the source code and  rights to copy,
  17 #  modify and redistribute granted by the license, users are provided only
  18 #  with a limited warranty  and the software's author,  the holder of the
  19 #  economic rights,  and the successive licensors  have only  limited
  20 #  liability.
  21 #
  22 #  The fact that you are presently reading this means that you have had
  23 #  knowledge of the CeCILL-B license and that you accept its terms.
  24 # ------------------------------------------------------------------------ */
  25
  26 /*=========================================================================
  27
  28   Program:   wxMaracas
  29   Module:    $RCSfile: marObject.h,v $
  30   Language:  C++
  31   Date:      $Date: 2012/11/15 14:16:12 $
  32   Version:   $Revision: 1.6 $
  33
  34   Copyright: (c) 2002, 2003
  35   License:
  36
  37      This software is distributed WITHOUT ANY WARRANTY; without even
  38      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  39      PURPOSE.  See the above copyright notice for more information.
  40
  41 =========================================================================*/
  42 #ifndef __MAR__KERNEL__OBJECT__HXX__
  43 #define __MAR__KERNEL__OBJECT__HXX__
  44
  45 #include <string>
  46 #include "marTypes.h"
  47 #include "marParameters.h"
  48
  49 /** /def marObject
  50  *  \brief General maracas object.
  51  */
  52 class creaMaracasVisu_EXPORT marObject
  53 {
  54     public:
  55
  56     /** Default constructor.
  57      */
  58     marObject( marParameters* p );
  59
  60     /** Default destructor.
  61      */
  62     virtual ~marObject( );
  63
  64     /** Parameters assignation methods.
  65      *
  66      *  You can assign a marParameters object by reference (setParameters)
  67      *  or by value (copyParameters).
  68      *  Besides, if you want to make your actual reference to be by value,
  69      *  call makeACopyParameters.
  70      */
  71     void setParameters( marParameters* p );
  72     void copyParameters( marParameters* p );
  73     void makeACopyParameters( )
  74     {
  75             copyParameters( _parameters );
  76     }
  77
  78     /** Parameters analizers.
  79      */
  80     marParameters* getParameters( ) { return( _parameters ); };
  81     bool parametersOwned( ) { return( _parametersCopied ); };
  82
  83     /** Virtual general methods
  84      *  (must be defined in each sub-class).
  85      */
  86     virtual void reset( ) = 0;
  87     virtual void copyFrom( const marObject& from ) = 0;
  88
  89     /** Virtual persistence methods
  90      *  (must be defined in each sub-class).
  91      */
  92     virtual bool save( std::ofstream& os ) = 0;
  93     virtual bool load( std::ifstream& is ) = 0;
  94
  95     /** Persistence methods
  96      */
  97     bool save( std::string& nw );
  98     bool load( std::string& nr );
  99
 100     private:
 101
 102     marParameters* _parameters;
 103     bool _parametersCopied;
 104
 105 };
 106
 107 #endif // __MAR__KERNEL__OBJECT__HXX__
 108
 109 // eof - marObject.h