---

PsControlParameter< Type > Class Template Reference

a typed control parameter More...

#include <PsControlParameter.h>

Inheritance diagram for PsControlParameter< Type >:

[legend]Collaboration diagram for PsControlParameter< Type >:

[legend]List of all members.

Public Methods
	PsControlParameter (PsSimulatedObject &owner, const PsName &attributeName, const PsEventIdentifier &eventId)
	contructor, with the associated envent Id
const PsEventIdentifier &	getAssociatedEventId () const
	get the event id of the sent event when a change occurs on the connected output
virtual const Type &	getLastExactValue (void) const=0
	get the last approved value of this control parameter
virtual const PsDate &	getDateOfLastExactValue (void) const=0
	get the last approved value of this control parameter
virtual void	set (const Type &val)=0
	suggest a new value to this control parameter
virtual const Type &	get () const=0
	read the last available value if the control parameter
virtual bool	connect (const PsName &objectName, const PsName &inputName)=0
	connect the control parameter to a public input of another object
virtual bool	connect (PsSimulatedObject &object, const PsName &inputName)=0
	connect the control parameter to a public input of another object
virtual bool	connect (PsSimulatedObject *pointerToObject, const PsName &inputName)=0
	connect the control parameter to a public input of another object
Protected Methods
virtual void	realSet (const Type &val)=0
	really change the value in the history
Protected Attributes
PsEventIdentifier	_associatedEventId
	event id of the sent event when a change occurs on the control parameter
Friends
class	PsChangedControlParameterEventListener< Type >

---

Detailed Description

template<typename Type>
class PsControlParameter< Type >

a typed control parameter

this class is "template " where type must derive from PsType

Author:

Thierry Duval

Version:

3.1 (revision $revision$

• 2.0 -> 3.0 by David Margery: made an abstract class out of PsControlParameter, and implemented it in PsGenericControlParameter
• 3.0 -> 3.1 by David Margery: virtual inheritance of PsAttribute

Definition at line 44 of file PsControlParameter.h.

---

Constructor & Destructor Documentation

template<typename Type> PsControlParameter< Type >::PsControlParameter (  PsSimulatedObject &    owner, const PsName &    attributeName, const PsEventIdentifier &    eventId )  [inline]

contructor, with the associated envent Id Definition at line 48 of file PsControlParameter.h. 00049 : 00050 PsAttribute (owner, attributeName), 00051 _associatedEventId (eventId) 00052 { 00053 //cerr<<"PsControlParameter: "<<_associatedEventId<<endl; }

---

Member Function Documentation

template<typename Type> virtual bool PsControlParameter< Type >::connect (  PsSimulatedObject *    pointerToObject, const PsName &    inputName )  [pure 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 Implemented in PsGenericControlParameter< Type, AncestorClass >.

template<typename Type> virtual bool PsControlParameter< Type >::connect (  PsSimulatedObject &    object, const PsName &    inputName )  [pure 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 Implemented in PsGenericControlParameter< Type, AncestorClass >.

template<typename Type> virtual bool PsControlParameter< Type >::connect (  const PsName &    objectName, const PsName &    inputName )  [pure 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 Implemented in PsGenericControlParameter< Type, AncestorClass >.

template<typename Type> virtual const Type& PsControlParameter< Type >::get (    )  const [pure virtual]

read the last available value if the control parameter Implemented in PsGenericControlParameter< Type, AncestorClass >.

template<typename Type> const PsEventIdentifier& PsControlParameter< Type >::getAssociatedEventId (    )  const [inline]

get the event id of the sent event when a change occurs on the connected output Definition at line 56 of file PsControlParameter.h. Referenced by PsGenericControlParameter< Type, AncestorClass >::set(). { return _associatedEventId ;

template<typename Type> virtual const PsDate& PsControlParameter< Type >::getDateOfLastExactValue (  void    )  const [pure virtual]

get the last approved value of this control parameter Implemented in PsGenericControlParameter< Type, AncestorClass >.

template<typename Type> virtual const Type& PsControlParameter< Type >::getLastExactValue (  void    )  const [pure virtual]

get the last approved value of this control parameter Implemented in PsGenericControlParameter< Type, AncestorClass >.

template<typename Type> virtual void PsControlParameter< Type >::realSet (  const Type &    val )  [protected, pure virtual]

really change the value in the history Implemented in PsGenericControlParameter< Type, AncestorClass >.

template<typename Type> virtual void PsControlParameter< Type >::set (  const Type &    val )  [pure virtual]

suggest a new value to this control parameter Implemented in PsControlParameterDuplique< Type >, and PsGenericControlParameter< Type, AncestorClass >. Referenced by PsControlParameterDuplique< Type >::computeNewValue(), and PsControlParameterDuplique< Type >::set().

---

Friends And Related Function Documentation

template<typename Type> friend class PsChangedControlParameterEventListener< Type > [friend]

Definition at line 102 of file PsControlParameter.h.

---

Member Data Documentation

template<typename Type> PsEventIdentifier PsControlParameter< Type >::_associatedEventId [protected]

event id of the sent event when a change occurs on the control parameter Definition at line 109 of file PsControlParameter.h.

---

The documentation for this class was generated from the following file:

• PsControlParameter.h

---