StationItem Class Reference

#include "Station.h"

Inheritance diagram for StationItem:

Collaboration diagram for StationItem:

Public Member Functions
StationType *	GetStationType ()
ShipItemRef	GetShipFromInventory (uint32 shipID)
CargoContainerRef	GetContainerFromInventory (uint32 contID)
PyRep *	GetOffices ()
int8	GetAvalibleOfficeCount ()
int32	GetOfficeRentalFee ()
uint32	GetOwnerID ()
uint32	GetID ()
void	RentOffice (OfficeData &odata)
uint32	GetOfficeID (uint32 corpID)
void	LoadStationOffice (uint32 corpID)
void	AddLoadedOffice (uint32 officeID)
void	RemoveLoadedOffice (uint32 officeID)
bool	IsLoaded ()
bool	IsOfficeLoaded (uint32 officeID)
void	GetGuestList (std::vector< Client * > &cVec)
void	AddGuest (Client *pClient)
void	RemoveGuest (Client *pClient)
void	GetRefineData (uint32 &stationCorpID, float &staEfficiency, float &tax)
bool	HasShip (Client *pClient)
Public Member Functions inherited from CelestialObject
	CelestialObject (uint32 _celestialID, const ItemType &_type, const ItemData &_data)
	CelestialObject (uint32 _celestialID, const ItemType &_type, const ItemData &_data, const CelestialObjectData &_cData)
virtual	~CelestialObject ()
void	Delete ()
double	radius () const
double	security () const
uint8	celestialIndex () const
uint8	orbitIndex () const
Public Member Functions inherited from InventoryItem
	InventoryItem (uint32 _itemID, const ItemType &_type, const ItemData &_data)
	InventoryItem (const InventoryItem &oth)
	InventoryItem (InventoryItem &&oth) noexcept
InventoryItem &	operator= (const InventoryItem &oth)=delete
InventoryItem &	operator= (InventoryItem &&oth)=delete
virtual	~InventoryItem () noexcept
virtual ShipItem *	GetShipItem ()
virtual ModuleItem *	GetModuleItem ()
virtual bool	IsShipItem ()
virtual bool	IsModuleItem ()
virtual void	Rename (std::string name)
Inventory *	GetMyInventory ()
bool	contraband () const
bool	isSingleton () const
int32	quantity () const
uint32	itemID () const
uint32	ownerID () const
uint32	locationID () const
EVEItemFlags	flag () const
const GPoint &	position () const
const ItemType &	type () const
const std::string &	itemName () const
const std::string &	customInfo () const
const char *	name ()
uint16	typeID () const
uint16	groupID () const
double	radius () const
uint8	categoryID () const
bool	isGlobal () const
bool	IsOnline ()
void	SetPosition (const GPoint &pos)
void	SetCustomInfo (const char *ci)
void	ChangeOwner (uint32 new_owner, bool notify=false)
void	Move (uint32 new_location=locTemp, EVEItemFlags flag=flagNone, bool notify=false)
void	Donate (uint32 new_owner=ownerSystem, uint32 new_location=locTemp, EVEItemFlags new_flag=flagNone, bool notify=true)
void	SendItemChange (uint32 toID, std::map< int32, PyRep * > &changes)
void	MergeTypesInCargo (ShipItem *pShip, EVEItemFlags flag=flagNone)
bool	ChangeSingleton (bool singleton, bool notify=false)
bool	AlterQuantity (int32 qty, bool notify=false)
bool	SetQuantity (int32 qty, bool notify=false, bool deleteOnZero=true)
bool	SetFlag (EVEItemFlags flag, bool notify=false)
void	SetOwner (uint32 ownerID)
void	SaveItem ()
void	UpdateLocation ()
void	UpdateLocation (uint32 locID)
virtual InventoryItemRef	Split (int32 qty=0, bool notify=true, bool silent=false)
virtual bool	Merge (InventoryItemRef to_merge, int32 qty=0, bool notify=true)
virtual void	Relocate (uint32 locID=0, EVEItemFlags flag=flagNone)
virtual void	AddItem (InventoryItemRef iRef)
virtual void	RemoveItem (InventoryItemRef iRef)
double	GetPackagedVolume ()
virtual void	SetPlayer (Client *pClient)
virtual bool	HasPilot ()
virtual Client *	GetPilot ()
void	ToVirtual (uint32 locationID)
PyRep *	GetItem () const
void	GetItemRow (PyPackedRow *into) const
void	GetItemStatusRow (PyPackedRow *into) const
void	GetChargeStatusRow (uint32 shipID, PyPackedRow *into) const
bool	Populate (Rsp_CommonGetInfo_Entry &into)
PyList *	GetItemInfo () const
PyObject *	ItemGetInfo ()
PyPackedRow *	GetItemRow () const
PyPackedRow *	GetItemStatusRow () const
PyPackedRow *	GetChargeStatusRow (uint32 shipID) const
bool	SkillCheck (InventoryItemRef refItem)
void	ClearModifiers ()
void	AddModifier (fxData &data)
void	RemoveModifier (fxData &data)
void	ResetAttributes ()
bool	HasReqSkill (const uint16 skillID)
AttributeMap *	GetAttributeMap ()
int64	GetTimeStamp ()
void	SetAttribute (uint16 attrID, int num, bool notify=true)
void	SetAttribute (uint16 attrID, uint32 num, bool notify=true)
void	SetAttribute (uint16 attrID, int64 num, bool notify=true)
void	SetAttribute (uint16 attrID, float num, bool notify=true)
void	SetAttribute (uint16 attrID, double num, bool notify=true)
void	SetAttribute (uint16 attrID, EvilNumber num, bool notify=true)
void	MultiplyAttribute (uint16 attrID, EvilNumber num, bool notify=false)
bool	HasAttribute (const uint16 attrID) const
bool	HasAttribute (const uint16 attrID, EvilNumber &value) const
bool	SaveAttributes ()
void	ResetAttribute (uint16 attrID, bool notify=false)
void	DeleteAttribute (uint16 attrID)
EvilNumber	GetAttribute (const uint16 attrID) const
EvilNumber	GetDefaultAttribute (const uint16 attrID) const
Public Member Functions inherited from RefObject
	RefObject (size_t initRefCount)
	Initializes reference count. More...
virtual	~RefObject ()
	Destructor; must be virtual. More...
size_t	GetCount ()

Static Public Member Functions
static StationItemRef	Load (uint32 stationID)
Static Public Member Functions inherited from CelestialObject
static CelestialObjectRef	Load (uint32 celestialID)
static CelestialObjectRef	Spawn (ItemData &data)
Static Public Member Functions inherited from InventoryItem
static uint32	CreateItemID (ItemData &data)
static uint32	CreateTempItemID (ItemData &data)
static InventoryItemRef	Load (uint32 itemID)
static InventoryItemRef	SpawnItem (uint32 itemID, const ItemData &data)
static InventoryItemRef	Spawn (ItemData &data)
static InventoryItemRef	SpawnTemp (ItemData &data)

Protected Member Functions
	StationItem (uint32 stationID, const StationType &type, const ItemData &data, const CelestialObjectData &cData)
virtual	~StationItem ()
virtual bool	_Load ()
void	SendBill ()
void	ImpoundOffice (uint32 officeID)
void	RecoverOffice (uint32 officeID)
Protected Member Functions inherited from RefObject
void	IncRef () const
	Increments reference count of object by one. More...
void	DecRef () const
	Decrements reference count of object by one. More...

Static Protected Member Functions
template<class _Ty >
static RefPtr< _Ty >	_LoadItem (uint32 stationID, const ItemType &type, const ItemData &data)
static uint32	CreateItemID (ItemData &data)
Static Protected Member Functions inherited from CelestialObject
template<class _Ty >
static RefPtr< _Ty >	_LoadItem (uint32 celestialID, const ItemType &type, const ItemData &data)
static uint32	CreateItemID (ItemData &data)
Static Protected Member Functions inherited from InventoryItem
template<class _Ty >
static RefPtr< _Ty >	Load (uint32 itemID)
template<class _Ty >
static RefPtr< _Ty >	_Load (uint32 itemID)
template<class _Ty >
static RefPtr< _Ty >	_LoadItem (uint32 itemID, const ItemType &type, const ItemData &data)

Private Attributes
PyRep *	m_officePyData
StationType	m_stationType
StationData	m_data
bool	m_loaded
uint32	m_stationID
std::map< uint32, Client * >	m_guestList
std::map< uint32, OfficeData >	m_officeMap
std::map< uint32, bool >	m_officeLoaded

Friends
class	InventoryItem
class	CelestialObject

Additional Inherited Members
Public Attributes inherited from InventoryItem
std::multimap< int8, fxData >	m_modifiers
Protected Attributes inherited from CelestialObject
double	m_radius
double	m_security
uint8	m_celestialIndex
uint8	m_orbitIndex
Protected Attributes inherited from InventoryItem
Inventory *	pInventory
uint32	m_itemID
AttributeMap *	pAttributeMap
Protected Attributes inherited from RefObject
size_t	mRefCount
	Reference count of instance. More...
bool	mDeleted

Detailed Description

CelestialObject which represents station.

Definition at line 70 of file Station.h.

Constructor & Destructor Documentation

StationItem::StationItem ( uint32  stationID, const StationType &  type, const ItemData &  data, const CelestialObjectData &  cData  )

protected

Definition at line 59 of file Station.cpp.

References _log, InventoryItem::itemID(), InventoryItem::name(), and InventoryItem::pInventory.

Referenced by _LoadItem().

: CelestialObject(stationID, type, data, cData),
m_officePyData(nullptr),
m_stationType(type),
m_stationID(stationID),
m_loaded(false)
{
    pInventory = new Inventory(InventoryItemRef(this));

    _log(ITEM__TRACE, "Created Station for item %s (%u).", name(), itemID());
}

Here is the call graph for this function:

Here is the caller graph for this function:

StationItem::~StationItem ( )

protectedvirtual

Definition at line 71 of file Station.cpp.

References m_guestList, m_officeMap, m_officePyData, InventoryItem::pInventory, PySafeDecRef, SafeDelete(), and Inventory::Unload().

{
    if (pInventory != nullptr)
        pInventory->Unload();
    SafeDelete(pInventory);

    m_officeMap.clear();
    m_guestList.clear();
    PySafeDecRef(m_officePyData);
}

Here is the call graph for this function:

Member Function Documentation

bool StationItem::_Load ( )

protectedvirtual

Reimplemented from InventoryItem.

Definition at line 87 of file Station.cpp.

References InventoryItem::_Load(), StationDB::GetOffices(), Inventory::LoadContents(), m_data, m_guestList, m_loaded, m_officeMap, m_officePyData, m_stationID, StationData::officeRentalFee, InventoryItem::pInventory, and stDataMgr.

                        {
    if (!pInventory->LoadContents())
        return false;

    m_officeMap.clear();
    m_guestList.clear();

    stDataMgr.GetStationData(m_stationID, m_data);
    stDataMgr.LoadOffices(m_stationID, m_officeMap);
    m_officePyData = StationDB::GetOffices(m_stationID);

    if (m_data.officeRentalFee < 10000)
        m_data.officeRentalFee = 10000;

    m_loaded = CelestialObject::_Load();

    return m_loaded;
}

Here is the call graph for this function:

template<class _Ty >

static RefPtr<_Ty> StationItem::_LoadItem ( uint32  stationID, const ItemType &  type, const ItemData &  data  )

inlinestaticprotected

Definition at line 128 of file Station.h.

References _log, ItemType::groupID(), sConfig, sDataMgr, sItemFactory, EVEDB::invGroups::Station, StationItem(), EvE::traceStack(), and InventoryItem::type().

    {
        if (type.groupID() != EVEDB::invGroups::Station) {
            _log(ITEM__ERROR, "Trying to load %s as Station.", sDataMgr.GetGroupName(type.groupID()));
            if (sConfig.debug.StackTrace)
                EvE::traceStack();
            return RefPtr<_Ty>();
        }
        // cast the type
        const StationType &stType = static_cast<const StationType &>( type );

        // load celestial data
        CelestialObjectData cData = CelestialObjectData();
        if (!sItemFactory.db()->GetCelestialObject(stationID, cData))
            return RefPtr<_Ty>();

        return StationItemRef(new StationItem(stationID, stType, data, cData));
    }

Here is the call graph for this function:

void StationItem::AddGuest

(

Client *

pClient

)

Definition at line 219 of file Station.cpp.

References Client::GetCharacterID(), and m_guestList.

Referenced by Client::MoveToLocation().

{
    m_guestList.emplace(pClient->GetCharacterID(), pClient);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void StationItem::AddLoadedOffice

(

uint32

officeID

)

Definition at line 120 of file Station.cpp.

References IsOfficeID, and m_officeLoaded.

{
    if (!IsOfficeID(officeID))
        return;
    m_officeLoaded.emplace(officeID, true);
}

uint32 StationItem::CreateItemID ( ItemData &  data )

staticprotected

Definition at line 106 of file Station.cpp.

References InventoryItem::CreateItemID().

Referenced by InventoryItem::Spawn().

                                                {
    return InventoryItem::CreateItemID(data);
}

Here is the call graph for this function:

Here is the caller graph for this function:

int8 StationItem::GetAvalibleOfficeCount ( )

inline

Definition at line 92 of file Station.h.

References m_officeMap, and maxRentableOffices.

{ return maxRentableOffices - m_officeMap.size(); }

CargoContainerRef StationItem::GetContainerFromInventory

(

uint32

contID

)

Definition at line 259 of file Station.cpp.

References Inventory::GetByID(), InventoryItem::pInventory, and RefPtr< X >::StaticCast().

{
    return CargoContainerRef::StaticCast(pInventory->GetByID(contID));
}

Here is the call graph for this function:

void StationItem::GetGuestList

(

std::vector< Client * > &

cVec

)

Definition at line 224 of file Station.cpp.

References m_guestList.

{
    for (auto cur : m_guestList)
        cVec.push_back(cur.second);
}

uint32 StationItem::GetID ( )

inline

Definition at line 95 of file Station.h.

References m_data, and StationData::stationID.

{ return m_data.stationID; }

uint32 StationItem::GetOfficeID

(

uint32

corpID

)

Definition at line 110 of file Station.cpp.

References IsPlayerCorp, and m_officeMap.

Referenced by LoadStationOffice().

{
    if (!IsPlayerCorp(corpID))
        return 0;
    for (auto cur : m_officeMap)
        if (cur.second.corporationID = corpID)
            return cur.first;
    return 0;
}

Here is the caller graph for this function:

int32 StationItem::GetOfficeRentalFee ( )

inline

Definition at line 93 of file Station.h.

References m_data, and StationData::officeRentalFee.

{ return m_data.officeRentalFee; }

PyRep* StationItem::GetOffices ( )

inline

Definition at line 91 of file Station.h.

References m_officePyData, and PyIncRef.

{ PyIncRef(m_officePyData); return m_officePyData; }  // cached officeData for client call

uint32 StationItem::GetOwnerID ( )

inline

Definition at line 94 of file Station.h.

References StationData::corporationID, and m_data.

{ return m_data.corporationID; }

void StationItem::GetRefineData	(	uint32 &	stationCorpID,
		float &	staEfficiency,
		float &	tax
	)

Definition at line 235 of file Station.cpp.

References StationData::corporationID, m_data, StationData::reprocessingEfficiency, and StationData::reprocessingStationsTake.

Referenced by ReprocessingServiceBound::ReprocessingServiceBound().

{
    stationCorpID = m_data.corporationID;
    staEfficiency = m_data.reprocessingEfficiency;
    tax = m_data.reprocessingStationsTake;
}

Here is the caller graph for this function:

ShipItemRef StationItem::GetShipFromInventory

(

uint32

shipID

)

Definition at line 254 of file Station.cpp.

References Inventory::GetByID(), InventoryItem::pInventory, and RefPtr< ShipItem >::StaticCast().

{
    return ShipItemRef::StaticCast(pInventory->GetByID(shipID));
}

Here is the call graph for this function:

StationType* StationItem::GetStationType ( )

inline

Definition at line 86 of file Station.h.

References m_stationType.

{ return &m_stationType; }

bool StationItem::HasShip

(

Client *

pClient

)

Definition at line 242 of file Station.cpp.

References EVEDB::invTypes::Capsule, Client::GetCharacterID(), Inventory::GetInvForOwner(), items, InventoryItem::pInventory, and EVEDB::invCategories::Ship.

Referenced by Client::DockToStation(), and Client::SelectCharacter().

{
    std::vector< InventoryItemRef > items;
    pInventory->GetInvForOwner(pClient->GetCharacterID(), items);

    for (auto cur : items)
        if (cur->categoryID() == EVEDB::invCategories::Ship)
            if (cur->typeID() != EVEDB::invTypes::Capsule)
                return true;
    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void StationItem::ImpoundOffice ( uint32  officeID )

protected

Definition at line 163 of file Station.cpp.

References m_officeMap.

{
    std::map<uint32, OfficeData>::iterator itr = m_officeMap.find(officeID);
    if (itr != m_officeMap.end())
        itr->second.lockDown = true;
}

bool StationItem::IsLoaded ( )

inline

Definition at line 103 of file Station.h.

References m_loaded.

{ return m_loaded; }

bool StationItem::IsOfficeLoaded

(

uint32

officeID

)

Definition at line 127 of file Station.cpp.

References IsOfficeID, and m_officeLoaded.

Referenced by LoadStationOffice().

{
    if (!IsOfficeID(officeID))
        return false;
    std::map<uint32, bool>::const_iterator itr = m_officeLoaded.find(officeID);
    if (itr != m_officeLoaded.end())
        return itr->second;
    return false;
}

Here is the caller graph for this function:

StationItemRef StationItem::Load ( uint32  stationID )

static

Loads station.

Parameters

[in]	factory
[in]	stationID	ID of station to load.

Returns

Pointer to new Station object; NULL if fails.

Definition at line 82 of file Station.cpp.

Referenced by InventoryItem::Spawn().

{
    return InventoryItem::Load<StationItem>(stationID);
}

Here is the caller graph for this function:

void StationItem::LoadStationOffice

(

uint32

corpID

)

Definition at line 144 of file Station.cpp.

References _log, GetOfficeID(), IsOfficeLoaded(), IsPlayerCorp, m_officeLoaded, m_stationID, and sItemFactory.

Referenced by Client::MoveToLocation().

{
    if (!IsPlayerCorp(corpID))
        return;
    uint32 officeID = GetOfficeID(corpID);
    if (officeID == 0)
        return;
    if (IsOfficeLoaded(officeID))
        return;
    _log(CORP__TRACE, "StationItem::LoadStationOffice() is loading corp office %u in stationID %u", officeID, m_stationID);
    StationOfficeRef oRef = sItemFactory.GetOffice(officeID);
    if (oRef->GetMyInventory() == nullptr) {   // not sure why this would be null, but i *may* have seen errors from it
        _log(ITEM__ERROR, "StationItem::LoadStationOffice() - GetMyInventory() for corp office %u in stationID %u is NULL.", officeID, m_stationID);
        return;
    }
    oRef->SetLoaded(oRef->GetMyInventory()->LoadContents());
    m_officeLoaded.emplace(officeID, true);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void StationItem::RecoverOffice ( uint32  officeID )

protected

Definition at line 170 of file Station.cpp.

References m_officeMap.

{
    std::map<uint32, OfficeData>::iterator itr = m_officeMap.find(officeID);
    if (itr != m_officeMap.end())
        itr->second.lockDown = false;
}

void StationItem::RemoveGuest

(

Client *

pClient

)

Definition at line 230 of file Station.cpp.

References Client::GetCharacterID(), and m_guestList.

{
    m_guestList.erase(pClient->GetCharacterID());
}

Here is the call graph for this function:

void StationItem::RemoveLoadedOffice

(

uint32

officeID

)

Definition at line 137 of file Station.cpp.

References IsOfficeID, and m_officeLoaded.

{
    if (!IsOfficeID(officeID))
        return;
    m_officeLoaded.erase(officeID);
}

void StationItem::RentOffice

(

OfficeData &

odata

)

Definition at line 178 of file Station.cpp.

References StationData::corporationID, OfficeData::corporationID, flagOffice, OfficeData::folderID, StationDB::GetOffices(), m_data, m_guestList, m_officeLoaded, m_officeMap, m_officePyData, m_stationID, InventoryItem::name(), OfficeData::officeID, PyDecRef, PyIncRef, PySafeDecRef, sItemFactory, STATION_OFFICE_OFFSET, OfficeData::stationID, stDataMgr, OfficeData::ticker, InventoryItem::typeID(), and OfficeData::typeID.

{
    odata.typeID = typeID();    // change from officeTypeID to stationTypeID
    odata.folderID = m_stationID + STATION_OFFICE_OFFSET;
    odata.stationID = m_stationID;

    // create new office item
    std::string name = odata.ticker;
    name += "'s Office";
    ItemData idata(27, m_data.corporationID, m_stationID, flagOffice, name.c_str());
    StationOfficeRef oRef = sItemFactory.SpawnOffice(idata, odata);
    if (oRef.get() == nullptr)
        return;  // make error here?

    // make and send notifications
    OnOfficeRentalChanged oorc;
        oorc.ownerID = odata.corporationID;
        oorc.officeID = odata.officeID;
        oorc.officeFolderID = odata.folderID;
    PyTuple* payload = oorc.Encode();
    for (auto cur : m_guestList) {
        PyIncRef(payload);
        cur.second->SendNotification("OnOfficeRentalChanged", "stationid", &payload, false);
    }
    PyDecRef( payload );

    oRef->ChangeOwner(odata.corporationID, true);

    // update data
    stDataMgr.AddOffice(m_stationID, odata);
    m_officeMap.emplace(odata.officeID, odata);
    m_officeLoaded.emplace(odata.officeID, true);
    PySafeDecRef(m_officePyData);
    m_officePyData = StationDB::GetOffices(m_stationID);
}

Here is the call graph for this function:

void StationItem::SendBill ( )

protected

Definition at line 214 of file Station.cpp.

{
    // do we need this here?
}

Friends And Related Function Documentation

friend class CelestialObject

friend

Definition at line 74 of file Station.h.

friend class InventoryItem

friend

Definition at line 73 of file Station.h.

Member Data Documentation

StationData StationItem::m_data

private

Definition at line 157 of file Station.h.

Referenced by _Load(), GetID(), GetOfficeRentalFee(), GetOwnerID(), GetRefineData(), and RentOffice().

std::map<uint32, Client*> StationItem::m_guestList

private

Definition at line 162 of file Station.h.

Referenced by _Load(), AddGuest(), GetGuestList(), RemoveGuest(), RentOffice(), and ~StationItem().

bool StationItem::m_loaded

private

Definition at line 159 of file Station.h.

Referenced by _Load(), and IsLoaded().

std::map<uint32, bool> StationItem::m_officeLoaded

private

Definition at line 165 of file Station.h.

Referenced by AddLoadedOffice(), IsOfficeLoaded(), LoadStationOffice(), RemoveLoadedOffice(), and RentOffice().

std::map<uint32, OfficeData> StationItem::m_officeMap

private

Definition at line 164 of file Station.h.

Referenced by _Load(), GetAvalibleOfficeCount(), GetOfficeID(), ImpoundOffice(), RecoverOffice(), RentOffice(), and ~StationItem().

PyRep* StationItem::m_officePyData

private

Definition at line 155 of file Station.h.

Referenced by _Load(), GetOffices(), RentOffice(), and ~StationItem().

uint32 StationItem::m_stationID

private

Definition at line 160 of file Station.h.

Referenced by _Load(), LoadStationOffice(), and RentOffice().

StationType StationItem::m_stationType

private

Definition at line 156 of file Station.h.

Referenced by GetStationType().

---

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

• /backups/local/src/eve/EvEmu_Crucible/src/eve-server/station/Station.h
• /backups/local/src/eve/EvEmu_Crucible/src/eve-server/station/Station.cpp