OSDLActiveObject.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_ACTIVE_OBJECT_H_
#define OSDL_ACTIVE_OBJECT_H_



#include "OSDLEngineCommon.h"   // for ObjectSchedulingPolicy, Weight, etc. 

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

#include <string>




namespace OSDL
{



    namespace Engine 
    {
    
    
    
            
        class OSDL_DLL ActiveObject : public Ceylan::TextDisplayable
        {
        
        
        
            public:
            
            
            
                explicit ActiveObject( ObjectSchedulingPolicy policy = relaxed, 
                    Weight weight = 1 ) ;
                                
                
                
                virtual ~ActiveObject() throw() ;




                // Registering section.
                
                
                
                virtual void registerToScheduler() = 0 ;
                
                
                
                virtual void unregisterFromScheduler() = 0 ;
                
                
                
                
                
                // Settings section.


                
                virtual ObjectSchedulingPolicy getPolicy() const ;
                
                
                
                virtual Weight getWeight() const ;
                
                
                
                virtual Events::SimulationTick getBirthTick() const ;
                
                
                
                virtual void setBirthTick( 
                    Events::SimulationTick currentSimulationTick ) ;

                
                
                virtual void onActivation( 
                    Events::SimulationTick newTick ) = 0 ;


                
                virtual void onSkip( Events::SimulationTick skippedTick ) ;



                virtual void onImpossibleActivation( 
                    Events::SimulationTick missedTick ) ;
                
                
                
                /*
                 * No onRegistering abstract method declared here, as 
                 * depending on the child class it takes different 
                 * parameters.
                 *
                 */
                 
        
        
                virtual const std::string toString( 
                    Ceylan::VerbosityLevels level = Ceylan::high ) const ;
                    
                
                
                    
            protected:      
        
                
                
                Events::SimulationTick getLocalTime() const ;


                
                ObjectSchedulingPolicy _policy ;
                
                
                
                 Weight _weight ;
                 
                 
                                
                bool _registered ;
                
                 
                 
                Events::SimulationTick _birthTick ;
                
                
                
        } ;
        

    }

}



#endif // OSDL_ACTIVE_OBJECT_H_

---