#include <mtsTextToSpeech.h>

Inheritance diagram for mtsTextToSpeech:

Public Member Functions
	mtsTextToSpeech (void)
	~mtsTextToSpeech (void)
void	Configure (const std::string &CMN_UNUSED(filename)="")
void	Startup (void)
void	Run (void)
void	Cleanup (void)
void	AddInterfaceRequiredForEventString (const std::string &interfaceName, const std::string &eventName)
void	AddInterfaceRequiredForEventCharacter (const std::string &interfaceName, const std::string &eventName)
void	AddInterfaceRequiredForEventButton (const std::string &interfaceName)
void	SetPreemptive (const bool &preemptive)
Public Member Functions inherited from mtsTaskFromSignal
	mtsTaskFromSignal (const std::string &name, unsigned int sizeStateTable=256)
	mtsTaskFromSignal (const mtsTaskConstructorArg &arg)
virtual	~mtsTaskFromSignal ()
void	Kill (void) override
mtsInterfaceRequired *	AddInterfaceRequiredWithoutSystemEventHandlers (const std::string &interfaceRequiredName, mtsRequiredType required=MTS_REQUIRED) override
mtsInterfaceProvided *	AddInterfaceProvidedWithoutSystemEvents (const std::string &newInterfaceName, mtsInterfaceQueueingPolicy queueingPolicy=MTS_COMPONENT_POLICY) override
Public Member Functions inherited from mtsTaskContinuous
	mtsTaskContinuous (const std::string &name, unsigned int sizeStateTable=256, bool newThread=true)
	mtsTaskContinuous (const mtsTaskContinuousConstructorArg &arg)
virtual	~mtsTaskContinuous ()
void	Create (void *data=0) override
void	Start (void) override
void	Suspend (void) override
virtual bool	CreatesThread (void) const
Public Member Functions inherited from mtsTask
	mtsTask (const std::string &name, unsigned int sizeStateTable=256)
virtual	~mtsTask ()
virtual void	OnStartupException (const std::exception &excp)
virtual void	OnRunException (const std::exception &excp)
void	Configure (const std::string &CMN_UNUSED(filename)="") override
void	SetInitializationDelay (double delay)
void	Create (void) override
double	GetAveragePeriod (void) const
const std::string	GetDefaultStateTableName (void) const
mtsStateTable *	GetDefaultStateTable (void)
virtual bool	WaitToStart (double timeout)
virtual bool	WaitToTerminate (double timeout)
virtual void	WaitForWakeup (void)
virtual void	Wakeup (void)
void	ProcessManagerCommandsIfNotActive ()
bool	CheckForOwnThread (void) const
virtual bool	IsPeriodic (void) const
virtual bool	IsOverranPeriod (void) const
virtual void	ResetOverranPeriod (void)
Public Member Functions inherited from mtsComponent
	mtsComponent (const std::string &deviceName)
virtual	~mtsComponent ()
const std::string &	GetName (void) const
void	GetName (std::string &placeHolder) const
void	AddTag (const std::string &tag)
const std::set< std::string > &	GetTags (void) const
void	SetName (const std::string &componentName)
virtual void	Configure (const std::string &filename="")
bool	CreateAndWait (double timeoutInSeconds)
bool	StartAndWait (double timeoutInSeconds)
bool	KillAndWait (double timeoutInSeconds)
mtsInterfaceProvided *	AddInterfaceProvided (const std::string &interfaceProvidedName, mtsInterfaceQueueingPolicy queueingPolicy=MTS_COMPONENT_POLICY)
CISST_DEPRECATED mtsInterfaceProvided *	AddProvidedInterface (const std::string &interfaceProvidedName)
virtual mtsInterfaceOutput *	AddInterfaceOutput (const std::string &interfaceOutputName)
std::vector< std::string >	GetNamesOfInterfacesProvidedOrOutput (void) const
std::vector< std::string >	GetNamesOfInterfacesProvided (void) const
std::vector< std::string >	GetNamesOfInterfacesOutput (void) const
bool	InterfaceExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const
bool	InterfaceProvidedOrOutputExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const
bool	InterfaceRequiredOrInputExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const
mtsInterfaceProvided *	GetInterfaceProvided (const std::string &interfaceProvidedName) const
mtsInterfaceOutput *	GetInterfaceOutput (const std::string &interfaceOutputName) const
size_t	GetNumberOfInterfacesProvided (void) const
size_t	GetNumberOfInterfacesOutput (void) const
bool	RemoveInterfaceProvided (const std::string &interfaceProvidedName)
mtsInterfaceRequired *	AddInterfaceRequired (const std::string &interfaceRequiredName, mtsRequiredType isRequired=MTS_REQUIRED)
CISST_DEPRECATED mtsInterfaceRequired *	AddRequiredInterface (const std::string &requiredInterfaceName)
virtual mtsInterfaceInput *	AddInterfaceInput (const std::string &interfaceInputName)
std::vector< std::string >	GetNamesOfInterfacesRequiredOrInput (void) const
std::vector< std::string >	GetNamesOfInterfacesRequired (void) const
std::vector< std::string >	GetNamesOfInterfacesInput (void) const
const mtsInterfaceProvided *	GetInterfaceProvidedFor (const std::string &interfaceRequiredName)
mtsInterfaceRequired *	GetInterfaceRequired (const std::string &interfaceRequiredName)
mtsInterfaceInput *	GetInterfaceInput (const std::string &interfaceInputName) const
size_t	GetNumberOfInterfacesRequired (void) const
size_t	GetNumberOfInterfacesInput (void) const
bool	RemoveInterfaceRequired (const std::string &interfaceRequiredName)
mtsStateTable *	GetStateTable (const std::string &stateTableName)
bool	AddStateTable (mtsStateTable *existingStateTable, bool addInterfaceProvided=true)
void	UseSeparateLogFileDefault (bool forwardToLogger=true)
void	UseSeparateLogFileDefaultWithDate (bool forwardToLogger=true)
void	UseSeparateLogFile (const std::string &filename, bool forwardToLogger=true)
cmnLogger::StreamBufType *	GetLogMultiplexer (void) const override
bool	AreAllInterfacesRequiredConnected (const bool log=false)
bool	IsRunning (void) const
bool CISST_DEPRECATED	Running (void) const
bool	IsStarted (void) const
bool	IsTerminated (void) const
bool	IsEndTask (void) const
const mtsComponentState &	GetState (void) const
void	GetState (mtsComponentState &state) const
void	ToStream (std::ostream &outputStream) const override
bool	SetReplayMode (void)
bool	SetReplayData (const std::string &stateTableName, const std::string &fileName)
bool	SetReplayTime (const double time)
Public Member Functions inherited from cmnGenericObject
virtual	~cmnGenericObject (void)
virtual const cmnClassServicesBase *	Services (void) const =0
bool	ReconstructFrom (const cmnGenericObject &other)
std::string	ToString (void) const
virtual void	ToStreamRaw (std::ostream &outputStream, const char delimiter=' ', bool headerOnly=false, const std::string &headerPrefix="") const
virtual bool	FromStreamRaw (std::istream &inputStream, const char delimiter=' ')
virtual void	SerializeRaw (std::ostream &outputStream) const
virtual void	DeSerializeRaw (std::istream &inputStream)
virtual size_t	ScalarNumber (void) const
virtual bool	ScalarNumberIsFixed (void) const
virtual double	Scalar (const size_t CMN_UNUSED(index)) const CISST_THROW(std
virtual std::string	ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const

Protected Member Functions
void	StringToSpeech (const std::string &text)
void	StringToSpeechInternal (const std::string &text)
void	CharacterToSpeech (const char &character)
void	ButtonToSpeech (const prmEventButton &button)
void	Beep (const vct3 &durationFrequencyAmplitude)
void	BeepInternal (const vct3 &durationFrequencyAmplitude)
Protected Member Functions inherited from mtsTaskFromSignal
void	Init (void)
void *	RunInternal (void *argument) override
void	PostCommandQueuedMethod (void)
Protected Member Functions inherited from mtsTaskContinuous
virtual void	StartInternal (void)
Protected Member Functions inherited from mtsTask
virtual const mtsManagerComponentServices *	GetManagerComponentServices (void) const override
void	RunEventHandler (void)
void	ChangeStateEventHandler (const mtsComponentState &newState)
mtsExecutionResult	RunEvent (bool check=true)
void	DoRunInternal (void)
virtual void	StartupInternal (void)
virtual void	CleanupInternal (void)
void	Sleep (double timeInSeconds)
mtsStateIndex::TimeTicksType	GetTick (void) const
virtual void	SaveThreadStartData (void *data)
virtual void	SetThreadReturnValue (void *returnValue)
void	ChangeState (mtsComponentState::Enum newState)
bool	WaitForState (mtsComponentState desiredState, double timeout) override
Protected Member Functions inherited from mtsComponent
	mtsComponent (void)
	mtsComponent (const mtsComponent &other)
void	Initialize (void)
mtsInterfaceRequired *	AddInterfaceRequiredExisting (const std::string &interfaceRequiredName, mtsInterfaceRequired *interfaceRequired)
mtsInterfaceRequired *	AddInterfaceRequiredUsingMailbox (const std::string &interfaceRequiredName, mtsMailBox *mailBox, mtsRequiredType required)
mtsInterfaceProvided *	AddInterfaceProvidedUsingMailbox (const std::string &interfaceProvidedName, mtsMailBox *mailBox)
mtsInterfaceInput *	AddInterfaceInputExisting (const std::string &interfaceInputName, mtsInterfaceInput *interfaceInput)
mtsInterfaceOutput *	AddInterfaceOutputExisting (const std::string &interfaceOutputName, mtsInterfaceOutput *interfaceOutput)
void	KillSeparateLogFile (void)
size_t	ProcessMailBoxes (InterfacesProvidedMapType &interfaces)
size_t	ProcessQueuedCommands (void)
size_t	ProcessQueuedEvents (void)
mtsInterfaceRequired *	EnableDynamicComponentManagement (void)
	Enable support for dynamic component management services.
bool	AddInterfaceInternal (const bool useMangerComponentServices=false)
	Add internal interfaces.
void	InterfaceInternalCommands_GetEndUserInterface (const mtsEndUserInterfaceArg &argin, mtsEndUserInterfaceArg &argout)
void	InterfaceInternalCommands_AddObserverList (const mtsEventHandlerList &argin, mtsEventHandlerList &argout)
void	InterfaceInternalCommands_RemoveEndUserInterface (const mtsEndUserInterfaceArg &argin, mtsEndUserInterfaceArg &argout)
void	InterfaceInternalCommands_RemoveObserverList (const mtsEventHandlerList &argin, mtsEventHandlerList &argout)

Protected Attributes
mtsTextToSpeechInternal *	Internals
std::string	StringToSpeechCommand
bool	Preemptive
std::string	LastString
vct3	LastBeep
Protected Attributes inherited from mtsTaskFromSignal
mtsCallableVoidBase *	PostCommandQueuedCallable
Protected Attributes inherited from mtsTaskContinuous
bool	NewThread
bool	CaptureThread
Protected Attributes inherited from mtsTask
osaThread	Thread
double	InitializationDelay
osaMutex	StateChange
osaThreadSignal	StateChangeSignal
mtsStateTable	StateTable
bool	OverranPeriod
void *	ThreadStartData
void *	ReturnValue
mtsCallableVoidBase *	InterfaceProvidedToManagerCallable
mtsInterfaceRequired *	ExecIn
mtsInterfaceProvided *	ExecOut
mtsFunctionVoid	RunEventInternal
bool	RunEventCalled
mtsFunctionWrite	ChangeStateEvent
Protected Attributes inherited from mtsComponent
std::string	Name
mtsComponentState	State
std::set< std::string >	mTags
mtsInterfaceProvided *	InterfaceProvidedToManager
bool	UseSeparateLogFileFlag
cmnLogger::StreamBufType *	LoDMultiplexerStreambuf
std::ofstream *	LogFile
InterfacesProvidedMapType	InterfacesProvided
InterfacesOutputMapType	InterfacesOutput
InterfacesRequiredMapType	InterfacesRequired
InterfacesInputMapType	InterfacesInput
StateTableMapType	StateTables
mtsManagerComponentServices *	ManagerComponentServices
mtsFunctionWrite	EventGeneratorChangeState
bool	ReplayMode

Additional Inherited Members
Public Types inherited from mtsTaskContinuous
typedef mtsTask	BaseType
Public Types inherited from mtsTask
typedef mtsComponent	BaseType
Public Types inherited from mtsComponent
typedef mtsComponent	ThisType
Static Public Attributes inherited from mtsTask
static std::runtime_error	UnknownException
Protected Types inherited from mtsTaskFromSignal
typedef mtsTaskContinuous	BaseType
Protected Types inherited from mtsComponent
typedef cmnNamedMap< mtsInterfaceProvided >	InterfacesProvidedMapType
typedef cmnNamedMap< mtsInterfaceOutput >	InterfacesOutputMapType
typedef cmnNamedMap< mtsInterfaceRequired >	InterfacesRequiredMapType
typedef cmnNamedMap< mtsInterfaceInput >	InterfacesInputMapType
typedef cmnNamedMap< mtsStateTable >	StateTableMapType

Detailed Description

Provides a simple component to convert text to speech. The current implementation uses command lines tools on Mac OS (say) and Linux (flite). On Windows, this component uses the native API.

The component has two default provided interfaces. The "Configuration" interface provides the command "SetPreemptive" (see method with same name). The interface "Commands" provides the commands "StringToSpeech" and "CharacterToSpeech".

This component can also be configured by adding required interface with event observers, see methods AddInterfaceRequiredForEventString, AddInterfaceRequiredForEventCharacter and AddInterfaceRequiredForEventButton. All these methods add a required interface (unless said interface already exists) and an event handler.

Constructor & Destructor Documentation

◆ mtsTextToSpeech()

mtsTextToSpeech::mtsTextToSpeech ( void )

◆ ~mtsTextToSpeech()

mtsTextToSpeech::~mtsTextToSpeech ( void )

Member Function Documentation

◆ AddInterfaceRequiredForEventButton()

void mtsTextToSpeech::AddInterfaceRequiredForEventButton ( const std::string & interfaceName )

Add a required interface with an event observer using a prmEventButton payload. If the interface already exists, the event is added to the existing interface.

◆ AddInterfaceRequiredForEventCharacter()

void mtsTextToSpeech::AddInterfaceRequiredForEventCharacter	(	const std::string &	interfaceName,
		const std::string &	eventName )

Add a required interface with an event observer using a character as payload. If the interface already exists, the event is added to the existing interface.

◆ AddInterfaceRequiredForEventString()

void mtsTextToSpeech::AddInterfaceRequiredForEventString	(	const std::string &	interfaceName,
		const std::string &	eventName )

Add a required interface with an event observer using a string as payload. If the interface already exists, the event is added to the existing interface.

◆ Beep()

void mtsTextToSpeech::Beep ( const vct3 & durationFrequencyAmplitude )

protected

◆ BeepInternal()

void mtsTextToSpeech::BeepInternal ( const vct3 & durationFrequencyAmplitude )

protected

◆ ButtonToSpeech()

void mtsTextToSpeech::ButtonToSpeech ( const prmEventButton & button )

protected

◆ CharacterToSpeech()

void mtsTextToSpeech::CharacterToSpeech ( const char & character )

protected

◆ Cleanup()

void mtsTextToSpeech::Cleanup ( void )

virtual

Virtual method that gets overloaded, and is run after the component gets killed using Kill() method.

Reimplemented from mtsComponent.

◆ Configure()

void mtsTextToSpeech::Configure ( const std::string & CMN_UNUSEDfilename = "" )

inline

◆ Run()

void mtsTextToSpeech::Run ( void )

virtual

Pure virtual method that gets overloaded to run the actual task.

Implements mtsTask.

◆ SetPreemptive()

void mtsTextToSpeech::SetPreemptive ( const bool & preemptive )

Turn on or off the preemptive mode, i.e. at each Run execution, all messages received are dequeued and only the last one is used for text to speech.

◆ Startup()

void mtsTextToSpeech::Startup ( void )

virtual

Virtual method that gets overloaded, and is run before the component is started.

Reimplemented from mtsComponent.

◆ StringToSpeech()

void mtsTextToSpeech::StringToSpeech ( const std::string & text )

protected

◆ StringToSpeechInternal()

void mtsTextToSpeech::StringToSpeechInternal ( const std::string & text )

protected

Member Data Documentation

◆ Internals

mtsTextToSpeechInternal* mtsTextToSpeech::Internals

protected

◆ LastBeep

vct3 mtsTextToSpeech::LastBeep

protected

◆ LastString

std::string mtsTextToSpeech::LastString

protected

◆ Preemptive

bool mtsTextToSpeech::Preemptive

protected

◆ StringToSpeechCommand

std::string mtsTextToSpeech::StringToSpeechCommand

protected

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

tmp/cisst-saw/sawTextToSpeech/components/include/sawTextToSpeech/mtsTextToSpeech.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ mtsTextToSpeech()

◆ ~mtsTextToSpeech()

Member Function Documentation

◆ AddInterfaceRequiredForEventButton()

◆ AddInterfaceRequiredForEventCharacter()

◆ AddInterfaceRequiredForEventString()

◆ Beep()

◆ BeepInternal()

◆ ButtonToSpeech()

◆ CharacterToSpeech()

◆ Cleanup()

◆ Configure()

◆ Run()

◆ SetPreemptive()

◆ Startup()

◆ StringToSpeech()

◆ StringToSpeechInternal()

Member Data Documentation

◆ Internals

◆ LastBeep

◆ LastString

◆ Preemptive

◆ StringToSpeechCommand