Interaction objects and ids
[The interaction protocol, Event ids]

Collaboration diagram for Interaction objects and ids:

The types and ids used for interaction. More...

Namespaces
namespace	OMK::Type
	Namespace of the interactor/inspector/interactive objects.
Classes
class	OMK::Type::AccessibleParameterPrm
	Class AccessibleParameterPrm generated. More...
class	OMK::Type::AccessLevelList< ItemType >
	A access level and a list. More...
class	OMK::Type::AccessGroup
	Class AccessGroup generated. More...
class	OMK::Type::TwoIdsPrm
	Class TwoIdsPrm generated. More...
class	OMK::Type::ControlTakeOverPrm
	Class ControlTakeOverPrm generated. More...
Ids for attributes events
EventIdentifier OMK_API	OMK::EventId::CURRENT_ATTRIBUTE_VALUE
	The event id for the event current_attribute_value.
EventIdentifier	OMK::EventId::getConnectToEventId (const std::string &id)
	This function generates the connect_to_attribute_id event id.
EventIdentifier	OMK::EventId::getCurrentValueEventId (const std::string &id)
	This function generates the current_value_of_id event id.
EventIdentifier	OMK::EventId::getDisconnectEventId (const std::string &id)
	This function generates the disconnect_id event id.
EventIdentifier	OMK::EventId::getGetValueEventId (const std::string &id)
	This function generates the event get_value_of_attribute_id event id.
Ids for interactive protocol events
OMKIII_API EventIdentifier	OMK::EventId::GET_ACCESSIBLE_PARAMETERS
	The event id for the event "get_accessible_parameters".
OMKIII_API EventIdentifier	OMK::EventId::ACCESSIBLE_PARAMETERS
	The event id for the event "accessible_parameters".
OMKIII_API EventIdentifier	OMK::EventId::CONTROL_TAKE_OVER_AND_GET_CURRENT_VALUES
	The event id for the event "control_take_over_and_get_current_value".
OMKIII_API EventIdentifier	OMK::EventId::CURRENT_VALUE
	The event id for the event "control_taken_and_get_current_value".
OMKIII_API EventIdentifier	OMK::EventId::CURRENT_VALUES_SENT_AND_CONTROL_TAKEN
	The event id for the event "current_values_sent_and_control_taken".
OMKIII_API EventIdentifier	OMK::EventId::CONTROL_RELEASE
	The event id for the event "control_release".
OMKIII_API EventIdentifier	OMK::EventId::CONTROL_RELEASED
	The event id for the event "control_released".
OMKIII_API EventIdentifier	OMK::EventId::CONTROL_TAKEN_BY
	The event id for the event "control_ended".
OMKIII_API EventIdentifier	OMK::EventId::CONTROL_RELEASED_BY
	The event id for the event "control_taken_by".
OMKIII_API EventIdentifier	OMK::EventId::CONTROL_ENDED
	The event id for the event "control_release_by".
OMKIII_API EventIdentifier	OMK::EventId::CONTROL_FREEZE
	The event id for the event "control_freeze".
OMKIII_API EventIdentifier	OMK::EventId::CONTROL_UNFREEZE
	The event id for the event "control_unfreeze".
OMKIII_API EventIdentifier	OMK::EventId::GET_CURRENT_VALUES
	The event id for the event "get_current_value".
OMKIII_API EventIdentifier	OMK::EventId::CURRENT_VALUES_SENT
	The event id for the event "current_values".
OMKIII_API EventIdentifier	OMK::EventId::NEW_VALUE_AVAILABLE
	The event id for the event "new_value_available".
typedef std::list< AccessibleParameterPrm >	OMK::Type::AccessibleParametersListPrm
	Datas and events.
typedef std::pair< Name, std::list< Name > >	OMK::Type::ControlTakenOfParameterPrm
typedef std::list< ControlTakenOfParameterPrm >	OMK::Type::ControlTakenPrm
typedef std::pair< Name, Name >	OMK::Type::ControlUpdatedPrm
typedef AccessGroup	OMK::Type::GetAccessibleParametersPrm
typedef AccessLevelList< ControlTakeOverPrm >	OMK::Type::TakeOverAndGetCurrentValuesPrm
typedef std::list< Name >	OMK::Type::ControlReleasePrm
typedef AccessLevelList< std::pair< Name, AccessGroupLevel > >	OMK::Type::ControlFreezePrm
typedef std::list< Name >	OMK::Type::ControlUnfreezePrm
typedef AccessLevelList< Name >	OMK::Type::GetCurrentValuesPrm
typedef std::pair< Name, Name >	OMK::Type::NewValueAvailablePrm
	OMK::Type::DECLARE_TYPE_EVENT_LISTENER (AccessibleParametersListPrm, AccessibleParametersList, OMK::Iii::InteractorExtension)
	OMK::Type::DECLARE_TYPE_EVENT_LISTENER (ControlTakenPrm, ControlTaken, OMK::Iii::InteractorExtension)
	OMK::Type::DECLARE_EVENT_LISTENER (Name, ControlReleased, OMK::Iii::InteractorExtension)
	OMK::Type::DECLARE_EVENT_LISTENER (Name, ControlEnded, OMK::Iii::InteractorExtension)
	OMK::Type::DECLARE_TYPE_EVENT_LISTENER (ControlUpdatedPrm, ControlUpdated, OMK::Iii::InteractorExtension)
	OMK::Type::DECLARE_TYPE_EVENT_LISTENER (GetAccessibleParametersPrm, GetAccessibleParameters, OMK::Iii::InteractiveExtension)
	OMK::Type::DECLARE_TYPE_EVENT_LISTENER (TakeOverAndGetCurrentValuesPrm, TakeOverAndGetCurrentValues, OMK::Iii::InteractiveExtension)
	OMK::Type::DECLARE_TYPE_EVENT_LISTENER (ControlReleasePrm, ControlRelease, OMK::Iii::InteractiveExtension)
	OMK::Type::DECLARE_TYPE_EVENT_LISTENER (ControlFreezePrm, ControlFreeze, OMK::Iii::InteractiveExtension)
	OMK::Type::DECLARE_TYPE_EVENT_LISTENER (ControlUnfreezePrm, ControlUnfreeze, OMK::Iii::InteractiveExtension)
	OMK::Type::DECLARE_TYPE_EVENT_LISTENER (GetCurrentValuesPrm, GetCurrentValues, OMK::Iii::InteractiveExtension)
	OMK::Type::DECLARE_TYPE_EVENT_LISTENER (NewValueAvailablePrm, NewValueAvailable, OMK::Iii::InteractiveExtension)

---

Detailed Description

The types and ids used for interaction.

---

Typedef Documentation

typedef std::list< AccessibleParameterPrm > OMK::Type::AccessibleParametersListPrm

Datas and events.

Date:

2006-10-22

Author:

Benoît Chanclou

Module description :

Different types defined for datas and events

Definition at line 136 of file OMKInteractiveEventId.h.

typedef AccessLevelList< std::pair< Name, AccessGroupLevel > > OMK::Type::ControlFreezePrm

Definition at line 160 of file OMKInteractiveEventId.h.

typedef std::list< Name > OMK::Type::ControlReleasePrm

Definition at line 157 of file OMKInteractiveEventId.h.

typedef std::pair< Name, std::list< Name > > OMK::Type::ControlTakenOfParameterPrm

Definition at line 139 of file OMKInteractiveEventId.h.

typedef std::list< ControlTakenOfParameterPrm > OMK::Type::ControlTakenPrm

Definition at line 140 of file OMKInteractiveEventId.h.

typedef std::list< Name > OMK::Type::ControlUnfreezePrm

Definition at line 163 of file OMKInteractiveEventId.h.

typedef std::pair< Name, Name > OMK::Type::ControlUpdatedPrm

Definition at line 147 of file OMKInteractiveEventId.h.

typedef AccessGroup OMK::Type::GetAccessibleParametersPrm

Definition at line 151 of file OMKInteractiveEventId.h.

typedef AccessLevelList< Name > OMK::Type::GetCurrentValuesPrm

Definition at line 166 of file OMKInteractiveEventId.h.

typedef std::pair< Name, Name > OMK::Type::NewValueAvailablePrm

Definition at line 169 of file OMKInteractiveEventId.h.

typedef AccessLevelList< ControlTakeOverPrm > OMK::Type::TakeOverAndGetCurrentValuesPrm

Definition at line 154 of file OMKInteractiveEventId.h.

---

Function Documentation

OMK::Type::DECLARE_EVENT_LISTENER	(	Name	,
		ControlEnded	,
		OMK::Iii::InteractorExtension
	)

OMK::Type::DECLARE_EVENT_LISTENER	(	Name	,
		ControlReleased	,
		OMK::Iii::InteractorExtension
	)

OMK::Type::DECLARE_TYPE_EVENT_LISTENER	(	NewValueAvailablePrm	,
		NewValueAvailable	,
		OMK::Iii::InteractiveExtension
	)

OMK::Type::DECLARE_TYPE_EVENT_LISTENER	(	GetCurrentValuesPrm	,
		GetCurrentValues	,
		OMK::Iii::InteractiveExtension
	)

OMK::Type::DECLARE_TYPE_EVENT_LISTENER	(	ControlUnfreezePrm	,
		ControlUnfreeze	,
		OMK::Iii::InteractiveExtension
	)

OMK::Type::DECLARE_TYPE_EVENT_LISTENER	(	ControlFreezePrm	,
		ControlFreeze	,
		OMK::Iii::InteractiveExtension
	)

OMK::Type::DECLARE_TYPE_EVENT_LISTENER	(	ControlReleasePrm	,
		ControlRelease	,
		OMK::Iii::InteractiveExtension
	)

OMK::Type::DECLARE_TYPE_EVENT_LISTENER	(	TakeOverAndGetCurrentValuesPrm	,
		TakeOverAndGetCurrentValues	,
		OMK::Iii::InteractiveExtension
	)

OMK::Type::DECLARE_TYPE_EVENT_LISTENER	(	GetAccessibleParametersPrm	,
		GetAccessibleParameters	,
		OMK::Iii::InteractiveExtension
	)

OMK::Type::DECLARE_TYPE_EVENT_LISTENER	(	ControlUpdatedPrm	,
		ControlUpdated	,
		OMK::Iii::InteractorExtension
	)

OMK::Type::DECLARE_TYPE_EVENT_LISTENER	(	ControlTakenPrm	,
		ControlTaken	,
		OMK::Iii::InteractorExtension
	)

OMK::Type::DECLARE_TYPE_EVENT_LISTENER	(	AccessibleParametersListPrm	,
		AccessibleParametersList	,
		OMK::Iii::InteractorExtension
	)

EventIdentifier OMK_API OMK::EventId::getConnectToEventId

(

const std::string &

id

)

This function generates the connect_to_attribute_id event id.

See Attribute feature.

Parameters:

[in]

id

the id to concat with "connect_to_" string

Returns:

the event id connect_to_id

This event is processed by the _connectToListener which calls OMK::IAttribute::processConnectTo.

Definition at line 50 of file OMKIAttribute.cpp.

{ 
  return EventIdentifier( ( "connect_to_attribute_" + id ).c_str() ) ; 
}

EventIdentifier OMK_API OMK::EventId::getCurrentValueEventId

(

const std::string &

id

)

This function generates the current_value_of_id event id.

See Attribute feature.

Parameters:

[in]

id

the id to concat with "current_value_of_attribute_" string

Returns:

the event id current value of id

Definition at line 40 of file OMKIAttribute.cpp.

Referenced by OMK::IAttribute::fireValueTo(), OMK::IAttributeAnimatorT< PrmType, ModelType, AccessorType >::loadParameters(), OMK::MultiValuedEventSignalEmitterUtilT< T, ModelType >::loadParametersUtil(), OMK::ValuedEventSignalEmitterUtilT< T, ModelType >::loadParametersUtil(), OMK::IAttribute::processGetValue(), OMK::IAttribute::sendValueTo(), and OMK::IAttributeAnimatorT< PrmType, ModelType, AccessorType >::setValueToOutput().

{ 
  return EventIdentifier( ( "current_value_of_attribute_" + id ).c_str() ) ; 
}

EventIdentifier OMK_API OMK::EventId::getDisconnectEventId

(

const std::string &

id

)

This function generates the disconnect_id event id.

See Attribute feature.

Parameters:

[in]

id

the id to concat with "disconnect_attribute_" string

Returns:

the event id disconnect_id

This event is processed by the _disconnectListener which calls processDisconnect.

Definition at line 55 of file OMKIAttribute.cpp.

{ 
  return EventIdentifier( ( "disconnect_attribute_" + id ).c_str() ) ; 
}

EventIdentifier OMK_API OMK::EventId::getGetValueEventId

(

const std::string &

id

)

This function generates the event get_value_of_attribute_id event id.

See Attribute feature.
See sendValue and activateSetByEventOf.

Definition at line 45 of file OMKIAttribute.cpp.

{ 
  return EventIdentifier( ( "get_value_of_attribute_" + id ).c_str() ) ; 
}

---

Variable Documentation

OMKIII_API EventIdentifier OMK::EventId::ACCESSIBLE_PARAMETERS

The event id for the event "accessible_parameters".

See "available connectors" in The interaction protocol.

Referenced by OMK::Iii::InteractorExtension::processAccessibleParameters(), and OMK::Iii::InteractorExtension::startInteractor().

OMKIII_API EventIdentifier OMK::EventId::CONTROL_ENDED

The event id for the event "control_release_by".

See "control taken" in The interaction protocol.

Referenced by OMK::Iii::IConnector::SendControlEnded(), and OMK::Iii::InteractorExtension::startInteractor().

OMKIII_API EventIdentifier OMK::EventId::CONTROL_FREEZE

The event id for the event "control_freeze".

See "control ended" in The interaction protocol.

Referenced by OMK::Iii::InteractiveExtension::loadExtensionParameters().

OMKIII_API EventIdentifier OMK::EventId::CONTROL_RELEASE

The event id for the event "control_release".

See "control release" in The interaction protocol.

Referenced by OMK::Iii::InteractiveExtension::loadExtensionParameters(), and OMK::Iii::SessionPrm::selfControlRelease().

OMKIII_API EventIdentifier OMK::EventId::CONTROL_RELEASED

The event id for the event "control_released".

See "control release" in The interaction protocol.

Referenced by OMK::Iii::IConnector::SendControlReleased(), and OMK::Iii::InteractorExtension::startInteractor().

OMKIII_API EventIdentifier OMK::EventId::CONTROL_RELEASED_BY

The event id for the event "control_taken_by".

See "control unfreeze" in The interaction protocol.

Referenced by OMK::Iii::IConnector::SendControlReleasedBy(), and OMK::Iii::InteractorExtension::startInteractor().

OMKIII_API EventIdentifier OMK::EventId::CONTROL_TAKE_OVER_AND_GET_CURRENT_VALUES

The event id for the event "control_take_over_and_get_current_value".

See "current values ?" in The interaction protocol.

Referenced by OMK::Iii::InteractiveExtension::loadExtensionParameters(), and OMK::Iii::SessionPrm::selfControlTakeOverAndGetCurrentValues().

OMKIII_API EventIdentifier OMK::EventId::CONTROL_TAKEN_BY

The event id for the event "control_ended".

See "control freeze" in The interaction protocol.

Referenced by OMK::Iii::IConnector::SendControlTakenBy(), and OMK::Iii::InteractorExtension::startInteractor().

OMKIII_API EventIdentifier OMK::EventId::CONTROL_UNFREEZE

The event id for the event "control_unfreeze".

See "current values sent" in The interaction protocol.

Referenced by OMK::Iii::InteractiveExtension::loadExtensionParameters().

EventIdentifier OMK_API OMK::EventId::CURRENT_ATTRIBUTE_VALUE

The event id for the event current_attribute_value.

See Attribute feature.
See also "current value" in The interaction protocol.

Referenced by OMK::IAttributeT< PrmType, ModelType, AccessorType >::activateSetByEvent(), OMK::IAttribute::activateSetBySignal(), OMK::IAttribute::fireValueOf(), OMK::IAttribute::fireValueTo(), OMK::IAttribute::sendValueOf(), and OMK::IAttribute::sendValueTo().

OMKIII_API EventIdentifier OMK::EventId::CURRENT_VALUE

The event id for the event "control_taken_and_get_current_value".

See also "current value" in The interaction protocol.

Referenced by OMK::Iii::InteractorOutputT< PrmType, ModelType >::InteractorOutputT(), OMK::Iii::SimpleConnectorT< Type >::sendValue(), and OMK::Iii::SharedConnectorT< Type >::sendValue().

OMKIII_API EventIdentifier OMK::EventId::CURRENT_VALUES_SENT

The event id for the event "current_values".

See InteractionProtocol_13Sec in The interaction protocol.

Referenced by OMK::Iii::InteractorExtension::processCurrentValuesSent(), and OMK::Iii::InteractorExtension::startInteractor().

OMKIII_API EventIdentifier OMK::EventId::CURRENT_VALUES_SENT_AND_CONTROL_TAKEN

The event id for the event "current_values_sent_and_control_taken".

See "control take over" in The interaction protocol.

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

OMKIII_API EventIdentifier OMK::EventId::GET_ACCESSIBLE_PARAMETERS

The event id for the event "get_accessible_parameters".

See "parameters ?" in The interaction protocol.

Referenced by OMK::Iii::InteractiveExtension::loadExtensionParameters(), and OMK::Iii::SessionPrm::selfGetAccessibleParameters().

OMKIII_API EventIdentifier OMK::EventId::GET_CURRENT_VALUES

The event id for the event "get_current_value".

See InteractionProtocol_12Sec in The interaction protocol.

Referenced by OMK::Iii::InteractiveExtension::loadExtensionParameters().

OMKIII_API EventIdentifier OMK::EventId::NEW_VALUE_AVAILABLE

The event id for the event "new_value_available".

See InteractionProtocol_14Sec in The interaction protocol.

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

---