OMK::GenericControlParameter< T, AncestorClass > Class Template Reference

a genric control parameter. More...

#include <OMKGenericControlParameter.h>

Inheritance diagram for OMK::GenericControlParameter< T, AncestorClass >:

[legend]Collaboration diagram for OMK::GenericControlParameter< T, AncestorClass >:

[legend]List of all members.

Public Member Functions
	GenericControlParameter (const Name &attributeName, SimulatedObject &owner, const int historyLength, OMK::Type::PolatorNT *polator)
	Constructor.
virtual	~GenericControlParameter ()
	Destructor.
virtual const T &	get (int &distanceToExactValue, const int precisionLevel, const Date &deltaT, T &calculatedResult) const
	redefined to avoid unecessary warnings because of the partial overide of get
virtual const T &	get () const
	get the last approved value of this control parameter
virtual const T &	getLastExactValue () const
	get the last approved value of this control parameter
virtual const Date &	getDateOfLastExactValue () const
	get the date of the last approved value of this control parameter
virtual void	set (const T &val)
	suggest a new value to this control parameter
virtual void	extract (std::istream &=std::cin)
	extract from an input stream
virtual void	unpack (IncomingSynchronisationMessage &)
	unpack from a message
virtual void	pack (OutgoingSynchronisationMessage &) const
	pack in a message
virtual void	insertInStream (std::ostream &=std::cout) const
	insert in an output stream
virtual void	printDebuggingInformation (std::ostream &err) const
	print any usefull debugging information
virtual bool	connect (const Name &objectName, const Name &inputName)
	connect the control parameter to a public input of another object
virtual bool	connect (SimulatedObject &object, const Name &inputName)
	connect the control parameter to a public input of another object
virtual bool	connect (SimulatedObject *pointerToObject, const Name &inputName)
	connect the control parameter to a public input of another object
Protected Member Functions
virtual void	realSet (const T &val)
	really change the value in the history
Protected Attributes
ChangedControlParameterEventListener< T > *	_associatedEventListener
	the default event listener reacting to changes suggested on that control parameter

---

Detailed Description

template<typename T, class AncestorClass>
class OMK::GenericControlParameter< T, AncestorClass >

a genric control parameter.

A control parameter is, with openMask 3.0 an output that accepts new value from all simulated objects. Therefore, control parameters are implemented has inehriting from outputs and the control parameter interface. As outputs can be redefined for better distribution, a generic control parameter inherits from it's second template parameter, wich should itself inherit from OMKOutput<T>, wher type is the first template parameter

Author:

David Margery

Version:

1.1 (revision

Revision

1.3

)

• 1.0 -> 1.1 by D. Margery (on the 2002/04/05) : set by the owner calls real set
• 1.1 -> 1.2 by D. Margery (on the 2002/06/04) : support for virtual inheritance of OMKKernelAttribute

Definition at line 38 of file OMKGenericControlParameter.h.

---

Constructor & Destructor Documentation

template<typename T, class AncestorClass>

OMK::GenericControlParameter< T, AncestorClass >::GenericControlParameter	(	const Name &	attributeName,
		SimulatedObject &	owner,
		const int	historyLength,
		OMK::Type::PolatorNT *	polator
	)			[inline]

Constructor.

Parameters:

	attributeName	name of this attribute for it's owner
	owner	simulatedObject owning that attribute
	historylength	the length of the stored history of values
	polator	the polator used to produced any needed values

Definition at line 146 of file OMKGenericControlParameter.h.

References OMK::GenericControlParameter< T, AncestorClass >::_associatedEventListener.

  :  KernelAttribute( owner, controlParameterName ),
     AncestorClass( controlParameterName,
                    owner,
                    historyLength,
                    polator ),
     ControlParameter< T >( owner, 
                            controlParameterName,
                            ( "ChangedControlParameter::" +
                              controlParameterName.getString() ) )
{
  _associatedEventListener =
    new ChangedControlParameterEventListener< T >( owner, *this ) ;
}

template<typename T, class AncestorClass>

OMK::GenericControlParameter< T, AncestorClass >::~GenericControlParameter

(

)

[inline, virtual]

Destructor.

Definition at line 168 of file OMKGenericControlParameter.h.

References OMK::GenericControlParameter< T, AncestorClass >::_associatedEventListener.

{
  delete _associatedEventListener ;
}

---

Member Function Documentation

template<typename T, class AncestorClass>

const T & OMK::GenericControlParameter< T, AncestorClass >::get	(	int &	distanceToExactValue,
		const int	precisionLevel,
		const Date &	deltaT,
		T &	calculatedResult
	)			const [virtual]

redefined to avoid unecessary warnings because of the partial overide of get

Definition at line 264 of file OMKGenericControlParameter.h.

{
  return AncestorClass::get( distanceToExactValue, precisionLevel, deltaT,
                             calculatedResult ) ;
}

template<typename T, class AncestorClass>

const T & OMK::GenericControlParameter< T, AncestorClass >::get

(

)

const [inline, virtual]

get the last approved value of this control parameter

Implements OMK::ControlParameter< T >.

Definition at line 277 of file OMKGenericControlParameter.h.

{
  return AncestorClass::getLastExactValue() ;
}

template<typename T, class AncestorClass>

const T & OMK::GenericControlParameter< T, AncestorClass >::getLastExactValue

(

)

const [inline, virtual]

get the last approved value of this control parameter

Implements OMK::ControlParameter< T >.

Definition at line 293 of file OMKGenericControlParameter.h.

{
  return AncestorClass::getLastExactValue() ;
}

template<typename T, class AncestorClass>

const Date & OMK::GenericControlParameter< T, AncestorClass >::getDateOfLastExactValue

(

)

const [inline, virtual]

get the date of the last approved value of this control parameter

Implements OMK::ControlParameter< T >.

Definition at line 285 of file OMKGenericControlParameter.h.

{
  return AncestorClass::getDateOfLastExactValue() ;
}

template<typename T, class AncestorClass>

void OMK::GenericControlParameter< T, AncestorClass >::set

(

const T &

val

)

[inline, virtual]

suggest a new value to this control parameter

Implements OMK::ControlParameter< T >.

Definition at line 176 of file OMKGenericControlParameter.h.

References OMK::KernelAttribute::_owner, OMK::ControlParameter< T >::getAssociatedEventId(), OMK::CurrentActiveObject::getCurrentActiveObject(), OMK::GenericControlParameter< T, AncestorClass >::realSet(), and OMK::SimulatedObject::sendValuedEvent().

{
   SimulatedObject * caller = CurrentActiveObject::getCurrentActiveObject() ;
   if( caller != 0 && caller != &_owner )
   {
     caller->sendValuedEvent( _owner, getAssociatedEventId(), val ) ;
   }
   else
   {
     /* Probably in initialisation phase : suppose the owner is calling set
      * with the initial value.
      * WARNING: this is a security hole because the currentActiveObject can
      * easily be changed.
      */
     realSet( val ) ;
   }
}

template<typename T, class AncestorClass>

void OMK::GenericControlParameter< T, AncestorClass >::extract

(

std::istream &

= std::cin

)

[inline, virtual]

extract from an input stream

Implements OMK::KernelAttribute.

Definition at line 221 of file OMKGenericControlParameter.h.

{
  /* Thread safety assessement : as thread safe as localInsert
   */
  AncestorClass::extract( in ) ;
}

template<typename T, class AncestorClass>

void OMK::GenericControlParameter< T, AncestorClass >::unpack

(

IncomingSynchronisationMessage &

)

[inline, virtual]

unpack from a message

Reimplemented from OMK::Flowable.

Definition at line 243 of file OMKGenericControlParameter.h.

{
  /* Thread safety assessement : as thread safe as localInsert
   */
  AncestorClass::unpack( in ) ;
}

template<typename T, class AncestorClass>

void OMK::GenericControlParameter< T, AncestorClass >::pack

(

OutgoingSynchronisationMessage &

)

const [inline, virtual]

pack in a message

Reimplemented from OMK::Flowable.

Definition at line 232 of file OMKGenericControlParameter.h.

{
  /* Thread safety assessement : as thread safe as localInsert
   */
  AncestorClass::pack( out ) ;
}

template<typename T, class AncestorClass>

void OMK::GenericControlParameter< T, AncestorClass >::insertInStream

(

std::ostream &

= std::cout

)

const [inline, virtual]

insert in an output stream

Implements OMK::KernelAttribute.

Definition at line 210 of file OMKGenericControlParameter.h.

{
  /* Thread safety assessement : as thread safe as localInsert
   */
  AncestorClass::insertInStream( out ) ; 
}

template<typename T, class AncestorClass>

void OMK::GenericControlParameter< T, AncestorClass >::printDebuggingInformation

(

std::ostream &

err

)

const [inline, virtual]

print any usefull debugging information

Implements OMK::KernelAttribute.

Definition at line 254 of file OMKGenericControlParameter.h.

{
  AncestorClass::printDebuggingInformation( err ) ;
  err << " Output is a control parameter " << std::endl ;
}

template<typename T, class AncestorClass>

bool OMK::GenericControlParameter< T, AncestorClass >::connect	(	const Name &	objectName,
		const Name &	inputName
	)			[virtual]

connect the control parameter to a public input of another object

Parameters:

	objectName	the object owning inputName
	inputName	the name of the input to be connected to

Returns:

bool connecting successfull

Implements OMK::ControlParameter< T >.

Definition at line 301 of file OMKGenericControlParameter.h.

{
  return AncestorClass::connect( objectName, inputName ) ;
}

template<typename T, class AncestorClass>

bool OMK::GenericControlParameter< T, AncestorClass >::connect	(	SimulatedObject &	object,
		const Name &	inputName
	)			[virtual]

connect the control parameter to a public input of another object

Parameters:

	objectthe	object owning inputName
	inputName	the name of the input to be connected to

Returns:

bool connecting successfull

Implements OMK::ControlParameter< T >.

Definition at line 310 of file OMKGenericControlParameter.h.

{
  return AncestorClass::connect( object, inputName ) ;
}

template<typename T, class AncestorClass>

bool OMK::GenericControlParameter< T, AncestorClass >::connect	(	SimulatedObject *	pointerToObject,
		const Name &	inputName
	)			[virtual]

connect the control parameter to a public input of another object

Parameters:

	pointerToObject	the object owning inputName
	inputName	the name of the input to be connected to

Returns:

bool connecting successfull

Implements OMK::ControlParameter< T >.

Definition at line 319 of file OMKGenericControlParameter.h.

{
  return AncestorClass::connect( pointerToObject, inputName ) ;
}

template<typename T, class AncestorClass>

void OMK::GenericControlParameter< T, AncestorClass >::realSet

(

const T &

val

)

[inline, protected, virtual]

really change the value in the history

Implements OMK::ControlParameter< T >.

Definition at line 197 of file OMKGenericControlParameter.h.

References OMK::KernelAttribute::_owner, OMK::SimulatedObject::getObjectHandle(), and OMK::ObjectHandle::notifyChangeInControlParameter().

Referenced by OMK::GenericControlParameter< T, AncestorClass >::set().

{
  if( _owner.getObjectHandle() != 0 )
  {//during initialisation phase, objectHandle of the owner can be null
    _owner.getObjectHandle()->notifyChangeInControlParameter( this ) ;
  }
  AncestorClass::set( val ) ;
}

---

Member Data Documentation

template<typename T, class AncestorClass>

ChangedControlParameterEventListener<T>* OMK::GenericControlParameter< T, AncestorClass >::_associatedEventListener [protected]

the default event listener reacting to changes suggested on that control parameter

Definition at line 127 of file OMKGenericControlParameter.h.

Referenced by OMK::GenericControlParameter< T, AncestorClass >::GenericControlParameter(), and OMK::GenericControlParameter< T, AncestorClass >::~GenericControlParameter().

---