Class to contain prompt information - string and rate. More...

#include <Prompt.h>

Public Member Functions
	Prompt ()

void	setString (const std::string &val)

const std::string &	getString () const

void	setRate (const double val)
	Set rate of desired prompting, in Hz (sec^-1). More...

double	getRate () const

void	setOffset (const double val)
	Set prompt offset in seconds. More...

double	getOffset () const

Private Attributes
std::string	_promptString

double	_promptRate

double	_promptOffset

Detailed Description

Class to contain prompt information - string and rate.

Constructor & Destructor Documentation

nidas::core::Prompt::Prompt ( )

inline

Member Function Documentation

double nidas::core::Prompt::getOffset ( ) const

inline

References _promptOffset.

Referenced by nidas::core::SerialSensor::initPrompting().

double nidas::core::Prompt::getRate ( ) const

inline

References _promptRate.

Referenced by nidas::core::SerialSensor::initPrompting().

const std::string& nidas::core::Prompt::getString ( ) const

inline

References _promptString.

Referenced by nidas::core::SerialSensor::initPrompting().

void nidas::core::Prompt::setOffset ( const double val )

inline

Set prompt offset in seconds.

For example, for a rate of 10Hz, an offset of 0 would result in prompts at 0.0, 0.1, 0.2 seconds after each second. An offset of 0.01 would result in prompts at 0.01, 0.11, 0.21 seconds after the second.

References _promptOffset.

Referenced by nidas::core::CharacterSensor::addPrompt().

void nidas::core::Prompt::setRate ( const double val )

inline

Set rate of desired prompting, in Hz (sec^-1).

References _promptRate.

Referenced by nidas::core::CharacterSensor::addPrompt().

void nidas::core::Prompt::setString ( const std::string & val )

inline

References _promptString.

Referenced by nidas::core::CharacterSensor::addPrompt().