tpie::pipelining::virtual_chunk_begin< Output > Class Template Reference

Virtual chunk that has no input (that is, virtual producer). More...

#include <tpie/pipelining/virtual.h>

Inherits tpie::pipelining::bits::virtual_chunk_base.

Public Member Functions
	virtual_chunk_begin ()
	Constructor that leaves the virtual chunk unassigned. More...
template<typename fact_t >
	virtual_chunk_begin (const pipe_begin< fact_t > &pipe, virtual_container *ctr=0)
	Constructor that recursively constructs a node and takes ownership of it. More...
template<typename Mid >
	virtual_chunk_begin (const virtual_chunk_begin< Mid > &left, const virtual_chunk< Mid, Output > &right)
	Constructor that combines two virtual chunks. More...
template<typename fact_t >
virtual_chunk_begin &	operator= (const pipe_begin< fact_t > &pipe)
	Construct a node and assign it to this virtual chunk. More...
template<typename NextOutput >
virtual_chunk_begin< NextOutput >	operator| (virtual_chunk< Output, NextOutput > dest)
	Connect this virtual chunk to another chunk. More...
virtual_chunk_base	operator| (virtual_chunk_end< Output > dest)
	Connect this virtual chunk to another chunk. More...
virt_node::ptr	get_node () const
void	set_container (virtual_container *ctr)
	operator bool ()
void	operator() (stream_size_type items, progress_indicator_base &pi, memory_size_type mem)
	Invoke the pipeline. More...
void	plot (std::ostream &out)
	Generate a GraphViz plot of the actor graph. More...
double	memory () const
node_map::ptr	get_node_map () const
void	forward_any (std::string key, const boost::any &value)
bool	can_fetch (std::string key)
boost::any	fetch_any (std::string key)

Protected Attributes
virt_node::ptr	m_node
node_map::ptr	m_segmap
double	m_memory

Friends
class	bits::access

Detailed Description

template<typename Output>
class tpie::pipelining::virtual_chunk_begin< Output >

Virtual chunk that has no input (that is, virtual producer).

Definition at line 280 of file virtual.h.

Constructor & Destructor Documentation

template<typename Output>

tpie::pipelining::virtual_chunk_begin< Output >::virtual_chunk_begin ( )

inline

Constructor that leaves the virtual chunk unassigned.

Definition at line 478 of file virtual.h.

        : m_recv(0)
    {}

template<typename Output>

template<typename fact_t >

tpie::pipelining::virtual_chunk_begin< Output >::virtual_chunk_begin ( const pipe_begin< fact_t > &  pipe, virtual_container *  ctr = 0  )

inline

Constructor that recursively constructs a node and takes ownership of it.

Definition at line 487 of file virtual.h.

                                                                                      {
        *this = pipe;
        set_container(ctr);
    }

template<typename Output>

template<typename Mid >

tpie::pipelining::virtual_chunk_begin< Output >::virtual_chunk_begin ( const virtual_chunk_begin< Mid > &  left, const virtual_chunk< Mid, Output > &  right  )

inline

Constructor that combines two virtual chunks.

Assumes that the virtual nodes are already connected. You should not use this constructor directly; instead, use the pipe operator.

Definition at line 498 of file virtual.h.

        : virtual_chunk_base(left.get_node_map(),
                             bits::virt_node::combine(left.get_node(), right.get_node()))
    {
        m_recv = acc::get_destination(right);
    }

Member Function Documentation

void tpie::pipelining::bits::pipeline_base::operator() ( stream_size_type  items, progress_indicator_base &  pi, memory_size_type  mem  )

inherited

Invoke the pipeline.

template<typename Output>

template<typename fact_t >

virtual_chunk_begin& tpie::pipelining::virtual_chunk_begin< Output >::operator= ( const pipe_begin< fact_t > &  pipe )

inline

Construct a node and assign it to this virtual chunk.

Definition at line 510 of file virtual.h.

References tpie::pipelining::node::get_node_map(), tpie::log_error(), and tpie::pipelining::bits::virt_node::take_own().

                                                                     {
        if (this->m_node) {
            log_error() << "Virtual chunk assigned twice" << std::endl;
            throw tpie::exception("Virtual chunk assigned twice");
        }
        typedef typename fact_t::template constructed<recv_type>::type constructed_type;
        recv_type temp(m_recv);
        this->m_node = bits::virt_node::take_own(new constructed_type(pipe.factory.construct(temp)));
        this->m_segmap = m_recv->get_node_map();
        return *this;
    }

template<typename Output>

template<typename NextOutput >

virtual_chunk_begin<NextOutput> tpie::pipelining::virtual_chunk_begin< Output >::operator| ( virtual_chunk< Output, NextOutput >  dest )

inline

Connect this virtual chunk to another chunk.

Definition at line 526 of file virtual.h.

                                                                                      {
        if (!*this) throw virtual_chunk_missing_begin();
        if (!dest) {
            return *bits::assert_types_equal_and_return<Output, NextOutput, virtual_chunk_begin<NextOutput> *>
                ::go(this);
        }
        m_recv->set_destination(acc::get_source(dest));
        return virtual_chunk_begin<NextOutput>(*this, dest);
    }

template<typename Output>

virtual_chunk_base tpie::pipelining::virtual_chunk_begin< Output >::operator| ( virtual_chunk_end< Output >  dest )

inline

Connect this virtual chunk to another chunk.

Definition at line 539 of file virtual.h.

References tpie::pipelining::bits::virt_node::combine().

                                                                 {
        if (!*this) throw virtual_chunk_missing_begin();
        if (!dest) throw virtual_chunk_missing_end();
        m_recv->set_destination(acc::get_source(dest));
        return virtual_chunk_base(this->m_segmap,
                                  bits::virt_node::combine(get_node(), dest.get_node()));
    }

void tpie::pipelining::bits::pipeline_base::plot ( std::ostream &  out )

inherited

Generate a GraphViz plot of the actor graph.

When rendered with dot, GraphViz will place the nodes in the topological order of the item flow graph with items flowing from the top downwards.

Thus, a downwards arrow in the plot is a push edge, and an upwards arrow is a pull edge (assuming no cycles in the item flow graph).

---

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

• pipelining/virtual.h