OMK::ObjectDescriptor Class Reference

object of this class are used to store the description of simulated object, with data meaningfull for object outside the kernel. More...

#include <OMKObjectDescriptor.h>

Inheritance diagram for OMK::ObjectDescriptor:

[legend]Collaboration diagram for OMK::ObjectDescriptor:

[legend]List of all members.

member functions using the object descriptor as a node of the simulation tree
typedef std::list< ObjectDescriptor * >	SonsContainerType
	The type of the container memorizing the sons of the described object in the simulation tree.
virtual const ObjectDescriptor *	getFathersObjectDescriptor () const
	get the object descriptor of the father
virtual ObjectDescriptor *	getFathersObjectDescriptor ()
	get the object descriptor of the father
virtual SonsContainerType &	getSons ()
	get a container with all the sons of this object in the simulation tree
virtual const std::list< ObjectDescriptor * > *	getSons () const
	get a container with all the sons of this object in the simulation tree the resulting list should be deleted
virtual std::list< const ObjectDescriptor * > *	getDescendants () const
	get a container with all the descendants of this object in the simualtion tree the result should be deleted after usage if the object has no descendants, an empty list is returned
virtual std::list< const ObjectDescriptor * > *	getDescendants (std::list< const ObjectDescriptor * > *resultList) const
	get a container with all the descendants of this object in the simualtion tree
virtual std::list< ObjectDescriptor * > *	getDescendants ()
	get a container with all the descendants of this object in the simualtion tree the result should be deleted after usage if the object has no descendants, an empty list is returned
virtual std::list< ObjectDescriptor * > *	getDescendants (std::list< ObjectDescriptor * > *resultList)
	get a container with all the descendants of this object in the simualtion tree
virtual void	addSon (ObjectDescriptor *newSon)
	add a son in the simulation tree to the described object If called after initialisation of the controller, isn't taken into account by the controller
virtual void	removeSon (ObjectDescriptor *oldSon)
	remove a son in the simulation tree If called after initialisation of the controller, isn't taken into account by the controller
template<typename type>
std::list< const ObjectDescriptor * > *	listSonsOfType () const
	listSonsOfType.
template<typename type>
std::list< const ObjectDescriptor * > *	listSonsOfType (std::list< const ObjectDescriptor * > *resultList) const
	list the sons of a certain Type.
template<typename type>
std::list< const ObjectDescriptor * > *	listDescendantsOfType () const
	listDescendantsOfType.
template<typename type>
std::list< const ObjectDescriptor * > *	listDescendantsOfType (std::list< const ObjectDescriptor * > *resultList) const
	listDescendantsOfType.
virtual const ObjectDescriptor *	findDescendantNamed (const Name &name) const
	find a descendant of this node
virtual ObjectDescriptor *	findDescendantNamed (const Name &name)
	find a descendant of this node
static void	interpretConfigurationParameterAsListOfSons (SonsContainerType &listOfSons, MultipleConfigurationParameter *sonsDescription)
	helper function, to help interpret a object described as a configuration parameter
static ObjectDescriptor *	interpretConfigurationParameterAsObjectDescription (std::string objectName, MultipleConfigurationParameter *)
	helper function, to create a object described as a configuration parameter
Public Types
enum	Distribution {   DEFAULT_OBJECT = 0,   LOCAL_OBJECT,   DUPLICATED_OBJECT }
Public Member Functions
	ObjectDescriptor ()
	default constructor needed for an object descriptor to be included in a valued event for distributed creation
	ObjectDescriptor (const ObjectDescriptor &)
	copy constructor
	ObjectDescriptor (const Name &objectName, const Name &classId, MultipleConfigurationParameter *schedulingParameters, ConfigurationParameterDescriptor *configurationParameters, ConfigurationParameterDescriptor *extensionParameters=0)
	Constructor responsability of the destruction of schedulingParameters and configurationParameters is transfered to the object.
	ObjectDescriptor (const Name &objectName, const Name &classId, const Frequency &frequency, ConfigurationParameterDescriptor *configurationParameters, ConfigurationParameterDescriptor *extensionParameters=0, Distribution distribution=DEFAULT_OBJECT)
	Constructor, used as a shortcut for constructing correct scheduling parameters responsability of the destruction of configurationParameters is transfered to the object.
	ObjectDescriptor (const Name &objectName, const Name &classId, const Name &processId, const Frequency &frequency, ConfigurationParameterDescriptor *configurationParameters, ConfigurationParameterDescriptor *extensionParameters=0, Distribution distribution=DEFAULT_OBJECT)
	Constructor, used as a shortcut for constructing correct scheduling parameters responsability of the destruction of configurationParameters is transfered to the object.
virtual	~ObjectDescriptor ()
	Destructor.
virtual const Name &	getName () const
	get the name of the described object
virtual const Name &	getClass () const
	get the class name of the described object
virtual const Name &	getProcess () const
	get the process wich this object is affected to
virtual const Frequency &	getFrequency () const
	get the frequency of the described object
virtual const Frequency &	getOriginalFrequency () const
	get the original frequency of the described object
virtual Distribution	getDistribution () const
	get the object type (default, local or duplicated)
virtual const ConfigurationParameterDescriptor *	getConfigurationParameters () const
	get the configuration parameters of the controled object
virtual ConfigurationParameterDescriptor *	getConfigurationParameters (bool create=false)
	get the configuration parameters of the controled object
virtual const ConfigurationParameterDescriptor *	getExtensionsParameters () const
	get the extensions parameters of the controled object
virtual ConfigurationParameterDescriptor *	getExtensionsParameters (bool create=false)
	get the extensions parameters of the controled object
virtual const MultipleConfigurationParameter *	getOriginalSchedulingParameters () const
	get the configuration parameters of the controled object
virtual const MultipleConfigurationParameter *	getSchedulingParameters () const
	get the configuration parameters of the controled object
virtual void	setProcess (const Name &newProcessName)
	change the process of the described object
virtual void	setFrequency (const Frequency &newFrequency)
	change the frequency of the described object
virtual void	setDistribution (Distribution newDistribution)
	change the distribution of the described object
virtual void	deleteCachedData ()
	in the event this object description contains cached data, delete it
virtual void	unpack (IncomingSynchronisationMessage &in)
	unpack from a synchronisation message
virtual void	pack (OutgoingSynchronisationMessage &out) const
	pack in a synchronisation message
virtual void	extract (std::istream &in)
	extract from a stream
virtual void	insertInStream (std::ostream &out) const
	insert in a stream
virtual MultipleConfigurationParameter *	getSchedulingParameters ()
	get the configuration parameters of the controled object (non const version)
Protected Member Functions
virtual SimulatedObject *	createDescribedObject () const
	create the described object if _pointerToSimulatedObject is nil, create the described object.
virtual void	setFathersDescription (ObjectDescriptor *newFather)
void	interpretSchedulingParameters (MultipleConfigurationParameter *schedulingParameters)
	interpret a ConfigurationParameterDescriptor as the initial scheduling parameters non virtual because called by the constructor
virtual void	printToStream (std::ostream &out, int currentOffset) const
	pretty insert in a stream
Protected Attributes
SimulatedObject *	_pointerToSimulatedObject
	if a simulated object corresponding to this descriptor has been created, a pointer to this object is memorised here.
bool	_destroySimulatedObject
	a pointer indicating if _pointerToSimulatedObject is deletable by this object
Name	_objectName
	decribed object's name
Name	_classId
	decribed object's class
ConfigurationParameterDescriptor *	_configurationParameters
	described object's configuration parameters (isn't const to enable extraction
ConfigurationParameterDescriptor *	_extensionsParameters
	described object's extension parameters (isn't const to enable extraction
MultipleConfigurationParameter *	_originalSchedulingParameters
	described object's scheduling parameters
MultipleConfigurationParameter *	_schedulingParameters
	described object's scheduling parameters
ObjectDescriptor *	_fathersDescription
	a pointer to the objects father in the simulation tree
SonsContainerType	_sonsContainer
	a container with all of the sons of an object.
bool	_creatingObject
	the boolean used to avoid recursive creation : should be accessed only protected
pthread_t	_creatingThread
	the thread id of the creating lock
Private Attributes
Name	_processId
	decribed object's current process (stored to avoid reinterpreting the scheduling parameters)
Frequency	_frequency
	decribed object's current frequency (stored to avoid reinterpreting the scheduling parameters)
Distribution	_distribution
	decribed object's current distribution (stored to avoid reinterpreting the scheduling parameters)
Frequency	_originalFrequency
	decribed object's current frequency (stored to avoid reinterpreting the scheduling parameters)
Friends
class	Controller
	make the controller a friend so that only controllers can ask for the creation of the described simulation object and change the father of an object
class	ObjectHandle
	make the object handle a friend so that only controllers can change the boolean indicating delete responsability
class	SimulatedObject
	make the simulated object friend so it can change the _pointerToSimulatedObject as early as possible

---

Detailed Description

object of this class are used to store the description of simulated object, with data meaningfull for object outside the kernel.

Objects of this class store real data, and not references or pointers to data. Therefore, whatever the means of creation of any simulated object, the permanent location for its general data is in objects of this class. An object handle is responsible for the creation of the corresponding simulated object and of its destruction if its destruction wasn't handled over to the object's handle.

Author:

Siames

Version:

1.0

2007/03/05 Benoît Chanclou added the Type to add a new property in the simulated object instead of the ugly subclassing in OMKLocalObject and OMKDuplicatedObject, these classes were deleted. Add the Distribution field in the Sheduling parameter to allow the object to be Local or Duplicated. By default if this parameter is not defined, the distibution is the usual one. Example

visuOgre
{
...
        Class OgreVis
        Scheduling
        {
                Frequency 25
                Distribution Local
        }
        UserParams
        {
...

Definition at line 69 of file OMKObjectDescriptor.h.

---

Member Typedef Documentation

typedef std::list< ObjectDescriptor * > OMK::ObjectDescriptor::SonsContainerType

The type of the container memorizing the sons of the described object in the simulation tree.

Definition at line 245 of file OMKObjectDescriptor.h.

---

Member Enumeration Documentation

enum OMK::ObjectDescriptor::Distribution

Enumerator:

DEFAULT_OBJECT
LOCAL_OBJECT
DUPLICATED_OBJECT

Definition at line 77 of file OMKObjectDescriptor.h.

   {
     DEFAULT_OBJECT = 0,
     LOCAL_OBJECT,
     DUPLICATED_OBJECT
   } ;

---

Constructor & Destructor Documentation

ObjectDescriptor::ObjectDescriptor

(

)

[explicit]

default constructor needed for an object descriptor to be included in a valued event for distributed creation

Definition at line 33 of file OMKObjectDescriptor.cpp.

References OMASSERT.

Referenced by interpretConfigurationParameterAsObjectDescription(), and ObjectDescriptor().

  : _pointerToSimulatedObject( 0 ),
    _destroySimulatedObject( false ),
    _configurationParameters( 0 ),
    _extensionsParameters( 0 ),
    _originalSchedulingParameters( 0 ),
    _schedulingParameters( 0 ),
    _fathersDescription( 0 ),
    _creatingObject( false ),
#ifndef _MSC_VER
    _creatingThread( 0 ),
#endif
    _frequency( 0 ),
    _distribution( DEFAULT_OBJECT ),
    _originalFrequency( 0 )
{
  // otherwise, the initial value of _creatingThread is inappropriate
#if !defined _MSC_VER && defined _OMK_MUTEX_
  OMASSERT( pthread_self() != 0 ) ;
#endif
}

ObjectDescriptor::ObjectDescriptor

(

const ObjectDescriptor &

)

copy constructor

Definition at line 55 of file OMKObjectDescriptor.cpp.

References _configurationParameters, _destroySimulatedObject, _extensionsParameters, _originalSchedulingParameters, _pointerToSimulatedObject, _schedulingParameters, _sonsContainer, addSon(), OMK::MultipleConfigurationParameter::clone(), OMK::ConfigurationParameterDescriptor::clone(), ObjectDescriptor(), and OMASSERT.

  : _pointerToSimulatedObject( 0 ),
    _destroySimulatedObject( false ),
    _objectName( orig._objectName ),
    _classId( orig._classId ),
    _configurationParameters( 0 ),
    _extensionsParameters( 0 ),
    _originalSchedulingParameters( 0 ),
    _schedulingParameters( 0 ),
    _fathersDescription( 0 ),
    _creatingObject( false ),
    _processId( orig._processId ),
    _frequency( orig._frequency ),
    _distribution( orig._distribution ),
    _originalFrequency( orig._originalFrequency )
{
  _configurationParameters =
    orig._configurationParameters != 0 ?
    orig._configurationParameters->clone() : 0 ;

  _extensionsParameters =
    orig._extensionsParameters != 0 ?
    orig._extensionsParameters->clone() : 0 ;

  _originalSchedulingParameters =
    orig._originalSchedulingParameters != 0 ?
    static_cast< MultipleConfigurationParameter *>(
      orig._originalSchedulingParameters->clone() ) : 0 ;

  _schedulingParameters =
    orig._schedulingParameters != 0 ?
    static_cast< MultipleConfigurationParameter *>(
      orig._schedulingParameters->clone() ) : 0 ;

  // Only one descriptor by object. Assume descriptor is copied only before
  // the described object is created
  OMASSERT( orig._pointerToSimulatedObject == 0 ) ;
  OMASSERT( orig._destroySimulatedObject == false ) ;

  // copy the sons
  for( SonsContainerType::const_iterator i = orig._sonsContainer.begin() ;
       i != orig. _sonsContainer.end() ;
       ++i )
  {
    addSon( new ObjectDescriptor( *( *i ) ) ) ;
  }
}

ObjectDescriptor::ObjectDescriptor	(	const Name &	objectName,
		const Name &	classId,
		MultipleConfigurationParameter *	schedulingParameters,
		ConfigurationParameterDescriptor *	configurationParameters,
		ConfigurationParameterDescriptor *	extensionParameters = 0
	)

Constructor responsability of the destruction of schedulingParameters and configurationParameters is transfered to the object.

Definition at line 183 of file OMKObjectDescriptor.cpp.

References interpretSchedulingParameters(), and OMASSERT.

  : _pointerToSimulatedObject( 0 ),
    _destroySimulatedObject( false ),
    _objectName( objectName ),
    _classId( classId ),
    _configurationParameters( configurationParameters ),
    _extensionsParameters( extensionsParameters ),
    _originalSchedulingParameters( 0 ),
    _schedulingParameters( schedulingParameters ),
    _fathersDescription( 0 ),
    _creatingObject( false )
#if !defined _MSC_VER && defined _OMK_MUTEX_
    ,_creatingThread( 0 )
#endif
{
#if !defined _MSC_VER && defined _OMK_MUTEX_
  OMASSERT( pthread_self() != 0 ) ;
#endif

  interpretSchedulingParameters( schedulingParameters ) ;
}

ObjectDescriptor::ObjectDescriptor	(	const Name &	objectName,
		const Name &	classId,
		const Frequency &	frequency,
		ConfigurationParameterDescriptor *	configurationParameters,
		ConfigurationParameterDescriptor *	extensionParameters = 0,
		Distribution	distribution = DEFAULT_OBJECT
	)

Constructor, used as a shortcut for constructing correct scheduling parameters responsability of the destruction of configurationParameters is transfered to the object.

Definition at line 145 of file OMKObjectDescriptor.cpp.

References _originalSchedulingParameters, _schedulingParameters, OMK::MultipleConfigurationParameter::appendSubDescriptorNamed(), OMK::MultipleConfigurationParameter::clone(), and OMASSERT.

  : _pointerToSimulatedObject( 0 ),
    _destroySimulatedObject( false ),
    _objectName( objectName ),
    _classId( classId ),
    _configurationParameters( configurationParameters ),
    _extensionsParameters( extensionsParameters ),
    _originalSchedulingParameters( 0 ),
    _schedulingParameters( 0 ),
    _fathersDescription( 0 ),
    _creatingObject( false ),
#ifndef _MSC_VER
    _creatingThread( 0 ),
#endif
    _frequency( frequency ),
    _distribution( distribution ),
    _originalFrequency( frequency )
{
#if !defined _MSC_VER && defined _OMK_MUTEX_
  OMASSERT( pthread_self() != 0 ) ;
#endif

  _schedulingParameters = new MultipleConfigurationParameter() ;
  std::ostringstream freq ;
  freq << frequency ;
  _schedulingParameters->appendSubDescriptorNamed(
    "Frequency", 
    new UniqueConfigurationParameter( freq.str() ) ) ;
  _originalSchedulingParameters = static_cast< MultipleConfigurationParameter *>(
    _schedulingParameters->clone() ) ;
}

ObjectDescriptor::ObjectDescriptor	(	const Name &	objectName,
		const Name &	classId,
		const Name &	processId,
		const Frequency &	frequency,
		ConfigurationParameterDescriptor *	configurationParameters,
		ConfigurationParameterDescriptor *	extensionParameters = 0,
		Distribution	distribution = DEFAULT_OBJECT
	)

Constructor, used as a shortcut for constructing correct scheduling parameters responsability of the destruction of configurationParameters is transfered to the object.

Definition at line 103 of file OMKObjectDescriptor.cpp.

References _originalSchedulingParameters, _schedulingParameters, OMK::MultipleConfigurationParameter::appendSubDescriptorNamed(), OMK::MultipleConfigurationParameter::clone(), OMK::Name::getString(), and OMASSERT.

  : _pointerToSimulatedObject( 0 ),
    _destroySimulatedObject( false ),
    _objectName( objectName ),
    _classId( classId ),
    _configurationParameters( configurationParameters ),
    _extensionsParameters( extensionsParameters ),
    _originalSchedulingParameters( 0 ),
    _schedulingParameters( 0 ),
    _fathersDescription( 0 ),
    _creatingObject( false ),
#ifndef _MSC_VER
    _creatingThread( 0 ),
#endif
    _processId( processId ),
    _frequency( frequency ),
    _distribution( distribution ),
    _originalFrequency( frequency )
{
#if !defined _MSC_VER && defined _OMK_MUTEX_
  OMASSERT( pthread_self() != 0 ) ;
#endif
  _schedulingParameters = new MultipleConfigurationParameter() ;
  std::ostringstream freq ;
  freq << frequency ;
  _schedulingParameters->appendSubDescriptorNamed(
    "Frequency",
    new UniqueConfigurationParameter( freq.str() ) ) ;
  _schedulingParameters->appendSubDescriptorNamed(
    "Process",
    new UniqueConfigurationParameter( processId.getString() ) ) ;
  _originalSchedulingParameters = static_cast< MultipleConfigurationParameter *>(
    _schedulingParameters->clone() ) ;
}

ObjectDescriptor::~ObjectDescriptor

(

)

[virtual]

Destructor.

Definition at line 210 of file OMKObjectDescriptor.cpp.

References _configurationParameters, _destroySimulatedObject, _extensionsParameters, _fathersDescription, _originalSchedulingParameters, _pointerToSimulatedObject, _schedulingParameters, _sonsContainer, getName(), OMERROR, OMK_DEBUG_OMK_OBJ, OMTRACEID, and removeSon().

{
  if( _destroySimulatedObject )
  {
    if( _pointerToSimulatedObject == 0 )
    {
      OMERROR( "ObjectDescriptor::~ObjectDescriptor() destroying "
               << getName() << " in incooherant state" << std::endl ) ;
    }
    delete _pointerToSimulatedObject ;
  }

  if( _fathersDescription != 0 )
  {
    _fathersDescription->removeSon( this ) ;
  }

  delete _originalSchedulingParameters ;
  delete _schedulingParameters ;
  delete _configurationParameters ;
  delete _extensionsParameters ;

  if( !_sonsContainer.empty() )
  {
    OMTRACEID( OMK_DEBUG_OMK_OBJ, "ObjectDescriptor with "
               << _sonsContainer.size()
               << " remaining sons deleted. Sons not deleted" << std::endl ) ;
  }
}

---

Member Function Documentation

virtual const Name& OMK::ObjectDescriptor::getName

(

)

const [inline, virtual]

get the name of the described object

Definition at line 124 of file OMKObjectDescriptor.h.

Referenced by addSon(), OMK::PvmMirrorObjectHandle::cancelRegistrationForSignal(), createDescribedObject(), OMK::DistributedController::createDuplicatedObject(), OMK::DistributedController::createLocalObject(), OMK::DistributedController::createMirrorObject(), OMK::Controller::createReferenceObject(), OMK::Controller::deleteObject(), OMK::Controller::deleteObjectHandle(), findDescendantNamed(), OMK::SimulatedObject::getFather(), OMK::SimulatedObject::getName(), OMK::SimulatedObject::isAncestor(), OMK::operator<=(), printToStream(), OMK::Controller::processDeleteEventOf(), OMK::Controller::processEvent(), OMK::DistributedController::processNewObjectDeclaration(), OMK::PvmMirrorObjectHandle::receiveEvent(), OMK::PvmMirrorObjectHandle::receiveRegistrationForSignal(), OMK::Controller::sendInitialEventsTo(), setFathersDescription(), and ~ObjectDescriptor().

   {
     return _objectName ;
   }

virtual const Name& OMK::ObjectDescriptor::getClass

(

)

const [inline, virtual]

get the class name of the described object

Definition at line 131 of file OMKObjectDescriptor.h.

Referenced by createDescribedObject(), OMK::debugMsg(), OMK::Vis::VisObjectExtension::loadAnimatorParameters(), and printToStream().

   {
     return _classId ;
   }

virtual const Name& OMK::ObjectDescriptor::getProcess

(

)

const [inline, virtual]

get the process wich this object is affected to

Definition at line 138 of file OMKObjectDescriptor.h.

Referenced by OMK::DistributedController::createLocalObject(), OMK::DistributedController::createObject(), OMK::DistributedController::getPointerToSimulatedObjectNamed(), OMK::DistributedController::processEvent(), OMK::DistributedController::processNewObjectDeclaration(), OMK::PvmMirrorObjectHandle::PvmMirrorObjectHandle(), and OMK::PvmMirrorObjectHandle::sendRequestToReferenceObject().

   {
     return _processId ;
   }

virtual const Frequency& OMK::ObjectDescriptor::getFrequency

(

)

const [inline, virtual]

get the frequency of the described object

Definition at line 145 of file OMKObjectDescriptor.h.

Referenced by OMK::Controller::computeScheduling(), OMK::SimulatedObject::getPeriod(), OMK::DistributedController::getPointerToSimulatedObjectNamed(), OMK::Clock::init(), OMK::Controller::processNewObjectDeclaration(), and OMK::Controller::sendInitialEventsTo().

   {
     return _frequency ;
   }

virtual const Frequency& OMK::ObjectDescriptor::getOriginalFrequency

(

)

const [inline, virtual]

get the original frequency of the described object

Definition at line 152 of file OMKObjectDescriptor.h.

Referenced by OMK::Controller::computeScheduling().

   {
     return _originalFrequency ;
   }

virtual Distribution OMK::ObjectDescriptor::getDistribution

(

)

const [inline, virtual]

get the object type (default, local or duplicated)

Definition at line 159 of file OMKObjectDescriptor.h.

Referenced by OMK::Controller::getPointerToDuplicatedObjectNamed(), and OMK::DistributedController::getPointerToSimulatedObjectNamed().

   {
     return _distribution ;
   }

virtual const ConfigurationParameterDescriptor* OMK::ObjectDescriptor::getConfigurationParameters

(

)

const [inline, virtual]

get the configuration parameters of the controled object

Definition at line 166 of file OMKObjectDescriptor.h.

Referenced by OMK::SimulatedObject::getConfigurationParameters(), and printToStream().

   {
     return _configurationParameters ;
   }

ConfigurationParameterDescriptor * ObjectDescriptor::getConfigurationParameters

(

bool

create = false

)

[virtual]

get the configuration parameters of the controled object

Definition at line 241 of file OMKObjectDescriptor.cpp.

References _configurationParameters.

{
  if( create && !_configurationParameters )
  {
    _configurationParameters = new MultipleConfigurationParameter() ;
  }
  return _configurationParameters ;
}

virtual const ConfigurationParameterDescriptor* OMK::ObjectDescriptor::getExtensionsParameters

(

)

const [inline, virtual]

get the extensions parameters of the controled object

Definition at line 177 of file OMKObjectDescriptor.h.

Referenced by OMK::ExtensibleSimulatedObject::init(), and printToStream().

   {
     return _extensionsParameters ;
   }

ConfigurationParameterDescriptor * ObjectDescriptor::getExtensionsParameters

(

bool

create = false

)

[virtual]

get the extensions parameters of the controled object

Definition at line 251 of file OMKObjectDescriptor.cpp.

References _extensionsParameters.

{
  if( create && !_extensionsParameters )
  {
    _extensionsParameters = new MultipleConfigurationParameter() ;
  }
  return _extensionsParameters ;
}

virtual const MultipleConfigurationParameter* OMK::ObjectDescriptor::getOriginalSchedulingParameters

(

)

const [inline, virtual]

get the configuration parameters of the controled object

Definition at line 188 of file OMKObjectDescriptor.h.

   {
     return _originalSchedulingParameters ;
   }

virtual const MultipleConfigurationParameter* OMK::ObjectDescriptor::getSchedulingParameters

(

)

const [inline, virtual]

get the configuration parameters of the controled object

Definition at line 195 of file OMKObjectDescriptor.h.

Referenced by OMK::Controller::getSchedulingParametersOfObject(), and printToStream().

   {
     return _schedulingParameters ;
   }

void ObjectDescriptor::setProcess

(

const Name &

newProcessName

)

[virtual]

change the process of the described object

Definition at line 394 of file OMKObjectDescriptor.cpp.

References _processId, _schedulingParameters, OMK::MultipleConfigurationParameter::appendSubDescriptorNamed(), OMK::UniqueConfigurationParameter::changeConfigurationParameter(), OMK::Name::getCString(), and OMK::MultipleConfigurationParameter::getSubDescriptorByName().

Referenced by OMK::DistributedController::processEvent(), and OMK::Controller::setProcessOfDescriptor().

{
  _processId = newProcessName ;
  UniqueConfigurationParameter * description =
    dynamic_cast< UniqueConfigurationParameter * >(
      _schedulingParameters->getSubDescriptorByName( "Process" ) );
  if( description != 0 )
  {
    description->changeConfigurationParameter( newProcessName.getCString() ) ;
  }
  else
  {
    _schedulingParameters->appendSubDescriptorNamed(
      "Process", 
      new UniqueConfigurationParameter( newProcessName.getCString() ) ) ;
  }
}

void ObjectDescriptor::setFrequency

(

const Frequency &

newFrequency

)

[virtual]

change the frequency of the described object

Definition at line 412 of file OMKObjectDescriptor.cpp.

References _frequency, _schedulingParameters, OMK::MultipleConfigurationParameter::appendSubDescriptorNamed(), OMK::UniqueConfigurationParameter::changeConfigurationParameter(), and OMK::MultipleConfigurationParameter::getSubDescriptorByName().

Referenced by OMK::Controller::computeScheduling(), and OMK::Controller::reactToControlledObjectsSystemEvents().

{
  _frequency = newFrequency ;
   
  UniqueConfigurationParameter *description =
    dynamic_cast< UniqueConfigurationParameter * >(
      _schedulingParameters->getSubDescriptorByName( "Frequency" ) );
  if( description != 0 )
  {
    std::ostringstream freq ;
    freq << newFrequency ;
    description->changeConfigurationParameter( freq.str() ) ;
  }
  else
  {
    std::ostringstream freq ;
    freq << newFrequency ;
    _schedulingParameters->appendSubDescriptorNamed(
      "Frequency",
      new UniqueConfigurationParameter( freq.str() ) ) ;
  }
}

void ObjectDescriptor::setDistribution

(

Distribution

newDistribution

)

[virtual]

change the distribution of the described object

Definition at line 435 of file OMKObjectDescriptor.cpp.

References _distribution, _schedulingParameters, OMK::MultipleConfigurationParameter::appendSubDescriptorNamed(), OMK::UniqueConfigurationParameter::changeConfigurationParameter(), DUPLICATED_OBJECT, OMK::MultipleConfigurationParameter::getSubDescriptorByName(), and LOCAL_OBJECT.

{
  _distribution = newDistribution ;
   UniqueConfigurationParameter *description =
     dynamic_cast< UniqueConfigurationParameter * >(
       _schedulingParameters->getSubDescriptorByName( "Distribution" ) ) ;
   if( description != 0 )
   {
     description->changeConfigurationParameter(
       ( newDistribution == DUPLICATED_OBJECT ) ? "Duplicated" :
       ( ( newDistribution == LOCAL_OBJECT ) ? "Local" : "Default" ) ) ;
   }
   else
   {
     _schedulingParameters->appendSubDescriptorNamed(
       "Distribution", 
       new UniqueConfigurationParameter(
         ( newDistribution == DUPLICATED_OBJECT ) ? "Duplicated" :
         ( ( newDistribution == LOCAL_OBJECT ) ? "Local" : "Default" ) ) ) ;
   }
}

void ObjectDescriptor::deleteCachedData

(

)

[virtual]

in the event this object description contains cached data, delete it

Definition at line 724 of file OMKObjectDescriptor.cpp.

References _destroySimulatedObject, _pointerToSimulatedObject, and OMASSERT.

{
  if( _destroySimulatedObject )
  {
    OMASSERT( _pointerToSimulatedObject != 0 ) ;
    delete _pointerToSimulatedObject ;
    _pointerToSimulatedObject = 0 ;
  }
  _destroySimulatedObject = false ;
}

void ObjectDescriptor::unpack

(

IncomingSynchronisationMessage &

in

)

[virtual]

unpack from a synchronisation message

Reimplemented from OMK::Flowable.

Definition at line 261 of file OMKObjectDescriptor.cpp.

References extract().

{
  std::string messageBuffer ;
  in >> messageBuffer ;
  std::istringstream message( messageBuffer );
  extract(message ) ;
}

void ObjectDescriptor::pack

(

OutgoingSynchronisationMessage &

out

)

const [virtual]

pack in a synchronisation message

Reimplemented from OMK::Flowable.

Definition at line 269 of file OMKObjectDescriptor.cpp.

References printToStream().

{
  // packed in a quite inefficient way (unsing the string representation of the
  // object descriptor), 
  // but much simpler to decode : therefore, use extract
  std::ostringstream char_out ;
  printToStream( char_out, 0 ) ;
  out << char_out.str() ;
}

void ObjectDescriptor::extract

(

std::istream &

in

)

[virtual]

extract from a stream

Implements OMK::Flowable.

Definition at line 279 of file OMKObjectDescriptor.cpp.

References _classId, _configurationParameters, _extensionsParameters, _objectName, _sonsContainer, OMK::ConfigurationParameterDescriptor::getAssociatedString(), OMK::MultipleConfigurationParameter::getSubDescriptorByName(), interpretConfigurationParameterAsListOfSons(), and interpretSchedulingParameters().

Referenced by unpack().

{
  _sonsContainer.clear() ;
   
  KernelIstreamLexer< std::istream > inputStream( in ) ;
  DLGLexer scan( & inputStream ) ;
  ANTLRTokenBuffer pipe( & scan ) ;
  ANTLRTokenPtr aToken = new ANTLRToken() ;
  scan.setToken( mytoken( aToken ) ) ;
  genericKernelParser extractor( &pipe ) ;
  extractor.init() ;

  std::string stringName;
  extractor.key( stringName ) ;
  _objectName = stringName ;

  ConfigurationParameterDescriptor *genericSubDescription =
    extractor.anonymousValue() ;
  MultipleConfigurationParameter * generalDescription =
    dynamic_cast< MultipleConfigurationParameter * >( genericSubDescription );
  if( generalDescription == 0 )
  {
    throw UserException( "Unable to extract a name for an ObjectDescriptor from a stream" ) ;
  }

  genericSubDescription = generalDescription->getSubDescriptorByName( "Class" ) ;
  if( genericSubDescription == 0 ) 
  {
    throw UserException( "Unable to extract a class for an ObjectDescriptor from a stream") ;
  }
  _classId = genericSubDescription->getAssociatedString() ;

  delete _configurationParameters ;
  _configurationParameters =
    generalDescription->getSubDescriptorByName( "UserParams" ) ;

  delete _extensionsParameters ;
  _extensionsParameters =
    generalDescription->getSubDescriptorByName( "Extensions" ) ;

  genericSubDescription =
    generalDescription->getSubDescriptorByName( "Scheduling" ) ;
  if( genericSubDescription !=0 )
  {
    interpretSchedulingParameters(
      dynamic_cast< MultipleConfigurationParameter * >( genericSubDescription ) ) ;
  }
  else
  {
    interpretSchedulingParameters( 0 ) ;
  }

  genericSubDescription = generalDescription->getSubDescriptorByName( "Sons" ) ;
  generalDescription =
    dynamic_cast< MultipleConfigurationParameter * >( genericSubDescription ) ;
  if( generalDescription != 0 )
  {
    interpretConfigurationParameterAsListOfSons( _sonsContainer, generalDescription ) ;
  }
}

void ObjectDescriptor::insertInStream

(

std::ostream &

out

)

const [virtual]

insert in a stream

Implements OMK::Flowable.

Definition at line 389 of file OMKObjectDescriptor.cpp.

References printToStream().

{
  printToStream( out, 0 ) ;
} 

virtual const ObjectDescriptor* OMK::ObjectDescriptor::getFathersObjectDescriptor

(

)

const [inline, virtual]

get the object descriptor of the father

Definition at line 232 of file OMKObjectDescriptor.h.

Referenced by createDescribedObject(), OMK::Controller::deleteObject(), OMK::SimulatedObject::getFather(), OMK::SimulatedObject::getFathersDescriptor(), OMK::SimulatedObject::isAncestor(), and OMK::Controller::listBrothersOfType().

   {
     return _fathersDescription ;
   }

virtual ObjectDescriptor* OMK::ObjectDescriptor::getFathersObjectDescriptor

(

)

[inline, virtual]

get the object descriptor of the father

Definition at line 239 of file OMKObjectDescriptor.h.

   {
     return _fathersDescription ;
   }

virtual SonsContainerType& OMK::ObjectDescriptor::getSons

(

)

[inline, virtual]

get a container with all the sons of this object in the simulation tree

Definition at line 249 of file OMKObjectDescriptor.h.

Referenced by OMK::DistributedController::createControlledObjects(), OMK::Controller::createControlledObjects(), OMK::Controller::destroyObject(), and OMK::Controller::finish().

   {
     return _sonsContainer ;
   }

virtual const std::list< ObjectDescriptor * >* OMK::ObjectDescriptor::getSons

(

)

const [inline, virtual]

get a container with all the sons of this object in the simulation tree the resulting list should be deleted

Definition at line 257 of file OMKObjectDescriptor.h.

   {
     return & _sonsContainer ;
   }

std::list< const ObjectDescriptor * > * ObjectDescriptor::getDescendants

(

)

const [virtual]

get a container with all the descendants of this object in the simualtion tree the result should be deleted after usage if the object has no descendants, an empty list is returned

Definition at line 760 of file OMKObjectDescriptor.cpp.

Referenced by OMK::Controller::computeScheduling(), getDescendants(), and OMK::PvmController::PvmController().

{
  std::list< const ObjectDescriptor * > *result =
    new std::list< const ObjectDescriptor * >() ;
  return getDescendants( result ) ;
}

std::list< const ObjectDescriptor * > * ObjectDescriptor::getDescendants

(

std::list< const ObjectDescriptor * > *

resultList

)

const [virtual]

get a container with all the descendants of this object in the simualtion tree

Parameters:

resultList

: the list in wich the descendants should be inserted. The list is unchanged if no descendants are found the result should be deleted after usage if the object has no descendants, an empty list is returned

Definition at line 767 of file OMKObjectDescriptor.cpp.

References _sonsContainer.

{
  for( SonsContainerType::const_iterator i = _sonsContainer.begin() ;
       i != _sonsContainer.end() ;
       ++i )
  {
    resultList->push_back( *i ) ;
    ( *i )->getDescendants( resultList ) ;
  }
  return resultList ;
}

std::list< ObjectDescriptor * > * ObjectDescriptor::getDescendants

(

)

[virtual]

get a container with all the descendants of this object in the simualtion tree the result should be deleted after usage if the object has no descendants, an empty list is returned

Definition at line 780 of file OMKObjectDescriptor.cpp.

References getDescendants().

{
  std::list< ObjectDescriptor * > *result = new std::list< ObjectDescriptor * >() ;
  return getDescendants( result ) ;
}

std::list< ObjectDescriptor * > * ObjectDescriptor::getDescendants

(

std::list< ObjectDescriptor * > *

resultList

)

[virtual]

get a container with all the descendants of this object in the simualtion tree

Parameters:

resultList

: the list in wich the descendants should be inserted. The list is unchanged if no descendants are found the result should be deleted after usage if the object has no descendants, an empty list is returned

Definition at line 786 of file OMKObjectDescriptor.cpp.

References _sonsContainer.

{
  for( SonsContainerType::const_iterator i = _sonsContainer.begin() ;
       i != _sonsContainer.end() ;
       ++i )
  {
    resultList->push_back( *i ) ;
    ( *i )->getDescendants( resultList ) ;
  }
  return resultList ;
}

void ObjectDescriptor::addSon

(

ObjectDescriptor *

newSon

)

[virtual]

add a son in the simulation tree to the described object If called after initialisation of the controller, isn't taken into account by the controller

Parameters:

newSon

the added son. Responsability of the destruction of that descriptor is passed to this object descriptor. Nevertheless, all sons should be removed before this object descriptor is deleted (to ensure the controllers data structures reflect addition and removal of sons ). Moreover, if addition fails, the newSon is destroyed

Definition at line 735 of file OMKObjectDescriptor.cpp.

References _fathersDescription, _sonsContainer, findDescendantNamed(), getName(), OMASSERT, OMK_DEBUG_OMK_OBJ, and OMTRACEID.

Referenced by ObjectDescriptor(), and setFathersDescription().

{
   OMASSERT( newSon != 0 ) ;
   const ObjectDescriptor *duplicate = findDescendantNamed( newSon->getName() ) ;
   if( duplicate == 0 )
   {
     _sonsContainer.push_back( newSon ) ;
     newSon->_fathersDescription = this ;
   }
   else
   {
     OMTRACEID( OMK_DEBUG_OMK_OBJ,
                "ObjectDescriptor::addSon named \"" << newSon->getName()
                << "\" failed because descendant with the same name allready exists for object named \""
                << getName() << "\"" ) ;
     // as respnsability is transfered and the son is not added, delete it
     delete newSon ;
   }
}

void ObjectDescriptor::removeSon

(

ObjectDescriptor *

oldSon

)

[virtual]

remove a son in the simulation tree If called after initialisation of the controller, isn't taken into account by the controller

Parameters:

oldSon

the son to remove. The removed son is not deleted

Definition at line 755 of file OMKObjectDescriptor.cpp.

References _sonsContainer.

Referenced by OMK::Controller::deleteObject(), setFathersDescription(), and ~ObjectDescriptor().

{
  _sonsContainer.remove( oldSon ) ;
}

template<typename Type>

std::list< const ObjectDescriptor * > * OMK::ObjectDescriptor::listSonsOfType

(

)

const

listSonsOfType.

Returns:

the list of sons of the current node that are of the type of the template parameter delete the resulting list after usage

Definition at line 486 of file OMKObjectDescriptor.h.

{
  return listSonsOfType< Type >( new std::list< const ObjectDescriptor * >() );
}
//------------------------------------------------------------------------------

template<typename Type>

std::list< const ObjectDescriptor * > * OMK::ObjectDescriptor::listSonsOfType

(

std::list< const ObjectDescriptor * > *

resultList

)

const

list the sons of a certain Type.

Parameters:

resultList

a list to be used to store the result

Returns:

the list of sons of the current node that are of the type of the template parameter

Definition at line 493 of file OMKObjectDescriptor.h.

References _sonsContainer.

{
  for( SonsContainerType::const_iterator i = _sonsContainer.begin() ;
       i != _sonsContainer.end() ;
       ++i )
  {
    if( dynamic_cast< Type * >( ( *i )->createDescribedObject() ) != 0 )
    {
      resultList->push_back( *i ) ;
    }
  }
  return resultList ;
}
//------------------------------------------------------------------------------

template<typename Type>

std::list< const ObjectDescriptor * > * OMK::ObjectDescriptor::listDescendantsOfType

(

)

const

listDescendantsOfType.

Returns:

the list of descendants of the current node that are of the type of the template parameter

Definition at line 510 of file OMKObjectDescriptor.h.

{
  return listDescendantsOfType< Type >(
    new std::list< const ObjectDescriptor * >() );
}
//------------------------------------------------------------------------------

template<typename Type>

std::list< const ObjectDescriptor * > * OMK::ObjectDescriptor::listDescendantsOfType

(

std::list< const ObjectDescriptor * > *

resultList

)

const

listDescendantsOfType.

Parameters:

resultList

a list to be used to store the result

Returns:

the list of descendants of the current node that are of the type of the template parameter delete the resulting list after usage

Definition at line 518 of file OMKObjectDescriptor.h.

References _sonsContainer, createDescribedObject(), and OMASSERTM.

{
  OMASSERTM( createDescribedObject(), "Unable to create descriptor" ) ;

  // test the current node
  if( dynamic_cast< Type * >( createDescribedObject() ) != 0 )
  {
    resultList->push_back( this ) ;
  }
  //recurse through the sons
  for( SonsContainerType::const_iterator i = _sonsContainer.begin() ;
       i != _sonsContainer.end() ;
       ++i )
  {
    OMASSERTM( ( *i )->getFathersObjectDescriptor() == this,
               "The father is not the good one" ) ;
    ( *i )->template listDescendantsOfType< Type >( resultList ) ;
  }
  return resultList ;
}
//------------------------------------------------------------------------------

const ObjectDescriptor * ObjectDescriptor::findDescendantNamed

(

const Name &

name

)

const [virtual]

find a descendant of this node

Parameters:

name

the named of the searched descriptor

Definition at line 800 of file OMKObjectDescriptor.cpp.

References _sonsContainer, findDescendantNamed(), and getName().

Referenced by addSon(), OMK::Controller::changeObjectsFather(), OMK::Controller::destroyObject(), findDescendantNamed(), OMK::DistributedController::getObjectDescriptorOfObject(), OMK::Controller::getObjectDescriptorOfObject(), OMK::DistributedController::getPointerToSimulatedObjectNamed(), OMK::Controller::listBrothersOfType(), OMK::Controller::listDescendantsOfType(), OMK::DistributedController::processEvent(), OMK::Controller::processEvent(), OMK::Controller::reactToControlledObjectsSystemEvents(), and setFathersDescription().

{
  const ObjectDescriptor *resul( 0 ) ;  
  if( name == getName() )
  {
    resul = this ;
  }
  else
  {
    SonsContainerType::const_iterator i = _sonsContainer.begin() ;
    while( ( resul == 0 ) && ( i != _sonsContainer.end() ) )
    {
      resul = ( *i )->findDescendantNamed( name ) ;
      ++i ;
    }
  }
  return resul ;
}

ObjectDescriptor * ObjectDescriptor::findDescendantNamed

(

const Name &

name

)

[virtual]

find a descendant of this node

Parameters:

name

the named of the searched descriptor

Definition at line 820 of file OMKObjectDescriptor.cpp.

References _sonsContainer, findDescendantNamed(), and getName().

{
  ObjectDescriptor *resul( 0 ) ;
  if( name == getName() )
  {
    resul = this ;
  }
  else
  {
    SonsContainerType::iterator i = _sonsContainer.begin() ;
    while( ( resul == 0 ) && ( i != _sonsContainer.end() ) )
    {
      resul = ( *i )->findDescendantNamed( name ) ;
      ++i ;
    }
  }
  return resul ;
}

void ObjectDescriptor::interpretConfigurationParameterAsListOfSons	(	SonsContainerType &	listOfSons,
		MultipleConfigurationParameter *	sonsDescription
	)			[static]

helper function, to help interpret a object described as a configuration parameter

Definition at line 839 of file OMKObjectDescriptor.cpp.

References OMK::MultipleConfigurationParameter::getNameOfSubDescriptor(), OMK::MultipleConfigurationParameter::getNumberOfSubItems(), OMK::MultipleConfigurationParameter::getSubDescriptorByPosition(), and interpretConfigurationParameterAsObjectDescription().

Referenced by extract(), and interpretConfigurationParameterAsObjectDescription().

{
  if( sonsDescription != 0 )
  {
    int nbSons = sonsDescription->getNumberOfSubItems() ;
    std::string sonName ;
    for( int i = 0 ; i < nbSons ; ++i )
    {
      ConfigurationParameterDescriptor * aGenericSonsDescription ;
      aGenericSonsDescription = sonsDescription->getSubDescriptorByPosition( i ) ;
      sonName = sonsDescription->getNameOfSubDescriptor( i ) ;
      MultipleConfigurationParameter * aSonsDescription ;
      aSonsDescription = dynamic_cast< MultipleConfigurationParameter * >(
        aGenericSonsDescription ) ;
      if( aSonsDescription != 0 )
      {
        ObjectDescriptor * descriptionOfSon =
          interpretConfigurationParameterAsObjectDescription(
            sonName, aSonsDescription ) ;
        listOfSons.push_back( descriptionOfSon );
      }
    }
  }
}

ObjectDescriptor * ObjectDescriptor::interpretConfigurationParameterAsObjectDescription	(	std::string	objectName,
		MultipleConfigurationParameter *
	)			[static]

helper function, to create a object described as a configuration parameter

Definition at line 866 of file OMKObjectDescriptor.cpp.

References OMK::ConfigurationParameterDescriptor::getAssociatedString(), OMK::MultipleConfigurationParameter::getSubDescriptorByName(), interpretConfigurationParameterAsListOfSons(), ObjectDescriptor(), and OMASSERT.

Referenced by interpretConfigurationParameterAsListOfSons().

{
  OMASSERT( generalDescription != 0 ) ;

  ConfigurationParameterDescriptor *genericSubDescription =
    generalDescription->getSubDescriptorByName( "Class" ) ;

  if( genericSubDescription == 0 ) 
  {
    throw UserException( "Unable to extract a class for an ObjectDescriptor from a stream" ) ;
  }

  std::string classId = genericSubDescription->getAssociatedString() ;

  ConfigurationParameterDescriptor *configurationParameters =
    generalDescription->getSubDescriptorByName( "UserParams" ) ;


  ConfigurationParameterDescriptor *extensionsParameters =
    generalDescription->getSubDescriptorByName( "Extensions" ) ;


  MultipleConfigurationParameter *schedulingParameters =
    dynamic_cast< MultipleConfigurationParameter * >(
      generalDescription->getSubDescriptorByName( "Scheduling" ) ) ;

  ObjectDescriptor *result = new ObjectDescriptor( Name( objectName ),
                                                   Name( classId ),
                                                   schedulingParameters,
                                                   configurationParameters,
                                                   extensionsParameters ) ;

  genericSubDescription = generalDescription->getSubDescriptorByName( "Sons" ) ;
  generalDescription =
    dynamic_cast< MultipleConfigurationParameter * >( genericSubDescription ) ;
  if( generalDescription != 0 )
  {
    interpretConfigurationParameterAsListOfSons(
      result->_sonsContainer, generalDescription ) ;
    //for all the sons, connect to their father, only known here
    for( SonsContainerType::const_iterator i = result->_sonsContainer.begin() ;
         i != result->_sonsContainer.end() ;
         ++i )
    {
      ( *i )->_fathersDescription = result ;
    }
  }
  return result ;
}

SimulatedObject * ObjectDescriptor::createDescribedObject

(

)

const [protected, virtual]

create the described object if _pointerToSimulatedObject is nil, create the described object.

Otherwise, returns a pointer to the previously created object responsability of the destruction of the object is kept by this objectDescriptor until _destroySimulatedObject is reset to false In particular, this member function is used for searches in the simulation tree in distributed contexts. the created object isn't handled to the controler for scheduling or other purposes, and isn't encapsulated in an object handle. only the constructor of the created object has been called

Definition at line 543 of file OMKObjectDescriptor.cpp.

References _creatingObject, _creatingThread, _destroySimulatedObject, _fathersDescription, _pointerToSimulatedObject, createDescribedObject(), getClass(), OMK::SimulatedObject::getController(), getFathersObjectDescriptor(), getName(), OMK_DEBUG_OMK_OBJ, and OMTRACEID.

Referenced by createDescribedObject(), OMK::Controller::createDescribedObject(), and listDescendantsOfType().

{
#if !defined _MSC_VER && defined _OMK_MUTEX_
  //here, use mutual exclusion, to avoid
  // 1 - recursive creation loops
  // 2 - simultaneous creations
  // 3 - recursive creation loops during simultaneous creations!
  //therefore, only allow one thread to do creation at a time (share the
  // creatingThread exclusion lock, and test to see if we're in a recursive loop)

  _dataLock.protect() ;

  SimulatedObject *result( _pointerToSimulatedObject ) ;

  if( _pointerToSimulatedObject == 0 )
  {
    if( _creatingObject && ( _creatingThread == pthread_self() ) )
    {
      // recursive creation loop : return null is the best that can be done
      _dataLock.unprotect() ;
    }
    else
    {
      // the object needs creating : here the question is whether an other
      // thread is creating it or not
      if( _creatingObject )
      {
        //other thread is creating the object : wait for it to finish creation
        _createdCondition.waitForChange( _dataLock ) ;
      }
      else 
      {
        //no thread is creating the object, 
        //therefore this thread takes responsability for creation
        _creatingObject = true ;
        _creatingThread = pthread_self() ;
        _dataLock.unprotect() ;

        //here, we can garantie that we are the only creating thread,
        //and that 
        // 1 - any recursive creation loop is a non-blocking creation
        // 2 - other threads creating the object are waiting on the condition

        //attempt object creation
        SimulatedObject *father( 0 ) ;
        const ObjectDescriptor *fathersDescription( _fathersDescription ) ;

        // as creation can happen during a paralel simulation,
        // it can happen at a time where getCurrentActiveObject returns the
        // object whose request triggered instance creation.
        // Therefore, the current active object is temporarly set to null,
        // so as to mimic creation phase.
        // If it is set to the controller, changing a controlparameter
        // triggers the sending of a valueEvent by the controller, which
        // might not have it's objectHandle initialized in order to avoid
        // being scheduled by itself
        CurrentActiveObject context( 0 ) ;
         
        while( fathersDescription != 0 )
        {
          father = fathersDescription->createDescribedObject() ;
          if( father != 0 )
          {
            OMTRACEID( OMK_DEBUG_OMK_OBJ,
                       "Creating object of type \"" << getClass() << "\"" ) ;
            SimulatedObject *result(
              SimulatedObjectFactory::getInstance().create( getClass() )(
                father->getController() , *this ) ) ;
            OMTRACEID( OMK_DEBUG_OMK_OBJ,
                       "Creating object of type \"" << getClass() << "\" done" ) ;

            //result = father -> createInstanceOfEncapsulatedClass( *this );
            _dataLock.protect() ;
            _pointerToSimulatedObject = result ;
            _dataLock.unprotect() ;
            if( _pointerToSimulatedObject != 0 )
            {
              _destroySimulatedObject = true ;
              fathersDescription = 0 ;
            }
            else 
            {
              fathersDescription = fathersDescription->getFathersObjectDescriptor() ;
            }
          }
          else 
          {
            fathersDescription = 0 ;
          }
        }
      }
      if( _pointerToSimulatedObject == 0 )
      {
        OMTRACEID( OMK_DEBUG_OMK_OBJ,
                   "ObjectDescriptor::createDescribedObject: unable to create \""
                   << getName() << "\" of class " << getClass() ) ;
      }
      _dataLock.protect() ;
      _creatingObject = false ;
      _creatingThread = 0 ;
      _dataLock.unprotect() ;
      //wathever the result, unblock other waiting threads
      _createdCondition.signalChange() ;
    }
  }
  else
  {
    _dataLock.unprotect() ;
  }
  return result ;

#else // _MSC_VER || ! _OMK_MUTEX_
  SimulatedObject *result( _pointerToSimulatedObject ) ;
  if( _pointerToSimulatedObject == 0 )
  {
    //no thread is creating the object, 
    _creatingObject = true ;
         
    //here, we can garantie that we are the only creating thread,
    //and that 
    // 1 - any recursive creation loop is a non-blocking creation
    // 2 - other threads creating the object are waiting on the condition

    //attempt object creation
    SimulatedObject *father( 0 ) ;
    const ObjectDescriptor *fathersDescription( _fathersDescription ) ;
         
    // as creation can happen during a paralel simulation, (not here : no multi
    // threading in MSC version) it can happen at a time where
    // getCurrentActiveObject returns the object whose request triggered
    // instance creation.
    // Therefore, the current active object is temporarly set to null, so as to
    // mimic creation phase. If it is set to the controller, changing a
    // controlparameter triggers the sending of a valueEvent by the controller,
    // which might not have it's objectHandle initialized in order to avoid
    // being scheduled by itself
    
    while( fathersDescription != 0 )
    {
      father = fathersDescription->createDescribedObject() ;
      if( father != 0 )
      {
        OMTRACEID( OMK_DEBUG_OMK_OBJ, "Creating object of type \""
                   << getClass() << "\"" ) ;
        result = OMK::SimulatedObjectFactory::getInstance().create(
          getClass() )( father->getController() , *this ) ;
        OMTRACEID( OMK_DEBUG_OMK_OBJ,
                   "Creating object of type \"" << getClass()
                   << "\" done " << result ) ;
        //result = father -> createInstanceOfEncapsulatedClass (*this);
        _pointerToSimulatedObject = result ;
        if( _pointerToSimulatedObject != 0 )
        {
          _destroySimulatedObject = true ;
          fathersDescription = 0 ;
        }
        else 
        {
          fathersDescription = fathersDescription->getFathersObjectDescriptor() ;
        }
      }
      else 
      {
        fathersDescription = 0 ;
      }
    }
  }

  if( _pointerToSimulatedObject == 0 )
  {
    OMTRACEID( OMK_DEBUG_OMK_OBJ,
               "ObjectDescriptor::createDescribedObject: unable to create \""
               << getName() << "\" of class " << getClass() ) ;
  }
  _creatingObject = false ;

  return result ;

#endif // _MSC_VER
}

void ObjectDescriptor::setFathersDescription

(

ObjectDescriptor *

newFather

)

[protected, virtual]

Definition at line 520 of file OMKObjectDescriptor.cpp.

References _fathersDescription, addSon(), findDescendantNamed(), getName(), OMASSERT, OMK_DEBUG_OMK_OBJ, OMTRACEID, and removeSon().

Referenced by OMK::Controller::changeObjectsFather().

{
  OMASSERT( newFather != 0 ) ;
  if( _fathersDescription != 0 )
  {
    _fathersDescription->removeSon( this ) ;
  }

  if( newFather->findDescendantNamed( getName() ) != 0 )
  {
    //cannot add the object : do nothing
    OMTRACEID( OMK_DEBUG_OMK_OBJ,
               "ObjectDescriptor::setFathersDescription of object named \""
               << getName()
               << "\" failed because descendant with the same name allready exists for object named \""
               << newFather->getName() << "\"" );
  }
  else 
  {
    newFather->addSon( this ) ;
  }
}

void ObjectDescriptor::interpretSchedulingParameters

(

MultipleConfigurationParameter *

schedulingParameters

)

[protected]

interpret a ConfigurationParameterDescriptor as the initial scheduling parameters non virtual because called by the constructor

Definition at line 457 of file OMKObjectDescriptor.cpp.

References _distribution, _frequency, _objectName, _originalFrequency, _originalSchedulingParameters, _processId, _schedulingParameters, OMK::MultipleConfigurationParameter::appendSubDescriptorNamed(), OMK::MultipleConfigurationParameter::clone(), DEFAULT_OBJECT, DUPLICATED_OBJECT, OMK::ConfigurationParameterDescriptor::getAssociatedString(), OMK::MultipleConfigurationParameter::getSubDescriptorByName(), LOCAL_OBJECT, OMK_DEBUG_PVM, and OMTRACEID.

Referenced by extract(), and ObjectDescriptor().

{
  if( _schedulingParameters != schedulingParameters )
  {
    delete _schedulingParameters ;
  }

  _schedulingParameters = schedulingParameters ;    
  if( _schedulingParameters == 0 )
  {
    _schedulingParameters = new MultipleConfigurationParameter() ;
  } 

  const ConfigurationParameterDescriptor *description =
    _schedulingParameters->getSubDescriptorByName( "Frequency" ) ;
  if( description != 0 )
  {
    std::istringstream strValue( description->getAssociatedString() ) ;
    strValue >> _frequency ;
  }
  else
  {
    _frequency = 0 ;
    _schedulingParameters->appendSubDescriptorNamed(
      "Frequency",
      new UniqueConfigurationParameter( "0" ) ) ;
  }

  delete _originalSchedulingParameters ;

  _originalSchedulingParameters =
    static_cast< MultipleConfigurationParameter *>(
      _schedulingParameters->clone() ) ;

  _originalFrequency = _frequency ;

  description = _schedulingParameters->getSubDescriptorByName( "Process" ) ; 
  if( description != 0 )
  {
    _processId = description->getAssociatedString() ;
  }
  else
  {
    OMTRACEID( OMK_DEBUG_PVM, "No Process parameter for OSO" << _objectName );
  }

  _distribution = DEFAULT_OBJECT ;
  description = _schedulingParameters->getSubDescriptorByName( "Distribution" ) ;
  if( description != 0 )
  {
    std::string value( description->getAssociatedString() ) ;
    if( value == "Local" )
    {
      _distribution = LOCAL_OBJECT ;
    }
    else if( value == "Duplicated" )
    {
      _distribution = DUPLICATED_OBJECT ;
    }
  }
}

virtual MultipleConfigurationParameter* OMK::ObjectDescriptor::getSchedulingParameters

(

)

[inline, virtual]

get the configuration parameters of the controled object (non const version)

Definition at line 410 of file OMKObjectDescriptor.h.

   {
     return _schedulingParameters ;
   }

void ObjectDescriptor::printToStream	(	std::ostream &	out,
		int	currentOffset
	)			const [protected, virtual]

pretty insert in a stream

Definition at line 340 of file OMKObjectDescriptor.cpp.

References _sonsContainer, getClass(), getConfigurationParameters(), getExtensionsParameters(), getName(), getSchedulingParameters(), OMK::printTabToStream(), OMK::ConfigurationParameterDescriptor::printToStream(), and OMK::MultipleConfigurationParameter::printToStream().

Referenced by insertInStream(), and pack().

{
  //suppose any needed offset has allready been printed
  out << getName() << std::endl ;
  printTabToStream( out,offset + 2 ) ;
  out << "{" << std::endl ;
  printTabToStream( out, offset + 4 ) ;
  out << "Class " << getClass() << std::endl ;
  if( getSchedulingParameters() != 0 )
  {
    printTabToStream( out, offset + 4 ) ;
    out << "Scheduling " ;
    getSchedulingParameters()->printToStream( out, offset + 6 ) ;
    out << std::endl ;
  }
  if( getConfigurationParameters() != 0 )
  {
    printTabToStream( out, offset + 4 ) ;
    out << "UserParams " ;
    getConfigurationParameters()->printToStream( out, offset + 6 ) ;
    out << std::endl ;
  }
  if( getExtensionsParameters() != 0 )
  {
    printTabToStream( out, offset + 4 ) ;
    out << "Extensions " ;
    getExtensionsParameters()->printToStream( out, offset + 6 ) ;
    out << std::endl ;
  }
  if( _sonsContainer.size() != 0 )
  {
    printTabToStream( out, offset + 4 ) ;
    out << "Sons" << std::endl ;
    printTabToStream( out, offset + 6 ) ;
    out << "{" << std::endl ;
    for( SonsContainerType::const_iterator i = _sonsContainer.begin() ;
         i != _sonsContainer.end() ;
         ++i )
    {
      printTabToStream( out, offset + 8 ) ;
      ( *i )->printToStream( out, offset + 8 ) ;
    }
    printTabToStream( out, offset + 6 ) ;
    out << "}" << std::endl ; 
  }
  printTabToStream( out, offset + 2 ) ;
  out << "}" << std::endl ;
}

---

Friends And Related Function Documentation

friend class Controller [friend]

make the controller a friend so that only controllers can ask for the creation of the described simulation object and change the father of an object

Definition at line 366 of file OMKObjectDescriptor.h.

friend class ObjectHandle [friend]

make the object handle a friend so that only controllers can change the boolean indicating delete responsability

Definition at line 371 of file OMKObjectDescriptor.h.

friend class SimulatedObject [friend]

make the simulated object friend so it can change the _pointerToSimulatedObject as early as possible

Definition at line 374 of file OMKObjectDescriptor.h.

---

Member Data Documentation

SimulatedObject* OMK::ObjectDescriptor::_pointerToSimulatedObject [mutable, protected]

if a simulated object corresponding to this descriptor has been created, a pointer to this object is memorised here.

destruction of this object is the responsability of the descriptor only if _destroySimulatedObject is true

Definition at line 394 of file OMKObjectDescriptor.h.

Referenced by OMK::Controller::Controller(), createDescribedObject(), deleteCachedData(), OMK::Controller::deleteObjectHandle(), ObjectDescriptor(), OMK::SimulatedObject::SimulatedObject(), ~ObjectDescriptor(), and OMK::SimulatedObject::~SimulatedObject().

bool OMK::ObjectDescriptor::_destroySimulatedObject [mutable, protected]

a pointer indicating if _pointerToSimulatedObject is deletable by this object

Definition at line 399 of file OMKObjectDescriptor.h.

Referenced by OMK::Controller::Controller(), createDescribedObject(), deleteCachedData(), ObjectDescriptor(), OMK::ObjectHandle::ObjectHandle(), and ~ObjectDescriptor().

Name OMK::ObjectDescriptor::_objectName [protected]

decribed object's name

Definition at line 417 of file OMKObjectDescriptor.h.

Referenced by extract(), and interpretSchedulingParameters().

Name OMK::ObjectDescriptor::_classId [protected]

decribed object's class

Definition at line 420 of file OMKObjectDescriptor.h.

Referenced by extract().

ConfigurationParameterDescriptor* OMK::ObjectDescriptor::_configurationParameters [protected]

described object's configuration parameters (isn't const to enable extraction

Definition at line 423 of file OMKObjectDescriptor.h.

Referenced by extract(), getConfigurationParameters(), ObjectDescriptor(), and ~ObjectDescriptor().

ConfigurationParameterDescriptor* OMK::ObjectDescriptor::_extensionsParameters [protected]

described object's extension parameters (isn't const to enable extraction

Definition at line 426 of file OMKObjectDescriptor.h.

Referenced by extract(), getExtensionsParameters(), ObjectDescriptor(), and ~ObjectDescriptor().

MultipleConfigurationParameter* OMK::ObjectDescriptor::_originalSchedulingParameters [protected]

described object's scheduling parameters

Definition at line 429 of file OMKObjectDescriptor.h.

Referenced by interpretSchedulingParameters(), ObjectDescriptor(), and ~ObjectDescriptor().

MultipleConfigurationParameter* OMK::ObjectDescriptor::_schedulingParameters [protected]

described object's scheduling parameters

Definition at line 432 of file OMKObjectDescriptor.h.

Referenced by interpretSchedulingParameters(), ObjectDescriptor(), setDistribution(), setFrequency(), setProcess(), and ~ObjectDescriptor().

ObjectDescriptor* OMK::ObjectDescriptor::_fathersDescription [protected]

a pointer to the objects father in the simulation tree

Definition at line 435 of file OMKObjectDescriptor.h.

Referenced by addSon(), createDescribedObject(), setFathersDescription(), and ~ObjectDescriptor().

SonsContainerType OMK::ObjectDescriptor::_sonsContainer [protected]

a container with all of the sons of an object.

Order of sons in the container should be conseidered meaningless

Definition at line 442 of file OMKObjectDescriptor.h.

Referenced by addSon(), extract(), findDescendantNamed(), getDescendants(), listDescendantsOfType(), listSonsOfType(), ObjectDescriptor(), printToStream(), removeSon(), and ~ObjectDescriptor().

bool OMK::ObjectDescriptor::_creatingObject [mutable, protected]

the boolean used to avoid recursive creation : should be accessed only protected

Definition at line 457 of file OMKObjectDescriptor.h.

Referenced by createDescribedObject().

pthread_t OMK::ObjectDescriptor::_creatingThread [mutable, protected]

the thread id of the creating lock

Definition at line 461 of file OMKObjectDescriptor.h.

Referenced by createDescribedObject().

Name OMK::ObjectDescriptor::_processId [private]

decribed object's current process (stored to avoid reinterpreting the scheduling parameters)

Definition at line 466 of file OMKObjectDescriptor.h.

Referenced by interpretSchedulingParameters(), and setProcess().

Frequency OMK::ObjectDescriptor::_frequency [private]

decribed object's current frequency (stored to avoid reinterpreting the scheduling parameters)

Definition at line 469 of file OMKObjectDescriptor.h.

Referenced by interpretSchedulingParameters(), and setFrequency().

Distribution OMK::ObjectDescriptor::_distribution [private]

decribed object's current distribution (stored to avoid reinterpreting the scheduling parameters)

Definition at line 472 of file OMKObjectDescriptor.h.

Referenced by interpretSchedulingParameters(), and setDistribution().

Frequency OMK::ObjectDescriptor::_originalFrequency [private]

decribed object's current frequency (stored to avoid reinterpreting the scheduling parameters)

Definition at line 475 of file OMKObjectDescriptor.h.

Referenced by interpretSchedulingParameters().

---