Menu
▾
▴
[Rccparser-commits] CVS: rccparser/src rccparser.h,1.28,1.29
|
From: Tom H. <tom...@us...> - 2003-03-20 11:58:52
|
Update of /cvsroot/rccparser/rccparser/src
In directory sc8-pr-cvs1:/tmp/cvs-serv2048/src
Modified Files:
rccparser.h
Log Message:
2003-03-20 Tom Howard <tom...@us...>
* ./src/rccparser.h
Added more docs
Index: rccparser.h
===================================================================
RCS file: /cvsroot/rccparser/rccparser/src/rccparser.h,v
retrieving revision 1.28
retrieving revision 1.29
diff -C2 -d -r1.28 -r1.29
*** rccparser.h 19 Mar 2003 18:40:34 -0000 1.28
--- rccparser.h 20 Mar 2003 11:58:49 -0000 1.29
***************
*** 7578,7582 ****
*
* \pre An entire illegal mode
! * message has been parsed.
*
*/
--- 7578,7582 ----
*
* \pre An entire illegal mode
! * error message has been parsed.
*
*/
***************
*** 7598,7602 ****
*
* \pre An entire illegal object form
! * message has been parsed.
*
*/
--- 7598,7602 ----
*
* \pre An entire illegal object form
! * error message has been parsed.
*
*/
***************
*** 7605,7640 ****
--- 7605,7775 ----
doBuildIllegalObjectFormError() {}
+ /** This function is called after parsing a said too many freeform
+ * error message.
+ *
+ * Override this function in your subclass to handle
+ * said too many freeform error messages.
+ *
+ * \pre The client is an online coach
+ *
+ * \pre The client has sent a freeform CLang message and exceeded
+ * it's current quota
+ *
+ * \pre An entire said too many freeform
+ * error message has been parsed.
+ *
+ */
virtual
void
doBuildSaidTooManyFreeformMessagesError() {}
+ /** This function is called after parsing a cannot say freeform
+ * error message.
+ *
+ * Override this function in your subclass to handle
+ * cannot say freeform error messages.
+ *
+ * \pre The client is an online coach
+ *
+ * \pre The client has sent a freeform CLang message and the playmode
+ * is playon.
+ *
+ * \pre An entire cannot say freeform
+ * error message has been parsed.
+ *
+ */
virtual
void
doBuildCannotSayFreeformWhilePlayonError() {}
+ /** This function is called after parsing a said too many meta
+ * error message.
+ *
+ * Override this function in your subclass to handle
+ * said too many meta error messages.
+ *
+ * \pre The client is an online coach
+ *
+ * \pre The client has sent a meta CLang message and exceeded
+ * it's current quota
+ *
+ * \pre An entire said too many meta
+ * error message has been parsed.
+ *
+ */
virtual
void
doBuildSaidTooManyMetaMessagesError() {}
+ /** This function is called after parsing a said too many advice
+ * error message.
+ *
+ * Override this function in your subclass to handle
+ * said too many advice error messages.
+ *
+ * \pre The client is an online coach
+ *
+ * \pre The client has sent a advice CLang message and exceeded
+ * it's current quota
+ *
+ * \pre An entire said too many advice
+ * error message has been parsed.
+ *
+ */
virtual
void
doBuildSaidTooManyAdviceMessagesError() {}
+ /** This function is called after parsing a said too many info
+ * error message.
+ *
+ * Override this function in your subclass to handle
+ * said too many info error messages.
+ *
+ * \pre The client is an online coach
+ *
+ * \pre The client has sent a info CLang message and exceeded
+ * it's current quota
+ *
+ * \pre An entire said too many info
+ * error message has been parsed.
+ *
+ */
virtual
void
doBuildSaidTooManyInfoMessagesError() {}
+ /** This function is called after parsing a said too many define
+ * error message.
+ *
+ * Override this function in your subclass to handle
+ * said too many define error messages.
+ *
+ * \pre The client is an online coach
+ *
+ * \pre The client has sent a define CLang message and exceeded
+ * it's current quota
+ *
+ * \pre An entire said too many define
+ * error message has been parsed.
+ *
+ */
virtual
void
doBuildSaidTooManyDefineMessagesError() {}
+ /** This function is called after parsing a cound not parse say
+ * error message.
+ *
+ * Override this function in your subclass to handle
+ * cound not parse say error messages.
+ *
+ * \pre The client is an online coach
+ *
+ * \pre The client has sent a malformed CLang message
+ *
+ * \pre An entire cound not parse say
+ * error message has been parsed.
+ *
+ */
virtual
void
doBuildCouldNotParseSayError() {}
+ /** This function is called after parsing a said too many
+ * error message.
+ *
+ * Override this function in your subclass to handle
+ * said too many error messages.
+ *
+ * \pre The client is an online coach
+ *
+ * \pre The client is using a pre version 7 protocol (this isn't
+ * actually supported with this parser)
+ *
+ * \pre An entire said too many
+ * error message has been parsed.
+ *
+ */
virtual
void
doBuildSaidTooManyMessagesError() {}
+ /** This function is called after parsing an unknown
+ * error message.
+ *
+ * Override this function in your subclass to handle
+ * unknown error messages.
+ *
+ * Unknown error message only occur when the parser is used with a
+ * newer version of the simulator and the parser has not been
+ * updated. By using this function you can provide support in your
+ * teams for new error messages without having to wait for the parser
+ * to be upgraded.
+ *
+ * \pre An entire unknown erro
+ * message has been parsed.
+ *
+ */
virtual
void
|
