jaulib v1.3.8
Jau Support Library (C++, Java, ..)
Loading...
Searching...
No Matches
jau::math::util::SyncBuffer Class Referenceabstract

Convenient tuple of a sync_action_t and data buffer. More...

#include <syncbuffer.hpp>

Inheritance diagram for jau::math::util::SyncBuffer:
Collaboration diagram for jau::math::util::SyncBuffer:

Public Member Functions

virtual ~SyncBuffer () noexcept=default
 
virtual sync_action_taction () noexcept=0
 Return the defined sync_action_t.
 
virtual const jau::type_infocompSignature () const noexcept=0
 Returns type signature of implementing class's stored component value type.
 
virtual const void * data () const noexcept=0
 Return the underlying data buffer as bytes w/o sync action().
 
SyncBuffersync () noexcept
 The component's size in bytes.
 
const void * syncedData () noexcept
 Return the underlying data buffer as bytes after invoking sync action().
 
virtual std::string toString () const =0
 

Detailed Description

Convenient tuple of a sync_action_t and data buffer.

sync_action_t is used to update the data buffer in case it is derived or must be otherwise transported, defined by the data provider.

Definition at line 45 of file syncbuffer.hpp.

Constructor & Destructor Documentation

◆ ~SyncBuffer()

virtual jau::math::util::SyncBuffer::~SyncBuffer ( )
virtualdefaultnoexcept

Member Function Documentation

◆ action()

virtual sync_action_t & jau::math::util::SyncBuffer::action ( )
pure virtualnoexcept

Return the defined sync_action_t.

Here is the caller graph for this function:

◆ data()

◆ syncedData()

const void * jau::math::util::SyncBuffer::syncedData ( )
inlinenoexcept

Return the underlying data buffer as bytes after invoking sync action().

Definition at line 56 of file syncbuffer.hpp.

Here is the caller graph for this function:

◆ compSignature()

◆ sync()

SyncBuffer & jau::math::util::SyncBuffer::sync ( )
inlinenoexcept

The component's size in bytes.

The number of components per element Returns element count. One element consist compsPerElem() components. Returns the byte size of all elements, i.e. elementCount() * compsPerElem() * bytesPerComp(). Synchronizes the underlying data before usage.

Convenient shortcut for action()() plus chaining.

Definition at line 79 of file syncbuffer.hpp.

Here is the caller graph for this function:

◆ toString()


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