---

IDEA::PslParameter Class Reference
[PlanServer handle classes]

A parameter is an instance of an argument in the context of an instance of a PslToken. More...

#include <PslParameter.hh>

List of all members.

Public Methods
	PslParameter (PslParameterImpl *impl)
	Constructor.
	~PslParameter ()
	Destructor.
bool	finalize () const
	Finalizes the parameter (the current value becomes irreversible). See finalizing.
const PslToken *	getToken () const
	Returns the token of the invoking parameter.
const PslArgument *	getArgument () const
	Returns the PslArgument of the invoking PslParameter is an instance of.
const PslVariable *	getContent () const
	Returns the variable containing all the possible values of the invoking parameter.
const PslVariable *	getObservedValue () const
	Returns the observed, value(s) of the invoking parameter. Only parameters which have the possibility of receiving values from external systems have an observed-value.
void	receivedValue (const std::string &value) const
	Will parse the string value to the type of the invoking parameter and set the value of the invoking parameter to the singleton value. Also will set the corresponding flag of the invoking parameter to true.
void	activateFlagConstraint (int authority) const
void	deActivateFlagConstraint () const
void	reset (const IntVector &authorities) const
	Will de-activate all the constraints associated with the invoking parameter whose authority is in the set authorities. After de-activation the parameter is reset.
void	print (std::ostream &os) const
const PslVariable *	getActualValue () const
Private Attributes
PslParameterImpl *	m_Impl

---

Detailed Description

A parameter is an instance of an argument in the context of an instance of a PslToken.

---

Constructor & Destructor Documentation

IDEA::PslParameter::PslParameter (  PslParameterImpl *    impl )

Constructor.

IDEA::PslParameter::~PslParameter (    )

Destructor.

---

Member Function Documentation

void IDEA::PslParameter::activateFlagConstraint (  int    authority )  const

void IDEA::PslParameter::deActivateFlagConstraint (    )

bool IDEA::PslParameter::finalize (    )

Finalizes the parameter (the current value becomes irreversible). See finalizing.

const PslVariable * IDEA::PslParameter::getActualValue (    )

Deprecated: Actual value term is not self-explanatory, use getObservedValue

const PslArgument * IDEA::PslParameter::getArgument (    )

Returns the PslArgument of the invoking PslParameter is an instance of.

const PslVariable * IDEA::PslParameter::getContent (    )

Returns the variable containing all the possible values of the invoking parameter. Is always a sub-set of the domain of the argument of the invoking parameter. Every parameter has a content-variable.

const PslVariable * IDEA::PslParameter::getObservedValue (    )

Returns the observed, value(s) of the invoking parameter. Only parameters which have the possibility of receiving values from external systems have an observed-value. The value-received-constraint pushes the observed value to the content-value when the token terminates (see PslReturnReceivedConstraint for details).

const PslToken * IDEA::PslParameter::getToken (    )

Returns the token of the invoking parameter.

void IDEA::PslParameter::print (  std::ostream &    os )  const

void IDEA::PslParameter::receivedValue (  const std::string &    value )  const

Will parse the string value to the type of the invoking parameter and set the value of the invoking parameter to the singleton value. Also will set the corresponding flag of the invoking parameter to true. This method will only work for parameter instances of arguments of type return and return-status with corresponding flags.

void IDEA::PslParameter::reset (  const IntVector &    authorities )  const

Will de-activate all the constraints associated with the invoking parameter whose authority is in the set authorities. After de-activation the parameter is reset.

---

Member Data Documentation

PslParameterImpl* IDEA::PslParameter::m_Impl [private]

---

Contact information © IDEA