YMacroPlayer Class Reference

#include <YMacroPlayer.h>

List of all members.

Public Member Functions
	YMacroPlayer (const string &macroFileName)
virtual	~YMacroPlayer ()
bool	error () const
bool	finished ()
YCPValue	evaluateNextBlock ()
void	rewind ()
Protected Member Functions
void	readMacroFile (const string &macroFileName)
void	clearError ()
void	setError ()
Protected Attributes
YBlockPtr	_macro
bool	_error
int	_nextBlockNo

---

Constructor & Destructor Documentation

YMacroPlayer::YMacroPlayer

(

const string &

macroFileName

)

Constructor

YMacroPlayer::~YMacroPlayer

(

)

[virtual]

Destructor

---

Member Function Documentation

bool YMacroPlayer::error

(

)

const [inline]

Report error status

bool YMacroPlayer::finished

(

)

Returns "true" if the execution of the entire macro is finished. Undefined on error, so check for error() first!

YCPValue YMacroPlayer::evaluateNextBlock

(

)

Return the result of the next macro block and increment the internal block counter. Returns YCPNull() on any previous error or if finished. Check for error() or finished() before calling this!

void YMacroPlayer::rewind

(

)

Rewind macro execution - prepare to redo from start

void YMacroPlayer::readMacroFile

(

const string &

macroFileName

)

[protected]

Read and parse a macro file. Sets the internal "error" status.

void YMacroPlayer::clearError

(

)

[inline, protected]

Clear error status

void YMacroPlayer::setError

(

)

[inline, protected]

Set error status

---

Member Data Documentation

YBlockPtr YMacroPlayer::_macro [protected]

The parsed macro

bool YMacroPlayer::_error [protected]

Error status

int YMacroPlayer::_nextBlockNo [protected]

Number of the next macro block to execute

---

The documentation for this class was generated from the following files:

• YMacroPlayer.h
• YMacroPlayer.cc

---