myCallBacks Class Reference

My Custom CallBacks class. More...

List of all members.

Public Member Functions
void	categoryLoaded (const StringPimpl &userId, const StringPimpl &botId, const StringPimpl &endUserId)
	This is called for each AIML category that is loaded into memory.
void	filePostLoad (const StringPimpl &fileName, const StringPimpl &userId, const StringPimpl &botId, const StringPimpl &endUserId)
	After each AIML file is parsed, this method is called.
void	filePreLoad (const StringPimpl &fileName, const StringPimpl &userId, const StringPimpl &botId, const StringPimpl &endUserId)
	Before each AIML file is parsed this method is called.
void	infiniteSymbolicReduction (const StringPimpl &userId, const StringPimpl &botId, const StringPimpl &endUserId)
	A infinite symbolic reduction has occured and has been terminated.
virtual void	inputTagNumericConversionError (const StringPimpl &message, const StringPimpl &userId, const StringPimpl &botId, const StringPimpl &endUserId)
	A AIML "Input" tag has a non number in its index attribute.
virtual void	inputTagSizeExceeded (const StringPimpl &userId, const StringPimpl &botId, const StringPimpl &endUserId)
	During runtime, the "input" AIML tag's size is exceeded.
virtual void	starTagNumericConversionError (const StringPimpl &message, const StringPimpl &userId, const StringPimpl &botId, const StringPimpl &endUserId)
	A AIML "Star" tag has a non number in its index attribute.
virtual void	starTagSizeExceeded (const StringPimpl &userId, const StringPimpl &botId, const StringPimpl &endUserId)
	During runtime, the "star" AIML tag's size is exceeded.
void	storeGossip (const StringPimpl &gossip, const StringPimpl &userId, const StringPimpl &botId, const StringPimpl &endUserId)
	This is called for each AIML "Gossip" tag.
void	symbolicReduction (const StringPimpl &symbol, const StringPimpl &userId, const StringPimpl &botId, const StringPimpl &endUserId)
	When the "srai" AIML tag is called, the text is sent to this method.
virtual void	thatStarTagNumericConversionError (const StringPimpl &message, const StringPimpl &userId, const StringPimpl &botId, const StringPimpl &endUserId)
	A AIML "thatStar" tag has a non number in its index attribute.
virtual void	thatStarTagSizeExceeded (const StringPimpl &userId, const StringPimpl &botId, const StringPimpl &endUserId)
	During runtime, the "thatStar" AIML tag's size is exceeded.
virtual void	thatTagNumericConversionError (const StringPimpl &message, const StringPimpl &userId, const StringPimpl &botId, const StringPimpl &endUserId)
	A AIML "That" tag has a non number in its index attribute.
virtual void	thatTagSizeExceeded (const StringPimpl &userId, const StringPimpl &botId, const StringPimpl &endUserId)
	During runtime, the "that" AIML tag's size is exceeded.
virtual void	topicStarTagNumericConversionError (const StringPimpl &message, const StringPimpl &userId, const StringPimpl &botId, const StringPimpl &endUserId)
	A AIML "TopicStar" tag has a non number in its index attribute.
virtual void	topicStarTagSizeExceeded (const StringPimpl &userId, const StringPimpl &botId, const StringPimpl &endUserId)
	During runtime, the "topicStar" AIML tag's size is exceeded.
virtual void	XMLParseError (const StringPimpl &message, const StringPimpl &userId, const StringPimpl &botId, const StringPimpl &endUserId)
	Sends you a message about a XMLParseError.
virtual void	XMLParseFatalError (const StringPimpl &message, const StringPimpl &userId, const StringPimpl &botId, const StringPimpl &endUserId)
	Sends you a message about a XMLParseFatalError.
virtual void	XMLParseWarning (const StringPimpl &message, const StringPimpl &userId, const StringPimpl &botId, const StringPimpl &endUserId)
	Sends you a message about a XMLParseWarning.

---

Detailed Description

My Custom CallBacks class.

This class inherits from Rebecca's CallBacks class and implements the callbacks for error reporting and informational reporting purposes.

Although, I pain stakenly reimplemnt every single method, you don't have to. Just pick and choose which ones you want to implement, and ignore the rest. All of the methods of CallBacks has a default do nothing implementation.

---

Member Function Documentation

void categoryLoaded	(	const StringPimpl &	userId,
		const StringPimpl &	botId,
		const StringPimpl &	endUserId
	)			[inline]

This is called for each AIML category that is loaded into memory.

Parameters:

	userId	The user that caused this
	botId	The bot that caused this
	endUserId	The end user that caused this

Loadtime occurs whenver the call GraphBuilder::createGraph() is made. For every 5000 categories loaded into Rebecca's internal data structure this prints a output message about it.

void filePostLoad	(	const StringPimpl &	fileName,
		const StringPimpl &	userId,
		const StringPimpl &	botId,
		const StringPimpl &	endUserId
	)			[inline]

After each AIML file is parsed, this method is called.

Parameters:

	userId	The user that caused this
	botId	The bot that caused this
	endUserId	The end user that caused this
	fileName	The name of the file just parsed.

void filePreLoad	(	const StringPimpl &	fileName,
		const StringPimpl &	userId,
		const StringPimpl &	botId,
		const StringPimpl &	endUserId
	)			[inline]

Before each AIML file is parsed this method is called.

Parameters:

	userId	The user that caused this
	botId	The bot that caused this
	endUserId	The end user that caused this
	fileName	The name of the file about to be parsed.

void infiniteSymbolicReduction	(	const StringPimpl &	userId,
		const StringPimpl &	botId,
		const StringPimpl &	endUserId
	)			[inline]

A infinite symbolic reduction has occured and has been terminated.

This method is called when symbolic reduction ends up in a infinite loop and has been terminated. This is just to alert you to the fact.

Parameters:

	userId	The user that caused this
	botId	The bot that caused this
	endUserId	The end user that caused this

virtual void inputTagNumericConversionError	(	const StringPimpl &	message,
		const StringPimpl &	userId,
		const StringPimpl &	botId,
		const StringPimpl &	endUserId
	)			[inline, virtual]

A AIML "Input" tag has a non number in its index attribute.

This method will only be called during loadtime, GraphBuilder::createGraph().

Parameters:

	message	The human readable message.
	userId	The user that caused this
	botId	The bot that caused this
	endUserId	The end user that caused this

virtual void inputTagSizeExceeded	(	const StringPimpl &	userId,
		const StringPimpl &	botId,
		const StringPimpl &	endUserId
	)			[inline, virtual]

During runtime, the "input" AIML tag's size is exceeded.

Runtime is during a call to GraphBuilder::getResponse()

Parameters:

	userId	The user that caused this
	botId	The bot that caused this
	endUserId	The end user that caused this

virtual void starTagNumericConversionError	(	const StringPimpl &	message,
		const StringPimpl &	userId,
		const StringPimpl &	botId,
		const StringPimpl &	endUserId
	)			[inline, virtual]

A AIML "Star" tag has a non number in its index attribute.

This method will only be called during loadtime, GraphBuilder::createGraph().

Parameters:

	message	The human readable message.
	userId	The user that caused this
	botId	The bot that caused this
	endUserId	The end user that caused this

virtual void starTagSizeExceeded	(	const StringPimpl &	userId,
		const StringPimpl &	botId,
		const StringPimpl &	endUserId
	)			[inline, virtual]

During runtime, the "star" AIML tag's size is exceeded.

Runtime is during a call to GraphBuilder::getResponse()

Parameters:

	userId	The user that caused this
	botId	The bot that caused this
	endUserId	The end user that caused this

void storeGossip	(	const StringPimpl &	gossip,
		const StringPimpl &	userId,
		const StringPimpl &	botId,
		const StringPimpl &	endUserId
	)			[inline]

This is called for each AIML "Gossip" tag.

I am just printing out the gossip. You can do other things like store it in a file and then reload the file at startup as a type of persistance.

Parameters:

	userId	The user that caused this
	botId	The bot that caused this
	endUserId	The end user that caused this
	gossip	The gossip sent to be stored as you see fit

void symbolicReduction	(	const StringPimpl &	symbol,
		const StringPimpl &	userId,
		const StringPimpl &	botId,
		const StringPimpl &	endUserId
	)			[inline]

When the "srai" AIML tag is called, the text is sent to this method.

Usually refered to as symbolic reduction, you can see what text is being re-fed back into the AIML GraphBuilder::getResponse() by AIML its self.

Parameters:

	userId	The user that caused this
	botId	The bot that caused this
	endUserId	The end user that caused this
	symbol	The text which is being sent back into GraphBuilder::getResponse().

virtual void thatStarTagNumericConversionError	(	const StringPimpl &	message,
		const StringPimpl &	userId,
		const StringPimpl &	botId,
		const StringPimpl &	endUserId
	)			[inline, virtual]

A AIML "thatStar" tag has a non number in its index attribute.

This method will only be called during loadtime, GraphBuilder::createGraph().

Parameters:

	message	The human readable message.
	userId	The user that caused this
	botId	The bot that caused this
	endUserId	The end user that caused this

virtual void thatStarTagSizeExceeded	(	const StringPimpl &	userId,
		const StringPimpl &	botId,
		const StringPimpl &	endUserId
	)			[inline, virtual]

During runtime, the "thatStar" AIML tag's size is exceeded.

Runtime is during a call to GraphBuilder::getResponse()

Parameters:

	userId	The user that caused this
	botId	The bot that caused this
	endUserId	The end user that caused this

virtual void thatTagNumericConversionError	(	const StringPimpl &	message,
		const StringPimpl &	userId,
		const StringPimpl &	botId,
		const StringPimpl &	endUserId
	)			[inline, virtual]

A AIML "That" tag has a non number in its index attribute.

This method will only be called during loadtime, GraphBuilder::createGraph().

Parameters:

	message	The human readable message.
	userId	The user that caused this
	botId	The bot that caused this
	endUserId	The end user that caused this

virtual void thatTagSizeExceeded	(	const StringPimpl &	userId,
		const StringPimpl &	botId,
		const StringPimpl &	endUserId
	)			[inline, virtual]

During runtime, the "that" AIML tag's size is exceeded.

Runtime is during a call to GraphBuilder::getResponse()

Parameters:

	userId	The user that caused this
	botId	The bot that caused this
	endUserId	The end user that caused this

virtual void topicStarTagNumericConversionError	(	const StringPimpl &	message,
		const StringPimpl &	userId,
		const StringPimpl &	botId,
		const StringPimpl &	endUserId
	)			[inline, virtual]

A AIML "TopicStar" tag has a non number in its index attribute.

This method will only be called during loadtime, GraphBuilder::createGraph().

Parameters:

	message	The human readable message.
	userId	The user that caused this
	botId	The bot that caused this
	endUserId	The end user that caused this

virtual void topicStarTagSizeExceeded	(	const StringPimpl &	userId,
		const StringPimpl &	botId,
		const StringPimpl &	endUserId
	)			[inline, virtual]

During runtime, the "topicStar" AIML tag's size is exceeded.

Runtime is during a call to GraphBuilder::getResponse()

Parameters:

	userId	The user that caused this
	botId	The bot that caused this
	endUserId	The end user that caused this

virtual void XMLParseError	(	const StringPimpl &	message,
		const StringPimpl &	userId,
		const StringPimpl &	botId,
		const StringPimpl &	endUserId
	)			[inline, virtual]

Sends you a message about a XMLParseError.

Either with AIML files or RebeccaAIML configuration files.

Parameters:

	userId	The user that caused this
	botId	The bot that caused this
	endUserId	The end user that caused this
	message	The human readable message.

virtual void XMLParseFatalError	(	const StringPimpl &	message,
		const StringPimpl &	userId,
		const StringPimpl &	botId,
		const StringPimpl &	endUserId
	)			[inline, virtual]

Sends you a message about a XMLParseFatalError.

Either with AIML files or RebeccaAIML configuration files.

Parameters:

	userId	The user that caused this
	botId	The bot that caused this
	endUserId	The end user that caused this
	message	The human readable message.

virtual void XMLParseWarning	(	const StringPimpl &	message,
		const StringPimpl &	userId,
		const StringPimpl &	botId,
		const StringPimpl &	endUserId
	)			[inline, virtual]

Sends you a message about a XMLParseWarning.

Either with AIML files or RebeccaAIML configuration files.

Parameters:

	message	The human readable message.
	userId	The user that caused this
	botId	The bot that caused this
	endUserId	The end user that caused this

---

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

• C:/rebecca/src/samples/console/console.cpp

---