---

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

See PslTimeline for API documentation. More...

#include <PslTimelineImpl.hh>

Inheritance diagram for IDEA::PslTimelineImpl:

List of all members.

Public Methods
virtual	~PslTimelineImpl ()
const PslDatabase *	getDatabase () const
const std::string &	getName () const
virtual const PslToken *	getNextToken (const PslToken *token) const=0
virtual const PslToken *	getPreviousToken (const PslToken *token) const=0
const PslToken *	getToken (const Time &time)
const PslTokenList &	getTokens ()
const std::string &	getComRelayName () const
	Returns what ComRelay to use to send messages out for this instance.
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 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.
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 ()
void	setAsGoal ()
void	setComRelayName (const std::string &name)
void	setTargetLocation (const TokenLocation &tokenLocation)
void	setTargetLatency (const Time &t)
void	print (std::ostream &os)
Protected Methods
	PslTimelineImpl (const PslDatabase *database, const PslObject *object, const PslAttribute *attribute)
Protected Attributes
PslTokenList	m_TokenList
Private Types
enum	Type { GOAL = 0, EXECUTABLE, INTERMEDIATE }
Private Methods
virtual bool	updateTokenList ()=0
	Updates the m_TokenList.
Private Attributes
std::string	m_ComRelayName
TokenLocation	m_TargetLocation
Time	m_TargetLatency
Type	m_Type
const PslDatabase *	m_Database
const PslAttribute *	m_Attribute
const PslObject *	m_Object

---

Detailed Description

See PslTimeline for API documentation.

class PslTimelineImpl

---

Member Enumeration Documentation

enum IDEA::PslTimelineImpl::Type [private]

Enumeration values: GOAL  EXECUTABLE  INTERMEDIATE

---

Constructor & Destructor Documentation

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

IDEA::PslTimelineImpl::PslTimelineImpl (  const PslDatabase *    database, const PslObject *    object, const PslAttribute *    attribute )  [protected]

---

Member Function Documentation

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

Returns the attribute the invoking instance has been created for.

const std::string & IDEA::PslTimelineImpl::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::PslTimelineImpl::getDatabase (    )

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

virtual const PslToken* IDEA::PslTimelineImpl::getNextToken (  const PslToken *    token )  const [pure virtual]

Implemented in IDEA::PlasmaTimelineImpl.

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

Returns the object the invoking instance has been created for.

virtual const PslToken* IDEA::PslTimelineImpl::getPreviousToken (  const PslToken *    token )  const [pure virtual]

Implemented in IDEA::PlasmaTimelineImpl.

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

Returns the target location latency.

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

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

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

const PslTokenList & IDEA::PslTimelineImpl::getTokens (    )

bool IDEA::PslTimelineImpl::isExecutable (    )

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

bool IDEA::PslTimelineImpl::isGoal (    )

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

void IDEA::PslTimelineImpl::print (  std::ostream &    os )

void IDEA::PslTimelineImpl::setAsExecutable (    )

void IDEA::PslTimelineImpl::setAsGoal (    )

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

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

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

virtual bool IDEA::PslTimelineImpl::updateTokenList (    )  [private, pure virtual]

Updates the m_TokenList. Implemented in IDEA::PlasmaTimelineImpl.

---

Member Data Documentation

const PslAttribute* IDEA::PslTimelineImpl::m_Attribute [private]

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

const PslDatabase* IDEA::PslTimelineImpl::m_Database [private]

const PslObject* IDEA::PslTimelineImpl::m_Object [private]

Time IDEA::PslTimelineImpl::m_TargetLatency [private]

TokenLocation IDEA::PslTimelineImpl::m_TargetLocation [private]

PslTokenList IDEA::PslTimelineImpl::m_TokenList [protected]

Type IDEA::PslTimelineImpl::m_Type [private]

---

Contact information © IDEA