---

IDEA::PslAttribute Class Reference
[PlanServer handle classes]

Abstraction representing one attribute (timeline) in the domain model. See XIDDL Objects. More...

#include <PslAttribute.hh>

List of all members.

Public Methods
	~PslAttribute ()
	Destructor.
PslAttributeImpl *	getImpl () const
	Returns the implementation of the invoking class.
const std::string &	getName () const
	Returns the name as a reference to a const string.
const PslPredicate *	createPredicate (const std::string &name) const
	Creates a PslPredicate by the name name associated to the invoking class. If a predicate by the name name already exists nothing will be created and the pre-existing predicate instance will be returned. See predicate.
const PslPredicate *	getPredicate (const std::string &name) const
	Returns an instance of PslPredicate by the name name if such exists otherwise returns 0.
const String2PslPredicateMap &	getPredicates () const
	Returns all the PslPredicate instances associated with the invoking class.
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) const
	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) const
	Sets the target-location for messages to be send out for tokens on instances of this attribute.
void	setAsDefaultExecutable () const
	Sets the default type for PslTimeline instances derived from this attribute to be executable.
void	setAsDefaultGoal () const
	Sets the default type for PslTimeline instances derived from this attribute to be goal.
bool	isDefaultExecutable () const
	Returns true if the default type PslTimeline instances derived of the invoking attribute is executable. Otherwise returns false.
bool	isDefaultGoal () const
	Returns true if the default type PslTimeline instances derived of the invoking attribute is goal. Otherwise returns false.
void	print (std::ostream &os) const
	Prints information of the invoking class to os.
Private Methods
	PslAttribute (PslAttributeImpl *impl)
	Constructor.
	PslAttribute ()
	Default constructor, not implemented by design.
	PslAttribute (const PslAttribute &)
	Copy constructor, not implemented by design.
PslAttribute &	operator= (const PslAttribute &)
	Assignment operator, not implemented by design.
Private Attributes
PslAttributeImpl *	m_Impl
Friends
class	PslObjectClassImpl

---

Detailed Description

Abstraction representing one attribute (timeline) in the domain model. See XIDDL Objects.

class PslAttribute

---

Constructor & Destructor Documentation

IDEA::PslAttribute::~PslAttribute (    )

Destructor.

IDEA::PslAttribute::PslAttribute (  PslAttributeImpl *    impl )  [private]

Constructor.

IDEA::PslAttribute::PslAttribute (    )  [private]

Default constructor, not implemented by design.

IDEA::PslAttribute::PslAttribute (  const PslAttribute &    )  [private]

Copy constructor, not implemented by design.

---

Member Function Documentation

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

Creates a PslPredicate by the name name associated to the invoking class. If a predicate by the name name already exists nothing will be created and the pre-existing predicate instance will be returned. See predicate.

const std::string & IDEA::PslAttribute::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.

PslAttributeImpl * IDEA::PslAttribute::getImpl (    )

Returns the implementation of the invoking class.

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

Returns the name as a reference to a const string.

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

Returns an instance of PslPredicate by the name name if such exists otherwise returns 0.

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

Returns all the PslPredicate instances associated with the invoking class.

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

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

bool IDEA::PslAttribute::isDefaultExecutable (    )

Returns true if the default type PslTimeline instances derived of the invoking attribute is executable. Otherwise returns false.

bool IDEA::PslAttribute::isDefaultGoal (    )

Returns true if the default type PslTimeline instances derived of the invoking attribute is goal. Otherwise returns false.

PslAttribute& IDEA::PslAttribute::operator= (  const PslAttribute &    )  [private]

Assignment operator, not implemented by design.

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

Prints information of the invoking class to os.

void IDEA::PslAttribute::setAsDefaultExecutable (    )

Sets the default type for PslTimeline instances derived from this attribute to be executable.

void IDEA::PslAttribute::setAsDefaultGoal (    )

Sets the default type for PslTimeline instances derived from this attribute to be goal.

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

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::PslAttribute::setTargetLocation (  const TokenLocation &    target )  const

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

---

Friends And Related Function Documentation

friend class PslObjectClassImpl [friend]

---

Member Data Documentation

PslAttributeImpl* IDEA::PslAttribute::m_Impl [private]

---

Contact information © IDEA