Simbody  3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
SimTK::Exception::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 SimTK::Exception::APIArgcheckFailed:

Public Member Functions

 APIArgcheckFailed (const char *fn, int ln, const char *assertion, const char *className, const char *methodName, const char *fmt...)
 
virtual ~APIArgcheckFailed () throw ()
 
- Public Member Functions inherited from SimTK::Exception::Base
 Base (const char *fn="<UNKNOWN>", int ln=0)
 
virtual ~Base () throw ()
 
const std::string & getMessage () const
 
const std::string & getMessageText () const
 
const char * what () const throw ()
 

Additional Inherited Members

- Protected Member Functions inherited from SimTK::Exception::Base
void setMessage (const std::string &msgin)
 

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

SimTK::Exception::APIArgcheckFailed::APIArgcheckFailed ( const char *  fn,
int  ln,
const char *  assertion,
const char *  className,
const char *  methodName,
const char *  fmt... 
)
inline
virtual SimTK::Exception::APIArgcheckFailed::~APIArgcheckFailed ( )
throw (
)
inlinevirtual
The documentation for this class was generated from the following file: