Horizon::Structures::LinkedList::Reference< TO, FROM > Class Template Reference

#include <Reference.hpp>

Inheritance diagram for Horizon::Structures::LinkedList::Reference< TO, FROM >:

Collaboration diagram for Horizon::Structures::LinkedList::Reference< TO, FROM >:

Public Member Functions
	Reference ()
virtual	~Reference ()
void	link (TO *toObj, FROM *fromObj)
	Links the Reference to the specified object by adding it to the front of the list. More...
void	remove ()
void	invalidate ()
bool	is_valid () 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 *	target () const
FROM *	source () const
Public Member Functions inherited from Horizon::Structures::LinkedList::Element
	Element ()
bool	has_next () const
	Returns true if this Element has a next Element in the list. More...
bool	has_prev () const
	Returns true if this Element has a previous Element in the list. More...
bool	is_in_list () const
	Returns true if this Element is in a list. More...
Element *	next ()
	Returns the next Element in the list. More...
Element const *	next () const
Element *	prev ()
	Returns the previous Element in the list. More...
Element const *	prev () const
Element *	nocheck_next ()
	Returns the next Element in the list without checking if it exists. More...
Element const *	nocheck_next () const
Element *	nocheck_prev ()
	Returns the previous Element in the list without checking if it exists. More...
Element const *	nocheck_prev () const
void	delink ()
	Removes this Element from the list. More...
void	push_before (Element *pElem)
	Pushes this Element before the given Element. More...
void	push_after (Element *pElem)
	Pushes this Element after the given Element. More...

Protected Member Functions
virtual void	target_object_build_link ()=0
virtual void	target_object_destroy_link ()=0
virtual void	source_object_destroy_link ()=0
Protected Member Functions inherited from Horizon::Structures::LinkedList::Element
	~Element ()

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

Private Attributes
TO *	_ref_to
FROM *	_ref_from

Detailed Description

template<class TO, class FROM>
class Horizon::Structures::LinkedList::Reference< TO, FROM >

This class is used to manage a linked list of References. It is not intended to be used directly. It is used as a base class for other classes that need to manage a linked list. The Head class is a friend of this class (derived from Element) to allow it to access the private members of this class. The relationship between the Reference and the ReferenceManager is a one-to-many relationship, where the ReferenceManager is the one and the Reference is the many. The ReferenceManager is responsible for creating and destroying the Reference. The ReferenceManager is also responsible for calling the link() and remove() methods of the Reference. This creates a dynamic responsibility chain between the ReferenceManager and the Reference.

Parameters

_next	(derived from Element)The next Reference in the list.
_prev	(derived from Element) The previous Reference in the list.
_ref_to	The object that is being referenced.
_ref_from	The object that is referencing.

Constructor & Destructor Documentation

Reference() [1/2]

template<class TO , class FROM >

Horizon::Structures::LinkedList::Reference< TO, FROM >::Reference ( )

inline

{ _ref_to = nullptr; _ref_from = nullptr; }

References Horizon::Structures::LinkedList::Reference< TO, FROM >::_ref_from, and Horizon::Structures::LinkedList::Reference< TO, FROM >::_ref_to.

~Reference()

template<class TO , class FROM >

virtual Horizon::Structures::LinkedList::Reference< TO, FROM >::~Reference ( )

inlinevirtual

{ }

Reference() [2/2]

template<class TO , class FROM >

Horizon::Structures::LinkedList::Reference< TO, FROM >::Reference ( Reference< TO, FROM > const &  )

privatedelete

Member Function Documentation

invalidate()

template<class TO , class FROM >

void Horizon::Structures::LinkedList::Reference< TO, FROM >::invalidate ( )

inline

    {
        source_object_destroy_link();
        delink();
        _ref_to = nullptr;
    }

References Horizon::Structures::LinkedList::Reference< TO, FROM >::_ref_to, Horizon::Structures::LinkedList::Element::delink(), and Horizon::Structures::LinkedList::Reference< TO, FROM >::source_object_destroy_link().

Referenced by TestObject< T >::remove_reference().

Here is the call graph for this function:

Here is the caller graph for this function:

is_valid()

template<class TO , class FROM >

bool Horizon::Structures::LinkedList::Reference< TO, FROM >::is_valid ( ) const

inline

    {
        return _ref_to != nullptr;
    }

References Horizon::Structures::LinkedList::Reference< TO, FROM >::_ref_to.

Referenced by Horizon::Zone::GridObject< T >::has_valid_grid_reference(), ReferenceObject< T >::is_valid(), Horizon::Structures::LinkedList::Reference< TO, FROM >::link(), and TestObject< T >::valid().

Here is the caller graph for this function:

link()

template<class TO , class FROM >

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

inline

Links the Reference to the specified object by adding it to the front of the list.

Parameters

toObj	The object to reference.
fromObj	The object that is referencing.

    {
        assert(fromObj);
 
        // Clear if any previous references to a reference manager.
        if (is_valid())
            remove();
 
        // Build the link.
        if (toObj != nullptr) {
            _ref_to = toObj;
            _ref_from = fromObj;
            target_object_build_link();
        }
    }

References Horizon::Structures::LinkedList::Reference< TO, FROM >::_ref_from, Horizon::Structures::LinkedList::Reference< TO, FROM >::_ref_to, Horizon::Structures::LinkedList::Reference< TO, FROM >::is_valid(), Horizon::Structures::LinkedList::Reference< TO, FROM >::remove(), and Horizon::Structures::LinkedList::Reference< TO, FROM >::target_object_build_link().

Referenced by Horizon::Zone::GridObject< T >::add_grid_reference(), TestObject< T >::add_reference(), and ReferenceObject< T >::add_reference().

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 > * Horizon::Structures::LinkedList::Reference< TO, FROM >::next ( )

inline

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

References Horizon::Structures::LinkedList::Element::next().

Here is the call graph for this function:

next() [2/2]

template<class TO , class FROM >

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

inline

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

References Horizon::Structures::LinkedList::Element::next().

Here is the call graph for this function:

nocheck_next() [1/2]

template<class TO , class FROM >

Reference< TO, FROM > * Horizon::Structures::LinkedList::Reference< TO, FROM >::nocheck_next ( )

inline

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

References Horizon::Structures::LinkedList::Element::nocheck_next().

Here is the call graph for this function:

nocheck_next() [2/2]

template<class TO , class FROM >

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

inline

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

References Horizon::Structures::LinkedList::Element::nocheck_next().

Here is the call graph for this function:

nocheck_prev() [1/2]

template<class TO , class FROM >

Reference< TO, FROM > * Horizon::Structures::LinkedList::Reference< TO, FROM >::nocheck_prev ( )

inline

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

References Horizon::Structures::LinkedList::Element::nocheck_prev().

Here is the call graph for this function:

nocheck_prev() [2/2]

template<class TO , class FROM >

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

inline

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

References Horizon::Structures::LinkedList::Element::nocheck_prev().

Here is the call graph for this function:

operator->()

template<class TO , class FROM >

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

inline

{ return _ref_to; }

References Horizon::Structures::LinkedList::Reference< TO, FROM >::_ref_to.

operator=()

template<class TO , class FROM >

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

privatedelete

prev() [1/2]

template<class TO , class FROM >

Reference< TO, FROM > * Horizon::Structures::LinkedList::Reference< TO, FROM >::prev ( )

inline

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

References Horizon::Structures::LinkedList::Element::prev().

Referenced by BOOST_AUTO_TEST_CASE().

Here is the call graph for this function:

Here is the caller graph for this function:

prev() [2/2]

template<class TO , class FROM >

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

inline

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

References Horizon::Structures::LinkedList::Element::prev().

Here is the call graph for this function:

remove()

template<class TO , class FROM >

void Horizon::Structures::LinkedList::Reference< TO, FROM >::remove ( )

inline

    {
        target_object_destroy_link();
        delink();
        _ref_to = nullptr;
        _ref_from = nullptr;
    }

References Horizon::Structures::LinkedList::Reference< TO, FROM >::_ref_from, Horizon::Structures::LinkedList::Reference< TO, FROM >::_ref_to, Horizon::Structures::LinkedList::Element::delink(), and Horizon::Structures::LinkedList::Reference< TO, FROM >::target_object_destroy_link().

Referenced by Horizon::Structures::LinkedList::Reference< TO, FROM >::link(), Horizon::Zone::GridObject< T >::remove_grid_reference(), and ReferenceObject< T >::remove_reference().

Here is the call graph for this function:

Here is the caller graph for this function:

source()

template<class TO , class FROM >

FROM * Horizon::Structures::LinkedList::Reference< TO, FROM >::source ( ) const

inline

{ return _ref_from; }

References Horizon::Structures::LinkedList::Reference< TO, FROM >::_ref_from.

source_object_destroy_link()

template<class TO , class FROM >

virtual void Horizon::Structures::LinkedList::Reference< TO, FROM >::source_object_destroy_link ( )

protectedpure virtual

Implemented in GridReference< OBJECT >, GridReference< Elemental >, GridReference< Homunculus >, GridReference< Item >, GridReference< Mercenary >, GridReference< Monster >, GridReference< NPC >, GridReference< Pet >, GridReference< Player >, GridReference< Skill >, GridReference< T >, TestReference< OBJECT >, TestReference< A >, TestReference< B >, TestReference< C >, TestReference< Player >, TestReference< T >, TestReference< OBJECT >, TestReference< A >, TestReference< B >, TestReference< C >, TestReference< Player >, and TestReference< T >.

Referenced by Horizon::Structures::LinkedList::Reference< TO, FROM >::invalidate().

Here is the caller graph for this function:

target()

template<class TO , class FROM >

TO * Horizon::Structures::LinkedList::Reference< TO, FROM >::target ( ) const

inline

{ return _ref_to; }

References Horizon::Structures::LinkedList::Reference< TO, FROM >::_ref_to.

target_object_build_link()

template<class TO , class FROM >

virtual void Horizon::Structures::LinkedList::Reference< TO, FROM >::target_object_build_link ( )

protectedpure virtual

Implemented in GridReference< OBJECT >, GridReference< Elemental >, GridReference< Homunculus >, GridReference< Item >, GridReference< Mercenary >, GridReference< Monster >, GridReference< NPC >, GridReference< Pet >, GridReference< Player >, GridReference< Skill >, GridReference< T >, TestReference< OBJECT >, TestReference< A >, TestReference< B >, TestReference< C >, TestReference< Player >, TestReference< T >, TestReference< OBJECT >, TestReference< A >, TestReference< B >, TestReference< C >, TestReference< Player >, and TestReference< T >.

Referenced by Horizon::Structures::LinkedList::Reference< TO, FROM >::link().

Here is the caller graph for this function:

target_object_destroy_link()

template<class TO , class FROM >

virtual void Horizon::Structures::LinkedList::Reference< TO, FROM >::target_object_destroy_link ( )

protectedpure virtual

Implemented in GridReference< OBJECT >, GridReference< Elemental >, GridReference< Homunculus >, GridReference< Item >, GridReference< Mercenary >, GridReference< Monster >, GridReference< NPC >, GridReference< Pet >, GridReference< Player >, GridReference< Skill >, GridReference< T >, TestReference< OBJECT >, TestReference< A >, TestReference< B >, TestReference< C >, TestReference< Player >, TestReference< T >, TestReference< OBJECT >, TestReference< A >, TestReference< B >, TestReference< C >, TestReference< Player >, and TestReference< T >.

Referenced by Horizon::Structures::LinkedList::Reference< TO, FROM >::remove().

Here is the caller graph for this function:

Member Data Documentation

_ref_from

template<class TO , class FROM >

FROM* Horizon::Structures::LinkedList::Reference< TO, FROM >::_ref_from

private

Referenced by Horizon::Structures::LinkedList::Reference< TO, FROM >::link(), Horizon::Structures::LinkedList::Reference< TO, FROM >::Reference(), Horizon::Structures::LinkedList::Reference< TO, FROM >::remove(), and Horizon::Structures::LinkedList::Reference< TO, FROM >::source().

_ref_to

template<class TO , class FROM >

TO* Horizon::Structures::LinkedList::Reference< TO, FROM >::_ref_to

private

Referenced by Horizon::Structures::LinkedList::Reference< TO, FROM >::invalidate(), Horizon::Structures::LinkedList::Reference< TO, FROM >::is_valid(), Horizon::Structures::LinkedList::Reference< TO, FROM >::link(), Horizon::Structures::LinkedList::Reference< TO, FROM >::operator->(), Horizon::Structures::LinkedList::Reference< TO, FROM >::Reference(), Horizon::Structures::LinkedList::Reference< TO, FROM >::remove(), and Horizon::Structures::LinkedList::Reference< TO, FROM >::target().

---

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

• src/Core/Structures/LinkedList/ReferenceList/Reference.hpp