ug4
pcl::SelectionCommPol< TLayout, TSelectorIn, TSelectorOut > Class Template Reference

communicates selection-status of interface elements More...

#include <pcl_util.h>

+ Inheritance diagram for pcl::SelectionCommPol< TLayout, TSelectorIn, TSelectorOut >:

Public Types

typedef ICommunicationPolicy< TLayout >::Interface Interface
 
- Public Types inherited from pcl::ICommunicationPolicy< TLayout >
typedef Layout::Interface Interface
 
typedef TLayout Layout
 

Public Member Functions

virtual bool collect (ug::BinaryBuffer &buff, Interface &interface)
 iterates over the interface entries. Writes 1 for selected, 0 for unselected. More...
 
virtual bool extract (ug::BinaryBuffer &buff, Interface &interface)
 iterates over the interface entries. selects for 1, deselects for 0. More...
 
 SelectionCommPol (TSelectorIn &selIn, TSelectorOut &selOut)
 
- Public Member Functions inherited from pcl::ICommunicationPolicy< TLayout >
virtual bool begin_layout_collection (const Layout *pLayout)
 signals the beginning of a layout collection. More...
 
virtual bool begin_layout_extraction (const Layout *pLayout)
 signals the beginning of a layout extraction. More...
 
virtual void begin_level_extraction (int level)
 signals that a new layout-level will now be processed. More...
 
virtual bool collect (ug::BinaryBuffer &buff, const Interface &interface)=0
 should write data which is associated with the interface elements to the buffer. More...
 
virtual bool end_layout_collection (const Layout *pLayout)
 signals the end of a layout collection More...
 
virtual bool end_layout_extraction (const Layout *pLayout)
 signals the end of a layout extraction More...
 
virtual bool extract (ug::BinaryBuffer &buff, const Interface &interface)=0
 extract data from the buffer and assigns it to the interface-elements. More...
 
virtual int get_required_buffer_size (const Interface &interface)
 returns the size of the buffer in bytes, that will be required for interface-communication. More...
 
virtual ~ICommunicationPolicy ()
 

Protected Attributes

TSelectorIn & m_selIn
 
TSelectorOut & m_selOut
 

Detailed Description

template<class TLayout, class TSelectorIn, class TSelectorOut>
class pcl::SelectionCommPol< TLayout, TSelectorIn, TSelectorOut >

communicates selection-status of interface elements

TLayout has to be compatible with the pcl::layout_tags.

TSelectorIn has to feature a method

bool TSelectorIn::is_selected(TLayout::Element e);

TSelectorOut has to feature methods

void TSelectorOut::select(TLayout::Element e);
void TSelectorOut::deselect(TLayout::Element e);

Member Typedef Documentation

◆ Interface

template<class TLayout , class TSelectorIn , class TSelectorOut >
typedef ICommunicationPolicy<TLayout>::Interface pcl::SelectionCommPol< TLayout, TSelectorIn, TSelectorOut >::Interface

Constructor & Destructor Documentation

◆ SelectionCommPol()

template<class TLayout , class TSelectorIn , class TSelectorOut >
pcl::SelectionCommPol< TLayout, TSelectorIn, TSelectorOut >::SelectionCommPol ( TSelectorIn &  selIn,
TSelectorOut &  selOut 
)
inline

Member Function Documentation

◆ collect()

template<class TLayout , class TSelectorIn , class TSelectorOut >
virtual bool pcl::SelectionCommPol< TLayout, TSelectorIn, TSelectorOut >::collect ( ug::BinaryBuffer buff,
Interface interface 
)
inlinevirtual

iterates over the interface entries. Writes 1 for selected, 0 for unselected.

References pcl::SelectionCommPol< TLayout, TSelectorIn, TSelectorOut >::m_selIn, and ug::BinaryBuffer::write().

◆ extract()

template<class TLayout , class TSelectorIn , class TSelectorOut >
virtual bool pcl::SelectionCommPol< TLayout, TSelectorIn, TSelectorOut >::extract ( ug::BinaryBuffer buff,
Interface interface 
)
inlinevirtual

iterates over the interface entries. selects for 1, deselects for 0.

References pcl::SelectionCommPol< TLayout, TSelectorIn, TSelectorOut >::m_selOut, and ug::BinaryBuffer::read().

Member Data Documentation

◆ m_selIn

template<class TLayout , class TSelectorIn , class TSelectorOut >
TSelectorIn& pcl::SelectionCommPol< TLayout, TSelectorIn, TSelectorOut >::m_selIn
protected

◆ m_selOut

template<class TLayout , class TSelectorIn , class TSelectorOut >
TSelectorOut& pcl::SelectionCommPol< TLayout, TSelectorIn, TSelectorOut >::m_selOut
protected

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