OSDLProgrammedActiveObject.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_PROGRAMMED_ACTIVE_OBJECT_H_
#define OSDL_PROGRAMMED_ACTIVE_OBJECT_H_



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


#include <string>
#include <list>




namespace OSDL
{



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





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

                bool areProgrammedActivationsAbsolute() const ;
                
                
                
                void absoluteProgrammedActivationsWanted( bool on ) ;
                 
                
                
                virtual const SimulationTickList & getProgrammedActivations() 
                    const ;
                
                
                                  
                virtual void setProgrammedActivations( 
                    const SimulationTickList & newActivationsList ) ;
                
                
                
                virtual void addProgrammedActivations( 
                    const SimulationTickList & additionalActivationsList ) ;
                
                    
                    
                virtual void onRegistering() ;
                
                
            
                virtual const std::string toString( 
                    Ceylan::VerbosityLevels level = Ceylan::high ) const ;
                    
                
                
                    
            protected:      
        
                
/* 
 * Takes care of the awful issue of Windows DLL with templates.
 *
 * @see Ceylan's developer guide and README-build-for-windows.txt 
 * to understand it, and to be aware of the associated risks. 
 * 
 */
#pragma warning( push )
#pragma warning( disable: 4251 )
                        
                SimulationTickList _programmedTicks ;
                 
#pragma warning( pop ) 


                 
                bool _absoluteTicks ; 
        
                                
                
        } ;
        

    }

}



#endif // OSDL_PROGRAMMED_ACTIVE_OBJECT_H_

---