Reference< TO, FROM > Class Template Reference

#include <Reference.h>

Public Member Functions
	Reference ()
virtual	~Reference ()
void	link (TO *toObj, FROM *fromObj)
void	unlink ()
void	invalidate ()
bool	isValid () const
Reference< TO, FROM > *	next ()
Reference< TO, FROM > const *	next () const
Reference< TO, FROM > *	prev ()
Reference< TO, FROM > const *	prev () const
Reference< TO, FROM > *	nocheck_next ()
Reference< TO, FROM > const *	nocheck_next () const
Reference< TO, FROM > *	nocheck_prev ()
Reference< TO, FROM > const *	nocheck_prev () const
TO *	operator-> () const
TO *	getTarget () const
FROM *	GetSource () const
Public Member Functions inherited from LinkedListElement
	LinkedListElement ()
bool	hasNext () const
bool	hasPrev () const
bool	isInList () const
LinkedListElement *	next ()
LinkedListElement const *	next () const
LinkedListElement *	prev ()
LinkedListElement const *	prev () const
LinkedListElement *	nocheck_next ()
LinkedListElement const *	nocheck_next () const
LinkedListElement *	nocheck_prev ()
LinkedListElement const *	nocheck_prev () const
void	delink ()
void	insertBefore (LinkedListElement *pElem)
void	insertAfter (LinkedListElement *pElem)

Protected Member Functions
virtual void	targetObjectBuildLink ()=0
virtual void	targetObjectDestroyLink ()=0
virtual void	sourceObjectDestroyLink ()=0
Protected Member Functions inherited from LinkedListElement
	~LinkedListElement ()

Private Member Functions
	Reference (Reference const &)=delete
Reference &	operator= (Reference const &)=delete

Private Attributes
TO *	iRefTo
FROM *	iRefFrom

Detailed Description

template<class TO, class FROM>
class Reference< TO, FROM >

Definition at line 26 of file Reference.h.

Constructor & Destructor Documentation

Reference() [1/2]

template<class TO , class FROM >

Reference< TO, FROM >::Reference ( )

inline

Definition at line 42 of file Reference.h.

{ iRefTo = nullptr; iRefFrom = nullptr; }

~Reference()

template<class TO , class FROM >

virtual Reference< TO, FROM >::~Reference ( )

inlinevirtual

Definition at line 43 of file Reference.h.

{ }

Reference() [2/2]

template<class TO , class FROM >

Reference< TO, FROM >::Reference ( Reference< TO, FROM > const &  )

privatedelete

Member Function Documentation

GetSource()

template<class TO , class FROM >

FROM * Reference< TO, FROM >::GetSource ( ) const

inline

Definition at line 96 of file Reference.h.

{ return iRefFrom; }

Here is the caller graph for this function:

getTarget()

template<class TO , class FROM >

TO * Reference< TO, FROM >::getTarget ( ) const

inline

Definition at line 94 of file Reference.h.

{ return iRefTo; }

Here is the caller graph for this function:

invalidate()

template<class TO , class FROM >

void Reference< TO, FROM >::invalidate ( )

inline

Definition at line 71 of file Reference.h.

 {
 sourceObjectDestroyLink();
 delink();
 iRefTo = nullptr;
 }

Here is the call graph for this function:

isValid()

template<class TO , class FROM >

bool Reference< TO, FROM >::isValid ( ) const

inline

Definition at line 78 of file Reference.h.

 {
 return iRefTo != nullptr;
 }

Here is the caller graph for this function:

link()

template<class TO , class FROM >

void Reference< TO, FROM >::link ( TO *  toObj, FROM *  fromObj  )

inline

Definition at line 46 of file Reference.h.

 {
 ASSERT(fromObj); // fromObj MUST not be NULL
 if (isValid())
 unlink();
 if (toObj != nullptr)
 {
 iRefTo = toObj;
 iRefFrom = fromObj;
 targetObjectBuildLink();
 }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

next() [1/2]

template<class TO , class FROM >

Reference< TO, FROM > * Reference< TO, FROM >::next ( )

inline

Definition at line 83 of file Reference.h.

{ return((Reference<TO, FROM> *) LinkedListElement::next()); }

Here is the call graph for this function:

Here is the caller graph for this function:

next() [2/2]

template<class TO , class FROM >

Reference< TO, FROM > const * Reference< TO, FROM >::next ( ) const

inline

Definition at line 84 of file Reference.h.

{ return((Reference<TO, FROM> const*) LinkedListElement::next()); }

Here is the call graph for this function:

nocheck_next() [1/2]

template<class TO , class FROM >

Reference< TO, FROM > * Reference< TO, FROM >::nocheck_next ( )

inline

Definition at line 88 of file Reference.h.

{ return((Reference<TO, FROM> *) LinkedListElement::nocheck_next()); }

Here is the call graph for this function:

nocheck_next() [2/2]

template<class TO , class FROM >

Reference< TO, FROM > const * Reference< TO, FROM >::nocheck_next ( ) const

inline

Definition at line 89 of file Reference.h.

{ return((Reference<TO, FROM> const*) LinkedListElement::nocheck_next()); }

Here is the call graph for this function:

nocheck_prev() [1/2]

template<class TO , class FROM >

Reference< TO, FROM > * Reference< TO, FROM >::nocheck_prev ( )

inline

Definition at line 90 of file Reference.h.

{ return((Reference<TO, FROM> *) LinkedListElement::nocheck_prev()); }

Here is the call graph for this function:

Here is the caller graph for this function:

nocheck_prev() [2/2]

template<class TO , class FROM >

Reference< TO, FROM > const * Reference< TO, FROM >::nocheck_prev ( ) const

inline

Definition at line 91 of file Reference.h.

{ return((Reference<TO, FROM> const*) LinkedListElement::nocheck_prev()); }

Here is the call graph for this function:

operator->()

template<class TO , class FROM >

TO * Reference< TO, FROM >::operator-> ( ) const

inline

Definition at line 93 of file Reference.h.

{ return iRefTo; }

operator=()

template<class TO , class FROM >

Reference & Reference< TO, FROM >::operator= ( Reference< TO, FROM > const &  )

privatedelete

prev() [1/2]

template<class TO , class FROM >

Reference< TO, FROM > * Reference< TO, FROM >::prev ( )

inline

Definition at line 85 of file Reference.h.

{ return((Reference<TO, FROM> *) LinkedListElement::prev()); }

Here is the call graph for this function:

prev() [2/2]

template<class TO , class FROM >

Reference< TO, FROM > const * Reference< TO, FROM >::prev ( ) const

inline

Definition at line 86 of file Reference.h.

{ return((Reference<TO, FROM> const*) LinkedListElement::prev()); }

Here is the call graph for this function:

sourceObjectDestroyLink()

template<class TO , class FROM >

virtual void Reference< TO, FROM >::sourceObjectDestroyLink ( )

protectedpure virtual

Implemented in GridReference< OBJECT >, GridReference< AreaTrigger >, GridReference< Conversation >, GridReference< Corpse >, GridReference< Creature >, GridReference< DynamicObject >, GridReference< GameObject >, GridReference< Player >, GridReference< SceneObject >, GridReference< T >, GridReference< NGrid< N, ACTIVE_OBJECT, WORLD_OBJECT_TYPES, GRID_OBJECT_TYPES > >, GroupInstanceReference, GroupReference, and MapReference.

Here is the caller graph for this function:

targetObjectBuildLink()

template<class TO , class FROM >

virtual void Reference< TO, FROM >::targetObjectBuildLink ( )

protectedpure virtual

Implemented in GridReference< OBJECT >, GridReference< AreaTrigger >, GridReference< Conversation >, GridReference< Corpse >, GridReference< Creature >, GridReference< DynamicObject >, GridReference< GameObject >, GridReference< Player >, GridReference< SceneObject >, GridReference< T >, GridReference< NGrid< N, ACTIVE_OBJECT, WORLD_OBJECT_TYPES, GRID_OBJECT_TYPES > >, GroupInstanceReference, GroupReference, and MapReference.

Here is the caller graph for this function:

targetObjectDestroyLink()

template<class TO , class FROM >

virtual void Reference< TO, FROM >::targetObjectDestroyLink ( )

protectedpure virtual

Implemented in GridReference< OBJECT >, GridReference< AreaTrigger >, GridReference< Conversation >, GridReference< Corpse >, GridReference< Creature >, GridReference< DynamicObject >, GridReference< GameObject >, GridReference< Player >, GridReference< SceneObject >, GridReference< T >, GridReference< NGrid< N, ACTIVE_OBJECT, WORLD_OBJECT_TYPES, GRID_OBJECT_TYPES > >, GroupInstanceReference, GroupReference, and MapReference.

Here is the caller graph for this function:

unlink()

template<class TO , class FROM >

void Reference< TO, FROM >::unlink ( )

inline

Definition at line 61 of file Reference.h.

 {
 targetObjectDestroyLink();
 delink();
 iRefTo = nullptr;
 iRefFrom = nullptr;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

iRefFrom

template<class TO , class FROM >

FROM* Reference< TO, FROM >::iRefFrom

private

Definition at line 30 of file Reference.h.

iRefTo

template<class TO , class FROM >

TO* Reference< TO, FROM >::iRefTo

private

Definition at line 29 of file Reference.h.

---

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

• src/server/shared/Dynamic/LinkedReference/Reference.h