ActiveObjectAce.hpp

Go to the documentation of this file.

/*
Copyright 2007, 2008, 2009, 2010, 2011 Instituto de Sistemas e Robotica, Instituto Superior Tecnico

This file is part of MeRMaID.

MeRMaID 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 3 of the License, or
(at your option) any later version.

MeRMaID 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 MeRMaID.  If not, see <http://www.gnu.org/licenses/>.
*/



/**
 * @Filename ActiveObjectAce.hpp
 * @Description ActiveObjectAce declaration
 * @Status Work in Progress
 * @Version $Id: ActiveObjectAce.hpp 1 2011-03-04 18:13:18Z jreis $
 * @Maintainer nmsra (nmsra@mega.ist.utl.pt)
 */


#ifndef __ACTIVEOBJECT_ACTIVEOBJECTACE_H
#define __ACTIVEOBJECT_ACTIVEOBJECTACE_H

#include "ActiveObject.hpp"
#include "ActiveObjectAceAddTaskMethod.hpp"


//ACE stuff
#include <ace/Activation_Queue.h>
#include "ace/Task.h"


namespace mermaid
{
  namespace support
  {
    namespace activeobject
    {
    
      /**
      * @Class ActiveObjectAce ActiveObjectAce.hpp "ActiveObjectAce.hpp"
      * @Description ActiveObjectAce interface
      * @Author Marco Barbosa + Nelson Ramos
      */
      class ActiveObjectAce : public ActiveObject, public ACE_Task<ACE_MT_SYNCH>
      {
      
          friend class ActiveObjectAceAddTaskMethod;
          friend class ActiveObjectAceRunTaskMethod;
          
        public:
          ActiveObjectAce (ActiveObjectManager * aom);
          
          virtual ~ActiveObjectAce();
          
          /**
          * this method start the active object.
          * @Author Marco Barbosa + Nelson Ramos
          */
          void start();
          
          /**
          * this method stop the active object.
          * @Author Marco Barbosa + Nelson Ramos
          */
          void stop();
          
          //mermaid internal stuff
          
          virtual void addTask (shared_ptr<Task> t);
          
          virtual void addTaskInternal (shared_ptr<Task> t);
          
          
        protected:
        
          //mermaid internal stuff implementation
          
          virtual void addTaskImplementation (shared_ptr<Task> t);
          //virtual void runTaskImplementation(shared_ptr<Task> t);
          
          
        private:
        
          //activation queue
          ACE_Activation_Queue activationQueue_;
          
          
          //ACE stuff
          
          /**
          * this method is that one that runs when the task is activated.
          * @Author Marco Barbosa + Nelson Ramos
          */
          int svc (void);
          
      }; // ActiveObject
    } // namespace activeobject
  } // namespace support
} // namespace mermaid

#endif // __ACTIVEOBJECT_ACTIVEOBJECTACE_H