OMK::IAttributeT< PrmType, ModelType, AccessorType > Class Template Reference
[Attribute feature]

Attribute interface. More...

#include <OMKAttribute.h>

Inheritance diagram for OMK::IAttributeT< PrmType, ModelType, AccessorType >:

[legend]Collaboration diagram for OMK::IAttributeT< PrmType, ModelType, AccessorType >:

[legend]List of all members.

Accessors.
AccessorType	_accessor
	The value of the attribute.
virtual const std::type_info &	getModelTypeId () const
	return the model type of the attribut.
virtual const PrmType &	get () const
	Get the value of the attribute.
virtual void	set (const PrmType &value)
	Set the value.
Creation of input and output.
Input< ModelType > *	_input
	The associated input.
Output< ModelType > *	_output
	The associated output.
virtual void	createInput ()
	Creates the associated input.
virtual InputNT *	getInput ()
	Returns the associated input.
Input< ModelType > *	getInputT ()
	Returns the typed associated input.
virtual void	createOutput ()
	Creates the associated output.
virtual OutputNT *	getOutput ()
	Returns the associated output.
Output< ModelType > *	getOutputT ()
	Returns the associated output.
Events processing to manage value setting.
virtual void	sendIdAndValue (const Name &receiver, const EventIdentifier &eventId, const Name &attributeId)
	Sends the value to the receiver in a valued event with the specified event id.
virtual void	sendValue (const Name &receiver, const EventIdentifier &eventId)
	Sends the value to the receiver with the specified event id.
virtual void	fireIdAndValue (const EventIdentifier &eventId, const Name &attributeId)
	Sends the value to the listening objects in a valued event with the specified event id.
virtual void	fireValue (const EventIdentifier &eventId)
	Sends the value to the listening objects to inform them of the current value.
bool	processSetValueOf (ValuedEvent< ModelType > *e)
	The call back method to process the update of the attribute value.
virtual bool	processSetValue (IdAndValueEvent *e)
	The call back method to process the update of the attribute value.
Public Types
typedef std::pair< Name, ModelType >	IdAndValuePrm
	The type of the data to update or retrieve the attibute value.
Public Member Functions
	DECLARE_TYPE_EVENT_LISTENER (IdAndValuePrm, IdAndValue, EventTypeForAttributeT< ModelType >)
	The type of the event to update or retrieve the attibute value.
Updating value according to the input or output.
virtual void	getValueFromInput ()
	Sets the attribute value with the one retrived in the associated input.
virtual void	setValueToOutput ()
	Sets the output value with the one retrived in the attribute.
Activation of event processing.
virtual void	activateSetByEvent ()
	Activate the handling of "current_value" event.
virtual void	activateSetByEventOf ()
	Activate the handling of "current_value_of_<i>id</i>" event.
Services for additional inputs.
use by connectors.
virtual InputNT *	createInput (const Name &name)
	Creates an input with the good type.
virtual void	getValueFromInput (InputNT *input)
	Retrieves the value in the given input to set the attribute value.
virtual void	getValueFromInput (PrmType &value, InputNT *input, int deltaT=0) const
	Retrieves the value in the given input.

---

Detailed Description

template<typename PrmType, typename ModelType, typename AccessorType>
class OMK::IAttributeT< PrmType, ModelType, AccessorType >

Attribute interface.

Date:

2007-05-01

Author:

Benoît Chanclou

This class defines an interface class and is the ancestor class for attrribute templated class (AttributeT and sons). It is a part of the attribute services.

This class is the full implementation of the attribute interface IAttribute, see it for more details.

There is three template arguments

• PrmType is the type of the attribute.
  There is no restriction on this type.
  
• ModelType is the type of the attribute for OpenMASK.
  As OpenMASK uses data which must be sons of OMKType to exchange information between objects, this type can be different of the attribute type.
  If the PrmType is a OMKType the ModelType will be the same,
  if not, the ModelType will be SimpleType< TypePrm >.
  
• AccessorType is the accessor type to use.
  There is three base accessors: AccessorT, AccessorFctT, and AccessorAccT.
  You can create a specific accessor for your own application. The only restriction is that the accessor must have a copy constructor (the default one is used for the three base accessors).

Definition at line 153 of file OMKAttribute.h.

---

Member Typedef Documentation

template<typename PrmType, typename ModelType, typename AccessorType>

typedef std::pair< Name, ModelType > OMK::IAttributeT< PrmType, ModelType, AccessorType >::IdAndValuePrm

The type of the data to update or retrieve the attibute value.

This is a pair in which the first item is an id and the second is the value.

See sendValue and fireValue.

Reimplemented from OMK::EventTypeForAttributeT< ModelType >.

Definition at line 156 of file OMKAttribute.h.

---

Constructor & Destructor Documentation

template<typename PrmType, typename ModelType, typename AccessorType>

OMK::IAttributeT< PrmType, ModelType, AccessorType >::IAttributeT	(	const Name &	id,
		const AccessorType &	init
	)			[protected]

Constructor.

Parameters:

[in]	id	See _id.
[in]	init	The accessor to intialise.

The attributes use the default copy constructor of the accessor. Be carreful if you create a new kind of accessor, be sure to have a copy constructor to use it for attribute, the default one is used for the three base accessors.

Definition at line 76 of file OMKAttribute.inl.

: OMK::IAttributeBaseT< PrmType >( id ),
  _accessor( init ),
  _input( 0 ),
  _output( 0 )
{
}

template<typename PrmType, typename ModelType, typename AccessorType>

OMK::IAttributeT< PrmType, ModelType, AccessorType >::~IAttributeT

(

)

[virtual]

Destructor.

Disconnect and delete the associated input.The output cannot be delete it stay alive but is no more updated

Definition at line 86 of file OMKAttribute.inl.

References OMK::IAttributeT< PrmType, ModelType, AccessorType >::_input, OMK::IAttribute::_owner, OMK::SimulatedObject::deleteInput(), OMK::Input< T >::disconnect(), and OMK::KernelAttribute::getName().

{
  // disconnect and delete the associated input
  if( _input )
  {
    _input->disconnect() ; 
    this->_owner->deleteInput( _input->getName() ) ;
    _input = 0 ;
  }
  // The output cannot be delete it stay alive but is no more updated
}

template<typename PrmType, typename ModelType, typename AccessorType>

OMK::IAttributeT< PrmType, ModelType, AccessorType >::~IAttributeT

(

)

[virtual]

Destructor.

Disconnect and delete the associated input.The output cannot be delete it stay alive but is no more updated

Definition at line 86 of file OMKAttribute.inl.

References OMK::IAttributeT< PrmType, ModelType, AccessorType >::_input, OMK::IAttribute::_owner, OMK::SimulatedObject::deleteInput(), OMK::Input< T >::disconnect(), and OMK::KernelAttribute::getName().

{
  // disconnect and delete the associated input
  if( _input )
  {
    _input->disconnect() ; 
    this->_owner->deleteInput( _input->getName() ) ;
    _input = 0 ;
  }
  // The output cannot be delete it stay alive but is no more updated
}

template<typename PrmType, typename ModelType, typename AccessorType>

OMK::IAttributeT< PrmType, ModelType, AccessorType >::IAttributeT	(	const Name &	id,
		const AccessorType &	init
	)			[protected]

Constructor.

Parameters:

[in]	id	See _id.
[in]	init	The accessor to intialise.

The attributes use the default copy constructor of the accessor. Be carreful if you create a new kind of accessor, be sure to have a copy constructor to use it for attribute, the default one is used for the three base accessors.

Definition at line 76 of file OMKAttribute.inl.

: OMK::IAttributeBaseT< PrmType >( id ),
  _accessor( init ),
  _input( 0 ),
  _output( 0 )
{
}

---

Member Function Documentation

template<typename PrmType, typename ModelType, typename AccessorType>

OMK::IAttributeT< PrmType, ModelType, AccessorType >::DECLARE_TYPE_EVENT_LISTENER	(	IdAndValuePrm	,
		IdAndValue	,
		EventTypeForAttributeT< ModelType >
	)

The type of the event to update or retrieve the attibute value.

This is a pair encapsulated in a valued event in which the first item is an id and the second is the value.

See sendValue and fireValue.

Reimplemented from OMK::EventTypeForAttributeT< ModelType >.

template<typename PrmType, typename ModelType, typename AccessorType>

virtual const std::type_info& OMK::IAttributeT< PrmType, ModelType, AccessorType >::getModelTypeId

(

)

const [inline, virtual]

return the model type of the attribut.

Returns:

the model type of the attribute as a std::type_info.

Implements OMK::IAttribute.

Definition at line 185 of file OMKAttribute.h.

{ return typeid( ModelType ) ; }

template<typename PrmType, typename ModelType, typename AccessorType>

virtual const PrmType& OMK::IAttributeT< PrmType, ModelType, AccessorType >::get

(

)

const [inline, virtual]

Get the value of the attribute.

Returns:

The current value of the attribute.

Get the value through the accessor. See _accessor.

Implements OMK::IAccessorT< PrmType >.

Definition at line 190 of file OMKAttribute.h.

Referenced by OMK::Trajectory::computeParameters(), OMK::Tracker::computeParameters(), OMK::Orbit::computeParameters(), OMK::HumanoRecorder::computeParameters(), OMK::FixedPoint::computeParameters(), OMK::IAttributeT< PrmType, ModelType, AccessorType >::fireIdAndValue(), OMK::IAttributeT< PrmType, ModelType, AccessorType >::fireValue(), OMK::Inp::PlusMinusExtension< T >::increment(), OMK::Trajectory::loadParameters(), OMK::Tracker::loadParameters(), OMK::Orbit::loadParameters(), OMK::FixedPoint::loadParameters(), OMK::TriggerBaseExtension::preComputeParameters(), OMK::PreOffsetExtension::preComputeParameters(), OMK::NotAttributeExtension::preComputeParameters(), OMK::MKMMoveToTaskExtension::preComputeParameters(), OMK::MKMMotionTaskExtension::preComputeParameters(), OMK::MKMHeadToTaskExtension::preComputeParameters(), OMK::IAttributeT< PrmType, ModelType, AccessorType >::sendIdAndValue(), OMK::IAttributeT< PrmType, ModelType, AccessorType >::sendValue(), OMK::IAttributeAnimatorT< PrmType, ModelType, AccessorType >::setValueToOutput(), and OMK::IAttributeT< PrmType, ModelType, AccessorType >::setValueToOutput().

  {
    return _accessor.AccessorType::get() ; 
  }

template<typename PrmType, typename ModelType, typename AccessorType>

virtual void OMK::IAttributeT< PrmType, ModelType, AccessorType >::set

(

const PrmType &

value

)

[inline, virtual]

Set the value.

Parameters:

[in]

value

The new value of the attribute.

Set the value through the accessor. See _accessor. Set the _updated flag to true.

Implements OMK::IAccessorT< PrmType >.

Definition at line 198 of file OMKAttribute.h.

Referenced by OMK::Trajectory::computeParameters(), OMK::Tracker::computeParameters(), OMK::Orbit::computeParameters(), OMK::MKMHumano::computeParameters(), OMK::HumanoPlayer::computeParameters(), OMK::FixedPoint::computeParameters(), OMK::IAttributeT< PrmType, ModelType, AccessorType >::getValueFromInput(), OMK::Inp::PlusMinusExtension< T >::loadExtensionParameters(), OMK::Trajectory::loadParameters(), OMK::FixedPoint::loadParameters(), OMK::NotAttributeExtension::postComputeParameters(), OMK::DistanceToExtension::preComputeParameters(), OMK::NotAttributeExtension::preComputeParameters(), OMK::MKMMoveToTaskExtension::preComputeParameters(), OMK::IAttributeT< PrmType, ModelType, AccessorType >::processSetValue(), and OMK::IAttributeT< PrmType, ModelType, AccessorType >::processSetValueOf().

  {
    this->_updated = true ;
    _accessor.AccessorType::set( value ) ; 
  }

template<typename PrmType, typename ModelType, typename AccessorType>

void OMK::IAttributeT< PrmType, ModelType, AccessorType >::createInput

(

)

[virtual]

Creates the associated input.

The value will be retrieved with getValueFromInput().

Implements OMK::IAttribute.

Definition at line 133 of file OMKAttribute.inl.

References OMK::IAttributeT< PrmType, ModelType, AccessorType >::_input, OMK::IAttribute::_owner, OMK::IAttribute::getId(), and OMASSERTM.

{
  OMASSERTM( !_input, "There is already an input!" ) ;

  _input = &this->_owner->template addInput< ModelType >( getId() ) ;
}

template<typename PrmType, typename ModelType, typename AccessorType>

OMK::InputNT * OMK::IAttributeT< PrmType, ModelType, AccessorType >::getInput

(

)

[virtual]

Returns the associated input.

Returns:

The associated input. See _input.

This input is not typed. So you cannot get the value, in fact, the value should be retrieved in the attribute. If you need the history features of the input see getValueFromInput.

Implements OMK::IAttribute.

Definition at line 160 of file OMKAttribute.inl.

References OMK::IAttributeT< PrmType, ModelType, AccessorType >::_input.

Referenced by OMK::Tracker::computeParameters(), and OMK::Iii::JointExtension::postComputeParameters().

{
  return _input ;
}

template<typename PrmType, typename ModelType, typename AccessorType>

OMK::Input< ModelType > * OMK::IAttributeT< PrmType, ModelType, AccessorType >::getInputT

(

)

Returns the typed associated input.

Returns:

The typed associated input. See _input.

This input is typed. It is not very usefull because the value should be retrieved in the attribute. If you need the history features of the input see getValueFromInput.

Definition at line 174 of file OMKAttribute.inl.

References OMK::IAttributeT< PrmType, ModelType, AccessorType >::_input.

{
  return _input ;
}

template<typename PrmType, typename ModelType, typename AccessorType>

void OMK::IAttributeT< PrmType, ModelType, AccessorType >::createOutput

(

)

[virtual]

Creates the associated output.

The call to this method must be done during the creation of the object which is the owner of the attribute.

The output will be set with setValueToOutput.

Implements OMK::IAttribute.

Definition at line 149 of file OMKAttribute.inl.

References OMK::IAttributeT< PrmType, ModelType, AccessorType >::_output, OMK::IAttribute::_owner, OMK::IAttribute::getId(), and OMK::IAttributeT< PrmType, ModelType, AccessorType >::setValueToOutput().

{
  if( !_output )
  {
    _output = &this->_owner->template addOutput< ModelType >( getId() ) ;
  }
  setValueToOutput() ;
}

template<typename PrmType, typename ModelType, typename AccessorType>

OMK::OutputNT * OMK::IAttributeT< PrmType, ModelType, AccessorType >::getOutput

(

)

[virtual]

Returns the associated output.

Returns:

The associated output. See _output.

To set the value of the output, you must use setValueToOutput.

Implements OMK::IAttribute.

Definition at line 167 of file OMKAttribute.inl.

References OMK::IAttributeT< PrmType, ModelType, AccessorType >::_output.

{
  return _output ;
}

template<typename PrmType, typename ModelType, typename AccessorType>

OMK::Output< ModelType > * OMK::IAttributeT< PrmType, ModelType, AccessorType >::getOutputT

(

)

Returns the associated output.

Returns:

The typed associated output. See _output.

Definition at line 181 of file OMKAttribute.inl.

References OMK::IAttributeT< PrmType, ModelType, AccessorType >::_output.

{
  return _output ;
}

template<typename PrmType, typename ModelType, typename AccessorType>

void OMK::IAttributeT< PrmType, ModelType, AccessorType >::getValueFromInput

(

)

[virtual]

Sets the attribute value with the one retrived in the associated input.

If the associated input is not already created, the attribute value stays unchanged. The input can be created with the method createInput.

If you need the history features of the input, you must use getValueFromInput whith arguments.

 AttributeT< Type > attribute( "myAttribute", Type() ) ;
 ...
 attribute.createInput() ;
 ...
 Type oldValue ;
 attribute.getValueFromInput( oldValue, attribute.getInput(), oldTime ) ;

Implements OMK::IAttribute.

Definition at line 188 of file OMKAttribute.inl.

References OMK::IAttributeT< PrmType, ModelType, AccessorType >::_input, OMK::Input< T >::get(), OMK::Input< T >::getConnectedOutput(), and OMK::IAttributeT< PrmType, ModelType, AccessorType >::set().

{
  if( _input && _input->getConnectedOutput() )
  {
    set( static_cast< const PrmType & >( _input->get() ) ) ;
  }
}

template<typename PrmType, typename ModelType, typename AccessorType>

void OMK::IAttributeT< PrmType, ModelType, AccessorType >::setValueToOutput

(

)

[virtual]

Sets the output value with the one retrived in the attribute.

If the associated output is not created this method does nothing. The output can be created with the method createOutput.

Implements OMK::IAttribute.

Reimplemented in OMK::IAttributeAnimatorT< PrmType, ModelType, AccessorType >, OMK::IAttributeAnimatorT< PrmType, PrmType, OMK::AccessorFctT< PrmType, ObjectType > >, OMK::IAttributeAnimatorT< PrmType, OMK::Type::SimpleTypeT< PrmType >, OMK::AccessorAccT< PrmType, PrmAccType > >, OMK::IAttributeAnimatorT< PrmType, PrmType, OMK::AccessorAccT< PrmType, PrmAccType > >, OMK::IAttributeAnimatorT< PrmType, PrmType, OMK::AccessorT< PrmType > >, OMK::IAttributeAnimatorT< PrmType, OMK::Type::SimpleTypeT< PrmType >, OMK::AccessorT< PrmType > >, and OMK::IAttributeAnimatorT< PrmType, OMK::Type::SimpleTypeT< PrmType >, OMK::AccessorFctT< PrmType, ObjectType > >.

Definition at line 220 of file OMKAttribute.inl.

References OMK::IAttributeT< PrmType, ModelType, AccessorType >::_output, OMK::IAttributeT< PrmType, ModelType, AccessorType >::get(), and OMK::Output< T >::set().

Referenced by OMK::IAttributeT< PrmType, ModelType, AccessorType >::createOutput(), OMK::Trajectory::loadParameters(), and OMK::Orbit::loadParameters().

{
  if( _output )
  {
    _output->set( ModelType( get() ) ) ;
  }
}

template<typename PrmType, typename ModelType, typename AccessorType>

void OMK::IAttributeT< PrmType, ModelType, AccessorType >::sendIdAndValue	(	const Name &	receiver,
		const EventIdentifier &	eventId,
		const Name &	attributeId
	)			[virtual]

Sends the value to the receiver in a valued event with the specified event id.

See IAttribute::sendIdAndValue.

Implements OMK::IAttribute.

Definition at line 249 of file OMKAttribute.inl.

References OMK::IAttribute::_owner, OMK::IAttributeT< PrmType, ModelType, AccessorType >::get(), and OMK::SimulatedObject::sendValuedEvent().

{
  this->_owner->sendValuedEvent( receiver, eventId, IdAndValueType( IdAndValuePrm( attributeId, ModelType( get() ) ) ) ) ;
}

template<typename PrmType, typename ModelType, typename AccessorType>

void OMK::IAttributeT< PrmType, ModelType, AccessorType >::sendValue	(	const Name &	receiver,
		const EventIdentifier &	eventId
	)			[virtual]

Sends the value to the receiver with the specified event id.

See IAttribute::sendValue.

Implements OMK::IAttribute.

Definition at line 256 of file OMKAttribute.inl.

References OMK::IAttribute::_owner, OMK::IAttributeT< PrmType, ModelType, AccessorType >::get(), and OMK::SimulatedObject::sendValuedEvent().

{
  this->_owner->sendValuedEvent( receiver, eventId, ModelType( get() ) ) ;
}

template<typename PrmType, typename ModelType, typename AccessorType>

void OMK::IAttributeT< PrmType, ModelType, AccessorType >::fireIdAndValue	(	const EventIdentifier &	eventId,
		const Name &	attributeId
	)			[virtual]

Sends the value to the listening objects in a valued event with the specified event id.

See IAttribute::fireIdAndValue.

Implements OMK::IAttribute.

Definition at line 263 of file OMKAttribute.inl.

References OMK::IAttribute::_owner, OMK::SimulatedObject::fireValuedSignal(), OMK::IAttributeT< PrmType, ModelType, AccessorType >::get(), and OMK::IAttribute::getId().

{
  this->_owner->fireValuedSignal( eventId, IdAndValueType( IdAndValuePrm( getId(), ModelType( get() ) ) ) ) ;
}

template<typename PrmType, typename ModelType, typename AccessorType>

void OMK::IAttributeT< PrmType, ModelType, AccessorType >::fireValue

(

const EventIdentifier &

eventId

)

[virtual]

Sends the value to the listening objects to inform them of the current value.

See IAttribute::fireValue.

Implements OMK::IAttribute.

Definition at line 270 of file OMKAttribute.inl.

References OMK::IAttribute::_owner, OMK::SimulatedObject::fireValuedSignal(), and OMK::IAttributeT< PrmType, ModelType, AccessorType >::get().

{
  this->_owner->fireValuedSignal( eventId, ModelType( get() ) ) ;
}

template<typename PrmType, typename ModelType, typename AccessorType>

bool OMK::IAttributeT< PrmType, ModelType, AccessorType >::processSetValueOf

(

ValuedEvent< ModelType > *

e

)

[protected]

The call back method to process the update of the attribute value.

Parameters:

[in]

e

The valued event which encapsulate the new value.

Returns:

true if processed.

Use activateSetByEventOf to activate this feature. You can use sendValue or fireSignal with the good attributeId and genericId set to false to send the event.

Definition at line 229 of file OMKAttribute.inl.

References OMK::IAttributeT< PrmType, ModelType, AccessorType >::set(), and OMK::ValuedEvent< UserType >::value.

{
  set( static_cast< const PrmType & >( e->value ) ) ;
  return true ;
}

template<typename PrmType, typename ModelType, typename AccessorType>

bool OMK::IAttributeT< PrmType, ModelType, AccessorType >::processSetValue

(

IdAndValueEvent *

e

)

[protected, virtual]

The call back method to process the update of the attribute value.

Parameters:

[in]

e

The valued event which encapsulate the attribute id and the new value. If the attibute id is not the good one, nothing is done.

Returns:

true if processed.

Use activateSetByEvent to activate this feature. You can use sendValue or fireSignal with the good attributeId and genericId set to true to send the event.

Implements OMK::EventTypeForAttributeT< ModelType >.

Definition at line 237 of file OMKAttribute.inl.

References OMK::IAttribute::getId(), and OMK::IAttributeT< PrmType, ModelType, AccessorType >::set().

{
  bool ok = e && ( getId() == e->value.getValue().first ) ; 
  if( ok )
  {
    set( static_cast< const PrmType & >( e->value.getValue().second ) ) ;
  }
  return ok ;
}

template<typename PrmType, typename ModelType, typename AccessorType>

void OMK::IAttributeT< PrmType, ModelType, AccessorType >::activateSetByEvent

(

)

[virtual]

Activate the handling of "current_value" event.

Creates the listener for the event to handle.

Implements OMK::IAttribute.

Definition at line 100 of file OMKAttribute.inl.

References OMK::IAttribute::_currentValueListener, OMK::EventId::CURRENT_ATTRIBUTE_VALUE, OMK::debugMsg(), OMK_DEBUG_OMK_ATTR, and OMTRACEID.

{
  if( !this->_currentValueListener )
  {
    this->_currentValueListener = new IdAndValueEventListener
        ( * this->_owner, this, 
        (typename IdAndValueEventListener::CallBackFct)&OMK::IAttributeT< PrmType, ModelType, AccessorType >::processSetValue, 
        EventId::CURRENT_ATTRIBUTE_VALUE ) ;
    OMTRACEID( OMK_DEBUG_OMK_ATTR, 
      "Information for " << OMK::debugMsg( this ) << std::endl
      << ">>> :-) Set by event is activated!" ) ;
  }
}

template<typename PrmType, typename ModelType, typename AccessorType>

void OMK::IAttributeT< PrmType, ModelType, AccessorType >::activateSetByEventOf

(

)

[virtual]

Activate the handling of "current_value_of_<i>id</i>" event.

Creates the listener for the event to handle.

Implements OMK::IAttribute.

Definition at line 116 of file OMKAttribute.inl.

References OMK::IAttribute::_currentValueOfListener, OMK::IAttribute::_owner, OMK::debugMsg(), OMK_DEBUG_OMK_ATTR, and OMTRACEID.

{
  if( !this->_currentValueOfListener )
  {
    this->_currentValueOfListener = new ValuedEventListenerCallBack< OMK::IAttributeT< PrmType, ModelType, AccessorType >, ModelType >
      ( * this->_owner, this, 
        ( typename ValuedEventListenerCallBack< OMK::IAttributeT< PrmType, ModelType, AccessorType >, ModelType >::CallBackFct)&OMK::IAttributeT< PrmType, ModelType, AccessorType >::processSetValueOf, 
          this->_currentValueOfId ) ;
    OMTRACEID( OMK_DEBUG_OMK_ATTR, 
      "Information for " << OMK::debugMsg( this ) << std::endl
          << ">>> :-) Set by event \"" << this->_currentValueOfId.getCString() 
      << "\" is activated!" ) ;
  }
}

template<typename PrmType, typename ModelType, typename AccessorType>

OMK::InputNT * OMK::IAttributeT< PrmType, ModelType, AccessorType >::createInput

(

const Name &

name

)

[virtual]

Creates an input with the good type.

Parameters:

[in]

name

The name of the input to create.

The value will be retrieved with getValueFromInput to set the attribute or with getValueFromInput to get the value, this last method needs a type.

Implements OMK::IAttribute.

Definition at line 142 of file OMKAttribute.inl.

References OMK::IAttribute::_owner.

{
  return &this->_owner->template addInput< ModelType >( name ) ;
}

template<typename PrmType, typename ModelType, typename AccessorType>

void OMK::IAttributeT< PrmType, ModelType, AccessorType >::getValueFromInput

(

InputNT *

input

)

[virtual]

Retrieves the value in the given input to set the attribute value.

Parameters:

[in]

input

The input in which the value will be retrieved.

If the input is not valid (null, of the wrong type or not connected) the attribute value stays unchanged. The input should be created with the method createInput.

If you need the history features of the input, you must use getValueFromInput whith arguments.

Implements OMK::IAttributeBaseT< PrmType >.

Definition at line 198 of file OMKAttribute.inl.

References OMK::Input< T >::get(), OMK::Input< T >::getConnectedOutput(), and OMK::IAttributeT< PrmType, ModelType, AccessorType >::set().

{
  Input< ModelType >*typedInput = dynamic_cast< Input< ModelType >* >( input ) ;
  if( typedInput && typedInput->getConnectedOutput() )
  {
    set( static_cast< const PrmType & >( typedInput->get() ) ) ;
  }
}

template<typename PrmType, typename ModelType, typename AccessorType>

void OMK::IAttributeT< PrmType, ModelType, AccessorType >::getValueFromInput	(	PrmType &	value,
		InputNT *	input,
		int	deltaT = 0
	)			const [virtual]

Retrieves the value in the given input.

Parameters:

[out]	value	The returned value.
[in]	input	The input in which the value will be retrieved. It was previously created by the call to createInput.
[in]	deltaT	The time of the asked value.

If the input is not valid (null, of the wrong type or not connected) the value stays unchanged. The input should be created with the method createInput.

If you need the history features of the input, you can specify the deltaT value.

 AttributeT< Type > attribute( "myAttribute", Type() ) ;
 ...
 InputNT* myInput = attribute.createInput( "myInput" ) ;
 ...
 Type oldValue ;
 attribute.getValueFromInput( oldValue, myInput, oldTime ) ;

Implements OMK::IAttributeBaseT< PrmType >.

Definition at line 209 of file OMKAttribute.inl.

References OMK::Input< T >::get(), and OMK::Input< T >::getConnectedOutput().

{
  Input< ModelType >*typedInput = dynamic_cast< Input< ModelType >* >( input ) ;
  if( typedInput && typedInput->getConnectedOutput() ) 
  { 
    value = static_cast< const PrmType & >( typedInput->get( deltaT ) ) ;
  }
}

---

Member Data Documentation

template<typename PrmType, typename ModelType, typename AccessorType>

AccessorType OMK::IAttributeT< PrmType, ModelType, AccessorType >::_accessor [protected]

The value of the attribute.

This value is reached through an accessor defined as a template argument.

Definition at line 206 of file OMKAttribute.h.

Referenced by OMK::IAttributeT< PrmType, OMK::Type::SimpleTypeT< PrmType >, OMK::AccessorFctT< PrmType, ObjectType > >::get(), OMK::AttributeAnimatorTypeT< PrmType >::getRef(), OMK::AttributeAnimatorT< PrmType >::getRef(), OMK::AttributeTypeT< PrmType >::getRef(), OMK::AttributeT< OMK::Type::Transform >::getRef(), OMK::IAttributeT< PrmType, OMK::Type::SimpleTypeT< PrmType >, OMK::AccessorFctT< PrmType, ObjectType > >::set(), OMK::AttributeAnimatorAccTypeT< PrmType, PrmAccType >::setAccessor(), OMK::AttributeAnimatorAccT< PrmType, PrmAccType >::setAccessor(), OMK::AttributeAccTypeT< PrmType, PrmAccType >::setAccessor(), and OMK::AttributeAccT< Type, AttributType >::setAccessor().

template<typename PrmType, typename ModelType, typename AccessorType>

Input< ModelType >* OMK::IAttributeT< PrmType, ModelType, AccessorType >::_input [protected]

The associated input.

The associated input is created by a call to createInput whithout argument.

Definition at line 247 of file OMKAttribute.h.

Referenced by OMK::IAttributeT< PrmType, ModelType, AccessorType >::createInput(), OMK::IAttributeT< PrmType, ModelType, AccessorType >::getInput(), OMK::IAttributeT< PrmType, ModelType, AccessorType >::getInputT(), OMK::IAttributeT< PrmType, ModelType, AccessorType >::getValueFromInput(), and OMK::IAttributeT< PrmType, ModelType, AccessorType >::~IAttributeT().

template<typename PrmType, typename ModelType, typename AccessorType>

Output< ModelType >* OMK::IAttributeT< PrmType, ModelType, AccessorType >::_output [protected]

The associated output.

The associated output is created by a call to createOutput and is set with calls to setValueToOutput.

Definition at line 251 of file OMKAttribute.h.

Referenced by OMK::IAttributeT< PrmType, ModelType, AccessorType >::createOutput(), OMK::IAttributeT< PrmType, ModelType, AccessorType >::getOutput(), OMK::IAttributeT< PrmType, ModelType, AccessorType >::getOutputT(), OMK::IAttributeAnimatorT< PrmType, ModelType, AccessorType >::setValueToOutput(), and OMK::IAttributeT< PrmType, ModelType, AccessorType >::setValueToOutput().

---