ISpeechSynthesizerMsgs_synthesize_helper Class Reference

Inheritance diagram for ISpeechSynthesizerMsgs_synthesize_helper:

Classes
class	Command
class	Reply

Public Types
using	funcptr_t = return_synthesize(*)(const std::string &)

Public Member Functions
	ISpeechSynthesizerMsgs_synthesize_helper ()=default
	ISpeechSynthesizerMsgs_synthesize_helper (const std::string &text)
bool	write (yarp::os::ConnectionWriter &connection) const override
	Write this object to a network connection.
bool	read (yarp::os::ConnectionReader &connection) override
	Read this object from a network connection.
void	call (ISpeechSynthesizerMsgs *ptr)
Public Member Functions inherited from yarp::os::Portable
virtual Type	getType () const
Public Member Functions inherited from yarp::os::PortReader
virtual	~PortReader ()
	Destructor.
virtual Type	getReadType () const
Public Member Functions inherited from yarp::os::PortWriter
virtual	~PortWriter ()
	Destructor.
virtual void	onCompletion () const
	This is called when the port has finished all writing operations.
virtual void	onCommencement () const
	This is called when the port is about to begin writing operations.
virtual yarp::os::Type	getWriteType () const

Public Attributes
Command	cmd
Reply	reply

Static Public Attributes
static constexpr const char *	s_tag {"synthesize"}
static constexpr size_t	s_tag_len {1}
static constexpr size_t	s_cmd_len {2}
static constexpr size_t	s_reply_len {2}
static constexpr const char *	s_prototype {"return_synthesize ISpeechSynthesizerMsgs::synthesize(const std::string& text)"}
static constexpr const char *	s_help {""}

Additional Inherited Members
Static Public Member Functions inherited from yarp::os::Portable
static bool	copyPortable (const PortWriter &writer, PortReader &reader)
	Copy one portable to another, via writing and reading.

Detailed Description

Definition at line 502 of file ISpeechSynthesizerMsgs.cpp.

Member Typedef Documentation

funcptr_t

using ISpeechSynthesizerMsgs_synthesize_helper::funcptr_t = return_synthesize (*)(const std::string&)

Definition at line 550 of file ISpeechSynthesizerMsgs.cpp.

Constructor & Destructor Documentation

ISpeechSynthesizerMsgs_synthesize_helper() [1/2]

ISpeechSynthesizerMsgs_synthesize_helper::ISpeechSynthesizerMsgs_synthesize_helper ( )

default

ISpeechSynthesizerMsgs_synthesize_helper() [2/2]

ISpeechSynthesizerMsgs_synthesize_helper::ISpeechSynthesizerMsgs_synthesize_helper ( const std::string &  text )

explicit

Definition at line 1713 of file ISpeechSynthesizerMsgs.cpp.

Member Function Documentation

call()

void ISpeechSynthesizerMsgs_synthesize_helper::call

(

ISpeechSynthesizerMsgs *

ptr

)

Definition at line 1861 of file ISpeechSynthesizerMsgs.cpp.

read()

bool ISpeechSynthesizerMsgs_synthesize_helper::read ( yarp::os::ConnectionReader &  reader )

overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters

reader

an interface to the network connection for reading

Returns

true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 1723 of file ISpeechSynthesizerMsgs.cpp.

write()

bool ISpeechSynthesizerMsgs_synthesize_helper::write ( yarp::os::ConnectionWriter &  writer ) const

overridevirtual

Write this object to a network connection.

Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write

Parameters

writer

an interface to the network connection for writing

Returns

true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 1718 of file ISpeechSynthesizerMsgs.cpp.

Member Data Documentation

cmd

Command ISpeechSynthesizerMsgs_synthesize_helper::cmd

Definition at line 553 of file ISpeechSynthesizerMsgs.cpp.

reply

Reply ISpeechSynthesizerMsgs_synthesize_helper::reply

Definition at line 554 of file ISpeechSynthesizerMsgs.cpp.

s_cmd_len

constexpr size_t ISpeechSynthesizerMsgs_synthesize_helper::s_cmd_len {2}

staticconstexpr

Definition at line 558 of file ISpeechSynthesizerMsgs.cpp.

s_help

constexpr const char* ISpeechSynthesizerMsgs_synthesize_helper::s_help {""}

staticconstexpr

Definition at line 561 of file ISpeechSynthesizerMsgs.cpp.

s_prototype

constexpr const char* ISpeechSynthesizerMsgs_synthesize_helper::s_prototype {"return_synthesize ISpeechSynthesizerMsgs::synthesize(const std::string& text)"}

staticconstexpr

Definition at line 560 of file ISpeechSynthesizerMsgs.cpp.

s_reply_len

constexpr size_t ISpeechSynthesizerMsgs_synthesize_helper::s_reply_len {2}

staticconstexpr

Definition at line 559 of file ISpeechSynthesizerMsgs.cpp.

s_tag

constexpr const char* ISpeechSynthesizerMsgs_synthesize_helper::s_tag {"synthesize"}

staticconstexpr

Definition at line 556 of file ISpeechSynthesizerMsgs.cpp.

s_tag_len

constexpr size_t ISpeechSynthesizerMsgs_synthesize_helper::s_tag_len {1}

staticconstexpr

Definition at line 557 of file ISpeechSynthesizerMsgs.cpp.

---

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

• src/devices/messages/ISpeechSynthesizerMsgs/idl_generated_code/ISpeechSynthesizerMsgs.cpp