OSDLModel.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_MODEL_H_
#define OSDL_MODEL_H_



#include "OSDLPeriodicalActiveObject.h"   // for inheritance
#include "OSDLProgrammedActiveObject.h"   // for inheritance
#include "OSDLEngineCommon.h"             // for ObjectSchedulingPolicy

#include "Ceylan.h"                       // for VerbosityLevels, inheritance


#include <string>
#include <list>




namespace OSDL
{



    namespace MVC 
    {
    
        
        
        /*
         * Here two kinds of event-based OSDL models are defined:
         *   - PeriodicalModel
         *   - ProgrammedModel
         *
         * @note In both cases, the Ceylan base event-driven MVC framework
         * is used, not the templated Generic MVC system.
         *
         */
            
            
            
            
        class OSDL_DLL PeriodicalModel : public Ceylan::Model, 
            public Engine::PeriodicalActiveObject
        {
        
        
            public:
            
            
            
                explicit PeriodicalModel( 
                    Events::Period period = 1,
                    bool autoRegister = true, 
                    Engine::ObjectSchedulingPolicy policy = Engine::relaxed,
                    Engine::Weight weight = 1 ) ;
                
                
                            
                virtual ~PeriodicalModel() throw() ;



                virtual const std::string toString( 
                    Ceylan::VerbosityLevels level = Ceylan::high ) const ;
            
                
        } ;




        class OSDL_DLL ProgrammedModel : public Ceylan::Model, 
            public Engine::ProgrammedActiveObject
        {
        
        
            public:
            
            
            
                explicit ProgrammedModel( 
                    const Engine::SimulationTickList & activationTicks,
                    bool absolutelyDefined = true, 
                    bool autoRegister = true, 
                    Engine::ObjectSchedulingPolicy policy = Engine::relaxed,
                    Engine::Weight weight = 1 ) ;
                
                
                
                explicit ProgrammedModel( 
                    Events::SimulationTick activationTick, 
                    bool absolutelyDefined = true, 
                    bool autoRegister = true, 
                    Engine::ObjectSchedulingPolicy policy = Engine::relaxed,
                    Engine::Weight weight = 1 ) ;
                
                    
                            
                virtual ~ProgrammedModel() throw() ;



                virtual const std::string toString( 
                    Ceylan::VerbosityLevels level = Ceylan::high ) const ;
            
            
                
        } ;
        

    }

}



#endif // OSDL_MODEL_H_

---