OMKOutputAlias.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 OutputAliasHEADER
#define OutputAliasHEADER

#include "OMKOutput.h"
#include "OMKTracer.h"

namespace OMK
{
//-----------------------------------------------------------------
/* An output alias
 * aliases are use to shared an output between an object and it's sons in the simulation tree
 * @author Olivier Filangi (version 1.0)
 * @version 1.3 (revision $revision$ )
 * \li 1.0 -> 1.1 by David Margery: english version of an alias
 * \li 1.1 -> 1.2 by David Margery: changed support for aliases of aliases : reponsability for correct alias linking is now responsability of this class
 * \li 1.2 -> 1.3 by David Margery (2002/06/04): added support for virtual inheritance of OMKKernelAttribute
 */

template< typename T >
class OutputAlias : public Output< T >
{
public:
    OutputAlias( const Name & name,
                 SimulatedObject & owner,
                 Output< T > * outputAliased,
                 int historyLength,
                 OMK::Type::PolatorNT * polator = NULL ) ;

   virtual ~OutputAlias() ;


   virtual void unsetAlias() ;

   virtual void setUsedOutput( Output< T > * output ) ;

   virtual void unalias() ;

   virtual void aliasedOutputDeleted() ;

   virtual void alias( Output< T > * aliasedOutput ) ;

protected:

   Output< T > * _aliasedOutput ;

}; // OutputAlias


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


template< typename T >
inline OutputAlias< T >::OutputAlias( const Name & aliasName,
                                      SimulatedObject & owner,
                                      Output< T > * aliasedOutput,
                                      int historyLength,
                                      OMK::Type::PolatorNT * polator ) 
  : KernelAttribute( owner, aliasName ),
    Output< T >( aliasName, owner, historyLength, polator ),
    _aliasedOutput( aliasedOutput )
{

   OMASSERT( aliasedOutput != 0 ) ;
   aliasedOutput->setAlias( this ) ;
   aliasedOutput->setUsedOutput( this ) ;
}

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

template< class T >
inline OutputAlias< T >::~OutputAlias()
{
  unalias() ;
}

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

template< class T >
void OutputAlias< T >::setUsedOutput( Output< T > * output )
{
  Output< T >::setUsedOutput( output ) ; 
  if( _aliasedOutput != 0 )
  {
    _aliasedOutput->setUsedOutput( output ) ;
  }
}

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

template< typename T >
inline void OutputAlias< T >::unalias()
{
  if( _aliasedOutput != 0 )
  {
    _aliasedOutput->unsetAlias() ;
    setUsedOutput( this ) ;
    _aliasedOutput = 0 ;
  }
}

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

template< typename T > 
inline void OutputAlias< T >::unsetAlias()
{
  Output< T >::unsetAlias() ;
}

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

template< typename T >
inline void OutputAlias< T >::alias( Output< T > * aliasedOutput )
{
   OMASSERT( aliasedOutput != 0 ) ;
   if( _aliasedOutput != 0 )
   {
     unalias() ;
     _aliasedOutput = aliasedOutput ;
   }
   aliasedOutput->setAlias( this ) ;
   aliasedOutput->setUsedOutput( this ) ;
}

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

template< typename T >
inline void OutputAlias< T >::aliasedOutputDeleted()
{
  _aliasedOutput = 0 ;
}

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

} // namespace OMK

#endif

---