Kodu::KoduPage Class Reference

Kodu Page. More...

#include <KoduPage.h>

---

Detailed Description

Kodu Page.

Definition at line 15 of file KoduPage.h.

List of all members.

Public Member Functions
	KoduPage (unsigned int kPageNumber)
	Constructor.
	~KoduPage ()
	Destructor.
void	addKoduRule (KoduRule *)
	Adds a Kodu rule to the end of the collection.
unsigned int	getPageNumber () const
	Get the page number.
KoduRule *	getRule (unsigned int number)
	Returns a rule with a specified ID (number).
KoduRule *	getRuleInPos (unsigned int pos)
	Returns a rule in a specified position of the vector.
unsigned int	getRuleCount () const
	Returns the size of the rules vector.
void	setPageRequiresVision (bool)
bool	requiresVision () const
	Checks if a page requires vision (the use of the robot's camera to perform a task).
Private Member Functions
	DISALLOW_COPY_ASSIGN (KoduPage)
	Disallow the copy constructor and assignment operator.
Private Attributes
unsigned int	pageNumber
	Page number.
std::vector< KoduRule * >	rules
	Collection of rules for a page.
bool	pageRequiresVision

---

Constructor & Destructor Documentation

Kodu::KoduPage::KoduPage

(

unsigned int

kPageNumber

)

[explicit]

Constructor.

Definition at line 18 of file KoduPage.h.

Kodu::KoduPage::~KoduPage

(

)

Destructor.

Definition at line 26 of file KoduPage.h.

---

Member Function Documentation

void Kodu::KoduPage::addKoduRule

(

KoduRule *

newRule

)

Adds a Kodu rule to the end of the collection.

Definition at line 4 of file KoduPage.cc.

Referenced by Kodu::Parser::KodeCreator::createKode().

Kodu::KoduPage::DISALLOW_COPY_ASSIGN

(

KoduPage

)

[private]

Disallow the copy constructor and assignment operator.

unsigned int Kodu::KoduPage::getPageNumber

(

)

const

Get the page number.

Definition at line 10 of file KoduPage.cc.

Referenced by KoduInterpreter::KoduConditionEvaluator::doStart().

KoduRule * Kodu::KoduPage::getRule

(

unsigned int

number

)

Returns a rule with a specified ID (number).

Definition at line 14 of file KoduPage.cc.

Referenced by KoduInterpreter::KoduConditionEvaluator::doStart().

unsigned int Kodu::KoduPage::getRuleCount

(

)

const

Returns the size of the rules vector.

Definition at line 18 of file KoduPage.cc.

Referenced by KoduInterpreter::PageSwitchActionRunner::SwitchToNewPage::doStart(), KoduInterpreter::KoduConditionEvaluator::doStart(), and getRuleInPos().

KoduRule * Kodu::KoduPage::getRuleInPos

(

unsigned int

pos

)

Returns a rule in a specified position of the vector.

Definition at line 22 of file KoduPage.cc.

Referenced by KoduInterpreter::PageSwitchActionRunner::SwitchToNewPage::doStart(), KoduInterpreter::KoduConditionEvaluator::doStart(), and getRule().

bool Kodu::KoduPage::requiresVision

(

)

const

Checks if a page requires vision (the use of the robot's camera to perform a task).

Definition at line 41 of file KoduPage.cc.

void Kodu::KoduPage::setPageRequiresVision

(

bool

bval

)

Definition at line 37 of file KoduPage.cc.

Referenced by Kodu::Parser::KodeCreator::createKode().

---

Member Data Documentation

unsigned int Kodu::KoduPage::pageNumber [private]

Page number.

Definition at line 58 of file KoduPage.h.

Referenced by getPageNumber().

bool Kodu::KoduPage::pageRequiresVision [private]

Definition at line 61 of file KoduPage.h.

Referenced by requiresVision(), and setPageRequiresVision().

std::vector<KoduRule*> Kodu::KoduPage::rules [private]

Collection of rules for a page.

Definition at line 59 of file KoduPage.h.

Referenced by addKoduRule(), getRuleCount(), getRuleInPos(), and ~KoduPage().

---

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

• KoduPage.h
• KoduPage.cc