Kodu::KoduObject Class Reference

Kodu Object class. More...

#include <KoduObject.h>

---

Detailed Description

Kodu Object class.

Definition at line 16 of file KoduObject.h.

List of all members.

Public Member Functions
	KoduObject (const std::string &kColor, const std::string &kType, SearchLocation_t locationsToSearch, bool canBeLandmark)
	Constructor.
	KoduObject (const KoduObject &kObject)
	Copy constructor.
	~KoduObject ()
	Destructor.
KoduObject &	operator= (const KoduObject &kObject)
	Assignment operator.
const std::string &	getColor () const
	Returns the object's color.
const std::string &	getType () const
	Returns the object's type.
bool	isLandmark () const
	Returns true if an object is a landmark or not.
bool	isMovable () const
	Returns true if an object is movable.
bool	hasMobility () const
	Returns true if an object can move throughout the environment (autonomously).
bool	foundValidMatch () const
	Returns true if the agent found an object that met the search criteria (color, type, etc).
const DualCoding::ShapeRoot &	getObject () const
	Returns the object that matches the description.
const DualCoding::Shape < DualCoding::AprilTagData > &	getObjectIdentifier () const
	Returns the matching object's april tag.
void	setObject (const DualCoding::ShapeRoot &)
	Stores the object that matches the search criteria.
void	setObjectIdentifier (const DualCoding::Shape< DualCoding::AprilTagData > &)
	Stores the object's identifier.
Public Attributes
DualCoding::ShapeRoot	matchingObject
	the object that matches search criteria
DualCoding::Shape < DualCoding::AprilTagData >	matchingObjTag
Protected Attributes
std::string	color
	the object's color
std::string	type
	the object's type (e.g. tree, rock, apple)
SearchLocation_t	searchLocations
	the locations the perceiver should search for an object
bool	objectIsLandmark
	can "this" object be used as a landmark

---

Constructor & Destructor Documentation

Kodu::KoduObject::KoduObject	(	const std::string &	kColor,
		const std::string &	kType,
		SearchLocation_t	locationsToSearch,
		bool	canBeLandmark
	)

Constructor.

Definition at line 6 of file KoduObject.cc.

Kodu::KoduObject::KoduObject

(

const KoduObject &

kObject

)

Copy constructor.

Definition at line 17 of file KoduObject.cc.

Kodu::KoduObject::~KoduObject

(

)

Destructor.

Definition at line 27 of file KoduObject.cc.

---

Member Function Documentation

bool Kodu::KoduObject::foundValidMatch

(

)

const

Returns true if the agent found an object that met the search criteria (color, type, etc).

Definition at line 62 of file KoduObject.cc.

const std::string & Kodu::KoduObject::getColor

(

)

const

Returns the object's color.

Definition at line 44 of file KoduObject.cc.

const DualCoding::ShapeRoot & Kodu::KoduObject::getObject

(

)

const

Returns the object that matches the description.

Definition at line 66 of file KoduObject.cc.

const DualCoding::Shape< DualCoding::AprilTagData > & Kodu::KoduObject::getObjectIdentifier

(

)

const

Returns the matching object's april tag.

Definition at line 70 of file KoduObject.cc.

const std::string & Kodu::KoduObject::getType

(

)

const

Returns the object's type.

Definition at line 48 of file KoduObject.cc.

bool Kodu::KoduObject::hasMobility

(

)

const

Returns true if an object can move throughout the environment (autonomously).

bool Kodu::KoduObject::isLandmark

(

)

const

Returns true if an object is a landmark or not.

Definition at line 52 of file KoduObject.cc.

bool Kodu::KoduObject::isMovable

(

)

const

Returns true if an object is movable.

Definition at line 56 of file KoduObject.cc.

KoduObject & Kodu::KoduObject::operator=

(

const KoduObject &

kObject

)

Assignment operator.

Definition at line 32 of file KoduObject.cc.

void Kodu::KoduObject::setObject

(

const DualCoding::ShapeRoot &

kShape

)

Stores the object that matches the search criteria.

Definition at line 74 of file KoduObject.cc.

void Kodu::KoduObject::setObjectIdentifier

(

const DualCoding::Shape< DualCoding::AprilTagData > &

kIdentifier

)

Stores the object's identifier.

Definition at line 78 of file KoduObject.cc.

---

Member Data Documentation

std::string Kodu::KoduObject::color [protected]

the object's color

Definition at line 62 of file KoduObject.h.

Referenced by getColor(), and operator=().

DualCoding::ShapeRoot Kodu::KoduObject::matchingObject

the object that matches search criteria

Definition at line 68 of file KoduObject.h.

Referenced by foundValidMatch(), getObject(), operator=(), and setObject().

DualCoding::Shape<DualCoding::AprilTagData> Kodu::KoduObject::matchingObjTag

Definition at line 69 of file KoduObject.h.

Referenced by getObjectIdentifier(), operator=(), and setObjectIdentifier().

bool Kodu::KoduObject::objectIsLandmark [protected]

can "this" object be used as a landmark

Definition at line 65 of file KoduObject.h.

Referenced by isLandmark(), and operator=().

SearchLocation_t Kodu::KoduObject::searchLocations [protected]

the locations the perceiver should search for an object

Definition at line 64 of file KoduObject.h.

Referenced by operator=().

std::string Kodu::KoduObject::type [protected]

the object's type (e.g. tree, rock, apple)

Definition at line 63 of file KoduObject.h.

Referenced by getType(), and operator=().

---

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

• KoduObject.h
• KoduObject.cc