OMK::Iii::InteractorOutput Class Reference
[Interactor]

This class defines informations about interactor output. More...

#include <OMKInteractorOutput.h>

Inheritance diagram for OMK::Iii::InteractorOutput:

[legend]Collaboration diagram for OMK::Iii::InteractorOutput:

[legend]List of all members.

Public Member Functions
virtual	~InteractorOutput ()
virtual const Name &	id () const
	Get the id of the associated attribute.
const Name &	category () const
	Get the category id of the interactor output.
const Name &	type () const
	Get the type id of the interactor output.
const OMK::Type::AccessGroupLevel &	getAccessGroup () const
	Get the new definition of the access control setting for the connector.
void	setAccessGroup (const OMK::Type::AccessGroupLevel &accessGroup)
	Change access settings of the interactor output.
Static Public Member Functions
static bool	create (const Name &id, InteractorExtension *interactor, const ConfigurationParameterDescriptor *node)
	Creates a interactor output.
static void	create (const Name &id, const Name &attributeId, InteractorExtension *interactor, const Name &category, const OMK::Type::AccessGroupLevel &accessGroup, bool setByEvent)
	Creates an interactor output.
Protected Member Functions
	InteractorOutput (const Name &id, InteractorExtension *interactor, const Name &category, const Name &type)
Protected Attributes
Attributes
Name	_id
	The id of the associated output.
Name	_category
	Category id of the output.
Name	_type
	Type id of the connection.
OMK::Type::AccessGroupLevel	_accessGroup
	Group setting which indicates how the interactor change the access to the connector.
InteractorExtension *	_interactor
	Reference to the interactor extension.

---

Detailed Description

This class defines informations about interactor output.

Author:

Benoît Chanclou

Date:

2006/06/15

It is a part of the interaction protocol.

The aim of this class is to store the informations of the interactor output: id, category id, type and access group setting.

The main job is done by the create static method.

Definition at line 59 of file OMKInteractorOutput.h.

---

Constructor & Destructor Documentation

InteractorOutput::InteractorOutput	(	const Name &	id,
		InteractorExtension *	interactor,
		const Name &	category,
		const Name &	type
	)			[protected]

Definition at line 36 of file OMKInteractorOutput.cpp.

: _id( id ), 
  _category( category ), 
  _type( type ),
  _interactor( interactor )
{ 
}

virtual OMK::Iii::InteractorOutput::~InteractorOutput

(

)

[inline, virtual]

Definition at line 64 of file OMKInteractorOutput.h.

{}

---

Member Function Documentation

virtual const Name& OMK::Iii::InteractorOutput::id

(

)

const [inline, virtual]

Get the id of the associated attribute.

Returns:

the id of the associated attribute, see _id.

Definition at line 67 of file OMKInteractorOutput.h.

{ return _id ; }

const Name& OMK::Iii::InteractorOutput::category

(

)

const [inline]

Get the category id of the interactor output.

Returns:

the category of the interactor output, see _category.

Definition at line 70 of file OMKInteractorOutput.h.

Referenced by OMK::Iii::InteractorExtension::addInteractorOutput(), and create().

{ return _category ; }

const Name& OMK::Iii::InteractorOutput::type

(

)

const [inline]

Get the type id of the interactor output.

Returns:

the type of the interactor output, see _type.

Definition at line 73 of file OMKInteractorOutput.h.

Referenced by OMK::Iii::InteractorExtension::addInteractorOutput().

{ return _type ; }

const OMK::Type::AccessGroupLevel& OMK::Iii::InteractorOutput::getAccessGroup

(

)

const [inline]

Get the new definition of the access control setting for the connector.

Returns:

the access control setting, see _accessGroup.

Definition at line 76 of file OMKInteractorOutput.h.

{ return _accessGroup ; }

void InteractorOutput::setAccessGroup

(

const OMK::Type::AccessGroupLevel &

accessGroup

)

Change access settings of the interactor output.

Parameters:

[in]

accessGroup

the new settings, see _accessGroup.

Change the connected connectors according to the settings.

Definition at line 45 of file OMKInteractorOutput.cpp.

References _accessGroup.

Referenced by create().

{
  if( accessGroup.empty() )
  {
    _accessGroup.clear() ;
    _accessGroup[ "*" ] = -1 ;
  }
  else
  {
    _accessGroup = accessGroup ;
  }
}

bool InteractorOutput::create	(	const Name &	id,
		InteractorExtension *	interactor,
		const ConfigurationParameterDescriptor *	node
	)			[static]

Creates a interactor output.

Parameters:

[in]	id	The id of the associated output of the interactor object.
[in]	interactor	The interactor extension.
[in]	node	The configuration node where to find informations.

Returns:

true if the parameters can be loaded.

Creates a interactor output and adds it to the InteractorExtension.

It also activates the set by event feature of the attribute to allow the initialisation.

Definition at line 58 of file OMKInteractorOutput.cpp.

References category(), and OMK::ParametersAccessor::get().

Referenced by OMK::Iii::JointInteractorExtension::loadExtensionParameters(), and OMK::Iii::InteractorExtension::loadExtensionParameters().

{
  // try to loads parameters
  Name category( "undefined" ) ;
  bool exclusive = false ;
  Name attributeId( id ) ;
  AccessGroupLevel accessGroup ;
  bool ok = ParametersAccessor::get( node, "Category", category ) ;
  ParametersAccessor::get( node, "AttributeId", attributeId ) ;
  ParametersAccessor::get( node, "AccessSetting", accessGroup ) ;
  if( ok ) create( id, attributeId, extension, category, accessGroup, true ) ;
  return ok ; 
}

void InteractorOutput::create	(	const Name &	id,
		const Name &	attributeId,
		InteractorExtension *	interactor,
		const Name &	category,
		const OMK::Type::AccessGroupLevel &	accessGroup,
		bool	setByEvent
	)			[static]

Creates an interactor output.

Parameters:

[in]	id	The id of the associated output of the interactor object.
[in]	interactor	The interactor extension.
[in]	atttributeId	The id of the associated attribute.
[in]	category	The category of the output.
[in]	accessGroup	The access settings of the connector.
[in]	setByEvent	flag to activate the set by event to update the interactor through a "get current values" event.

Creates an interactor output and adds it to the InteractorExtension.

Definition at line 74 of file OMKInteractorOutput.cpp.

References OMK::Iii::InteractorExtension::addInteractorOutput(), category(), OMK::debugMsg(), OMK::ExtensibleSimulatedObject::getAttribute(), OMK::Iii::InteractorExtension::getInteractor(), OMK::IAttribute::getTypes(), OMK_DEBUG_III, OMTRACEID, and setAccessGroup().

{
  ExtensibleSimulatedObject* owner = interactor->getInteractor() ;
  // try to find the associated output 
  IAttribute* attribute = owner->getAttribute( id ) ;
  if( attribute )
  {
    // Creates the interactor output
    InteractorOutput *interactorOutput = InteractorOutputFactory::getInstance().create( owner->getAttribute( id )->getTypes() )
      ( id, atttributeId, interactor, category, setByEvent ) ;
    // Adds it to the listener which will store and manage it
    interactor->addInteractorOutput( interactorOutput ) ;
    // Set the access group settings
    interactorOutput->setAccessGroup( accessGroup ) ;

    OMTRACEID( OMK_DEBUG_III, "Information for " << OMK::debugMsg( interactor, owner ) << std::endl
        << ">>> Create the interactor output for \"" << id << "\" category \"" << interactorOutput->category() << "\"" ) ; 
  }
  else
  {
    OMTRACEID( OMK_DEBUG_III, ":-( Error for " << OMK::debugMsg( interactor, owner ) << std::endl
             << ">>> Unable to create the interactor output for \"" << id << "\" because this attribute doesn't exist !" ) ; 
  }
}

---

Member Data Documentation

Name OMK::Iii::InteractorOutput::_id [protected]

The id of the associated output.

Definition at line 117 of file OMKInteractorOutput.h.

Name OMK::Iii::InteractorOutput::_category [protected]

Category id of the output.

This id define the category for the output and identifies the parameter category. The interactors know the parameter category thanks to this id. It is defined at the creation of the interactor output and cannot be changed during its life.

Definition at line 123 of file OMKInteractorOutput.h.

Name OMK::Iii::InteractorOutput::_type [protected]

Type id of the connection.

This id defines the type of the connector and identifies it. It is defined at the creation of the connector and cannot be changed during its life.

Definition at line 127 of file OMKInteractorOutput.h.

OMK::Type::AccessGroupLevel OMK::Iii::InteractorOutput::_accessGroup [protected]

Group setting which indicates how the interactor change the access to the connector.

Definition at line 129 of file OMKInteractorOutput.h.

Referenced by setAccessGroup().

InteractorExtension* OMK::Iii::InteractorOutput::_interactor [protected]

Reference to the interactor extension.

Definition at line 131 of file OMKInteractorOutput.h.

Referenced by OMK::Iii::InteractorOutputT< PrmType, ModelType >::InteractorOutputT(), and OMK::Iii::InteractorOutputT< PrmType, ModelType >::processSetValue().

---