Classes | Public Member Functions

fawkes::SpeechSynthInterface::SayMessage Class Reference

SayMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::SpeechSynthInterface::SayMessage:
Inheritance graph
[legend]

List of all members.

Classes

struct  SayMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 SayMessage (const char *ini_text)
 Constructor with initial values.
 SayMessage ()
 Constructor.
 ~SayMessage ()
 Destructor.
 SayMessage (const SayMessage *m)
 Copy constructor.
char * text () const
 Get text value.
void set_text (const char *new_text)
 Set text value.
size_t maxlenof_text () const
 Get maximum length of text value.
virtual Messageclone () const
 Clone this message.

Detailed Description

SayMessage Fawkes BlackBoard Interface Message.

Definition at line 69 of file SpeechSynthInterface.h.


Constructor & Destructor Documentation

fawkes::SpeechSynthInterface::SayMessage::SayMessage ( const char *  ini_text  ) 

Constructor with initial values.

Parameters:
ini_text initial value for text

Definition at line 259 of file SpeechSynthInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_STRING.

fawkes::SpeechSynthInterface::SayMessage::SayMessage (  ) 
fawkes::SpeechSynthInterface::SayMessage::~SayMessage (  ) 

Destructor.

Definition at line 281 of file SpeechSynthInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::SpeechSynthInterface::SayMessage::SayMessage ( const SayMessage m  ) 

Copy constructor.

Parameters:
m message to copy from

Definition at line 289 of file SpeechSynthInterface.cpp.

References fawkes::Message::data_ptr, fawkes::Message::data_size, and fawkes::Message::data_ts.


Member Function Documentation

Message * fawkes::SpeechSynthInterface::SayMessage::clone (  )  const [virtual]

Clone this message.

Produces a message of the same type as this message and copies the data to the new message.

Returns:
clone of this message

Reimplemented from fawkes::Message.

Definition at line 339 of file SpeechSynthInterface.cpp.

References SayMessage().

size_t fawkes::SpeechSynthInterface::SayMessage::maxlenof_text (  )  const

Get maximum length of text value.

Returns:
length of text value, can be length of the array or number of maximum number of characters for a string

Definition at line 316 of file SpeechSynthInterface.cpp.

void fawkes::SpeechSynthInterface::SayMessage::set_text ( const char *  new_text  ) 

Set text value.

Last spoken string. Must be properly null-terminated.

Parameters:
new_text new text value

Definition at line 328 of file SpeechSynthInterface.cpp.

char * fawkes::SpeechSynthInterface::SayMessage::text (  )  const

Get text value.

Last spoken string. Must be properly null-terminated.

Returns:
text value

Definition at line 306 of file SpeechSynthInterface.cpp.


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