PdCom  5.0
Process data communication client
Public Types | Public Member Functions | List of all members
PdCom::Selector Struct Reference

Selector base class for creating views on multidimensional data. More...

#include <Subscription.h>

Public Types

using CopyFunctionType = std::function< void(void *, const void *)>
 

Public Member Functions

virtual std::unique_ptr< Selectorclone () const
 Deep copy. More...
 
virtual std::size_t getRequiredSize (const Variable &variable) const
 Required size of the view, in bytes. More...
 
virtual CopyFunctionType getCopyFunction (const Variable &variable) const
 Smart memcpy(). More...
 

Detailed Description

Selector base class for creating views on multidimensional data.

Developers have to override clone(), getRequiredSize() and getCopyFunction() in their derived class.

Member Function Documentation

◆ clone()

virtual std::unique_ptr<Selector> PdCom::Selector::clone ( ) const
virtual

Deep copy.

Returns
A deep copy of a Selector.

◆ getCopyFunction()

virtual CopyFunctionType PdCom::Selector::getCopyFunction ( const Variable variable) const
virtual

Smart memcpy().

Returns
A functor which will copy arriving variable data to the provided view memory.

◆ getRequiredSize()

virtual std::size_t PdCom::Selector::getRequiredSize ( const Variable variable) const
virtual

Required size of the view, in bytes.

Returns
The required memory space for the view, in bytes.

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