OMK::ExtensionOfExtensionCreatorEvent Class Reference
[Extension feature]

Extension to create extension by event. More...

#include <OMKExtensionOfExtensionCreatorEvent.h>

Inheritance diagram for OMK::ExtensionOfExtensionCreatorEvent:

[legend]Collaboration diagram for OMK::ExtensionOfExtensionCreatorEvent:

[legend]List of all members.

Public Member Functions
	DECLARE_EXTENSION_FACTORY (ExtensionOfExtensionCreatorEvent)
	Factory and constructor/destructor.
Configuration loaders
Configuration parameters loader of Extension. Add the event listener to the object
virtual bool	loadExtensionParameters (const ConfigurationParameterDescriptor *node)
	Configuration parameters loader of Extension.
Static Public Attributes
static EventIdentifier	EVENT_ID
	The event id use to create a new extension.

---

Detailed Description

Extension to create extension by event.

Date:

2007-02-28

Author:

Benoît Chanclou

Module description :

This extension add an event listener to its owner. This event listener handles a event which allows to create extension.
To add this extension to your object you have to :

• Register the extension in the factory

   bool registered = ExtensionOfExtensionCreatorEvent::registerInFactory() ;
  

• Declare it in the configuration file

  theObject
  {
    ...
    Extensions
    {
      creator
      {
        Class ExtensionCreatorEvent
      }
    }
  }
  

To add a new extension during running send the following event to the object

sendValuedEvent( # the name of the receiver #, 
                 OMK::ExtensionOfExtensionCreatorEvent::s_eventId, 
                 CreateAndAddExtensionPrm( # the extension class id #, # the extension id # ) ) ;

Definition at line 64 of file OMKExtensionOfExtensionCreatorEvent.h.

---

Member Function Documentation

OMK::ExtensionOfExtensionCreatorEvent::DECLARE_EXTENSION_FACTORY

(

ExtensionOfExtensionCreatorEvent

)

Factory and constructor/destructor.

See Extension feature

bool ExtensionOfExtensionCreatorEvent::loadExtensionParameters

(

const ConfigurationParameterDescriptor *

node

)

[virtual]

Configuration parameters loader of Extension.

Parameters:

[in]

node

the root node of the configuration parameter, null if no node defined for the extension.

Returns:

should return true if all the parameters are well retrieved.

Overwrite this method to initialise the extension. This method allows the extension to get parameters of its own field.
Be careful, loadObjectParameters method is called before this method.
See How to configure an extension ? for details.

Reimplemented from OMK::Extension.

Definition at line 42 of file OMKExtensionOfExtensionCreatorEvent.cpp.

References OMK::ExtensionT< SimulatedObjectType >::_owner.

{
  _owner->activateCreateExtensionByEvent( true ) ;
  return true ;
}

---

Member Data Documentation

EventIdentifier OMK::ExtensionOfExtensionCreatorEvent::EVENT_ID [static]

The event id use to create a new extension.

Definition at line 68 of file OMKExtensionOfExtensionCreatorEvent.h.

---