Speaker Class Reference

This "motor" emulates a speaker or piezo element to produce sound. More...

#include <speaker.h>

Inheritance diagram for Speaker:

Collaboration diagram for Speaker:

Public Member Functions
	Speaker (float frequency, double visualSize=0.5, Pos visualOffset=Pos(0, 0, 1))
virtual	~Speaker ()
virtual void	init (Primitive *own, Joint *joint=0)
	initialises motor with body of robot More...
virtual int	getMotorNumber () const
	return the dimensionality of this motor More...
virtual bool	act (GlobalData &globaldata)
	performs the actions, This is usually called in doInternalStuff() from the robot More...
virtual int	set (const motor *values, int length)
	sends the action commands to the motor. More...
Public Member Functions inherited from Motor
	Motor ()
virtual	~Motor ()
virtual std::list < SensorMotorInfo >	getMotorInfos () const
	returns a list of motor names ( More...
Public Member Functions inherited from SensorMotorInfoAble
	SensorMotorInfoAble ()
void	setBaseName (const std::string &basename)
void	setBaseInfo (const SensorMotorInfo &baseinfo)
SensorMotorInfo	getBaseInfo ()
void	setNamingFunc (const NamingFunction &func)
NamingFunction	getNamingFunc () const
void	setNames (const std::vector< std::string > &names)
	set names explicitly (basename is anyway suffixed) More...
std::string	getName (int index) const
	returns the name of a single item. Typically called from within Sensor and Motor class. More...
std::list< SensorMotorInfo >	getInfos (int number) const
	get all infos. More...

Additional Inherited Members
Public Types inherited from SensorMotorInfoAble
typedef std::function < std::string(int)>	NamingFunction
	function that returns the name given the index More...
Static Public Member Functions inherited from SensorMotorInfoAble
static std::string	defaultNameing (int index)
	the default implementation is for index==0: basename, otherwise basename + (index+1) More...
Protected Attributes inherited from SensorMotorInfoAble
NamingFunction	func
SensorMotorInfo	baseinfo

Detailed Description

This "motor" emulates a speaker or piezo element to produce sound.

The sound can be detected by sound sensors (

See Also

SoundSensor). Note that obstacles do not interact with the sound in any way.

Constructor & Destructor Documentation

Speaker ( float  frequency, double  visualSize = 0.5, Pos  visualOffset = Pos(0,0,1)  )

inline

virtual ~Speaker ( )

inlinevirtual

Member Function Documentation

virtual bool act ( GlobalData &  globaldata )

inlinevirtual

performs the actions, This is usually called in doInternalStuff() from the robot

Implements Motor.

virtual int getMotorNumber ( ) const

inlinevirtual

return the dimensionality of this motor

Implements Motor.

virtual void init ( Primitive *  own, Joint *  joint = 0  )

inlinevirtual

initialises motor with body of robot

Implements Motor.

virtual int set ( const motor *  values, int  length  )

inlinevirtual

sends the action commands to the motor.

It returns the number of used values. (should be equal to getMotorNumber)

Implements Motor.

---

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

• speaker.h