OMK::Iii::IConvertorT< TypeOut, TypeIn > Class Template Reference
[Attribute feature]

The interface class for convertor. More...

#include <OMKIConvertor.h>

Inheritance diagram for OMK::Iii::IConvertorT< TypeOut, TypeIn >:

[legend]List of all members.

Public Member Functions
virtual	~IConvertorT ()
virtual void	convert (TypeOut &value, const TypeIn &newValue)=0
	Set the value.
Static Public Member Functions
static IConvertorT< TypeOut, TypeIn > *	create (const ConfigurationParameterDescriptor *node)
	Helper method to create a convertor dynamically.

---

Detailed Description

template<typename TypeOut, typename TypeIn>
class OMK::Iii::IConvertorT< TypeOut, TypeIn >

The interface class for convertor.

Date:

2007-01-19

Author:

Benoît Chanclou

This class defines a simple interface class which defines convertion of a value into an other value. The values can be of differents types.

This interface is a template class, the parameters are:

• TypeIn, it is the type of the input value.
• TypeOut, it is the type of the output value.

Every convertor which wants to be dynamically created must be registered in this factory. Use the macros to do this registration, see REGISTER_TEMPLATE_CONVERTOR_FACTORY and REGISTER_CONVERTOR_FACTORY for registration and DECLARE_TEMPLATE_CONVERTOR_FACTORY and for declaration DECLARE_CONVERTOR_FACTORY.

It is used in shared connectors.

Definition at line 195 of file OMKIConvertor.h.

---

Constructor & Destructor Documentation

template<typename TypeOut, typename TypeIn>

virtual OMK::Iii::IConvertorT< TypeOut, TypeIn >::~IConvertorT

(

)

[inline, virtual]

Definition at line 198 of file OMKIConvertor.h.

Referenced by OMK::Iii::IConvertorT< Type, std::vector< Type > >::~IConvertorT().

{ 

---

Member Function Documentation

template<typename TypeOut, typename TypeIn>

virtual void OMK::Iii::IConvertorT< TypeOut, TypeIn >::convert	(	TypeOut &	value,
		const TypeIn &	newValue
	)			[pure virtual]

Set the value.

Parameters:

[out]	The	output value set to its new value.
[in]	newValue	The input value.

Referenced by OMK::Iii::SharedConnectorT< Type >::updateParameter(), and OMK::Iii::IConvertorT< Type, std::vector< Type > >::~IConvertorT().

template<typename TypeOut, typename TypeIn>

IConvertorT< TypeOut, TypeIn > * OMK::Iii::IConvertorT< TypeOut, TypeIn >::create

(

const ConfigurationParameterDescriptor *

node

)

[static]

Helper method to create a convertor dynamically.

Parameters:

[in]

node

The configuration node where to find the informations.

Definition at line 36 of file OMKIConvertor.inl.

References OMK::ParametersAccessor::get(), OMK::ConfigurationParameterDescriptor::getSubDescriptorByName(), and OMASSERTM.

Referenced by OMK::Iii::IConvertorT< Type, std::vector< Type > >::~IConvertorT().

{
  IConvertorT< TypeOut, TypeIn >* convertor = 0 ;
  std::string convertorClassId ;
  const MultipleConfigurationParameter* convertorNode = dynamic_cast< const MultipleConfigurationParameter* >( node->getSubDescriptorByName( "Convertor" ) ) ;
  if( !convertorNode && ParametersAccessor::get( node, "Convertor", convertorClassId ) )
  {
    convertor = OBT::Singleton< ConvertorFactoryT< TypeOut, TypeIn > >::getInstance().create( convertorClassId )( node ) ;
    OMASSERTM( convertor, "Unable to create the convertor \"" << convertorClassId << "\", may be not registered !" ) ;
  }
  else if( convertorNode )
  { 
    if( ParametersAccessor::get( convertorNode, "Class", convertorClassId ) )
    {
      convertor = OBT::Singleton< ConvertorFactoryT< TypeOut, TypeIn > >::getInstance().create( convertorClassId )( convertorNode ) ;
      OMASSERTM( convertor, "Unable to create the convertor \"" << convertorClassId << "\", may be not registered !" ) ;
    }
    else
    {
      OMASSERTM( false, "Unable to create the convertor because the \"Class\" cannot be found in the \"Convertor\" node of" << std::endl << *node ) ;
    }
  }
  return convertor ;
}

---