APIArgcheckFailed Class Reference

This is for reporting problems detected by checking the caller's supplied arguments to a SimTK API method. More...

#include <Exception.h>

Inheritance diagram for APIArgcheckFailed:

List of all members.

Public Member Functions
	APIArgcheckFailed (const char *fn, int ln, const char *assertion, const char *className, const char *methodName, const char *fmt...)

---

Detailed Description

This is for reporting problems detected by checking the caller's supplied arguments to a SimTK API method.

Messages should be suitable for SimTK API users. This is not intended for detection of internal bugs where a SimTK developer passed bad arguments to some internal routine -- use Assert instead for that. The exception message accepts printf-style arguments and should contain useful information for the API user. Don't throw this exception directly; use one of the family SimTK_APIARGCHECK and SimTK_APIARGCHECK_ALWAYS macros.

---

Constructor & Destructor Documentation

APIArgcheckFailed	(	const char *	fn,
		int	ln,
		const char *	assertion,
		const char *	className,
		const char *	methodName,
		const char *	fmt...
	)			[inline]

References Base::setMessage().

---

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

• Exception.h