OSDLPeriodicalActiveObject.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_PERIODICAL_ACTIVE_OBJECT_H_
#define OSDL_PERIODICAL_ACTIVE_OBJECT_H_



#include "OSDLActiveObject.h"   // for inheritance
#include "OSDLPeriodicSlot.h"   // for Period, SchedulingException
#include "OSDLEngineCommon.h"   // for ObjectSchedulingPolicy, Weight, etc. 


#include <string>




namespace OSDL
{



    namespace Engine 
    {
    
    
    
            
        class OSDL_DLL PeriodicalActiveObject : public ActiveObject
        {
        
        
            public:
            
                
                
                explicit PeriodicalActiveObject( 
                    Ceylan::System::Millisecond periodDuration, 
                    bool autoRegister = true,
                    Ceylan::Maths::Percentage maxErrorPercentage = 5 ) ;
                            
                            
                        
                PeriodicalActiveObject( 
                    Events::Period period, 
                    bool autoRegister,
                    ObjectSchedulingPolicy policy, 
                    Weight weight ) ;
                            
                
                
                virtual ~PeriodicalActiveObject() throw() ;




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

                
                
                virtual Events::Period getPeriod() const ;
                
                
                
                virtual void setPeriod( Events::Period newPeriod ) ;
                                                 
                 
                 
                virtual Ceylan::Maths::Hertz setFrequency( 
                    Ceylan::Maths::Hertz newFrequency ) ; 
                
                    
                    
                virtual Events::Period getSubslotNumber() const ;
                
                    
                    
                virtual void onRegistering( Events::Period subslot ) ;


                    
                virtual void setBirthTick( 
                    Events::SimulationTick currentSimulationTick ) ;


                    
                virtual Events::SimulationTick
                    convertDurationToActivationCount(
                        Ceylan::System::Millisecond duration ) const ;
        
        
        
                virtual const std::string toString( 
                        Ceylan::VerbosityLevels level = Ceylan::high ) const ;
                    
                
                
                    
            protected:      

                
                Events::Period _period ;
                            
                
                                
                Events::Period _subslot ;
                                
                
        } ;
        

    }

}



#endif // OSDL_PERIODICAL_ACTIVE_OBJECT_H_

---