---

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

See PslAttribute for API documentation. More...

#include <PslAttributeImpl.hh>

Inheritance diagram for IDEA::PslAttributeImpl:

List of all members.

Public Methods
	PslAttributeImpl (const std::string &name)
	Constructor.
virtual	~PslAttributeImpl ()
	Destructor.
const std::string &	getName () const
	Returns the name of the invoking attribute.
const PslPredicate *	createPredicate (const PslAttribute *attr, const std::string &name)
	Creates a predicate instance by the name for the invoking attribute.
const PslPredicate *	getPredicate (const std::string &name) const
	Returns the predicate instance by the name name if it exists otherwise returns 0.
const String2PslPredicateMap &	getPredicates () const
	Returns a map of predicates which are possible on the invoking attribute.
const std::string &	getComRelayName () const
	Returns the name (key) of the ComRelay instance to be used when sending out messages on instances of the invoking class.
void	setComRelayName (const std::string &name)
	Sets the name (key) of the ComRelay instance to be used when sending out messages on instances of the invoking class to name.
const TokenLocation &	getTargetLocation () const
	Returns the target-location for messages to be send out for tokens on instances of this attribute.
void	setTargetLocation (const TokenLocation &target)
	Sets the target-location for messages to be send out for tokens on instances of this attribute.
void	print (std::ostream &os) const
	Prints information of the invoking class to os.
void	setAsDefaultExecutable ()
void	setAsDefaultGoal ()
bool	isDefaultExecutable () const
bool	isDefaultGoal () const
Private Types
enum	Type { GOAL = 0, EXECUTABLE, INTERMEDIATE }
Private Attributes
std::string	m_Name
std::string	m_ComRelayName
TokenLocation	m_TargetLocation
Type	m_DefaultType
String2PslPredicateMap	m_Predicates

---

Detailed Description

See PslAttribute for API documentation.

class PslAttributeImpl

---

Member Enumeration Documentation

enum IDEA::PslAttributeImpl::Type [private]

Enumeration values: GOAL  EXECUTABLE  INTERMEDIATE

---

Constructor & Destructor Documentation

IDEA::PslAttributeImpl::PslAttributeImpl (  const std::string &    name )

Constructor.

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

Destructor.

---

Member Function Documentation

const PslPredicate * IDEA::PslAttributeImpl::createPredicate (  const PslAttribute *    attr, const std::string &    name )

Creates a predicate instance by the name for the invoking attribute.

const std::string & IDEA::PslAttributeImpl::getComRelayName (    )

Returns the name (key) of the ComRelay instance to be used when sending out messages on instances of the invoking class. By default this value is UNKNOWN and can only be set by invoking PslAttribute::setComRelayName.

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

Returns the name of the invoking attribute.

const PslPredicate * IDEA::PslAttributeImpl::getPredicate (  const std::string &    name )  const

Returns the predicate instance by the name name if it exists otherwise returns 0.

const String2PslPredicateMap & IDEA::PslAttributeImpl::getPredicates (    )

Returns a map of predicates which are possible on the invoking attribute.

const TokenLocation & IDEA::PslAttributeImpl::getTargetLocation (    )

Returns the target-location for messages to be send out for tokens on instances of this attribute.

bool IDEA::PslAttributeImpl::isDefaultExecutable (    )

bool IDEA::PslAttributeImpl::isDefaultGoal (    )

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

Prints information of the invoking class to os.

void IDEA::PslAttributeImpl::setAsDefaultExecutable (    )

void IDEA::PslAttributeImpl::setAsDefaultGoal (    )

void IDEA::PslAttributeImpl::setComRelayName (  const std::string &    name )

Sets the name (key) of the ComRelay instance to be used when sending out messages on instances of the invoking class to name.

void IDEA::PslAttributeImpl::setTargetLocation (  const TokenLocation &    target )

Sets the target-location for messages to be send out for tokens on instances of this attribute.

---

Member Data Documentation

std::string IDEA::PslAttributeImpl::m_ComRelayName [private]

Type IDEA::PslAttributeImpl::m_DefaultType [private]

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

String2PslPredicateMap IDEA::PslAttributeImpl::m_Predicates [private]

TokenLocation IDEA::PslAttributeImpl::m_TargetLocation [private]

---

Contact information © IDEA