OSDLEngineCommon.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2003-2009 Olivier Boudeville
 *
 * This file is part of the OSDL library.
 *
 * The OSDL library is free software: you can redistribute it and/or modify
 * it under the terms of either the GNU Lesser General Public License or
 * the GNU General Public License, as they are published by the Free Software
 * Foundation, either version 3 of these Licenses, or (at your option) 
 * any later version.
 *
 * The OSDL 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 and the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License and of the GNU General Public License along with the OSDL library.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * Author: Olivier Boudeville (olivier.boudeville@esperide.com)
 *
 */


#ifndef OSDL_ENGINE_COMMON_H_
#define OSDL_ENGINE_COMMON_H_



#include "OSDLException.h"      // for Exception
#include "OSDLEvents.h"         // for SimulationTick

#include <string>
#include <list>




/*
 * This file has for purpose to solve all intricated dependency links 
 * existing between the scheduler, the active objects and the periodic slots.
 *
 */
 
 
 

namespace OSDL
{



    namespace Engine 
    {
    
    
        
        // Forward declarations:
        class ActiveObject ;

        class PeriodicalActiveObject ;
        class ProgrammedActiveObject ;
        
        
        
        class OSDL_DLL EngineException : public OSDL::Exception
        {
            public:
        
                explicit EngineException( const std::string & reason ) ;
                
                virtual ~EngineException() throw() ;
            
        } ;

        
        
        class OSDL_DLL SchedulingException : public EngineException
        {
            public:
        
                explicit SchedulingException( const std::string & reason ) ;
                
                virtual ~SchedulingException() throw() ;
            
        } ;



        typedef std::list<PeriodicalActiveObject *> ListOfActiveObjects ;

        
        
        typedef std::list<PeriodicalActiveObject *>
            ListOfPeriodicalActiveObjects ;



        typedef std::list<ProgrammedActiveObject *>
            ListOfProgrammedActiveObjects ;



        typedef Ceylan::Uint16 Weight ;
        
        
        
        enum ObjectSchedulingPolicy { relaxed, strict } ;
        
        
    
        typedef std::list<Events::SimulationTick> SimulationTickList ;
        
        
        
        typedef Ceylan::Uint32 Delay ;
            
        
        
    }
    
}   



#endif // OSDL_ENGINE_COMMON_H_

---