---

IDEA::PslTimeline Class Reference
[PlanServer handle classes]

PslTimeline is an instance of PslAttribute associated with a PslObject an instance of PslObjectClass. More...

#include <PslTimeline.hh>

List of all members.

Public Methods
	~PslTimeline ()
const PslTimelineImpl *	getImpl () const
const std::string &	getComRelayName () const
	Returns what ComRelay to use to send messages out for this instance.
const std::string &	getName () const
	Returns the name of the invoking timeline.
const TokenLocation &	getTargetLocation () const
	Returns the target-location for messages to be send out for tokens on this timeline.
const Time &	getTargetLatency () const
	Returns the target location latency.
const PslDatabase *	getDatabase () const
	Returns the database the invoking timeline is part of.
const PslAttribute *	getAttribute () const
	Returns the attribute the invoking instance has been created for.
const PslObject *	getObject () const
	Returns the object the invoking instance has been created for.
PslTokenList	getTokens () const
	Returns all the PslToken instances which are allocated to the invoking timeline.
const PslToken *	getNextToken (const PslToken *token) const
	Returns the next token of token on the invoking timeline. Returns 0 if no such token exists or if token is not on the timeline.
const PslToken *	getPreviousToken (const PslToken *token) const
	Returns the previous token of token on the invoking timeline. Returns 0 if no such token exists or if token is not on the timeline.
const PslToken *	getToken (const Time &time) const
	Returns the token which is executing at time time. If no such token exists it will return 0. See executing token.
bool	isGoal () const
	Returns true if the invoking timeline is a goal timeline. Otherwise returns false.
bool	isExecutable () const
	Returns true if the invoking timeline is an executable timeline. Otherwise returns false.
void	setAsExecutable () const
	Sets the invoking timeline as an executable timeline.
void	setAsGoal () const
	Sets the invoking timeline as a goal timeline.
void	setComRelayName (const std::string &name) const
	Sets the comrelay key to use for this timeline to name. See Goal Timelines and AgentRelay::registerComRelay.
void	setTargetLocation (const TokenLocation &tokenLocation) const
	Sets the target for start messages of tokens on this timeline.
void	setTargetLatency (const Time &t) const
	Sets the target for start messages of tokens on this timeline.
void	print (std::ostream &os) const
Private Methods
	PslTimeline (PslTimelineImpl *impl)
	Constructor, creates an instance of PslTimeline for PslAttribute attribute.
	PslTimeline ()
	Default constructor, not implemented by design.
	PslTimeline (const PslTimeline &)
	Copy constructor, not implemented by design.
PslTimeline &	operator= (const PslTimeline &)
	Assignment operator, not implemented by design.
Private Attributes
PslTimelineImpl *	m_Impl
Friends
class	PslObjectImpl

---

Detailed Description

PslTimeline is an instance of PslAttribute associated with a PslObject an instance of PslObjectClass.

---

Constructor & Destructor Documentation

IDEA::PslTimeline::~PslTimeline (    )

IDEA::PslTimeline::PslTimeline (  PslTimelineImpl *    impl )  [private]

Constructor, creates an instance of PslTimeline for PslAttribute attribute.

IDEA::PslTimeline::PslTimeline (    )  [private]

Default constructor, not implemented by design.

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

Copy constructor, not implemented by design.

---

Member Function Documentation

const PslAttribute * IDEA::PslTimeline::getAttribute (    )

Returns the attribute the invoking instance has been created for.

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

Returns what ComRelay to use to send messages out for this instance. Returns an empty string if the commmunication-relay-name hasn't been set.

const PslDatabase * IDEA::PslTimeline::getDatabase (    )

Returns the database the invoking timeline is part of.

const PslTimelineImpl * IDEA::PslTimeline::getImpl (    )

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

Returns the name of the invoking timeline.

const PslToken * IDEA::PslTimeline::getNextToken (  const PslToken *    token )  const

Returns the next token of token on the invoking timeline. Returns 0 if no such token exists or if token is not on the timeline.

const PslObject * IDEA::PslTimeline::getObject (    )

Returns the object the invoking instance has been created for.

const PslToken * IDEA::PslTimeline::getPreviousToken (  const PslToken *    token )  const

Returns the previous token of token on the invoking timeline. Returns 0 if no such token exists or if token is not on the timeline.

const Time & IDEA::PslTimeline::getTargetLatency (    )

Returns the target location latency.

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

Returns the target-location for messages to be send out for tokens on this timeline.

const PslToken * IDEA::PslTimeline::getToken (  const Time &    time )  const

Returns the token which is executing at time time. If no such token exists it will return 0. See executing token.

PslTokenList IDEA::PslTimeline::getTokens (    )

Returns all the PslToken instances which are allocated to the invoking timeline.

bool IDEA::PslTimeline::isExecutable (    )

Returns true if the invoking timeline is an executable timeline. Otherwise returns false.

bool IDEA::PslTimeline::isGoal (    )

Returns true if the invoking timeline is a goal timeline. Otherwise returns false.

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

Assignment operator, not implemented by design.

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

void IDEA::PslTimeline::setAsExecutable (    )

Sets the invoking timeline as an executable timeline.

void IDEA::PslTimeline::setAsGoal (    )

Sets the invoking timeline as a goal timeline.

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

Sets the comrelay key to use for this timeline to name. See Goal Timelines and AgentRelay::registerComRelay.

void IDEA::PslTimeline::setTargetLatency (  const Time &    t )  const

Sets the target for start messages of tokens on this timeline. Deprecated: Has no semantic meaning anymore

void IDEA::PslTimeline::setTargetLocation (  const TokenLocation &    tokenLocation )  const

Sets the target for start messages of tokens on this timeline.

---

Friends And Related Function Documentation

friend class PslObjectImpl [friend]

---

Member Data Documentation

PslTimelineImpl* IDEA::PslTimeline::m_Impl [private]

---

Contact information © IDEA