VOS::Talkative Class Reference
[libmetaobject_misc]

#include <vos/metaobjects/misc/talkative.hh>

Inheritance diagram for VOS::Talkative:

Detailed Description

This object type facilitates verbal intercommunication in the form of text (which may be synthesized as human speech if possible).

Definition at line 49 of file talkative.hh.

Public Member Functions

Talkative (VobjectBase *superobject)
const std::string getVOSType ()
Return type string ("talkative").
std::string getVoice ()
Get the voice property.
void setVoice (const std::string &value)
Set voice property.
virtual void say (TalkMessage &msg)
Send a talk message to this object.
void say (const std::string &text, Talkative &sender, const unsigned short scope, const int priority=0, uint32_t replynonce=0, uint32_t thisnonce=0)
Contructs a TalkMessage and calls say(TalkMessage&).
void say (const std::string &text, Talkative &sender, uint32_t in_reply_to=0)
calls say(text, sender, UNSPECIFIED, 0, "")
virtual VUtil::vRef< Vobject > getRelayListeners ()
virtual void addRelay (Talkative *t)
virtual void removeRelay (Talkative *t)
virtual void sayToAllMembers (Vobject *target, TalkMessage &msg)
If the target object has a relay listeners group, then resend message via that target object, otherwise, iterate over target object's children and send the message directly to each talkative object (other than this).
virtual void resend (Talkative *resendTo, TalkMessage &msg)
Have this object resend the supplied message as if it came from itself.
void resend (Talkative *resendTo, const std::string &text, const unsigned short scope, const int priority=0, uint32_t replynonce=0, uint32_t thisnonce=0)
Contructs a TalkMessage and calls resend(TalkMessage&).
void resend (Talkative *resendTo, const std::string &text, uint32_t in_reply_to=0)
calls resend(text, sender, UNSPECIFIED, 0, "")

Static Public Attributes

Message scope codes

static const unsigned short UNSPECIFIED
static const unsigned short PUBLIC
static const unsigned short PRIVATE
static const unsigned short AUTO
static const unsigned short FROM_APP
Same as SYSTEM.
static const unsigned short SYSTEM
Same as FROM_APP.
static const unsigned short EMOTE

Protected Member Functions

virtual void do_say (TalkMessage &msg)=0
virtual void do_resend (Talkative *resendTo, TalkMessage &m)=0

Constructor & Destructor Documentation

VOS::Talkative::Talkative ( VobjectBase * superobject )

Member Function Documentation

virtual void VOS::Talkative::addRelay ( Talkative * t ) [virtual]

virtual void VOS::Talkative::do_resend	(	Talkative *	resendTo,
		TalkMessage &	m
	)			`[protected, pure virtual]`

Implemented in VOS::LocalTalkative, and VOS::RemoteTalkative.

virtual void VOS::Talkative::do_say ( TalkMessage & msg ) [protected, pure virtual]

Implemented in VOS::LocalTalkative, and VOS::RemoteTalkative.

virtual VUtil::vRef<Vobject> VOS::Talkative::getRelayListeners ( ) [virtual]

Returns:: the object containing relay listeners, if it exists.

std::string VOS::Talkative::getVoice ( )

Get the voice property.

See also:: setVoice

const std::string VOS::Talkative::getVOSType ( ) [virtual]

Return type string ("talkative").

Reimplemented from VOS::MetaObject.

virtual void VOS::Talkative::removeRelay ( Talkative * t ) [virtual]

void VOS::Talkative::resend	(	Talkative *	resendTo,
		const std::string &	text,
		uint32_t	in_reply_to = `0`
	)			`[inline]`

calls resend(text, sender, UNSPECIFIED, 0, "")

Definition at line 136 of file talkative.hh.

void VOS::Talkative::resend	(	Talkative *	resendTo,
		const std::string &	text,
		const unsigned short	scope,
		const int	priority = `0`,
		uint32_t	replynonce = `0`,
		uint32_t	thisnonce = `0`
	)

Contructs a TalkMessage and calls resend(TalkMessage&).

virtual void VOS::Talkative::resend	(	Talkative *	resendTo,
		TalkMessage &	msg
	)			`[virtual]`

Have this object resend the supplied message as if it came from itself.

void VOS::Talkative::say	(	const std::string &	text,
		Talkative &	sender,
		uint32_t	in_reply_to = `0`
	)			`[inline]`

calls say(text, sender, UNSPECIFIED, 0, "")

Definition at line 103 of file talkative.hh.

void VOS::Talkative::say	(	const std::string &	text,
		Talkative &	sender,
		const unsigned short	scope,
		const int	priority = `0`,
		uint32_t	replynonce = `0`,
		uint32_t	thisnonce = `0`
	)

Contructs a TalkMessage and calls say(TalkMessage&).

virtual void VOS::Talkative::say ( TalkMessage & msg ) [virtual]

Send a talk message to this object.

This message contains text to be spoken or displayed. The "voice" property should be used, to select a voice if applicable.

See also:: Talkative::TalkMessage

virtual void VOS::Talkative::sayToAllMembers	(	Vobject *	target,
		TalkMessage &	msg
	)			`[virtual]`

If the target object has a relay listeners group, then resend message via that target object, otherwise, iterate over target object's children and send the message directly to each talkative object (other than this).

For example, use this method to send a message to the other members of an A3DL world sector.

void VOS::Talkative::setVoice ( const std::string & value )

Set voice property.

Parameters:

value

The new value. This is a voice definition to be passed to the Festival speech synthesis system: it can be a predefined voice, a full voice definition function, or "#f" for no voice.

Member Data Documentation

const unsigned short VOS::Talkative::AUTO [static]

Definition at line 62 of file talkative.hh.

const unsigned short VOS::Talkative::EMOTE [static]

Definition at line 65 of file talkative.hh.

const unsigned short VOS::Talkative::FROM_APP [static]

Same as SYSTEM.

Definition at line 63 of file talkative.hh.

const unsigned short VOS::Talkative::PRIVATE [static]

Definition at line 61 of file talkative.hh.

const unsigned short VOS::Talkative::PUBLIC [static]

Definition at line 60 of file talkative.hh.

const unsigned short VOS::Talkative::SYSTEM [static]

Same as FROM_APP.

Definition at line 64 of file talkative.hh.

const unsigned short VOS::Talkative::UNSPECIFIED [static]

Definition at line 59 of file talkative.hh.

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

/home/tetron/hack/vos/libs/vos/metaobjects/misc/talkative.hh

[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]

VOS::Talkative Class Reference [libmetaobject_misc]