OSDLActiveObject.h

Go to the documentation of this file.

#ifndef OSDL_ACTIVE_OBJECT_H_
#define OSDL_ACTIVE_OBJECT_H_



#include "OSDLPeriodicSlot.h"   // for Period, SchedulingException
#include "OSDLEngineCommon.h"   // for ObjectSchedulingPolicy, Weight, etc. 
#include "OSDLEvents.h"         // for SimulationTick

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

#include <string>
#include <list>



namespace OSDL
{


    namespace Engine 
    {
    
            
        class OSDL_DLL ActiveObject : public Ceylan::TextDisplayable
        {
        
        
            public:
            
            
                typedef std::list<Events::SimulationTick> SimulationTickList ;
                
            
                explicit ActiveObject( Events::Period period = 1, 
                    ObjectSchedulingPolicy policy = relaxed, 
                    Weight weight = 1 ) throw() ;
                
                
                explicit ActiveObject( 
                    const SimulationTickList & triggeringStates, 
                    bool absolutlyDefined = true, 
                    ObjectSchedulingPolicy policy = relaxed, 
                    Weight weight = 1 ) throw() ;
                
                
                explicit ActiveObject( Events::SimulationTick triggerTick, 
                    bool absolutlyDefined, 
                    ObjectSchedulingPolicy policy = relaxed, 
                    Weight weight = 1 ) throw() ;
                
                
                virtual ~ActiveObject() throw() ;

                
                virtual ObjectSchedulingPolicy getPolicy() const throw() ;
                
                
                virtual Weight getWeight() const throw() ;
                
                
                virtual Events::Period getPeriod() const throw() ;
                
                
                virtual void setPeriod( Events::Period newPeriod ) throw() ;
                 
                 
                virtual Events::Hertz setFrequency( 
                    Events::Hertz newFrequency ) throw( SchedulingException ) ; 
                    
                    
                virtual bool hasProgrammedActivations() const throw() ;
                

                bool areProgrammedActivationsAbsolute() const throw() ;
                
                
                void absoluteProgrammedActivationsWanted( bool on ) throw() ;
                 
                
                virtual const SimulationTickList & getProgrammedActivations() 
                    const throw( SchedulingException ) ;
                
                                  
                virtual void setProgrammedActivations( 
                    const SimulationTickList & newActivationsList ) throw() ;
                
                
                virtual void addProgrammedActivations( 
                        const SimulationTickList & additionalActivationsList )
                    throw() ;
                
                
                virtual void setUniqueProgrammedTicks() throw() ;
                
                
                virtual Events::SimulationTick getBirthTime() const throw() ;
                
                
                virtual void setBirthTime( 
                    Events::SimulationTick birthSimulationTick ) throw() ;
                
                
                virtual void onActivation( 
                    Events::SimulationTick newTick ) throw() = 0 ;

                
                virtual void onSkip( Events::SimulationTick skippedStep ) 
                    throw( SchedulingException ) ;


                virtual void onImpossibleActivation( 
                        Events::SimulationTick missedStep ) 
                    throw( SchedulingException ) ;
                
        
                virtual const std::string toString( 
                        Ceylan::VerbosityLevels level = Ceylan::high ) 
                    const throw() ;
                    
                
                    
            protected:      
        
                
                Events::SimulationTick getLocalTime() const throw() ;


                
                ObjectSchedulingPolicy _policy ;
                
                
                 Weight _weight ;
                 
                
                Events::Period _period ;
                
                
                SimulationTickList * _programmedTriggerTicks ;
                 
                 
                bool _absoluteTriggers ; 
        
                 
                Events::SimulationTick _birthTime ;
                
                
        } ;

    }

}


#endif // OSDL_ACTIVE_OBJECT_H_

---