---

IDEA::PslTrueFalseVariable Class Reference
[PlanServer handle classes]

A PslTrueFalseVariable is a variable which can be used to flip-flop between states without triggering re-propation. One state of the variable is 'true' and the other state is 'false'. Typically going from one grounded state to another grounded state on a PslVariable can be very speed-inefficient. More...

#include <PslTrueFalseVariable.hh>

List of all members.

Public Methods
	PslTrueFalseVariable (const PslDatabase *database, const std::string &name, bool initialValue=false)
	~PslTrueFalseVariable ()
void	setToTrue () const
	Sets the value of the invoking variable to true.
void	setToFalse () const
	Sets the value of the invoking variable to false.
bool	isTrue () const
	Returns true if the value of the invoking variable is true.
bool	isFalse () const
	Returns true if the value of the invoking variable is false.
const PslVariable *	getVariable () const
	Returns the PslVariable instance used to create the behaviour of the invoking class.
Private Attributes
const PslVariable *	m_Variable

---

Detailed Description

A PslTrueFalseVariable is a variable which can be used to flip-flop between states without triggering re-propation. One state of the variable is 'true' and the other state is 'false'. Typically going from one grounded state to another grounded state on a PslVariable can be very speed-inefficient.

Warning:

Be aware this is not the same as a boolean variable.

---

Constructor & Destructor Documentation

IDEA::PslTrueFalseVariable::PslTrueFalseVariable (  const PslDatabase *    database, const std::string &    name, bool    initialValue = false )

IDEA::PslTrueFalseVariable::~PslTrueFalseVariable (    )

---

Member Function Documentation

const PslVariable * IDEA::PslTrueFalseVariable::getVariable (    )

Returns the PslVariable instance used to create the behaviour of the invoking class.

bool IDEA::PslTrueFalseVariable::isFalse (    )

Returns true if the value of the invoking variable is false.

bool IDEA::PslTrueFalseVariable::isTrue (    )

Returns true if the value of the invoking variable is true.

void IDEA::PslTrueFalseVariable::setToFalse (    )

Sets the value of the invoking variable to false.

void IDEA::PslTrueFalseVariable::setToTrue (    )

Sets the value of the invoking variable to true.

---

Member Data Documentation

const PslVariable* IDEA::PslTrueFalseVariable::m_Variable [private]

---

Contact information © IDEA