ModuleFunctions.hpp

Go to the documentation of this file.

/***************************************************************************
 * Copyright (C) 2005 by Benjamin Hadorn (bhadorn@swissinfo.org)           *
 ***************************************************************************
 * Projekt : Zeus
 * Module  : ModuleFunctions
 * Package : MOM
 * Author  : Benjamin Hadorn
 * Datum   : $Date: 3.11.09 16:01 $
 * Ablage  : $File$
 * System  : Cell Computing Model
 ***************************************************************************
 * Licence:                                                                *
 *   This library is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU Lesser General Public License as        *
 *   published by the Free Software Foundation; either version             *
 *   2.1 of the License, or (at your option) any later version.            *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the          *
 *   GNU Lesser General Public License for more details.                   *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA  *
 ***************************************************************************/

/***************************************************************************
 Changes :
 $Log: /Development_F/StuderWIN/dev/Zeus/src/zeusbase/MOM/ModuleFunctions.hpp $
** 
** 12    3.11.09 16:01 Bha
** comments corrected
**
** 11    26.02.07 9:00 bha
**
** 8     20.10.06 10:23 bha
** Redesign of IXObject interface
***************************************************************************/

#ifndef ModuleFunctionsHPP
#define ModuleFunctionsHPP

#include <zeusbase/MOM/Module.h>
#include <zeusbase/MOM/Interfaces/IModule.hpp>


BEGIN_NAMESPACE_Zeus


/*************************************************************************/
/*************************************************************************/
template <class TModuleType> class TModuleFunctions
{
  public:

    /*************************************************************************/
    /*************************************************************************/
    static void activateFirstChild(TModuleType& rMod, bool& rActiveFlag)
    {
      Int iCount = rMod.getChildCount();
      bool bFound = false;
      IXObject* pObject = NULL;
      IModule* pModule = NULL;
      for(Int i = 0; i < iCount && !bFound; i++)
      {
        if (rMod.getChild(i, pObject) == RET_NOERROR)
        {
          if (pObject->askForInterface(INTERFACE_IModule, ICAST(pModule)) == RET_NOERROR)
          {
            //Secure code: The flag must be set befor calling the activate() method
            rActiveFlag = true;

            pModule->activate();
            pModule->release();
            bFound = true;
          }
          pObject->release();
        }
      }
    }

    /***************************************************************************/
    /***************************************************************************/
    static Retval getModule(TModuleType& rMod, const IString& rName, IModule*& rpModule)
    {
      Retval retValue = RET_REQUEST_FAILED;
      IXObject* pObject = NULL;
      retValue = rMod.getObject(rName, pObject);
      if (retValue == RET_NOERROR)
      {
        if (pObject->askForInterface(INTERFACE_IModule, ICAST(rpModule)) == RET_NOERROR)
        {
          retValue = RET_NOERROR;
        }
        else
        {
          retValue = RET_REQUEST_FAILED;
        }
        pObject->release();
      }
      return retValue;
    }

};


END_NAMESPACE_Zeus

#endif