Attire Class Reference

Public Member Functions
	Attire (HardwareInterface *hardware)
	Attire (const Attire &other)
Attire &	operator= (const Attire &other)
Tactor *	addTactor (string name, Tactor *tactor)
Tactor *	removeTactor (string name)
Sensor *	addSensor (string name, Sensor *sensor)
Sensor *	removeSensor (string name)
bool	command (string tactorName, string command)
string	check (string sensorName)
bool	execute (SimplePattern pattern)
void	execute (ComplexPattern pattern)

Constructor & Destructor Documentation

Attire::Attire

(

HardwareInterface *

hardware

)

A constructor that gives the hardwareInterface for this Attire to use for its tactors and sensors

Parameters

hardware

the hardware interface to signal tactors and sensors through

Member Function Documentation

Sensor* Attire::addSensor	(	string	name,
		Sensor *	sensor
	)

Adds the sensor given by sensor and associates it with the string name

Parameters

name	the name of the sensor being added
sensor	the sensor to add to this attire

Returns

the previous sensor with that name or void if none existed

Tactor* Attire::addTactor	(	string	name,
		Tactor *	tactor
	)

Adds the tactor given by tactor and associates it with the string name

Parameters

name	the name of the tactor being added
tactor	a tactor to add to this attire

Returns

the previous tactor with that name or void if none existed

string Attire::check

(

string

sensorName

)

Checks the given sensor

Parameters

sensorName

the name of the sensor to check within this attire

Returns

the data from the sensor or the empty string if the check failed

bool Attire::command	(	string	tactorName,
		string	command
	)

Sends a command to a tactor

Parameters

tactorName	the name of the tactor within this attire to be signalled
command	the command to be sent to that tactor

Returns

true if the command was successfully sent, false otherwise

bool Attire::execute

(

SimplePattern

pattern

)

Execute the given simplePattern

Parameters

pattern

the pattern to be executed

Returns

true if the pattern was successfully commanded

void Attire::execute

(

ComplexPattern

pattern

)

Execute the given complexPattern

Parameters

pattern

the complexPattern to be executed

Sensor* Attire::removeSensor

(

string

name

)

Removes the sensor given by name from the attire

Parameters

name	the name of the sensor to be removed

Returns

the removed sensor or void if none existed

Tactor* Attire::removeTactor

(

string

name

)

Removes the tactor given by name from the attire

Parameters

name	the name of the tactor to remove

Returns

the removed tactor or void if none existed

---

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

• TactileAPI/include/Attire.h