---

IDEA::PslConstraintImpl Class Reference
[PlanServer implementation base classes]

See PslConstraint for API documentation. More...

#include <PslConstraintImpl.hh>

Inheritance diagram for IDEA::PslConstraintImpl:

List of all members.

Public Methods
virtual	~PslConstraintImpl ()
	Destructor.
const std::string &	getName () const
virtual int	getId () const=0
	Returns a unique identifier of the constraint.
virtual bool	isActive () const=0
	Returns true if the invoking instance is active, eq. is maintained to be true by the underlying plan-database. Otherwise returns false.
void	activate (int authority=-1)
	Activates the invoking constraint if not yet activated. An activated constraint need to be maintained to be true by the underlying plan-database.
virtual void	deActivate () const=0
	De-activates the invoking constraint if activated. Once an activated constraint is de-activated the underlying plan-database is no longer required to maintain it to be true.
virtual void	execute ()=0
	Should implement the invariant maintained by the invoking constraint.
int	getAuthority () const
	Returns the authority of the invoking constraint.
virtual void	print (std::ostream &os)
	Streams information of the invoking instance to os.
Protected Methods
	PslConstraintImpl (int authority, const std::string &name)
	Constructor.
void	setAuthority (int authority)
virtual void	activateExtended (int authority=-1) const=0
Private Methods
	PslConstraintImpl ()
	Default constructor, not implemented by design.
Private Attributes
int	m_Authority
std::string	m_Name

---

Detailed Description

See PslConstraint for API documentation.

class PslConstraintImpl

---

Constructor & Destructor Documentation

IDEA::PslConstraintImpl::~PslConstraintImpl (    )  [virtual]

Destructor.

IDEA::PslConstraintImpl::PslConstraintImpl (  int    authority, const std::string &    name )  [protected]

Constructor.

IDEA::PslConstraintImpl::PslConstraintImpl (    )  [private]

Default constructor, not implemented by design.

---

Member Function Documentation

void IDEA::PslConstraintImpl::activate (  int    authority = -1 )

Activates the invoking constraint if not yet activated. An activated constraint need to be maintained to be true by the underlying plan-database.

virtual void IDEA::PslConstraintImpl::activateExtended (  int    authority = -1 )  const [protected, pure virtual]

Implemented in IDEA::PlasmaConstraintImpl, IDEA::PlasmaReturnFlagReceivedConstraintImpl, IDEA::PlasmaObservedConstraintImpl, and IDEA::PlasmaTimeConstraintImpl.

virtual void IDEA::PslConstraintImpl::deActivate (    )  [pure virtual]

De-activates the invoking constraint if activated. Once an activated constraint is de-activated the underlying plan-database is no longer required to maintain it to be true. Note: No re-propagation from it's original state is triggered. Implemented in IDEA::PlasmaConstraintImpl, IDEA::PlasmaReturnFlagReceivedConstraintImpl, IDEA::PlasmaObservedConstraintImpl, and IDEA::PlasmaTimeConstraintImpl.

virtual void IDEA::PslConstraintImpl::execute (    )  [pure virtual]

Should implement the invariant maintained by the invoking constraint. Implemented in IDEA::PslObservedConstraintImpl, IDEA::PslReturnReceivedConstraintImpl, IDEA::PslTimeConstraintImpl, and IDEA::PlasmaConstraintImpl.

int IDEA::PslConstraintImpl::getAuthority (    )

Returns the authority of the invoking constraint. The authority of the constraint is equal to the authority of the last invocation of activate or construction if activate has not been invoked explicitly.

virtual int IDEA::PslConstraintImpl::getId (    )  [pure virtual]

Returns a unique identifier of the constraint. Implemented in IDEA::PlasmaConstraintImpl, IDEA::PlasmaReturnFlagReceivedConstraintImpl, IDEA::PlasmaObservedConstraintImpl, and IDEA::PlasmaTimeConstraintImpl.

const std::string & IDEA::PslConstraintImpl::getName (    )

virtual bool IDEA::PslConstraintImpl::isActive (    )  [pure virtual]

Returns true if the invoking instance is active, eq. is maintained to be true by the underlying plan-database. Otherwise returns false. Implemented in IDEA::PlasmaConstraintImpl, IDEA::PlasmaReturnFlagReceivedConstraintImpl, IDEA::PlasmaObservedConstraintImpl, and IDEA::PlasmaTimeConstraintImpl.

void IDEA::PslConstraintImpl::print (  std::ostream &    os )  [virtual]

Streams information of the invoking instance to os. Reimplemented in IDEA::PslObservedConstraintImpl, IDEA::PslReturnReceivedConstraintImpl, and IDEA::PslTimeConstraintImpl.

void IDEA::PslConstraintImpl::setAuthority (  int    authority )  [protected]

---

Member Data Documentation

int IDEA::PslConstraintImpl::m_Authority [private]

std::string IDEA::PslConstraintImpl::m_Name [private]

---

Contact information © IDEA