CustomError Class Reference

Advanced version of UserError that allows to send a full custom message. More...

#include "PyExceptions.h"

Inheritance diagram for CustomError:

Collaboration diagram for CustomError:

Public Member Functions
	CustomError (const char *message,...)
Public Member Functions inherited from UserError
	UserError (const char *exceptionType)
UserError &	AddFormatValue (const char *name, PyRep *value)
	Fluent version of the protected AddKeyword, allows for adding a keyword to the exception. More...
UserError &	AddDateTime (const char *name, time_t date)
	Shorthand method for adding the given date-time as a datetime string in the message. More...
UserError &	AddDate (const char *name, time_t date)
	Shorthand method for adding the given date time as a date string in the message. More...
UserError &	AddTime (const char *name, time_t time)
	Shorthand method for adding the given date time as a time string in the message. More...
UserError &	AddTimeShort (const char *name, time_t time)
	Shorthand method for adding the given time as a time string in the message (without minutes) More...
UserError &	AddA (const char *name, const char *value)
	Shorthand method for adding "a" before the beginning of the value. More...
UserError &	AddThe (const char *name, const char *value)
	Shorthand method for adding "the" before the beginning of the value. More...
UserError &	AddUELocalization (const char *name, const char *strKey, PyDict *args=nullptr)
	Shorthand method for adding a string in the client's translations. More...
UserError &	AddList (const char *name, PyList *listEntries, const char *separator=nullptr)
	Shorthand method for adding a list of format parameters. More...
UserError &	AddOwnerName (const char *name, uint32 ownerID)
	Shorthand method for adding an owner's name. More...
UserError &	AddOwnerNick (const char *name, uint32 ownerID)
	Shorthand method for adding an owner's nick (first name without surname) More...
UserError &	AddLocationName (const char *name, uint32 locationID)
	Shorthand method for adding a location's name. More...
UserError &	AddTypeName (const char *name, uint32 typeID)
	Shorthand method for adding a type's name. More...
UserError &	AddTypeDescription (const char *name, uint32 typeID)
	Shorthand method for adding a type's description. More...
UserError &	AddTypeList (const char *name, PyList *typeIDs)
	Shorthand method for adding a list of types' names. More...
UserError &	AddBlueprintTypeName (const char *name, uint32 bpTypeID)
	Shorthand method for adding a blueprint's type name. More...
UserError &	AddGroupName (const char *name, uint32 groupID)
	Shorthand method for adding a group's name. More...
UserError &	AddGroupDescription (const char *name, uint32 groupID)
	Shorthand method for adding a group's description. More...
UserError &	AddCategoryName (const char *name, uint32 categoryID)
	Shorthand method for adding a category's name. More...
UserError &	AddCategoryDescription (const char *name, uint32 categoryID)
	Shorthand method for adding a category's description. More...
UserError &	AddAmount (const char *name, int quantity)
	Shorthand method for adding a quantity value. More...
UserError &	AddAmount (const char *name, uint quantity)
	Shorthand method for adding a quantity value. More...
UserError &	AddAmount (const char *name, double quantity)
	Shorthand method for adding a quantity value. More...
UserError &	AddISK (const char *name, double isk)
	Shorthand method for adding an ISK amount. More...
UserError &	AddAUR (const char *name, double aur)
	Shorthand method for adding an AUR amount. More...
UserError &	AddDistance (const char *name, double distance)
	Shorthand method for adding distance in a easy to read unit. More...
UserError &	AddTypeIDAndQuantity (const char *name, uint32 typeID, int quantity)
	Shorthand method for adding type ID and quantity. More...
Public Member Functions inherited from PyException
	PyException (PyRep *except)
	PyException (const PyException &oth)
	~PyException ()
PyException &	operator= (const PyException &oth)

Static Private Attributes
static const char *	EXCEPTION_NAME = "CustomError"

Additional Inherited Members
Public Attributes inherited from PyException
PyRep *	ssException
Protected Member Functions inherited from UserError
void	AddKeyword (const char *name, PyRep *value)
	Adds keyword to exception. More...
UserError &	AddParameterKeyword (const char *name, UserError_ParameterIDs type, PyRep *value, PyRep *value2=nullptr)
	Adds a keyword to exception. More...
PyDict *	_GetTupleKeywords () const
PyDict *	_GetDictKeywords () const
PyTuple *	_CreateArgs (const char *msg)
PyDict *	_CreateKeywords (const char *msg)
Protected Attributes inherited from UserError
PyTuple *	m_args
PyDict *	m_keywords
Static Protected Attributes inherited from UserError
static const char *	EXCEPTION_NAME = "ccp_exceptions.UserError"

Detailed Description

Advanced version of UserError that allows to send a full custom message.

Shorthand version of UserError with fully customizable message

Author

almamu almam.nosp@m.u@al.nosp@m.mamu..nosp@m.com

Definition at line 453 of file PyExceptions.h.

Constructor & Destructor Documentation

CustomError::CustomError	(	const char *	message,
			...
	)

Initializes a CustomError with the given message

Parameters

[in]	message	The message to send to the client
[in]	...	Format arguments to the message

Definition at line 294 of file PyExceptions.cpp.

References UserError::AddFormatValue(), SafeFree(), and vasprintf().

: UserError (EXCEPTION_NAME)
{
    va_list va;
    va_start (va, fmt);

    char* str = nullptr;
    vasprintf (&str, fmt, va);
    assert (str);

    va_end (va);

    this->AddFormatValue ("error", new PyString (str));

    SafeFree (str);
}

Here is the call graph for this function:

Member Data Documentation

const char * CustomError::EXCEPTION_NAME = "CustomError"

staticprivate

Definition at line 463 of file PyExceptions.h.

---

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

• /backups/local/src/eve/EvEmu_Crucible/src/eve-common/python/classes/PyExceptions.h
• /backups/local/src/eve/EvEmu_Crucible/src/eve-common/python/classes/PyExceptions.cpp