OMK::FrameScheduler Class Reference

the basic frame scheduler, where each scheduled object is queued on the appropriate frame for multifrequential execution More...

#include <OMKFrameScheduler.h>

Inheritance diagram for OMK::FrameScheduler:

[legend]Collaboration diagram for OMK::FrameScheduler:

[legend]List of all members.

Public Member Functions
	FrameScheduler (unsigned int numberOfSteps)
	constructor, specifying the numeber of different simulation stpes in a simualtion cycle
virtual	~FrameScheduler ()
	destructor
virtual void	addToScheduable (ReferenceObjectHandle *ref, unsigned int when)
	add an object to the list of scheduable objects
virtual void	removeFromScheduable (ReferenceObjectHandle *ref)
	remove an object from the list of scheduable objects
virtual void	schedule (ReferenceObjectHandle *ref)
	mark an object as active
virtual void	unschedule (ReferenceObjectHandle *ref)
	mark an object as inactive
virtual void	runStep (unsigned int which)
	run the scheduler for a certain simulation step
Protected Attributes
DoubleList **	Frames
	tha data strcuture associated to the scheduler

---

Detailed Description

the basic frame scheduler, where each scheduled object is queued on the appropriate frame for multifrequential execution

Definition at line 27 of file OMKFrameScheduler.h.

---

Constructor & Destructor Documentation

FrameScheduler::FrameScheduler

(

unsigned int

numberOfSteps

)

constructor, specifying the numeber of different simulation stpes in a simualtion cycle

Definition at line 28 of file OMKFrameScheduler.cpp.

References OMK::Scheduler::_numberOfSteps, Frames, OMK_DEBUG_OMK_EXEC, and OMTRACEID.

                                                         :
   Scheduler(numberOfSteps)
{
   OMTRACEID( OMK_DEBUG_OMK_EXEC, "FrameScheduler::FrameScheduler ( " << numberOfSteps << " )" );

   Frames = new DoubleList *[_numberOfSteps];
   for(unsigned int i = 0 ; i < _numberOfSteps ; i++) 
   {
      Frames[i]=new DoubleList();
   }  
}

FrameScheduler::~FrameScheduler

(

)

[virtual]

destructor

Definition at line 40 of file OMKFrameScheduler.cpp.

References OMK::Scheduler::_numberOfSteps, and Frames.

{
  if (Frames!=NULL) 
  {
    for(unsigned int i = 0 ; i <_numberOfSteps ; i ++) 
    {
      if(Frames[ i ]!=NULL) delete Frames[i];
    }
    delete [] Frames;
  }
}

---

Member Function Documentation

void FrameScheduler::addToScheduable	(	ReferenceObjectHandle *	ref,
		unsigned int	when
	)			[virtual]

add an object to the list of scheduable objects

Parameters:

	ref	the reference handler of the added object
	when	the index in the cycle of the simulation step where the object should be added

Implements OMK::Scheduler.

Definition at line 53 of file OMKFrameScheduler.cpp.

References Frames, OMK::SimulatedObject::getName(), OMK::ObjectHandle::getSimulatedObject(), OMK::DoubleList::insert(), OMK_DEBUG_OMK_EXEC, and OMTRACEID.

{
   OMTRACEID( OMK_DEBUG_OMK_EXEC, "FrameScheduler::addToScheduable( \"" << ref->getSimulatedObject().getName() << "\", "<<when<<" )" );

   Frames[when]->insert(ref) ;
}

void FrameScheduler::removeFromScheduable

(

ReferenceObjectHandle *

ref

)

[virtual]

remove an object from the list of scheduable objects

Implements OMK::Scheduler.

Definition at line 60 of file OMKFrameScheduler.cpp.

References OMK::Scheduler::_numberOfSteps, Frames, OMK::SimulatedObject::getName(), OMK::ObjectHandle::getSimulatedObject(), OMK_DEBUG_OMK_EXEC, and OMTRACEID.

{
   OMTRACEID( OMK_DEBUG_OMK_EXEC, "FrameScheduler::removeFromScheduable ( \"" << ref->getSimulatedObject().getName() << "\" )" ) ;

   for (unsigned int i = 0 ; i < _numberOfSteps ; i++ ) 
   {
      Frames[i] -> remove ( ref ) ;
   }
}

void FrameScheduler::schedule

(

ReferenceObjectHandle *

ref

)

[virtual]

mark an object as active

Implements OMK::Scheduler.

Definition at line 70 of file OMKFrameScheduler.cpp.

References OMK::Scheduler::_numberOfSteps, Frames, OMK::SimulatedObject::getName(), OMK::ObjectHandle::getSimulatedObject(), OMK_DEBUG_OMK_EXEC, and OMTRACEID.

{
   OMTRACEID( OMK_DEBUG_OMK_EXEC, "FrameScheduler::schedule( \"" << ref->getSimulatedObject().getName() << "\" )" ) ;

   for (unsigned int i = 0 ; i < _numberOfSteps ; i++ ) 
   {
      Frames[i] -> activate ( ref ) ;
   }
}

void FrameScheduler::unschedule

(

ReferenceObjectHandle *

ref

)

[virtual]

mark an object as inactive

Implements OMK::Scheduler.

Definition at line 80 of file OMKFrameScheduler.cpp.

References OMK::Scheduler::_numberOfSteps, Frames, OMK::SimulatedObject::getName(), OMK::ObjectHandle::getSimulatedObject(), OMK_DEBUG_OMK_EXEC, and OMTRACEID.

{
   OMTRACEID( OMK_DEBUG_OMK_EXEC, "FrameScheduler::unschedule \"" << ref->getSimulatedObject().getName() << "\" )" ) ;

   for (unsigned int i = 0 ; i < _numberOfSteps ; i++ ) 
   {
      Frames[i] -> suspend ( ref ) ;
   }
}

void FrameScheduler::runStep

(

unsigned int

which

)

[virtual]

run the scheduler for a certain simulation step

Parameters:

which

the index in the cycle of the step to be run

Implements OMK::Scheduler.

Definition at line 91 of file OMKFrameScheduler.cpp.

References OMK::debugMsg(), Frames, OMK::ObjectHandle::getSimulatedObject(), OMK::DoubleListElement::listeElem, OMK::DoubleList::next(), OMK_DEBUG_OMK_EXEC, and OMTRACEID.

{
   OMTRACEID( OMK_DEBUG_OMK_EXEC, "FrameScheduler::runStep: Running step " << which ) ;
   DoubleListElement * pListe ;
   for( pListe = Frames [which]->begin () ;
              pListe != NULL ; 
              pListe = Frames[which]->next (pListe)) 
   {
     OMTRACEID( OMK_DEBUG_OMK_EXEC, "Calling compute of "<< OMK::debugMsg( &pListe->listeElem->getSimulatedObject() ) ) ;
      (*pListe).listeElem->compute () ;
      OMTRACEID( OMK_DEBUG_OMK_EXEC, "Compute of "<< OMK::debugMsg( &pListe->listeElem->getSimulatedObject() ) << " done" ) ;
   }

}

---

Member Data Documentation

DoubleList* * OMK::FrameScheduler::Frames [protected]

tha data strcuture associated to the scheduler

Definition at line 60 of file OMKFrameScheduler.h.

Referenced by addToScheduable(), FrameScheduler(), removeFromScheduable(), runStep(), schedule(), unschedule(), and ~FrameScheduler().

---