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 ()
virtual	~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

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

Private Attributes
TO *	iRefTo
FROM *	iRefFrom

Constructor & Destructor Documentation

template<class TO, class FROM>

Reference< TO, FROM >::Reference ( )

inline

{ iRefTo = NULL; iRefFrom = NULL; }

template<class TO, class FROM>

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

inlinevirtual

{ }

template<class TO, class FROM>

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

private

Member Function Documentation

template<class TO, class FROM>

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

inline

{ return iRefFrom; }

Here is the caller graph for this function:

template<class TO, class FROM>

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

inline

{ return iRefTo; }

Here is the caller graph for this function:

template<class TO, class FROM>

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

inline

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

template<class TO, class FROM>

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

inline

 {
 return iRefTo != NULL;
 }

Here is the caller graph for this function:

template<class TO, class FROM>

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

inline

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

Here is the caller graph for this function:

template<class TO, class FROM>

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

inline

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

Here is the caller graph for this function:

template<class TO, class FROM>

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

inline

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

template<class TO, class FROM>

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

inline

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

template<class TO, class FROM>

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

inline

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

template<class TO, class FROM>

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

inline

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

Here is the caller graph for this function:

template<class TO, class FROM>

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

inline

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

template<class TO, class FROM>

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

inline

{ return iRefTo; }

template<class TO, class FROM>

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

private

template<class TO, class FROM>

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

inline

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

template<class TO, class FROM>

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

inline

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

template<class TO, class FROM>

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

protectedpure virtual

Implemented in LootValidatorRef, HostileReference, GridReference< OBJECT >, GridReference< Corpse >, GridReference< T >, GridReference< GameObject >, GridReference< DynamicObject >, GridReference< NGrid< N, ACTIVE_OBJECT, WORLD_OBJECT_TYPES, GRID_OBJECT_TYPES > >, GridReference< AreaTrigger >, GridReference< Creature >, MapReference, GroupReference, and FollowerReference.

Here is the caller graph for this function:

template<class TO, class FROM>

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

protectedpure virtual

Implemented in Roll, HostileReference, GridReference< OBJECT >, GroupReference, GridReference< Corpse >, GridReference< T >, GridReference< GameObject >, GridReference< DynamicObject >, GridReference< NGrid< N, ACTIVE_OBJECT, WORLD_OBJECT_TYPES, GRID_OBJECT_TYPES > >, GridReference< AreaTrigger >, GridReference< Creature >, FollowerReference, and MapReference.

Here is the caller graph for this function:

template<class TO, class FROM>

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

protectedpure virtual

Implemented in LootValidatorRef, HostileReference, GridReference< OBJECT >, GridReference< Corpse >, GridReference< T >, GridReference< GameObject >, GridReference< DynamicObject >, GridReference< NGrid< N, ACTIVE_OBJECT, WORLD_OBJECT_TYPES, GRID_OBJECT_TYPES > >, GridReference< AreaTrigger >, GridReference< Creature >, MapReference, GroupReference, and FollowerReference.

Here is the caller graph for this function:

template<class TO, class FROM>

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

inline

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

Here is the caller graph for this function:

Member Data Documentation

template<class TO, class FROM>

FROM* Reference< TO, FROM >::iRefFrom

private

template<class TO, class FROM>

TO* Reference< TO, FROM >::iRefTo

private

---

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

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