UserError Class Reference

Python object "ccp_exceptions.UserError". More...

#include "PyExceptions.h"

Inheritance diagram for UserError:

Collaboration diagram for UserError:

Public Member Functions
	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)

Protected Member Functions
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
PyTuple *	m_args
PyDict *	m_keywords

Static Protected Attributes
static const char *	EXCEPTION_NAME = "ccp_exceptions.UserError"

Additional Inherited Members
Public Attributes inherited from PyException
PyRep *	ssException

Detailed Description

Python object "ccp_exceptions.UserError".

This exception can be used for various errors.

Author

Bloody.Rabbit

Definition at line 121 of file PyExceptions.h.

Constructor & Destructor Documentation

UserError::UserError

(

const char *

exceptionType

)

Definition at line 97 of file PyExceptions.cpp.

: PyException (new PyObjectEx_Type1 (new PyToken (EXCEPTION_NAME), _CreateArgs (exceptionType), _CreateKeywords (exceptionType)))
{
}

Member Function Documentation

PyTuple * UserError::_CreateArgs ( const char *  msg )

protected

Definition at line 274 of file PyExceptions.cpp.

References m_args, and PyTuple::SetItem().

{
    this->m_args = new PyTuple (2);

    this->m_args->SetItem (0, new PyString (msg));
    this->m_args->SetItem (1, new PyDict);

    return this->m_args;
}

Here is the call graph for this function:

PyDict * UserError::_CreateKeywords ( const char *  msg )

protected

Definition at line 284 of file PyExceptions.cpp.

References m_keywords, and PyDict::SetItemString().

{
    this->m_keywords = new PyDict;

    this->m_keywords->SetItemString ("msg", new PyString (msg));
    this->m_keywords->SetItemString ("dict", new PyDict);

    return this->m_keywords;
}

Here is the call graph for this function:

PyDict * UserError::_GetDictKeywords ( ) const

protected

Definition at line 269 of file PyExceptions.cpp.

References PyRep::AsDict(), PyDict::GetItemString(), and m_keywords.

Referenced by AddKeyword().

{
    return this->m_keywords->GetItemString ("dict")->AsDict ();
}

Here is the call graph for this function:

Here is the caller graph for this function:

PyDict * UserError::_GetTupleKeywords ( ) const

protected

Definition at line 264 of file PyExceptions.cpp.

References PyRep::AsDict(), PyTuple::GetItem(), and m_args.

Referenced by AddKeyword().

{
    return this->m_args->GetItem (1)->AsDict();
}

Here is the call graph for this function:

Here is the caller graph for this function:

UserError & UserError::AddA	(	const char *	name,
		const char *	value
	)

Shorthand method for adding "a" before the beginning of the value.

Specially useful for things like "you need a Shield hardener" type of messages

Parameters

[in]	name	The parameter
[in]	value	The value to display after "a/an"

Returns

self

Definition at line 141 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_A.

{
    return this->AddParameterKeyword (name, UserError_Parameter_A, new PyString (value));
}

Here is the call graph for this function:

UserError & UserError::AddAmount	(	const char *	name,
		int	quantity
	)

Shorthand method for adding a quantity value.

Parameters

[in]	name	The parameter
[in]	quantity	The quantity for the client to format

Returns

self

Definition at line 219 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_Amount.

Referenced by StructureSE::Activate(), RamMethods::JobsCheck(), and Inventory::ValidateAddItem().

{
    return this->AddParameterKeyword (name, UserError_Parameter_Amount, new PyInt (quantity));
}

Here is the call graph for this function:

Here is the caller graph for this function:

UserError & UserError::AddAmount	(	const char *	name,
		uint	quantity
	)

Shorthand method for adding a quantity value.

Parameters

[in]	name	The parameter
[in]	quantity	The quantity for the client to format

Returns

self

Definition at line 224 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_Amount.

{
    return this->AddParameterKeyword (name, UserError_Parameter_Amount, new PyInt (quantity));
}

Here is the call graph for this function:

UserError & UserError::AddAmount	(	const char *	name,
		double	quantity
	)

Shorthand method for adding a quantity value.

Parameters

[in]	name	The parameter
[in]	amount	The quantity for the client to format

Returns

self

Definition at line 229 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_Amount.

{
    return this->AddParameterKeyword (name, UserError_Parameter_Amount, new PyFloat (quantity));
}

Here is the call graph for this function:

UserError & UserError::AddAUR	(	const char *	name,
		double	aur
	)

Shorthand method for adding an AUR amount.

Parameters

[in]	name	The parameter
[in]	aur	The AUR quantity for the client to format

Returns

self

Definition at line 239 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_AUR.

{
    return this->AddParameterKeyword (name, UserError_Parameter_AUR, new PyFloat (aur));
}

Here is the call graph for this function:

UserError & UserError::AddBlueprintTypeName	(	const char *	name,
		uint32	bpTypeID
	)

Shorthand method for adding a blueprint's type name.

Parameters

[in]	name	The parameter
[in]	typeID	The blueprint's type ID

Returns

self

Definition at line 194 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_BluePrintTypeName.

{
    return this->AddParameterKeyword (name, UserError_Parameter_BluePrintTypeName, new PyInt (bpTypeID));
}

Here is the call graph for this function:

UserError & UserError::AddCategoryDescription	(	const char *	name,
		uint32	categoryID
	)

Shorthand method for adding a category's description.

Parameters

[in]	name	The parameter
[in]	typeID	The category's ID

Returns

self

Definition at line 214 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_CategoryDescription.

{
    return this->AddParameterKeyword (name, UserError_Parameter_CategoryDescription, new PyInt (categoryID));
}

Here is the call graph for this function:

UserError & UserError::AddCategoryName	(	const char *	name,
		uint32	categoryID
	)

Shorthand method for adding a category's name.

Parameters

[in]	name	The parameter
[in]	typeID	The category's ID

Returns

self

Definition at line 209 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_CategoryName.

{
    return this->AddParameterKeyword (name, UserError_Parameter_CategoryName, new PyInt (categoryID));
}

Here is the call graph for this function:

UserError & UserError::AddDate	(	const char *	name,
		time_t	date
	)

Shorthand method for adding the given date time as a date string in the message.

Parameters

[in]	name	The parameter
[in]	date	The date in win32 epoch format

Returns

self

Definition at line 127 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_Date.

{
    return this->AddParameterKeyword (name, UserError_Parameter_Date, new PyLong (date));
}

Here is the call graph for this function:

UserError & UserError::AddDateTime	(	const char *	name,
		time_t	date
	)

Shorthand method for adding the given date-time as a datetime string in the message.

Parameters

[in]	name	The parameter
[in]	date	The date in win32 epoch format

Returns

self

Definition at line 122 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_DateTime.

{
    return this->AddParameterKeyword (name, UserError_Parameter_DateTime, new PyLong (date));
}

Here is the call graph for this function:

UserError & UserError::AddDistance	(	const char *	name,
		double	distance
	)

Shorthand method for adding distance in a easy to read unit.

Parameters

[in]	name	The parameter
[in]	distance	The distance for the client to format (in meters)

Returns

self

Definition at line 244 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_Distance.

{
    return this->AddParameterKeyword (name, UserError_Parameter_Distance, new PyFloat (distance));
}

Here is the call graph for this function:

UserError & UserError::AddFormatValue	(	const char *	name,
		PyRep *	value
	)

Fluent version of the protected AddKeyword, allows for adding a keyword to the exception.

Keywords are simple parameters used to replace a specific part of the message string. These parameters are defined in the string itself in the form of %(name)s

Parameters

[in]	name	The parameter
[in]	value	The value

Returns

self

Definition at line 102 of file PyExceptions.cpp.

References AddKeyword().

Referenced by StructureSE::Activate(), AddParameterKeyword(), ActiveModule::CanActivate(), CustomError::CustomError(), CommandDispatcher::Execute(), MarketMgr::ExecuteBuyOrder(), AccountService::HandleCorpTransaction(), ShipItem::LoadCharge(), RamMethods::MaterialSkillsCheck(), RamMethods::ProductionTimeCheck(), ShipItem::TryModuleLimitChecks(), and Inventory::ValidateAddItem().

{
    this->AddKeyword (name, value);

    return *this;
}

Here is the call graph for this function:

Here is the caller graph for this function:

UserError & UserError::AddGroupDescription	(	const char *	name,
		uint32	groupID
	)

Shorthand method for adding a group's description.

Parameters

[in]	name	The parameter
[in]	typeID	The group's ID

Returns

self

Definition at line 204 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_GroupDescription.

{
    return this->AddParameterKeyword (name, UserError_Parameter_GroupDescription, new PyInt (groupID));
}

Here is the call graph for this function:

UserError & UserError::AddGroupName	(	const char *	name,
		uint32	groupID
	)

Shorthand method for adding a group's name.

Parameters

[in]	name	The parameter
[in]	typeID	The group's ID

Returns

self

Definition at line 199 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_GroupName.

{
    return this->AddParameterKeyword (name, UserError_Parameter_GroupName, new PyInt (groupID));
}

Here is the call graph for this function:

UserError & UserError::AddISK	(	const char *	name,
		double	isk
	)

Shorthand method for adding an ISK amount.

Parameters

[in]	name	The parameter
[in]	isk	The ISK quantity for the client to format

Returns

self

Definition at line 234 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_ISK.

Referenced by Character::AlterBalance(), and AccountService::HandleCorpTransaction().

{
    return this->AddParameterKeyword (name, UserError_Parameter_ISK, new PyFloat (isk));
}

Here is the call graph for this function:

Here is the caller graph for this function:

void UserError::AddKeyword ( const char *  name, PyRep *  value  )

protected

Adds keyword to exception.

Parameters

[in]	name	The keyword.
[in]	value	Value to be associated with the keyword.

Definition at line 254 of file PyExceptions.cpp.

References _GetDictKeywords(), _GetTupleKeywords(), PyIncRef, and PyDict::SetItemString().

Referenced by AddFormatValue().

{
    // We need 2 refs ... the first one is given to us,
    // but we must create the second one ...
    PyIncRef( value );

    _GetTupleKeywords()->SetItemString( name, value );
    _GetDictKeywords()->SetItemString( name, value );
}

Here is the call graph for this function:

Here is the caller graph for this function:

UserError & UserError::AddList	(	const char *	name,
		PyList *	listEntries,
		const char *	separator = nullptr
	)

Shorthand method for adding a list of format parameters.

TODO: OFFER A WAY OF GENERATING listEntries AS THAT CAN ALSO HAVE FORMAT PARAMETERS LIKE THE USERERROR CLASS

Parameters

[in]	name	The parameter
[in]	listEntries	The list of data to concatenate
[in]	separator	The separator to use (if any), uses the language's default if not specified

Returns

self

Definition at line 156 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_List.

{
    if (separator == nullptr)
        return this->AddParameterKeyword (name, UserError_Parameter_List, listEntries);
    else
        return this->AddParameterKeyword (name, UserError_Parameter_List, listEntries, new PyString (separator));
}

Here is the call graph for this function:

UserError & UserError::AddLocationName	(	const char *	name,
		uint32	locationID
	)

Shorthand method for adding a location's name.

Parameters

[in]	name	The parameter
[in]	locationID	The location's ID

Returns

self

Definition at line 174 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_LocationName.

Referenced by RamMethods::ItemLocationCheck(), and Inventory::ValidateAddItem().

{
    return this->AddParameterKeyword (name, UserError_Parameter_LocationName, new PyLong (locationID));
}

Here is the call graph for this function:

Here is the caller graph for this function:

UserError & UserError::AddOwnerName	(	const char *	name,
		uint32	ownerID
	)

Shorthand method for adding an owner's name.

Parameters

[in]	name	The parameter
[in]	ownerID	The owner's ID

Returns

self

Definition at line 164 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_OwnerName.

Referenced by AccountService::HandleCorpTransaction().

{
    return this->AddParameterKeyword (name, UserError_Parameter_OwnerName, new PyLong (ownerID));
}

Here is the call graph for this function:

Here is the caller graph for this function:

UserError & UserError::AddOwnerNick	(	const char *	name,
		uint32	ownerID
	)

Shorthand method for adding an owner's nick (first name without surname)

Parameters

[in]	name	The parameter
[in]	ownerID	The owner's ID

Returns

self

Definition at line 169 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_OwnerNick.

{
    return this->AddParameterKeyword (name, UserError_Parameter_OwnerNick, new PyLong (ownerID));
}

Here is the call graph for this function:

UserError & UserError::AddParameterKeyword ( const char *  name, UserError_ParameterIDs  type, PyRep *  value, PyRep *  value2 = nullptr  )

protected

Adds a keyword to exception.

Shorthand method for any of the Add* values

Parameters

[in]	name	The keyword
[in]	type	Type of parameter to send
[in]	value	The parameter's value
[in]	value2	The second value (if present)

Returns

self

Definition at line 109 of file PyExceptions.cpp.

References AddFormatValue(), and PyTuple::SetItem().

Referenced by AddA(), AddAmount(), AddAUR(), AddBlueprintTypeName(), AddCategoryDescription(), AddCategoryName(), AddDate(), AddDateTime(), AddDistance(), AddGroupDescription(), AddGroupName(), AddISK(), AddList(), AddLocationName(), AddOwnerName(), AddOwnerNick(), AddThe(), AddTime(), AddTimeShort(), AddTypeDescription(), AddTypeIDAndQuantity(), AddTypeList(), AddTypeName(), and AddUELocalization().

{
    PyTuple* param = new PyTuple (value2 == nullptr ? 2 : 3);

    param->SetItem (0, new PyInt (type));
    param->SetItem (1, value);

    if (value2 != nullptr)
        param->SetItem (2, value2);

    return this->AddFormatValue (name, param);
}

Here is the call graph for this function:

Here is the caller graph for this function:

UserError & UserError::AddThe	(	const char *	name,
		const char *	value
	)

Shorthand method for adding "the" before the beginning of the value.

Parameters

[in]	name	The parameter
[in]	value	The value to display after "the"

Returns

self

Definition at line 146 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_The.

{
    return this->AddParameterKeyword (name, UserError_Parameter_The, new PyString (value));
}

Here is the call graph for this function:

UserError & UserError::AddTime	(	const char *	name,
		time_t	time
	)

Shorthand method for adding the given date time as a time string in the message.

Parameters

[in]	name	The parameter
[in]	time	The date in win32 epoch format

Returns

self

Definition at line 132 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_Time.

{
    return this->AddParameterKeyword (name, UserError_Parameter_Time, new PyLong (time));
}

Here is the call graph for this function:

UserError & UserError::AddTimeShort	(	const char *	name,
		time_t	time
	)

Shorthand method for adding the given time as a time string in the message (without minutes)

Specially useful when displaying time lapses (like time left for something)

Parameters

[in]	name	The parameter
[in]	time	The date in win32 epoch format

Returns

self

Definition at line 137 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_TimeShort.

{
    return this->AddParameterKeyword (name, UserError_Parameter_TimeShort, new PyLong (time));
}

Here is the call graph for this function:

UserError & UserError::AddTypeDescription	(	const char *	name,
		uint32	typeID
	)

Shorthand method for adding a type's description.

Parameters

[in]	name	The parameter
[in]	typeID	The type's ID

Returns

self

Definition at line 184 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_TypeDescription.

{
    return this->AddParameterKeyword (name, UserError_Parameter_TypeDescription, new PyInt (typeID));
}

Here is the call graph for this function:

UserError & UserError::AddTypeIDAndQuantity	(	const char *	name,
		uint32	typeID,
		int	quantity
	)

Shorthand method for adding type ID and quantity.

Parameters

[in]	name	The parameter
[in]	typeID	The type's ID
[in]	quantity	The quantity

Returns

self

Definition at line 249 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_TypeIDAndQuantity.

{
    return this->AddParameterKeyword (name, UserError_Parameter_TypeIDAndQuantity, new PyInt (typeID), new PyInt (quantity));
}

Here is the call graph for this function:

UserError & UserError::AddTypeList	(	const char *	name,
		PyList *	typeIDs
	)

Shorthand method for adding a list of types' names.

Parameters

[in]	name	The parameter
[in]	typeIDs	The list of type ids

Returns

self

Definition at line 189 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_TypeIDList.

{
    return this->AddParameterKeyword (name, UserError_Parameter_TypeIDList, typeIDs);
}

Here is the call graph for this function:

UserError & UserError::AddTypeName	(	const char *	name,
		uint32	typeID
	)

Shorthand method for adding a type's name.

Parameters

[in]	name	The parameter
[in]	typeID	The type's ID

Returns

self

Definition at line 179 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_TypeName.

Referenced by ReprocessingServiceBound::GetQuote(), ModuleManager::Online(), and ShipItem::TryModuleLimitChecks().

{
    return this->AddParameterKeyword (name, UserError_Parameter_TypeName, new PyInt (typeID));
}

Here is the call graph for this function:

Here is the caller graph for this function:

UserError & UserError::AddUELocalization	(	const char *	name,
		const char *	strKey,
		PyDict *	args = nullptr
	)

Shorthand method for adding a string in the client's translations.

Parameters

[in]	name	The parameter
[in]	strKey	The name of the extra MLS string to lookup
[in]	format	The extra format to apply if any

Returns

self

Definition at line 151 of file PyExceptions.cpp.

References AddParameterKeyword(), and UserError_Parameter_Localization.

{
    return this->AddParameterKeyword (name, UserError_Parameter_Localization, new PyString (strKey), args);
}

Here is the call graph for this function:

Member Data Documentation

const char * UserError::EXCEPTION_NAME = "ccp_exceptions.UserError"

staticprotected

The name of the exception for EVE

Definition at line 413 of file PyExceptions.h.

PyTuple* UserError::m_args

protected

Definition at line 443 of file PyExceptions.h.

Referenced by _CreateArgs(), and _GetTupleKeywords().

PyDict* UserError::m_keywords

protected

Definition at line 444 of file PyExceptions.h.

Referenced by _CreateKeywords(), and _GetDictKeywords().

---

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