boost::python::detail::container_element< Container, Index, Policies > Class Template Reference

#include <indexing_suite_detail.hpp>

Public Types
typedef Index	index_type
typedef Container	container_type
typedef Policies::data_type	element_type
typedef Policies	policies_type
typedef container_element < Container, Index, Policies >	self_t
typedef proxy_group< self_t >	links_type
typedef Index	index_type
typedef Container	container_type
typedef Policies::data_type	element_type
typedef Policies	policies_type
typedef container_element < Container, Index, Policies >	self_t
typedef proxy_group< self_t >	links_type

Public Member Functions
	container_element (object container, Index index)
	container_element (container_element const &ce)
	~container_element ()
element_type &	operator* () const
element_type *	get () const
void	detach ()
bool	is_detached () const
Container &	get_container () const
Index	get_index () const
void	set_index (Index i)
	container_element (object container, Index index)
	container_element (container_element const &ce)
	~container_element ()
element_type &	operator* () const
element_type *	get () const
void	detach ()
bool	is_detached () const
Container &	get_container () const
Index	get_index () const
void	set_index (Index i)

Static Public Member Functions
static proxy_links< self_t, Container > &	get_links ()
static proxy_links< self_t, Container > &	get_links ()

Detailed Description

template<class Container, class Index, class Policies>
class boost::python::detail::container_element< Container, Index, Policies >

Definition at line 352 of file source/boost/detail/indexing_suite_detail.hpp.

Member Typedef Documentation

template<class Container, class Index, class Policies>

typedef Container boost::python::detail::container_element< Container, Index, Policies >::container_type

Definition at line 357 of file source/boost/detail/indexing_suite_detail.hpp.

template<class Container, class Index, class Policies>

typedef Container boost::python::detail::container_element< Container, Index, Policies >::container_type

Definition at line 357 of file tests/test12/include/detail/indexing_suite_detail.hpp.

template<class Container, class Index, class Policies>

typedef Policies::data_type boost::python::detail::container_element< Container, Index, Policies >::element_type

Definition at line 358 of file tests/test12/include/detail/indexing_suite_detail.hpp.

template<class Container, class Index, class Policies>

typedef Policies::data_type boost::python::detail::container_element< Container, Index, Policies >::element_type

Definition at line 358 of file source/boost/detail/indexing_suite_detail.hpp.

template<class Container, class Index, class Policies>

typedef Index boost::python::detail::container_element< Container, Index, Policies >::index_type

Definition at line 356 of file source/boost/detail/indexing_suite_detail.hpp.

template<class Container, class Index, class Policies>

typedef Index boost::python::detail::container_element< Container, Index, Policies >::index_type

Definition at line 356 of file tests/test12/include/detail/indexing_suite_detail.hpp.

template<class Container, class Index, class Policies>

typedef proxy_group<self_t> boost::python::detail::container_element< Container, Index, Policies >::links_type

Definition at line 361 of file tests/test12/include/detail/indexing_suite_detail.hpp.

template<class Container, class Index, class Policies>

typedef proxy_group<self_t> boost::python::detail::container_element< Container, Index, Policies >::links_type

Definition at line 361 of file source/boost/detail/indexing_suite_detail.hpp.

template<class Container, class Index, class Policies>

typedef Policies boost::python::detail::container_element< Container, Index, Policies >::policies_type

Definition at line 359 of file tests/test12/include/detail/indexing_suite_detail.hpp.

template<class Container, class Index, class Policies>

typedef Policies boost::python::detail::container_element< Container, Index, Policies >::policies_type

Definition at line 359 of file source/boost/detail/indexing_suite_detail.hpp.

template<class Container, class Index, class Policies>

typedef container_element<Container, Index, Policies> boost::python::detail::container_element< Container, Index, Policies >::self_t

Definition at line 360 of file tests/test12/include/detail/indexing_suite_detail.hpp.

template<class Container, class Index, class Policies>

typedef container_element<Container, Index, Policies> boost::python::detail::container_element< Container, Index, Policies >::self_t

Definition at line 360 of file source/boost/detail/indexing_suite_detail.hpp.

Constructor & Destructor Documentation

template<class Container, class Index, class Policies>

boost::python::detail::container_element< Container, Index, Policies >::container_element ( object  container, Index  index  )

inline

Definition at line 363 of file source/boost/detail/indexing_suite_detail.hpp.

            : ptr()
            , container(container)
            , index(index)
        {
        }

template<class Container, class Index, class Policies>

boost::python::detail::container_element< Container, Index, Policies >::container_element ( container_element< Container, Index, Policies > const &  ce )

inline

Definition at line 370 of file source/boost/detail/indexing_suite_detail.hpp.

          : ptr(ce.ptr.get() == 0 ? 0 : new element_type(*ce.ptr.get()))
          , container(ce.container)
          , index(ce.index)
        {
        }

template<class Container, class Index, class Policies>

boost::python::detail::container_element< Container, Index, Policies >::~container_element ( )

inline

Definition at line 377 of file source/boost/detail/indexing_suite_detail.hpp.

References boost::python::detail::container_element< Container, Index, Policies >::get_links(), and boost::python::detail::container_element< Container, Index, Policies >::is_detached().

        {
            if (!is_detached())
                get_links().remove(*this);
        }

template<class Container, class Index, class Policies>

boost::python::detail::container_element< Container, Index, Policies >::container_element ( object  container, Index  index  )

inline

Definition at line 363 of file tests/test12/include/detail/indexing_suite_detail.hpp.

            : ptr()
            , container(container)
            , index(index)
        {
        }

template<class Container, class Index, class Policies>

boost::python::detail::container_element< Container, Index, Policies >::container_element ( container_element< Container, Index, Policies > const &  ce )

inline

Definition at line 370 of file tests/test12/include/detail/indexing_suite_detail.hpp.

          : ptr(ce.ptr.get() == 0 ? 0 : new element_type(*ce.ptr.get()))
          , container(ce.container)
          , index(ce.index)
        {
        }

template<class Container, class Index, class Policies>

boost::python::detail::container_element< Container, Index, Policies >::~container_element ( )

inline

Definition at line 377 of file tests/test12/include/detail/indexing_suite_detail.hpp.

References boost::python::detail::container_element< Container, Index, Policies >::get_links(), and boost::python::detail::container_element< Container, Index, Policies >::is_detached().

        {
            if (!is_detached())
                get_links().remove(*this);
        }

Member Function Documentation

template<class Container, class Index, class Policies>

void boost::python::detail::container_element< Container, Index, Policies >::detach ( )

inline

Definition at line 398 of file source/boost/detail/indexing_suite_detail.hpp.

References boost::python::detail::container_element< Container, Index, Policies >::get_container(), and boost::python::detail::container_element< Container, Index, Policies >::is_detached().

        {
            if (!is_detached())
            {
                ptr.reset(
                    new element_type(
                        Policies::get_item(get_container(), index)));
                container = object(); // free container. reset it to None
            }
        }

template<class Container, class Index, class Policies>

void boost::python::detail::container_element< Container, Index, Policies >::detach ( )

inline

Definition at line 398 of file tests/test12/include/detail/indexing_suite_detail.hpp.

References boost::python::detail::container_element< Container, Index, Policies >::get_container(), and boost::python::detail::container_element< Container, Index, Policies >::is_detached().

        {
            if (!is_detached())
            {
                ptr.reset(
                    new element_type(
                        Policies::get_item(get_container(), index)));
                container = object(); // free container. reset it to None
            }
        }

template<class Container, class Index, class Policies>

element_type* boost::python::detail::container_element< Container, Index, Policies >::get ( ) const

inline

Definition at line 390 of file tests/test12/include/detail/indexing_suite_detail.hpp.

References boost::python::detail::container_element< Container, Index, Policies >::get_container(), boost::python::detail::get_pointer(), and boost::python::detail::container_element< Container, Index, Policies >::is_detached().

        {
            if (is_detached())
                return get_pointer(ptr);
            return &Policies::get_item(get_container(), index);
        }

template<class Container, class Index, class Policies>

element_type* boost::python::detail::container_element< Container, Index, Policies >::get ( ) const

inline

Definition at line 390 of file source/boost/detail/indexing_suite_detail.hpp.

References boost::python::detail::container_element< Container, Index, Policies >::get_container(), boost::python::detail::get_pointer(), and boost::python::detail::container_element< Container, Index, Policies >::is_detached().

Referenced by boost::python::detail::get_pointer().

        {
            if (is_detached())
                return get_pointer(ptr);
            return &Policies::get_item(get_container(), index);
        }

template<class Container, class Index, class Policies>

Container& boost::python::detail::container_element< Container, Index, Policies >::get_container ( ) const

inline

Definition at line 416 of file source/boost/detail/indexing_suite_detail.hpp.

Referenced by boost::python::detail::container_element< Container, Index, Policies >::detach(), boost::python::detail::container_element< Container, Index, Policies >::get(), and boost::python::detail::container_element< Container, Index, Policies >::operator*().

        {
            return extract<Container&>(container)();
        }

template<class Container, class Index, class Policies>

Container& boost::python::detail::container_element< Container, Index, Policies >::get_container ( ) const

inline

Definition at line 416 of file tests/test12/include/detail/indexing_suite_detail.hpp.

        {
            return extract<Container&>(container)();
        }

template<class Container, class Index, class Policies>

Index boost::python::detail::container_element< Container, Index, Policies >::get_index ( ) const

inline

Definition at line 422 of file source/boost/detail/indexing_suite_detail.hpp.

        {
            return index;
        }

template<class Container, class Index, class Policies>

Index boost::python::detail::container_element< Container, Index, Policies >::get_index ( ) const

inline

Definition at line 422 of file tests/test12/include/detail/indexing_suite_detail.hpp.

        {
            return index;
        }

template<class Container, class Index, class Policies>

static proxy_links<self_t, Container>& boost::python::detail::container_element< Container, Index, Policies >::get_links ( )

inlinestatic

Definition at line 434 of file source/boost/detail/indexing_suite_detail.hpp.

Referenced by boost::python::detail::container_element< Container, Index, Policies >::~container_element().

        {
            // All container_element(s) maintain links to
            // its container in a global map (see proxy_links).
            // This global "links" map is a singleton.
            
            static proxy_links<self_t, Container> links;
            return links; // singleton
        }

template<class Container, class Index, class Policies>

static proxy_links<self_t, Container>& boost::python::detail::container_element< Container, Index, Policies >::get_links ( )

inlinestatic

Definition at line 434 of file tests/test12/include/detail/indexing_suite_detail.hpp.

        {
            // All container_element(s) maintain links to
            // its container in a global map (see proxy_links).
            // This global "links" map is a singleton.
            
            static proxy_links<self_t, Container> links;
            return links; // singleton
        }

template<class Container, class Index, class Policies>

bool boost::python::detail::container_element< Container, Index, Policies >::is_detached ( ) const

inline

Definition at line 410 of file source/boost/detail/indexing_suite_detail.hpp.

References boost::python::detail::get_pointer().

Referenced by boost::python::detail::container_element< Container, Index, Policies >::detach(), boost::python::detail::container_element< Container, Index, Policies >::get(), boost::python::detail::container_element< Container, Index, Policies >::operator*(), and boost::python::detail::container_element< Container, Index, Policies >::~container_element().

        {
            return get_pointer(ptr) != 0;
        }

template<class Container, class Index, class Policies>

bool boost::python::detail::container_element< Container, Index, Policies >::is_detached ( ) const

inline

Definition at line 410 of file tests/test12/include/detail/indexing_suite_detail.hpp.

References boost::python::detail::get_pointer().

        {
            return get_pointer(ptr) != 0;
        }

template<class Container, class Index, class Policies>

element_type& boost::python::detail::container_element< Container, Index, Policies >::operator* ( ) const

inline

Definition at line 383 of file source/boost/detail/indexing_suite_detail.hpp.

References boost::python::detail::container_element< Container, Index, Policies >::get_container(), boost::python::detail::get_pointer(), and boost::python::detail::container_element< Container, Index, Policies >::is_detached().

        {
            if (is_detached())
                return *get_pointer(ptr);
            return Policies::get_item(get_container(), index);
        }

template<class Container, class Index, class Policies>

element_type& boost::python::detail::container_element< Container, Index, Policies >::operator* ( ) const

inline

Definition at line 383 of file tests/test12/include/detail/indexing_suite_detail.hpp.

References boost::python::detail::container_element< Container, Index, Policies >::get_container(), boost::python::detail::get_pointer(), and boost::python::detail::container_element< Container, Index, Policies >::is_detached().

        {
            if (is_detached())
                return *get_pointer(ptr);
            return Policies::get_item(get_container(), index);
        }

template<class Container, class Index, class Policies>

void boost::python::detail::container_element< Container, Index, Policies >::set_index ( Index  i )

inline

Definition at line 428 of file tests/test12/include/detail/indexing_suite_detail.hpp.

        {
            index = i;
        }

template<class Container, class Index, class Policies>

void boost::python::detail::container_element< Container, Index, Policies >::set_index ( Index  i )

inline

Definition at line 428 of file source/boost/detail/indexing_suite_detail.hpp.

        {
            index = i;
        }

---

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

• source/boost/detail/indexing_suite_detail.hpp