Horizon Official Technical Documentation
GridRefManager< OBJECT > Class Template Reference

Forward declaration of GridRefManager, the class that manages GridReference. More...

#include <GridRefManager.hpp>

+ Inheritance diagram for GridRefManager< OBJECT >:
+ Collaboration diagram for GridRefManager< OBJECT >:

Public Types

typedef Horizon::Structures::LinkedList::Head::Iterator< GridReference< OBJECT > > iterator
 
- Public Types inherited from Horizon::Structures::LinkedList::RefManager< GridRefManager< OBJECT >, OBJECT >
typedef Head::Iterator< Reference< GridRefManager< OBJECT >, OBJECT > > iterator
 
- Public Types inherited from Horizon::Structures::LinkedList::Head
typedef Iterator< Elementiterator
 

Public Member Functions

GridReference< OBJECT > * first ()
 
GridReference< OBJECT > const * first () const
 
iterator begin ()
 
- Public Member Functions inherited from Horizon::Structures::LinkedList::RefManager< GridRefManager< OBJECT >, OBJECT >
 RefManager ()
 
Reference< GridRefManager< OBJECT >, OBJECT > * first ()
 Returns the first Reference in the list. More...
 
Reference< GridRefManager< OBJECT >, OBJECT > const * first () const
 
iterator begin ()
 Returns the iterator at the beginning of the list. More...
 
iterator end ()
 Returns the iterator at the end of the list. More...
 
virtual ~RefManager ()
 
void clear_all ()
 
- Public Member Functions inherited from Horizon::Structures::LinkedList::Head
 Head ()
 
bool is_empty () const
 Returns true if the list is empty. More...
 
Elementfirst ()
 Returns the first Element in the list. More...
 
Element const * first () const
 
Elementlast ()
 Returns the last Element in the list. More...
 
Element const * last () const
 
void push_front (Element *pElem)
 push_front() and push_back() are used to add an Element to the list. More...
 
void push_back (Element *pElem)
 
uint32_t get_size () const
 returns the number of Elements in the list (not including the head and tail Elements or the first and last Elements) More...
 
void inc_size ()
 
void dec_size ()
 

Additional Inherited Members

- Protected Member Functions inherited from Horizon::Structures::LinkedList::Head
 ~Head ()
 

Detailed Description

template<class OBJECT>
class GridRefManager< OBJECT >

Forward declaration of GridRefManager, the class that manages GridReference.

GridRefManager is a manager for GridReference. It is used to link objects and iterate through them.

Template Parameters
OBJECTThe type of object to be linked.

Member Typedef Documentation

◆ iterator

template<class OBJECT >
typedef Horizon::Structures::LinkedList::Head::Iterator<GridReference<OBJECT> > GridRefManager< OBJECT >::iterator

Member Function Documentation

◆ begin()

◆ first() [1/2]

template<class OBJECT >
GridReference< OBJECT > * GridRefManager< OBJECT >::first ( )
inline
46 {
48 }
GridReference is a reference to an object in GridRefManager. It is used to link objects.
Definition: GridReference.hpp:43
This class is used to manage a linked list of References. It is not intended to be used directly....
Definition: RefManager.hpp:33

References GridRefManager< OBJECT >::first().

Referenced by GridRefManager< OBJECT >::begin(), and GridRefManager< OBJECT >::first().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ first() [2/2]

template<class OBJECT >
GridReference< OBJECT > const * GridRefManager< OBJECT >::first ( ) const
inline

References GridRefManager< OBJECT >::first().

+ Here is the call graph for this function:

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