SignalLogger
A library for signal logging.
signal_logger::BufferInterface Class Referenceabstract

#include <BufferInterface.hpp>

Inheritance diagram for signal_logger::BufferInterface:
Inheritance graph

Public Member Functions

virtual std::size_t getBufferSize () const =0
 
virtual void setBufferSize (const std::size_t bufferSize)=0
 
virtual BufferType getBufferType () const =0
 
virtual void setBufferType (const BufferType bufferType)=0
 
virtual std::size_t noTotalItems () const =0
 
virtual std::size_t noUnreadItems () const =0
 
virtual void clear ()=0
 clears the buffer More...
 

Member Function Documentation

◆ clear()

virtual void signal_logger::BufferInterface::clear ( )
pure virtual

clears the buffer

Implemented in signal_logger::Buffer< ValueType_ >.

◆ getBufferSize()

virtual std::size_t signal_logger::BufferInterface::getBufferSize ( ) const
pure virtual
Returns
size of the buffer

Implemented in signal_logger::Buffer< ValueType_ >.

◆ getBufferType()

virtual BufferType signal_logger::BufferInterface::getBufferType ( ) const
pure virtual
Returns
type of the buffer

Implemented in signal_logger::Buffer< ValueType_ >.

◆ noTotalItems()

virtual std::size_t signal_logger::BufferInterface::noTotalItems ( ) const
pure virtual
Returns
no items in the buffer (unread and read)

Implemented in signal_logger::Buffer< ValueType_ >.

◆ noUnreadItems()

virtual std::size_t signal_logger::BufferInterface::noUnreadItems ( ) const
pure virtual
Returns
no unread items in the buffer

Implemented in signal_logger::Buffer< ValueType_ >.

◆ setBufferSize()

virtual void signal_logger::BufferInterface::setBufferSize ( const std::size_t  bufferSize)
pure virtual
Parameters
desiredsize of the buffer

Implemented in signal_logger::Buffer< ValueType_ >.

◆ setBufferType()

virtual void signal_logger::BufferInterface::setBufferType ( const BufferType  bufferType)
pure virtual
Parameters
desiredsize of the buffer

Implemented in signal_logger::Buffer< ValueType_ >.


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