RefPtr< X > Class Template Reference

Reference-counting-based smart pointer. More...

#include "RefPtr.h"

Inheritance diagram for RefPtr< X >:

Collaboration diagram for RefPtr< X >:

Public Member Functions
	RefPtr (X *p=nullptr)
	Primary constructor. More...
	RefPtr (const RefPtr &oth)
	Copy constructor. More...
template<typename Y >
	RefPtr (const RefPtr< Y > &oth)
	Casting copy constructor. More...
virtual	~RefPtr ()
	Destructor, releases reference. More...
RefPtr &	operator= (const RefPtr &oth)
	Copy operator. More...
template<typename Y >
RefPtr &	operator= (const RefPtr< Y > &oth)
	Casting copy operator. More...
X *	get () const
	operator bool () const
X &	operator* () const
X *	operator-> () const
template<typename Y >
bool	operator== (const RefPtr< Y > &oth) const
	Compares two references. More...

Static Public Member Functions
template<typename Y >
static RefPtr	StaticCast (const RefPtr< Y > &oth)
	Acts as static_cast from one RefPtr to another. More...

Protected Attributes
X *	mPtr
	The pointer to the reference-counted object. More...

Detailed Description

template<typename X>
class RefPtr< X >

Reference-counting-based smart pointer.

This smart pointer cares about acquiring/releasing reference of the stored object.

NOTE: this class DOES increment count on creation (whereas RefObject does not)

Author

Bloody.Rabbit

Definition at line 133 of file RefPtr.h.

Constructor & Destructor Documentation

template<typename X>

RefPtr< X >::RefPtr ( X *  p = nullptr )

inlineexplicit

Primary constructor.

Parameters

[in]

p

Pointer to object to be referenced.

Definition at line 141 of file RefPtr.h.

Referenced by RefPtr< Character >::StaticCast().

    : mPtr( p )
    {
        if (*this)
            (*this)->IncRef();
    }

Here is the caller graph for this function:

template<typename X>

RefPtr< X >::RefPtr ( const RefPtr< X > &  oth )

inline

Copy constructor.

Parameters

[in]

oth

Object to copy the reference from.

Definition at line 152 of file RefPtr.h.

    : mPtr( oth.get() )
    {
        if (*this)
            (*this)->IncRef();
    }

template<typename X>

template<typename Y >

RefPtr< X >::RefPtr ( const RefPtr< Y > &  oth )

inline

Casting copy constructor.

Parameters

[in]

oth

Object to copy the reference from.

Definition at line 164 of file RefPtr.h.

    : mPtr( oth.get() )
    {
        if (*this)
            (*this)->IncRef();
    }

template<typename X>

virtual RefPtr< X >::~RefPtr ( )

inlinevirtual

Destructor, releases reference.

Definition at line 174 of file RefPtr.h.

    {
        if (*this)
            (*this)->DecRef();
    }

Member Function Documentation

template<typename X>

X* RefPtr< X >::get ( ) const

inline

Returns

Stored reference.

Definition at line 213 of file RefPtr.h.

Referenced by Character::_Load(), ActiveModule::Activate(), RamMethods::ActivityCheck(), CorporationDB::AddCorporation(), StationOffice::AddItem(), StructureItem::AddItem(), Inventory::AddItem(), ShipItem::AddItem(), Character::AddItem(), ShipItem::AddItemByFlag(), FleetService::AddMember(), AnomalyMgr::AddSignal(), TurretModule::ApplyDamage(), SystemEntity::ApplyDamage(), ActiveModule::ApplyEffect(), SystemManager::BootSystem(), DynamicEntityFactory::BuildEntity(), ReprocessingServiceBound::CalcReprocessingEfficiency(), MiningLaser::CanActivate(), TradeBound::CancelTrade(), Agent::CanUseAgent(), Client::CheckShipRef(), Command_dogma(), Command_giveallskills(), Command_giveskill(), Command_inventory(), Command_shipinventory(), Command_status(), Command_tr(), Client::ContainsTypeQty(), AllianceDB::CreateAlliance(), ShipService::CreateBoundObject(), FleetService::CreateFleet(), ProbeItem::Delete(), InventoryItem::Delete(), GenericModule::DeOverload(), Client::DockToStation(), InventoryItem::Donate(), DroneSE::DroneSE(), Prospector::DropSalvage(), Client::Eject(), MarketMgr::ExecuteBuyOrder(), MarketMgr::ExecuteSellOrder(), EntityList::FindClientByName(), FleetService::GetBoosterData(), Client::GetCharID(), Client::GetCorpTaxRate(), RepairService::GetDamageReports(), ItemFactory::GetInventoryFromId(), ItemFactory::GetItemContainer(), ItemFactory::GetItemContainerInventory(), ModuleManager::GetModule(), Client::GetName(), ShipSE::GetPilot(), ReprocessingServiceBound::GetQuote(), Character::GetSkill(), Character::GetSkillLevel(), ShipSE::HasPilot(), Character::HasSkillTrainedToLevel(), Character::InjectSkillIntoBrain(), GenericModule::IsLoaded(), Sentry::Killed(), CustomsSE::Killed(), NPC::Killed(), DroneSE::Killed(), StructureSE::Killed(), ShipSE::LaunchDrone(), FleetService::LeaveFleet(), BeltMgr::Load(), TurretModule::LoadCharge(), MiningLaser::LoadCharge(), ActiveModule::LoadCharge(), ModuleManager::LoadCharge(), ShipItem::LoadCharge(), ShipItem::LoadChargesToBank(), Inventory::LoadContents(), Character::LoadPausedSkillQueue(), ProbeSE::MakeSlimItem(), SpawnMgr::MakeSpawn(), InventoryItem::Merge(), InventoryItem::MergeTypesInCargo(), Missile::Missile(), InventoryItem::Move(), Client::MoveItem(), InventoryBound::MoveItems(), ShipItem::MoveModuleSlot(), Client::MoveToLocation(), NPC::NPC(), NPCAIMgr::NPCAIMgr(), GenericModule::Offline(), GenericModule::Online(), RefPtr< Character >::operator=(), RefPtr< Character >::operator==(), GenericModule::Overload(), Client::PickAlternateShip(), Colony::PlanetXfer(), ProbeSE::ProbeSE(), ActiveModule::Process(), ShipSE::Process(), MiningLaser::ProcessCycle(), GenericModule::ProcessEffects(), ShipItem::ProcessShipEffects(), ProbeSE::ProcessTic(), Prospector::Prospector(), InventoryItem::Relocate(), StationOffice::RemoveItem(), StructureItem::RemoveItem(), Inventory::RemoveItem(), CargoContainer::RemoveItem(), ShipItem::RemoveItem(), WreckContainer::RemoveItem(), FleetService::RemoveMember(), Client::RemoveMissionItem(), ShipItem::RemoveRig(), ActiveModule::ReprocessCharge(), ReprocessingServiceBound::ReprocessingServiceBound(), Client::ResetAfterPopped(), Client::SelectCharacter(), Client::SelfChatMessage(), Client::SendSessionChange(), ProbeSE::SendSlimChange(), Client::SetPodItem(), ActiveModule::ShowEffect(), Character::SkillQueueLoop(), ModuleItem::Spawn(), Skill::Spawn(), InventoryItem::Spawn(), BeltMgr::SpawnAsteroid(), ItemFactory::SpawnAsteroid(), ItemFactory::SpawnCargoContainer(), ItemFactory::SpawnItem(), InventoryItem::SpawnItem(), ItemFactory::SpawnModule(), ItemFactory::SpawnOffice(), ItemFactory::SpawnProbe(), ItemFactory::SpawnShip(), ItemFactory::SpawnSkill(), ItemFactory::SpawnStructure(), ItemFactory::SpawnWreckContainer(), Blueprint::SplitBlueprint(), RefPtr< Character >::StaticCast(), SystemEntity::SystemEntity(), TargetManager::TimeToLock(), InventoryItem::ToVirtual(), TradeService::TransferContainerContents(), ActiveModule::UnloadCharge(), ModuleManager::UnloadCharge(), Prospector::Update(), FleetService::UpdateMember(), Client::UpdateSession(), Agent::UpdateStandings(), and Client::~Client().

{ return mPtr; }

template<typename X>

RefPtr< X >::operator bool ( ) const

inline

Returns

True if stores a reference, false otherwise.

Definition at line 218 of file RefPtr.h.

{ return ( mPtr != nullptr ); }

template<typename X>

X& RefPtr< X >::operator* ( ) const

inline

Definition at line 220 of file RefPtr.h.

{ assert( *this ); return *mPtr; }

template<typename X>

X* RefPtr< X >::operator-> ( ) const

inline

Definition at line 221 of file RefPtr.h.

{ assert( *this ); return mPtr; }

template<typename X>

RefPtr& RefPtr< X >::operator= ( const RefPtr< X > &  oth )

inline

Copy operator.

Parameters

[in]

oth

Object to copy the reference from.

Definition at line 185 of file RefPtr.h.

    {
        if (*this)
            (*this)->DecRef();
        mPtr = oth.get();
        if (*this)
            (*this)->IncRef();
        return *this;
    }

template<typename X>

template<typename Y >

RefPtr& RefPtr< X >::operator= ( const RefPtr< Y > &  oth )

inline

Casting copy operator.

Parameters

[in]

oth

Object to copy the reference from.

Definition at line 200 of file RefPtr.h.

    {
        if (*this)
            (*this)->DecRef();
        mPtr = oth.get();
        if (*this)
            (*this)->IncRef();
        return *this;
    }

template<typename X>

template<typename Y >

bool RefPtr< X >::operator== ( const RefPtr< Y > &  oth ) const

inline

Compares two references.

Returns

True if both references are of same object, false if not.

Definition at line 229 of file RefPtr.h.

    {
        return ( mPtr == oth.get() );
    }

template<typename X>

template<typename Y >

static RefPtr RefPtr< X >::StaticCast ( const RefPtr< Y > &  oth )

inlinestatic

Acts as static_cast from one RefPtr to another.

Definition at line 238 of file RefPtr.h.

Referenced by ItemFactory::_GetItem(), ShipItem::AddItemByFlag(), Command_giveallskills(), SystemManager::GetContainerFromInventory(), StationItem::GetContainerFromInventory(), Character::GetSkill(), ModuleManager::Initialize(), Character::InjectSkillIntoBrain(), CustomsSE::Killed(), StructureSE::Killed(), ShipSE::Killed(), SystemBubble::MarkBubble(), Blueprint::Merge(), InventoryBound::MoveItems(), Blueprint::SplitBlueprint(), and Character::VerifySP().

    {
        return RefPtr( static_cast<X*>( oth.get() ) );
    }

Here is the caller graph for this function:

Member Data Documentation

template<typename X>

X* RefPtr< X >::mPtr

protected

The pointer to the reference-counted object.

Definition at line 245 of file RefPtr.h.

Referenced by RefPtr< Character >::get(), RefPtr< Character >::operator bool(), RefPtr< Character >::operator*(), RefPtr< Character >::operator->(), RefPtr< Character >::operator=(), and RefPtr< Character >::operator==().

---

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

• /backups/local/src/eve/EvEmu_Crucible/src/eve-core/memory/RefPtr.h