#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)

virtual	~mtsTaskFromSignal ()

void	Kill (void)

mtsInterfaceRequired *	AddInterfaceRequiredWithoutSystemEventHandlers (const std::string &interfaceRequiredName, mtsRequiredType required=MTS_REQUIRED)

mtsInterfaceProvided *	AddInterfaceProvidedWithoutSystemEvents (const std::string &newInterfaceName, mtsInterfaceQueueingPolicy queueingPolicy=MTS_COMPONENT_POLICY, bool isProxy=false)

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)

void	Start (void)

void	Suspend (void)

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	SetInitializationDelay (double delay)

void	Create (void)

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	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)

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, const bool skipDisconnect=false)

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)

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, const bool skipDisconnect=false)

const mtsManagerComponentServices *	GetManagerComponentServices (void) const

mtsManagerComponentServices *	GetManagerComponentServices (void)

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

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

bool	SetReplayMode (void)

bool	SetReplayData (const std::string &stateTableName, const std::string &fileName)

bool	SetReplayTime (const double time)

std::vector< std::string >	GetNamesOfInterfacesProvidedOrOutput (void) const

std::vector< std::string >	GetNamesOfInterfacesProvided (void) const

std::vector< std::string >	GetNamesOfInterfacesOutput (void) const

std::vector< std::string >	GetNamesOfInterfacesRequiredOrInput (void) const

std::vector< std::string >	GetNamesOfInterfacesRequired (void) const

std::vector< std::string >	GetNamesOfInterfacesInput (void) const

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 throw (std::out_of_range)

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)

Protected Member Functions inherited from mtsTaskFromSignal
void *	RunInternal (void *argument)

void	PostCommandQueuedMethod (void)

Protected Member Functions inherited from mtsTaskContinuous
virtual void	StartInternal (void)

Protected Member Functions inherited from mtsTask
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)

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. More...

bool	AddInterfaceInternal (const bool useMangerComponentServices=false)
	Add internal interfaces. More...

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)

void	InterfaceInternalCommands_ComponentCreate (const mtsDescriptionComponent &componentDescription, bool &result)

void	InterfaceInternalCommands_ComponentStartOther (const mtsComponentStatusControl &arg)

Protected Attributes
mtsTextToSpeechInternal *	Internals

std::string	StringToSpeechCommand

bool	Preemptive

std::string	LastString

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

mtsInterfaceProvided *	InterfaceProvidedToManager

bool	UseSeparateLogFileFlag

cmnLogger::StreamBufType *	LoDMultiplexerStreambuf

std::ofstream *	LogFile

StateTableMapType	StateTables

mtsManagerComponentServices *	ManagerComponentServices

mtsFunctionWrite	EventGeneratorChangeState

bool	ReplayMode

InterfacesProvidedMapType	InterfacesProvided

InterfacesOutputMapType	InterfacesOutput

InterfacesRequiredMapType	InterfacesRequired

InterfacesInputMapType	InterfacesInput

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 < mtsStateTable >	StateTableMapType

typedef cmnNamedMap < mtsInterfaceProvided >	InterfacesProvidedMapType

typedef cmnNamedMap < mtsInterfaceOutput >	InterfacesOutputMapType

typedef cmnNamedMap < mtsInterfaceRequired >	InterfacesRequiredMapType

typedef cmnNamedMap < mtsInterfaceInput >	InterfacesInputMapType

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 ( void )

mtsTextToSpeech::~mtsTextToSpeech ( void )

Member Function Documentation

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.

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.

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.

void mtsTextToSpeech::ButtonToSpeech ( const prmEventButton & button )

protected

void mtsTextToSpeech::CharacterToSpeech ( const char & character )

protected

void mtsTextToSpeech::Cleanup ( void )

virtual

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

Reimplemented from mtsComponent.

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

inlinevirtual

Virtual method that gets called when the task/interface needs to be configured. Should it take XML info??

Reimplemented from mtsTask.

void mtsTextToSpeech::Run ( void )

virtual

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

Implements mtsTask.

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.

void mtsTextToSpeech::Startup ( void )

virtual

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

Reimplemented from mtsComponent.

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

protected

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

protected

Member Data Documentation

mtsTextToSpeechInternal* mtsTextToSpeech::Internals

protected

std::string mtsTextToSpeech::LastString

protected

bool mtsTextToSpeech::Preemptive

protected

std::string mtsTextToSpeech::StringToSpeechCommand

protected

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

/home/adeguet1/catkin_ws/src/cisst-saw/sawTextToSpeech/include/sawTextToSpeech/mtsTextToSpeech.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation