OMK::ParametersAccessor Class Reference

Provide some accessors for configuration parameters. More...

#include <OMKParametersAccessor.h>

List of all members.

Public Member Functions
Specialisations of template methods.
template<>
bool	getTxtValue (const std::string &textValue, std::string &value)
	Specialisation for string.
template<>
bool	setTxtValue (std::string &textValue, const std::string &value)
	Specialisation for string.
template<>
bool	getValue (const ConfigurationParameterDescriptor *nodeValue, const ConfigurationParameterDescriptor *&value, std::string &errorStr)
	Specialisation for const node.
template<>
bool	getValue (const ConfigurationParameterDescriptor *nodeValue, ConfigurationParameterDescriptor *&value, std::string &errorStr)
	Specialisation for node.
Static Public Member Functions
The get methods to read a value in a node.
template<typename T>
static bool	get (const ConfigurationParameterDescriptor *node, const std::string &name, T &value, SimulatedObject *object=0)
	Retrieves a value of type "T".
The get methods to read a enum in a node.
template<typename T>
static bool	get (const ConfigurationParameterDescriptor *node, const std::string &name, T &value, const std::map< std::string, T > &mapping, SimulatedObject *object=0)
	Retrieves a value of enum "T".
The get methods to read a object name in a node.
static bool	getAndCheckObject (const ConfigurationParameterDescriptor *node, const std::string &name, Name &objectName, Controller &controller, SimulatedObject *object=0)
	Retrieves a object name and check its existance in the configuration tree.
The set methods to write a value in a node.
template<typename T>
static ConfigurationParameterDescriptor *	set (ConfigurationParameterDescriptor *&node, const std::string &name, const T &value)
	Allows to append the data to the node.
static ConfigurationParameterDescriptor *	set (ConfigurationParameterDescriptor *&node, const std::string &name, ConfigurationParameterDescriptor *newNode)
	Specialisation for ConfigurationParameterDescriptor pointer.
The set methods to read a enum in a node.
template<typename T>
static ConfigurationParameterDescriptor *	set (ConfigurationParameterDescriptor *&node, const std::string &name, const T &value, const std::map< T, std::string > &mapping)
	Allows to append the enum "T" to the node.
Static Protected Member Functions
The getValue methods to read the value in a node.
Many types for many cases.
static bool	getValue (const ConfigurationParameterDescriptor *nodeValue, bool &value, std::string &errorStr)
static bool	getValue (const ConfigurationParameterDescriptor *nodeValue, Type::Color &value, std::string &errorStr)
static bool	getValue (const ConfigurationParameterDescriptor *nodeValue, Type::Transform &value, std::string &errorStr)
template<typename T>
static bool	getValue (const ConfigurationParameterDescriptor *nodeValue, IAttributeBaseT< T > &value, std::string &errorStr)
template<typename T>
static bool	getValue (const ConfigurationParameterDescriptor *nodeValue, std::vector< T > &value, std::string &errorStr)
template<typename T>
static bool	getValue (const ConfigurationParameterDescriptor *nodeValue, std::list< T > &value, std::string &errorStr)
template<typename T1, typename T2>
static bool	getValue (const ConfigurationParameterDescriptor *nodeValue, std::pair< T1, T2 > &value, std::string &errorStr)
template<typename TK, typename TD>
static bool	getValue (const ConfigurationParameterDescriptor *nodeValue, std::map< TK, TD > &value, std::string &errorStr)
template<typename T>
static bool	getValue (const ConfigurationParameterDescriptor *nodeValue, T &value, std::string &errorStr)
Protected methods to convert text, find node and display error.
template<typename T>
static bool	getTxtValue (const std::string &textValue, T &value)
	Gets a value from a string Retrieves the value in the string.
static const ConfigurationParameterDescriptor *	getNodeValue (const ConfigurationParameterDescriptor *node, const std::string &name, std::string &errorStr)
	Retrieve the node named name in the tree.
static bool	displayError (const std::string &name, const std::string &functionName, SimulatedObject *object, const std::string &errorStr)
	Display the message errorStr.
Protected methods to convert value.
template<typename T>
static bool	setTxtValue (std::string &textValue, const T &value)
	Gets a string from a value.
The setValue methods to create a node with a value.
Many types for many cases.
template<typename T>
static ConfigurationParameterDescriptor *	setValue (const T &value, std::string &errorStr)
static ConfigurationParameterDescriptor *	setValue (const bool &value, std::string &errorStr)
static ConfigurationParameterDescriptor *	setValue (const Type::Color &value, std::string &errorStr)
static ConfigurationParameterDescriptor *	setValue (const Type::Transform &value, std::string &errorStr)
template<typename T>
static ConfigurationParameterDescriptor *	setValue (const IAttributeBaseT< T > &values, std::string &errorStr)
template<typename T>
static ConfigurationParameterDescriptor *	setValue (const std::vector< T > &values, std::string &errorStr)
template<typename T>
static ConfigurationParameterDescriptor *	setValue (const std::list< T > &value, std::string &errorStr)
template<typename TK, typename TD>
static ConfigurationParameterDescriptor *	setValue (const std::map< TK, TD > &value, std::string &errorStr)
template<typename T1, typename T2>
static ConfigurationParameterDescriptor *	setValue (const std::pair< T1, T2 > &value, std::string &errorStr)

---

Detailed Description

Provide some accessors for configuration parameters.

Author:

Benoit Chanclou

Date:

2006-03-24

Module description :

Gets value(s) in the tree of configuration parameter descriptors. The values are found by their name.

Getting a boolean.

The parameter accessor for a boolean reads a boolean expression. So the following syntaxes are valid (no matter using upcase or not)

 // mean true
 flag true
 flag True
 flag TRUE
 flag on
 flag 1 
 flag enable
 flag yes
 // means false
 flag false
 flag off
 flag 0 
 flag disable
 flag no

Getting a Type::Color "Color".

The parameter accessor for Color reads a color with or without the alpha channel. The RGB values could be in [0, 1] or in [0, 255]. So these following colors are valid

 black     [0 0 0] 
 white     [1 1 1]
 withAlpha [0.4 0.3 1.0 .5]
 fullGreen [255 0 0]
 darkGreen [0.5 0 0]

You can also use the "string" syntax, but in that case the four values (in [0 1] set) must be set. No test are be done, if the alpha channel is not present, the call crashes.

 withAlpha "0.4 0.3 1.0 .5"

Getting a Transform.

The parameter accessor for Type::Transform reads a transformation.

The transform is a array [translation rotation scale] where:

• translation is [x y z].
• rotation is [alpha beta gamma type] Euler angles or a matrix 3x3. The type of the Euler angle is a letter: (r)adian, (d)egrees, (g)rad or fraction of (p)i. It is an optional field, by default it is radians.
• scale is uniform [scale] or not [x y z].

The scale and rotation are optional.
So these following tranformations are valid

 identity       [[0 0 0]]
 translation    [[1 1 1]]
 rotationEuler  [[0 0 0][0 1.57 0]]    // radian is implicit
 rotationEulerR [[0 0 0][0 1.57 0 r]]  // radian
 rotationEulerD [[0 0 0][0 180 0 d]]   // degrees
 rotationEulerG [[0 0 0][0 200 0 g]]   // grad
 rotationEulerP [[0 0 0][0 1 0 p]]     // faction of pi
 rotationMatrix [[0 0 0][1 0 0 0 1 0 0 0 1]]
 uniformScale   [[0 0 0][0 0 0][2]]
 scale          [[0 0 0][0 0 0][2 4 1]]

Getting a pair of parameters.

You can read a pair like this:

 std::pair< int, std::string > myPair ;
 ParametersAccessor::get( node, "MyPair", myPair ) ;

The configuration file will be

 MyPair [3 "is three"]

Getting a vector or a list of parameters.

You can read a set of parameters like this:

 std::vector< std::string > values ; // or std::list< std::string > values ;
 ParametersAccessor::get( node, "ASet", values ) ;

The configuration file will be

 ASet ["one" "two" "three"]

Getting a map of parameters.

You can read a map of parameters like this:

 std::map< std::string, int > values ;
 ParametersAccessor::get( node, "AMap", values ) ;

The configuration file will be

 AMap [["one" 1] ["two" 2] ["three" 3]]

Getting a matrix or compound data.

Getting a matrix can be done like this:

 std::vector< std::vector< float > > values ;
 ParametersAccessor::get( node, "Identity", values ) ;

The configuration file will be

 Identity [[1.0 0.0 0.0][0.0 1.0 0.0][0.0 0.0 1.0]]

Getting compound data can be done like this:

 std::vector< std::pair< std::vector< float >, std::string > > positionsAndNames ;
 ParametersAccessor::get( node, "Set", positionsAndNames ) ;
 x = positionsAndNames[0].first[0] ;
 y = positionsAndNames[0].first[1] ;
 name = positionsAndNames[0].second ;

The configuration file will be

 Set [[[1.0 1.0] "upperright"] [[-1.0 -1.0] "bottomleft"]]

Example for getting

See the Trajectory or Attribute configuration loaders.

Setting a boolean.

The parameter accessor for a boolean sets a boolean to true or false.

Setting a Type::Color "Color".

The parameter accessor for Color sets a color with the RGB values in the the range of [0, 1] and the alpha channel if it is different from 1.

Setting a Transform.

The parameter accessor for Type::Transform sets a transformation.

The transform is a array [translation rotation scale] where:

• translation is [x y z].
• rotation is matrix 3x3, it is set only if the rotate is not the identity or if the scale is diffent from 1.
• scale is [scale] if it is uniform or [x y z] if not.

Setting a set of parameters.

You can set the node from a attribute, a pair, a vector, a list or a map.

Setting a hierarchical parameters.

You can set the node from a node, see example below.

Example for setting

the following example shows how to append a SwitchAnimator node to the animator node of the visualisation.

The equivalent configuration parameter of this example are :

 Animator
 {
   ...
   mySwitchAnimator
   {
     Class SwitchAnimator
     EventId SwitchStringEvent
     FileTab [ badTie.scene goodTie.scene ]
   }
   ...

To append this animator use this code

  // Creates the data for the switch animator
  ConfigurationParameterDescriptor * switchAnimatorNode = 0 ;
  ParametersAccessor::set( switchAnimatorNode, "Class", "SwitchAnimator" ) ;
  ParametersAccessor::set( switchAnimatorNode, "EventId", "SwitchStringEvent" ) ;
  std::vector< std::string > tab ;
  tab.push_back( "badTie.scene" );
  tab.push_back( "goodTie.scene" );
  ParametersAccessor::set( switchAnimatorNode, "FileTab", tab ) ;
  // Looking for the "Animator" node
  ConfigurationParameterDescriptor * animatorNode = 0 ;
  ParametersAccessor::get( theVisualisation->getObjectDescriptor()->getConfigurationParameters (), 
                              "Animator", animatorNode );
  // adds them to the Animator field of the visualisation
  // Here we should test if animatorNode is not null or create it
  ParametersAccessor::set( animatorNode, "mySwitchAnimator", switchAnimatorNode ) ;

Definition at line 218 of file OMKParametersAccessor.h.

---

Member Function Documentation

template<typename T>

bool OMK::ParametersAccessor::get	(	const ConfigurationParameterDescriptor *	node,
		const std::string &	name,
		T &	value,
		SimulatedObject *	object = 0
	)			[inline, static]

Retrieves a value of type "T".

Returns:

true if the node can be read, else false

Parameters:

[in]	node	the node where is the parameter
[in]	name	the name of the parameter to find
[out]	value	the returned value of type T
[in]	object	the simulated object which try to retrieve the information (default is null) only use to display error message.

For error messages details see displayError

Definition at line 99 of file OMKParametersAccessor.inl.

References displayError(), getNodeValue(), and getValue().

Referenced by OMK::Vis::Animator::Animator(), OMK::Vis::AnimatorT< T >::AnimatorT(), OMK::MKMHumano::computeParameters(), OMK::Controller::Controller(), OMK::Iii::InteractorOutput::create(), OMK::Iii::IConvertorT< TypeOut, TypeIn >::create(), OMK::ExtensionManager::createExtensionsFromParameters(), OMK::Inp::InputExtension::createOISInputSystem(), OMK::StaticHumano::getInitialiseSequence(), OMK::MovingHumano::getVisualObjectPrm(), OMK::Iii::IAccessRule::IAccessRule(), OMK::Iii::IConnector::IConnector(), OMK::Vis::SwitchAnimator::init(), OMK::PluginsLoaderClass::init(), OMK::Clock::init(), OMK::IAttributeAnimatorT< PrmType, ModelType, AccessorType >::initAnimator(), OMK::Inp::InputExtension::initCallBackForKey(), OMK::Type::AddVisualObjectPrm::innerParametersLoader(), OMK::Inp::AddInputListenerPrm::innerParametersLoader(), OMK::Inp::AddInputKeyPrm::innerParametersLoader(), OMK::Type::AddAnimatorPrm::innerParametersLoader(), OMK::Inp::KeyListener::KeyListener(), OMK::Vis::OgreObjectScene::loadConfigurationParameters(), OMK::TriggerAttributeExtension::loadExtensionParameters(), OMK::DistanceToExtension::loadExtensionParameters(), OMK::MultiTriggerEmitterExtensionT< T, ModelType >::loadExtensionParameters(), OMK::TriggerEmitterExtensionT< T, ModelType >::loadExtensionParameters(), OMK::TriggerEmitterExtension::loadExtensionParameters(), OMK::MultiTriggerContainerExtension::loadExtensionParameters(), OMK::TriggerContainerExtension::loadExtensionParameters(), OMK::Inp::PlusMinusExtension< T >::loadExtensionParameters(), OMK::Inp::OverlayExtension::loadExtensionParameters(), OMK::PreOffsetExtension::loadExtensionParameters(), OMK::MKMMoveToTaskExtension::loadExtensionParameters(), OMK::MKMMotionTaskExtension::loadExtensionParameters(), OMK::Iii::JointExtension::loadExtensionParameters(), OMK::Iii::JointInteractorExtension::loadExtensionParameters(), OMK::Iii::InteractorExtension::loadExtensionParameters(), OMK::Iii::InteractiveExtension::loadExtensionParameters(), OMK::Inp::InputExtension::loadExtensionParameters(), OMK::Inp::GenericKeyExtension< OMK::ExtensibleSimulatedObject >::loadExtensionParameters(), OMK::DuplicatedAttributeExtension< AttributType, Type >::loadExtensionParameters(), OMK::Inp::DebugOverlayExtension::loadExtensionParameters(), OMK::ContainerExtension::loadExtensionParameters(), OMK::ExtensionManager::loadFromExtensionsParameters(), OMK::Vis::VisObjectExtension::loadObjectParameters(), OMK::Iii::JointInteractorExtension::loadObjectParameters(), OMK::ExtensionManager::loadOrder(), OMK::Trajectory::loadParameters(), OMK::Tracker::loadParameters(), OMK::Vis::OgreVis::loadParameters(), OMK::IAttribute::loadParameters(), OMK::HumanoRecorder::loadParameters(), OMK::HumanoPlayer::loadParameters(), OMK::Iii::AssociatedConnectorT< Type >::loadParameters(), OMK::IAttributeAnimatorT< PrmType, ModelType, AccessorType >::loadParameters(), OMK::IAttributeBaseT< PrmType >::loadParameters(), OMK::MultiValuedEventSignalEmitterUtilT< T, ModelType >::loadParametersUtil(), OMK::ValuedEventSignalEmitterUtilT< T, ModelType >::loadParametersUtil(), OMK::EventSignalEmitterUtil::loadParametersUtil(), OMK::loadSignalRegistrationParameters(), OMK::Vis::OgreAnimatorCommon::OgreAnimatorCommon(), OMK::PvmController::PvmController(), OMK::Vis::VisualObject::readConfigurationParameters(), OMK::Inp::DistributedCameraListener::readConfigurationParameters(), OMK::Inp::InputListener::retrieveCodeFromConfig(), and OMK::IAttribute::setOwner().

{
  std::string errorStr ;
  // Get the node for the value
  const ConfigurationParameterDescriptor * nodeValue = getNodeValue( node, name, errorStr ) ;
  // if it is good, get the value else display error
  return ( nodeValue && getValue( nodeValue, value, errorStr ) ) 
      || displayError( name, "get", object, errorStr ) ;
}

template<typename T>

bool OMK::ParametersAccessor::get	(	const ConfigurationParameterDescriptor *	node,
		const std::string &	name,
		T &	value,
		const std::map< std::string, T > &	mapping,
		SimulatedObject *	object = 0
	)			[inline, static]

Retrieves a value of enum "T".

Returns:

true if the node can be read, else false

Parameters:

[in]	node	the node where is the enum parameter
[in]	name	the name of the enum parameter to find
[out]	value	the returned enum of type T
[in]	mapping	the map for correspondance between enum and text
[in]	object	the simulated object which try to retrieve the information (default is null) only use to display error message.

To be case sensitive or not you have to modify the compare parameter of the map.

For error messages details see displayError

Definition at line 115 of file OMKParametersAccessor.inl.

References displayError(), getNodeValue(), and getValue().

{
  std::string errorStr ;
  // Get the node for the value
  const ConfigurationParameterDescriptor * nodeValue = getNodeValue( node, name, errorStr ) ;
  // get the value as a string and convert it with the mapping
  std::string txt ;
  bool ok = false ;
  if( nodeValue && getValue( nodeValue, txt, errorStr ) )
  {
    typename std::map< std::string, T >::const_iterator i = mapping.find( txt ) ;
    if( i != mapping.end() ) 
    {
      value = i->second ;
      ok = true ;
    }
    else
    {
      errorStr = "Cannot read a valid enum value in string \"" ;
      errorStr += txt ;
      errorStr += "\"" ;
    }
  }
  // true if it is good else display error
  return ok || displayError( name, "get", object, errorStr ) ;

}

bool ParametersAccessor::getAndCheckObject	(	const ConfigurationParameterDescriptor *	node,
		const std::string &	name,
		Name &	objectName,
		Controller &	controller,
		SimulatedObject *	object = 0
	)			[static]

Retrieves a object name and check its existance in the configuration tree.

Returns:

true if the node can be read and object exists, else false

Parameters:

[in]	node	the node where is the parameter
[in]	name	the name of the parameter to find
[out]	objectName	the name of a object to find
[in]	the	controller which manage the objects (use to check the object)
[in]	object	the simulated object which try to retrieve the information (default is null) only use to display error message.

For error messages details see displayError

Definition at line 73 of file OMKParametersAccessor.cpp.

References displayError(), OMK::Name::getCString(), getNodeValue(), OMK::Controller::getObjectDescriptorOfObject(), and getValue().

{
  std::string errorStr ;
  // Get the node for the value
  const ConfigurationParameterDescriptor * nodeValue = getNodeValue( node, name, errorStr ) ;
  // if it is good, get the value else display error
  bool ok = ( nodeValue != NULL ) ;
  ok = ok && getValue( nodeValue, objectName, errorStr ) ;
  if( ok )
  {
    try
    {
      //check wether paramVariable exists: if it does not, a OMKUserException is thrown
      controller.getObjectDescriptorOfObject( objectName );
    }
    catch( UserException e )
    {
      ok = false ;
      errorStr = "Object \"" ;
      errorStr += objectName.getCString();
      errorStr += "\" doesn't exist" ;
    }
  }
  return ok || displayError( name, "getAndCheckObject", object, errorStr ) ;
}

bool ParametersAccessor::getValue	(	const ConfigurationParameterDescriptor *	nodeValue,
		bool &	value,
		std::string &	errorStr
	)			[static, protected]

Definition at line 105 of file OMKParametersAccessor.cpp.

Referenced by get(), getAndCheckObject(), and getValue().

{
  std::string str;
  if( !getValue( nodeValue, str, errorStr ) )
  { // Error
    return false;
  }
  std::transform( str.begin(), str.end(), str.begin(), toupper );
  flag = ( str == "TRUE" || str == "ON" || str == "ENABLE" || str == "YES" || str == "1" ) ;
  bool ok = flag || ( str == "FALSE" || str == "OFF" || str == "DISABLE" || str == "NO" || str == "0" ) ;
  if( !ok )
  {
    errorStr = "Cannot read the boolean" ;       
  }
  return ok ;
}

bool ParametersAccessor::getValue	(	const ConfigurationParameterDescriptor *	nodeValue,
		Type::Color &	value,
		std::string &	errorStr
	)			[static, protected]

Definition at line 126 of file OMKParametersAccessor.cpp.

References OMK::ConfigurationParameterDescriptor::getAssociatedString(), OMK::ConfigurationParameterDescriptor::getNumberOfSubItems(), OMK::ConfigurationParameterDescriptor::getSubDescriptorByPosition(), getTxtValue(), and getValue().

{
  if( !nodeValue )
    return false; // Error no valid node
  
  if( nodeValue->getAssociatedString()[0] == '{' ) 
  {
    // array format => read it 
    // rgb or rgba
    bool ok = ( 3 == nodeValue->getNumberOfSubItems() 
             || 4 == nodeValue->getNumberOfSubItems() ); 
    if ( !ok && errorStr.empty() ) 
      errorStr = "Bad format of OMK::Type::Color (need 3 or 4 arguments)" ;
    // 4 values => rgb + alpha
    bool withAlpha = ( 4 == nodeValue->getNumberOfSubItems() ) ;
    float r = 0.0f;
    float g = 0.0f;
    float b = 0.0f;
    float a = 1.0f; 
    if( ok )
    {
      ok = ok && getValue( nodeValue->getSubDescriptorByPosition( 0 ), r, errorStr ) ;
      ok = ok && getValue( nodeValue->getSubDescriptorByPosition( 1 ), g, errorStr ) ;
      ok = ok && getValue( nodeValue->getSubDescriptorByPosition( 2 ), b, errorStr ) ;
      if( withAlpha ) ok = ok && getValue( nodeValue->getSubDescriptorByPosition( 3 ), a, errorStr ) ;
      if ( !ok ) 
        errorStr += ". Cannot get one of the OMK::Type::Color argument" ;
    }
    // Normalize in [0, 1] set
    if( 1.0f < r || 1.0f < g || 1.0f < b )
    {
      r /= 255.0f;
      g /= 255.0f;
      b /= 255.0f;
    }
    ok = ok 
      && ( 0.0f <= r ) && ( r <= 1.0f )
      && ( 0.0f <= g ) && ( g <= 1.0f )
      && ( 0.0f <= b ) && ( b <= 1.0f )
      && ( 0.0f <= a ) && ( a <= 1.0f ) ;
    if ( !ok && errorStr.empty() )
      errorStr = "One of the OMK::Type::Color argument is not in the good range [0.0 1.0] or [0 255]" ;
        
    if( ok )
    { // Create the color
      color = OMK::Type::Color( r, g, b, a ) ;
    }
    return ok;
  }
  // string format
  return getTxtValue( nodeValue->getAssociatedString(), color );
}

bool ParametersAccessor::getValue	(	const ConfigurationParameterDescriptor *	nodeValue,
		Type::Transform &	value,
		std::string &	errorStr
	)			[static, protected]

Definition at line 184 of file OMKParametersAccessor.cpp.

References OMK::ConfigurationParameterDescriptor::getAssociatedString(), OMK::ConfigurationParameterDescriptor::getNumberOfSubItems(), OMK::ConfigurationParameterDescriptor::getSubDescriptorByPosition(), getTxtValue(), getValue(), OMK::Type::Transform::setRotate(), OMK::Type::Transform::setScale(), OMK::Type::Transform::setTranslate(), OMK::Type::Transform::setUniformScale(), OMK::Type::Transform::sk_identity, and OMK::Type::Transform::updateFlags().

{
  if( !nodeValue )
    return false; // Error no valid node
  
  bool ok = false ;
  if( nodeValue->getAssociatedString()[0] == '{' ) 
  {
    transform = OMK::Type::Transform::sk_identity ;
  
    // array format => read it 
    // rgb or rgba
    ok = ( 1 <= nodeValue->getNumberOfSubItems() 
        && nodeValue->getNumberOfSubItems() <= 3 ); 
    if ( !ok && errorStr.empty() ) 
    {
      errorStr = "Bad format of Transform (need 1 to 3 arguments)" ;
    }
    // get the 3 sub nodes for translation, rotation and scale
    const ConfigurationParameterDescriptor * translationNode = 
        nodeValue->getSubDescriptorByPosition( 0 ) ;
    const ConfigurationParameterDescriptor * rotationNode    = 
        ( 2 <= nodeValue->getNumberOfSubItems() ) ? nodeValue->getSubDescriptorByPosition( 1 ) : 0 ;
    const ConfigurationParameterDescriptor * scaleNode       = 
        ( 3 == nodeValue->getNumberOfSubItems() ) ? nodeValue->getSubDescriptorByPosition( 2 ) : 0 ;
    
    // Translation
    Wm4::Vector3f translation = Wm4::Vector3f::ZERO ;
    if( ok && translationNode )
    {
      ok = 3 == translationNode->getNumberOfSubItems() ;
      float t[ 3 ] = { 0.0f, 0.0f, 0.0f } ;
      for ( int i = 0 ; i < 3 && ok ; i++ ) 
      {
        ok = ok && getValue( translationNode->getSubDescriptorByPosition( i ), t[ i ], errorStr ) ;
      }
      if ( ok ) 
      {
        transform.setTranslate( Wm4::Vector3f( t ) ) ;
      }
      else
      {
        errorStr += ". Cannot get one of the translation of the Transform argument" ;
      }
    }
    
    // Rotation
    Wm4::Matrix3f rotation = Wm4::Matrix3f::IDENTITY ;
    if( ok && rotationNode )
    {
      float rm[ 9 ] = { 1.0f, 0.0f, 0.0f, 0.0f, 1.0f, 0.0f, 0.0f, 0.0f, 1.0f } ;
      // check for 3 or 9 items
      int nbItems = rotationNode->getNumberOfSubItems() ;
      ok = 9 == nbItems || 4 == nbItems || 3 == nbItems ;
      char angleType( 'r' );
      if( 4 == nbItems )
      { // The 4th flag is the type
        nbItems = 3 ; // only 3 numeric values 
        getValue( rotationNode->getSubDescriptorByPosition( 3 ), angleType, errorStr ) ;
      }
      // gets the items value
      for ( int i = 0 ; i < nbItems && ok ; i++ )
      {
        ok = ok && getValue( rotationNode->getSubDescriptorByPosition( i ), rm[ i ], errorStr ) ;
      }
      if( 9 == nbItems )
      { // Rotation matrix
        if ( ok ) 
        {
          rotation = Wm4::Matrix3f( rm, true ) ; // Row major
          transform.setRotate( rotation ) ;
        }
        else
        {
          errorStr += ". Cannot get one of the rotation matrix of the Transform argument" ;
        }
      }
      else if( 3 == nbItems )
      { // Rotation angles Euler Radian 
        if ( ok ) 
        {
          switch( angleType )
          {
          case 'r' : // Radian nothing to do
            break; 
          case 'd' : // Degrees
            rm[ 0 ] *= Wm4::Mathf::DEG_TO_RAD ;
            rm[ 1 ] *= Wm4::Mathf::DEG_TO_RAD ;
            rm[ 2 ] *= Wm4::Mathf::DEG_TO_RAD ;
            break ;
          case 'g' : // Grad
            rm[ 0 ] *= Wm4::Mathf::DEG_TO_RAD * 0.9f ;
            rm[ 1 ] *= Wm4::Mathf::DEG_TO_RAD * 0.9f ;
            rm[ 2 ] *= Wm4::Mathf::DEG_TO_RAD * 0.9f ;
            break ;
          case 'p' : // Fraction of pi
            rm[ 0 ] *= Wm4::Mathf::PI ;
            rm[ 1 ] *= Wm4::Mathf::PI ;
            rm[ 2 ] *= Wm4::Mathf::PI ;
            break ;
          default :
            ok = false ;
            errorStr += "Unknow type of angle (only 'r', 'd', 'g' and 'p' are allowed)" ;
          }
          rotation.FromEulerAnglesXYZ( rm[ 0 ] ,  
                                       rm[ 1 ] , 
                                       rm[ 2 ] );  // Euler angles
          transform.setRotate( rotation ) ;
        }
        else
        {
          errorStr += ". Cannot get one of the rotation Euler angle of the Transform argument" ;
        }
      }
      else
      {
        errorStr += "Cannot get the rotation of the Transform argument" ;
      }
    }
    
    // Scale
    Wm4::Vector3f scale = Wm4::Vector3f::ONE ;
    if( ok && scaleNode )
    {
      int nbItems = scaleNode->getNumberOfSubItems() ;
      ok = 1 == nbItems || 3 == nbItems ;
      float s[ 3 ] = { 1.0f, 1.0f, 1.0f } ;
      for ( int i = 0 ; i < nbItems && ok ; i++ )
      {
        ok = ok && getValue( scaleNode->getSubDescriptorByPosition( i ), s[ i ], errorStr ) ;
      }
      if( 1 == nbItems )
      { // Uniform scale
        if ( ok ) 
        {
          transform.setUniformScale( s[ 0 ] ) ;
        }
        else
        {
          errorStr += ". Cannot get the uniform scale of the Transform argument" ;
        }
      }
      else if( 3 == nbItems )
      { // No uniform scale
        if ( ok ) 
        {
          transform.setScale( Wm4::Vector3f( s ) ) ;
        }
        else
        {
          errorStr += ". Cannot get one of the scale of the Transform argument" ;
        }
      }
      else
      {
        errorStr += "Cannot get the scale of the Transform argument" ;
      }
    }
  }
  else
  {
    ok = getTxtValue( nodeValue->getAssociatedString(), transform ) ;
  }
  transform.updateFlags() ;
  
  // string format
  return ok ;
}

template<typename T>

bool OMK::ParametersAccessor::getValue	(	const ConfigurationParameterDescriptor *	nodeValue,
		IAttributeBaseT< T > &	value,
		std::string &	errorStr
	)			[inline, static, protected]

Definition at line 150 of file OMKParametersAccessor.inl.

References OMK::ConfigurationParameterDescriptor::getAssociatedString(), getValue(), and OMK::IAccessorT< T >::set().

{
  T value ;
  bool ok = ( nodeValue != NULL ) ;
  ok = ok && getValue( nodeValue, value, errorStr ) ;
  if( ok )
  {
    attr.set( value ) ; 
  }
  else
  {
    errorStr = "Cannot read the value in string \"" ;
    errorStr += nodeValue ? nodeValue->getAssociatedString() : "empty" ;
    errorStr += "\"" ;
  }
  return ok ;
}

template<typename T>

bool OMK::ParametersAccessor::getValue	(	const ConfigurationParameterDescriptor *	nodeValue,
		std::vector< T > &	value,
		std::string &	errorStr
	)			[inline, static, protected]

Definition at line 173 of file OMKParametersAccessor.inl.

References OMK::ConfigurationParameterDescriptor::getNumberOfSubItems(), OMK::ConfigurationParameterDescriptor::getSubDescriptorByPosition(), and getValue().

{
  bool ok = ( nodeValue != NULL ) ;
  if( ok )
  {
    for( int i = 0 ; ok && ( i < nodeValue->getNumberOfSubItems() ) ; i++ )
    {
      T aValue;
      ok = ParametersAccessor::getValue( nodeValue->getSubDescriptorByPosition( i ), aValue, errorStr ) ;
      if( ok )
      {
        values.push_back(aValue);
      }
      else
      {
        std::ostringstream oss ;
        oss << ", cannot get the parameter number " << i ;
        errorStr += oss.str() ;
      }
    }
  }
  return ok ;
}

template<typename T>

bool OMK::ParametersAccessor::getValue	(	const ConfigurationParameterDescriptor *	nodeValue,
		std::list< T > &	value,
		std::string &	errorStr
	)			[inline, static, protected]

Definition at line 202 of file OMKParametersAccessor.inl.

References OMK::ConfigurationParameterDescriptor::getNumberOfSubItems(), OMK::ConfigurationParameterDescriptor::getSubDescriptorByPosition(), and getValue().

{
  bool ok = ( nodeValue != NULL ) ;
  if( ok )
  {
    for( int i = 0 ; ok && ( i < nodeValue->getNumberOfSubItems() ) ; i++ )
    {
      T aValue;
      ok = ParametersAccessor::getValue( nodeValue->getSubDescriptorByPosition( i ), aValue, errorStr ) ;
      if( ok )
      {
        values.push_back(aValue);
      }
      else
      {
        std::ostringstream oss ;
        oss << ", cannot get the parameter number " << i ;
        errorStr += oss.str() ;
      }
    }
  }
  return ok ;
}

template<typename T1, typename T2>

bool OMK::ParametersAccessor::getValue	(	const ConfigurationParameterDescriptor *	nodeValue,
		std::pair< T1, T2 > &	value,
		std::string &	errorStr
	)			[inline, static, protected]

Definition at line 260 of file OMKParametersAccessor.inl.

References OMK::ConfigurationParameterDescriptor::getAssociatedString(), OMK::ConfigurationParameterDescriptor::getNumberOfSubItems(), OMK::ConfigurationParameterDescriptor::getSubDescriptorByPosition(), and getValue().

{
  bool ok( ( nodeValue != NULL ) && ( nodeValue->getNumberOfSubItems() == 2 ) ) ;
  if ( !ok && errorStr.empty() ) 
  {
    errorStr = "Bad format of pair (need 2 arguments)" + nodeValue->getAssociatedString() ; 
  }
  ok = ok && getValue( nodeValue->getSubDescriptorByPosition( 0 ), value.first, errorStr ) ;
  ok = ok && getValue( nodeValue->getSubDescriptorByPosition( 1 ), value.second, errorStr ) ;
  return ok ;
}

template<typename TK, typename TD>

bool OMK::ParametersAccessor::getValue	(	const ConfigurationParameterDescriptor *	nodeValue,
		std::map< TK, TD > &	value,
		std::string &	errorStr
	)			[inline, static, protected]

Definition at line 231 of file OMKParametersAccessor.inl.

References OMK::ConfigurationParameterDescriptor::getNumberOfSubItems(), OMK::ConfigurationParameterDescriptor::getSubDescriptorByPosition(), and getValue().

{
  bool ok = ( nodeValue != NULL ) ;
  if( ok )
  {
    for( int i = 0 ; ok && ( i < nodeValue->getNumberOfSubItems() ) ; i++ )
    {
      std::pair< TK, TD > aValue;
      ok = ParametersAccessor::getValue( nodeValue->getSubDescriptorByPosition( i ), aValue, errorStr ) ;
      if( ok )
      {
        values[ aValue.first ] = aValue.second ;
      }
      else
      {
        std::ostringstream oss ;
        oss << ", cannot get the parameter number " << i ;
        errorStr += oss.str() ;
      }
    }
  }
  return ok ;
}

template<typename T>

bool OMK::ParametersAccessor::getValue	(	const ConfigurationParameterDescriptor *	nodeValue,
		T &	value,
		std::string &	errorStr
	)			[inline, static, protected]

Definition at line 69 of file OMKParametersAccessor.inl.

References OMK::ConfigurationParameterDescriptor::getAssociatedString(), and getTxtValue().

{
  bool ok = ( nodeValue != NULL ) ;
  ok = ok && getTxtValue( nodeValue->getAssociatedString(), value ) ;
  if( !ok )
  {
    errorStr = "Cannot read the value in string \"" ;
    errorStr += nodeValue ? nodeValue->getAssociatedString() : "empty" ;
    errorStr += "\"" ;
  }
  return ok ;
}

template<typename T>

bool OMK::ParametersAccessor::getTxtValue	(	const std::string &	textValue,
		T &	value
	)			[inline, static, protected]

Gets a value from a string Retrieves the value in the string.

Uses a stream to convert the string in a value of type T

Definition at line 88 of file OMKParametersAccessor.inl.

Referenced by getValue().

{
  std::stringstream is;
  is << textValue;
  is >> value;
  return 0 != (void*)is;
}

const ConfigurationParameterDescriptor * ParametersAccessor::getNodeValue	(	const ConfigurationParameterDescriptor *	node,
		const std::string &	name,
		std::string &	errorStr
	)			[static, protected]

Retrieve the node named name in the tree.

Definition at line 29 of file OMKParametersAccessor.cpp.

References OMK::ConfigurationParameterDescriptor::getSubDescriptorByName().

Referenced by get(), and getAndCheckObject().

{
  const ConfigurationParameterDescriptor * nodeValue = node ? node->getSubDescriptorByName( name ) : 0 ;
  if ( !node && errorStr.empty() ) 
    errorStr = "Invalid ConfigurationParameterDescriptor node" ;
  if ( !nodeValue && errorStr.empty() )
    errorStr = "Parameter not found" ;
  return nodeValue ;
}

bool ParametersAccessor::displayError	(	const std::string &	name,
		const std::string &	functionName,
		SimulatedObject *	object,
		const std::string &	errorStr
	)			[static, protected]

Display the message errorStr.

Returns:

false so it is use as return ok || displayError(...) ; at the end of the public get methods.

This method is called by the public get methods to display the error message if it is impossible to retrieve the asked value.

In release mode no message will be displayed. In debug mode, if an object is given an error message is displayed, if not it is onnly a warning message.

Definition at line 46 of file OMKParametersAccessor.cpp.

References OMK::debugMsg(), OMERROR, OMK_DEBUG_OMK_OBJ, and OMTRACEID.

Referenced by get(), and getAndCheckObject().

{
  if( !errorStr.empty() )
  {
    if( object ) 
    {
      OMERROR( "Error in ParametersAccessor::" << functionName 
          << " with parameter [" + name + "] for " << OMK::debugMsg( object ) << std::endl 
          << ">>> :-( " << errorStr ) ;
    }
    else
    {
      OMTRACEID( OMK_DEBUG_OMK_OBJ, "Warning in ParametersAccessor::" << functionName 
          << " with parameter [" + name + "]" << std::endl 
          << ">>> :-| " << errorStr ) ;
    }
  } 
  // Return always false 
  return false ;
}

template<typename T>

ConfigurationParameterDescriptor * OMK::ParametersAccessor::set	(	ConfigurationParameterDescriptor *&	node,
		const std::string &	name,
		const T &	value
	)			[inline, static]

Allows to append the data to the node.

Parameters:

	in/out]	node The node in which the data will be appended. if null a new node is created.
[in]	name	The name of the data to append.
[in]	value	The value of the data to append.
	T	The template argument is the type of the data.

Returns:

The node appended or null if unable to set the node.

This method is the only public member of the class. Its use is easy, see example in the class definition.

Definition at line 278 of file OMKParametersAccessor.inl.

References OMK::ConfigurationParameterDescriptor::appendSubDescriptorNamed(), OMERROR, and setValue().

Referenced by OMK::MovingHumano::getVisualObjectPrm(), and OMK::IAttributeAnimatorT< PrmType, ModelType, AccessorType >::loadParameters().

{
  std::string errorStr ;
  ConfigurationParameterDescriptor* newNode = setValue( value, errorStr ) ;
  if( newNode )
  {
    if( !node ) node = new MultipleConfigurationParameter() ;
    node->appendSubDescriptorNamed( name, newNode ) ;
  }
  else
  {
    OMERROR( "Warning in ParametersAccessor::Set with parameter [" + name + "]" << std::endl 
        << ">>> :-( " << errorStr ) ;
  }
  return newNode ;
}

ConfigurationParameterDescriptor * ParametersAccessor::set	(	ConfigurationParameterDescriptor *&	node,
		const std::string &	name,
		ConfigurationParameterDescriptor *	newNode
	)			[static]

Specialisation for ConfigurationParameterDescriptor pointer.

Parameters:

[in]

Definition at line 441 of file OMKParametersAccessor.cpp.

References OMK::ConfigurationParameterDescriptor::appendSubDescriptorNamed(), and OMERROR.

{
  if( newNode )
  {
    if( !node ) node = new MultipleConfigurationParameter() ;
    node->appendSubDescriptorNamed( name, newNode ) ;
  }
  else
  {
    OMERROR( "Warning in ParametersAccessor::Set with parameter [" + name + "]" << std::endl 
        << ">>> :-( The node to append is null" ) ;
  }
  return newNode ;
}

template<typename T>

ConfigurationParameterDescriptor * OMK::ParametersAccessor::set	(	ConfigurationParameterDescriptor *&	node,
		const std::string &	name,
		const T &	value,
		const std::map< T, std::string > &	mapping
	)			[static]

Allows to append the enum "T" to the node.

Parameters:

	in/out]	node The node in which the data will be appended. if null a new node is created.
[in]	name	The name of the data to append.
[in]	value	The enum value to append.
[in]	mapping	the map for correspondance between text and enum
	T	The template argument is the enum type.

Returns:

The node appended or null if unable to set the node.

Definition at line 300 of file OMKParametersAccessor.inl.

References OMK::ConfigurationParameterDescriptor::appendSubDescriptorNamed(), OMERROR, and setValue().

{
  bool ok = false ; 
  std::string errorStr ;
  std::string txt ;
  typename std::map< T, std::string >::const_iterator i = mapping.find( value ) ;
  if( i != mapping.end() ) 
  {
    txt = i->second ;
    ok = true ;
  }
  else
  {
    errorStr = "Cannot get a valid string value with the enum value #" ;
    errorStr += (int)value ;
  }

  ConfigurationParameterDescriptor* newNode = ok ? setValue( value, errorStr ) : 0 ; 
  if( newNode )
  {
    if( !node ) node = new MultipleConfigurationParameter() ;
    node->appendSubDescriptorNamed( name, newNode ) ;
  }
  if( !ok )
  {
    OMERROR( "Warning in ParametersAccessor::Set with parameter [" + name + "]" << std::endl 
        << ">>> :-( " << errorStr ) ;
  }
  return newNode ;
}

template<typename T>

bool OMK::ParametersAccessor::setTxtValue	(	std::string &	textValue,
		const T &	value
	)			[inline, static, protected]

Gets a string from a value.

Converts a value in a text. Uses a stream to convert the value of type T in a string

Definition at line 339 of file OMKParametersAccessor.inl.

Referenced by setValue().

{
  std::stringstream os;
  os << value ;
  textValue = os.str() ;
  return 0 != (void*)os ;
}

template<typename T>

ConfigurationParameterDescriptor * OMK::ParametersAccessor::setValue	(	const T &	value,
		std::string &	errorStr
	)			[inline, static, protected]

Definition at line 350 of file OMKParametersAccessor.inl.

References setTxtValue().

Referenced by set(), and setValue().

{
  ConfigurationParameterDescriptor *node = 0 ;
  std::string textValue ;
  if( setTxtValue( textValue, value ) ) 
  {
    node = new UniqueConfigurationParameter( textValue ) ;
  }
  else
  {
    errorStr = "Unable to convert the value in a string" ;
  }
  return node ;
}

ConfigurationParameterDescriptor * ParametersAccessor::setValue	(	const bool &	value,
		std::string &	errorStr
	)			[static, protected]

Definition at line 355 of file OMKParametersAccessor.cpp.

{
  return new UniqueConfigurationParameter( value ? "true" : "false" ) ;
}

ConfigurationParameterDescriptor * ParametersAccessor::setValue	(	const Type::Color &	value,
		std::string &	errorStr
	)			[static, protected]

Definition at line 362 of file OMKParametersAccessor.cpp.

References OMK::ConfigurationParameterDescriptor::appendSubDescriptor(), OMK::Type::Color::getA(), OMK::Type::Color::getB(), OMK::Type::Color::getG(), OMK::Type::Color::getR(), and setTxtValue().

{
  ConfigurationParameterDescriptor *node = new MultipleConfigurationParameter() ;
  bool ok = true ;
  std::string text ;
  ok = ok && setTxtValue( text, color.getR() ) ;
  if( ok ) node->appendSubDescriptor( new UniqueConfigurationParameter( text ) ) ;
  ok = ok && setTxtValue( text, color.getG() ) ;
  if( ok ) node->appendSubDescriptor( new UniqueConfigurationParameter( text ) ) ;
  ok = ok && setTxtValue( text, color.getB() ) ;
  if( ok ) node->appendSubDescriptor( new UniqueConfigurationParameter( text ) ) ;
  if( color.getA() != 1.0f )
  {
    ok = ok && setTxtValue( text, color.getA() ) ;
    if( ok ) node->appendSubDescriptor( new UniqueConfigurationParameter( text ) ) ;
  }
  if( !ok ) 
  {
    delete node ;
    node = 0 ;
    errorStr = "Unable to convert the color into a node" ;
  }
  return node ;
}

ConfigurationParameterDescriptor * ParametersAccessor::setValue	(	const Type::Transform &	value,
		std::string &	errorStr
	)			[static, protected]

Definition at line 389 of file OMKParametersAccessor.cpp.

References OMK::ConfigurationParameterDescriptor::appendSubDescriptor(), OMK::Type::Transform::getRotate(), OMK::Type::Transform::getScale(), OMK::Type::Transform::getTranslate(), OMK::Type::Transform::getUniformScale(), OMK::Type::Transform::isUniformScale(), and setTxtValue().

{
  bool ok = true ;
  bool needScale = !transf.isUniformScale() || transf.getUniformScale() != 1.0f ;
  std::string text ;
  ConfigurationParameterDescriptor *node = new MultipleConfigurationParameter() ;
  // Translate
  {
    ConfigurationParameterDescriptor *translateNode = new MultipleConfigurationParameter() ;
    node->appendSubDescriptor( translateNode ) ;
    for( int i = 0 ; i < 3 ; i++ )
    {
      ok = ok && setTxtValue( text, transf.getTranslate()[ i ] ) ;
      if( ok ) translateNode->appendSubDescriptor( new UniqueConfigurationParameter( text ) ) ;
    }
  }
  // Rotate
  if( ok && ( needScale || transf.getRotate() != Wm4::Matrix3f::IDENTITY ) )
  {
    ConfigurationParameterDescriptor *rotateNode = new MultipleConfigurationParameter() ;
    node->appendSubDescriptor( rotateNode ) ;
    for( int r = 0 ; r < 3 ; r++ )
    {
      for( int c = 0 ; c < 3 ; c++ )
      {
        ok = ok && setTxtValue( text, transf.getRotate()[r][c] ) ;
        if( ok ) rotateNode->appendSubDescriptor( new UniqueConfigurationParameter( text ) ) ;
      }
    }
  }
  // Scale
  if( ok && needScale )
  {
    ConfigurationParameterDescriptor *scaleNode = new MultipleConfigurationParameter() ;
    node->appendSubDescriptor( scaleNode ) ;
    for( int i = 0 ; i < ( transf.isUniformScale() ? 1 : 3 ) ; i++ )
    {
      ok = ok && setTxtValue( text, transf.getScale()[ i ] ) ;
      if( ok ) scaleNode->appendSubDescriptor( new UniqueConfigurationParameter( text ) ) ;
    }
  }
  // ok ?
  if( !ok ) 
  {
    errorStr = "Unable to convert the tranform into a node" ;
    delete node ;
    node = 0 ;
  }
  return node ;
}

template<typename T>

ConfigurationParameterDescriptor * OMK::ParametersAccessor::setValue	(	const IAttributeBaseT< T > &	values,
		std::string &	errorStr
	)			[inline, static, protected]

Definition at line 369 of file OMKParametersAccessor.inl.

References OMK::IAccessorT< T >::get(), and setTxtValue().

{
  ConfigurationParameterDescriptor *node = 0 ;
  std::string textValue ;
  if( setTxtValue( textValue, attr.get() ) ) 
  {
    node = new UniqueConfigurationParameter( textValue ) ;
  }
  else
  {
    errorStr = "Unable to convert the value of the attribut in a string" ;
  }
  return node ;
}

template<typename T>

ConfigurationParameterDescriptor * OMK::ParametersAccessor::setValue	(	const std::vector< T > &	values,
		std::string &	errorStr
	)			[inline, static, protected]

Definition at line 388 of file OMKParametersAccessor.inl.

References OMK::ConfigurationParameterDescriptor::appendSubDescriptor(), and setValue().

{
  ConfigurationParameterDescriptor *node = new MultipleConfigurationParameter() ;
  for( unsigned int i = 0 ; i < values.size() ; i++ )
  {
    ConfigurationParameterDescriptor *itemNode = setValue( values[ i ], errorStr ) ;
    if( itemNode )
    {
      node->appendSubDescriptor( itemNode ) ;
    }
    else
    {
      errorStr += "\nUnable to set the value #" ;
      errorStr += i ;
    }
  }
  return node ;
}

template<typename T>

ConfigurationParameterDescriptor * OMK::ParametersAccessor::setValue	(	const std::list< T > &	value,
		std::string &	errorStr
	)			[inline, static, protected]

Definition at line 411 of file OMKParametersAccessor.inl.

References OMK::ConfigurationParameterDescriptor::appendSubDescriptor(), and setValue().

{
  ConfigurationParameterDescriptor *node = new MultipleConfigurationParameter() ;
  for( typename std::list< T >::const_iterator i = values.begin() ; i != values.end() ; i++ )
  {
    ConfigurationParameterDescriptor *itemNode = setValue( *i, errorStr ) ;
    if( itemNode )
    {
      node->appendSubDescriptor( itemNode ) ;
    }
    else
    {
      errorStr += "\nUnable to set the value of the list" ;
    }
  }
  return node ;
}

template<typename TK, typename TD>

ConfigurationParameterDescriptor * OMK::ParametersAccessor::setValue	(	const std::map< TK, TD > &	value,
		std::string &	errorStr
	)			[inline, static, protected]

Definition at line 433 of file OMKParametersAccessor.inl.

References OMK::ConfigurationParameterDescriptor::appendSubDescriptor(), and setValue().

{
  ConfigurationParameterDescriptor *node = new MultipleConfigurationParameter() ;
  for( typename std::map< TK, TD >::const_iterator i = values.begin() ; i != values.end() ; i++ )
  {
    ConfigurationParameterDescriptor *keyNode = setValue( i->first, errorStr ) ;
    ConfigurationParameterDescriptor *dataNode = setValue( i->second, errorStr ) ;
    if( keyNode && dataNode )
    {
      ConfigurationParameterDescriptor *itemNode = new MultipleConfigurationParameter() ;
      itemNode->appendSubDescriptor( keyNode ) ;
      itemNode->appendSubDescriptor( dataNode ) ;
      node->appendSubDescriptor( itemNode ) ;
    }
    else
    {
      errorStr += "\nUnable to set the value of the map" ;
    }
  }
  return node ;
}

//-------------------------------------------------------------------

template<typename T1, typename T2>

ConfigurationParameterDescriptor * OMK::ParametersAccessor::setValue	(	const std::pair< T1, T2 > &	value,
		std::string &	errorStr
	)			[inline, static, protected]

Definition at line 459 of file OMKParametersAccessor.inl.

References OMK::ConfigurationParameterDescriptor::appendSubDescriptor(), and setValue().

  {
    node->appendSubDescriptor( firstNode ) ;
    node->appendSubDescriptor( secondNode ) ;
  }
  else
  {
    errorStr += "\nUnable to set the value of the pair" ;
  }
  return node ;
}
} // namespace OMK

#endif // PSPARAMETERSACCESSOR_INL

template<>

bool OMK::ParametersAccessor::getTxtValue	(	const std::string &	textValue,
		std::string &	value
	)			[inline]

Specialisation for string.

No need to use stream.

Definition at line 19 of file OMKParametersAccessor.inl.

{
  value = textValue;
  return true;
}

template<>

bool OMK::ParametersAccessor::setTxtValue	(	std::string &	textValue,
		const std::string &	value
	)			[inline]

Specialisation for string.

No need to use stream.

Definition at line 30 of file OMKParametersAccessor.inl.

{
  textValue = value ;
  return true ;
}

template<>

bool OMK::ParametersAccessor::getValue	(	const ConfigurationParameterDescriptor *	nodeValue,
		const ConfigurationParameterDescriptor *&	value,
		std::string &	errorStr
	)			[inline]

Specialisation for const node.

Allows to walk through the hierarchy.

Definition at line 41 of file OMKParametersAccessor.inl.

{
  errorStr = "The node is empty" ;
  // Get the value of the node
  value = nodeValue ;
  // if it is not null, return true
  return value != 0 ;
}
//-------------------------------------------------------------------

template<>

bool OMK::ParametersAccessor::getValue	(	const ConfigurationParameterDescriptor *	nodeValue,
		ConfigurationParameterDescriptor *&	value,
		std::string &	errorStr
	)			[inline]

Specialisation for node.

A non const is not possible.

Definition at line 56 of file OMKParametersAccessor.inl.

{
  value = 0 ;
  errorStr = "Unable to get a no-const ConfigurationParameterDescriptor*" ;
  return false ;
}

---