Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry Class Reference

#include <at_list.h>

Inheritance diagram for at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry:

Inheritance graph
[legend]
Collaboration diagram for at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry:

Collaboration graph
[legend]
List of all members.

Public Types

typedef xC_List_Entry txC_List_Entry
typedef xC_List_Head txC_List_Head
typedef w_payload_type txW_PayloadType
typedef w_mutex_type txC_MutexType
typedef w_accessor_traits txC_List_Traits
typedef w_foward_class txW_Forward_Class
typedef xC_List_Head list
typedef xC_List_Entry *xC_List_Entry::* txC_Entry_MemberPtr

Public Methods

bool xF_InList ()
 xC_List_Entry (const xC_List_Entry &i_other)
xC_List_Entry & operator= (const xC_List_Entry &i_other)
void xF_Inserter (xC_List_Entry *xC_List_Entry::*w_elem_pos, xC_List_Entry *xC_List_Entry::*w_elem_neg, xC_List_Entry *xC_List_Head::*w_head_pos, xC_List_Entry *xC_List_Head::*w_head_neg, xC_List_Entry *i_entry)
void xF_InsertBack (xC_List_Entry *i_entry)
void xF_InsertForw (xC_List_Entry *i_entry)
void xF_RemoveSelf ()
bool xF_Unlink ()
 ~xC_List_Entry ()
 xC_List_Entry ()

Public Attributes

xC_List_Entry * m_back
xC_List_Entry * m_forw
xC_List_Headm_head

Detailed Description

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
class at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry

This is the list entry. The entry know how to insert itself remove itself, delete itself as well as knowing how to find the payload it inherits.


Member Typedef Documentation

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
typedef xC_List_Head at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::list
 

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
typedef xC_List_Entry* xC_List_Entry::* at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::txC_Entry_MemberPtr
 

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
typedef xC_List_Entry at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::txC_List_Entry
 

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
typedef xC_List_Head at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::txC_List_Head
 

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
typedef w_accessor_traits at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::txC_List_Traits
 

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
typedef w_mutex_type at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::txC_MutexType
 

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
typedef w_foward_class at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::txW_Forward_Class
 

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
typedef w_payload_type at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::txW_PayloadType
 


Constructor & Destructor Documentation

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::xC_List_Entry const xC_List_Entry &    i_other [inline]
 

copy constructor - this must not be linked

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::~xC_List_Entry   [inline]
 

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::xC_List_Entry   [inline]
 


Member Function Documentation

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
xC_List_Entry& at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::operator= const xC_List_Entry &    i_other [inline]
 

assignment operator must do nothing. The object remains in list it is in.

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
bool at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::xF_InList   [inline]
 

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
void at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::xF_InsertBack xC_List_Entry *    i_entry [inline]
 

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
void at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::xF_Inserter xC_List_Entry *xC_List_Entry::*    w_elem_pos,
xC_List_Entry *xC_List_Entry::*    w_elem_neg,
xC_List_Entry *xC_List_Head::*    w_head_pos,
xC_List_Entry *xC_List_Head::*    w_head_neg,
xC_List_Entry *    i_entry
[inline]
 

Inserts an element on either side of an element already in the list.

Parameters:
i_entry  is the entry to insert
Returns:
nothing

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
void at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::xF_InsertForw xC_List_Entry *    i_entry [inline]
 

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
void at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::xF_RemoveSelf   [inline]
 

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
bool at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::xF_Unlink   [inline]
 

This will check for the entry's allocation in a list and will remove itself.

Returns:
result of unlink operation:
  • true if the element was actually removed
  • false if the element was not within a list hence no removal was needed.


Member Data Documentation

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
xC_List_Entry* at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::m_back
 

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
xC_List_Entry* at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::m_forw
 

template<typename w_foward_class, typename w_base_class, typename w_accessor_traits, typename w_payload_type = typename w_base_class::xW_PayloadType, typename w_mutex_type = typename w_payload_type::xW_DefaultMutexType>
xC_List_Head* at::List_Types< w_foward_class, w_base_class, w_accessor_traits, w_payload_type, w_mutex_type >::xC_List_Entry::m_head
 


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

Generated for Austria by doxygen and MakeXS at Sun Oct 24 17:35:34 PDT 2004