Caffa  1.1.0
C++ Application Framework for Embedded Systems with introspection
Public Member Functions | List of all members
caffa::DataFieldDirectStorageAccessor< DataType > Class Template Reference

Direct storage accessor, which stores data values in local memory. More...

#include <cafDataFieldAccessor.h>

Inheritance diagram for caffa::DataFieldDirectStorageAccessor< DataType >:
Inheritance graph
[legend]
Collaboration diagram for caffa::DataFieldDirectStorageAccessor< DataType >:
Collaboration graph
[legend]

Public Member Functions

 DataFieldDirectStorageAccessor ()=default
 Construct a new Data Field Direct Storage Accessor object.
 
 DataFieldDirectStorageAccessor (const DataType &value)
 Construct a new Data Field Direct Storage Accessor object with a default value. More...
 
std::unique_ptr< DataFieldAccessor< DataType > > clone () const override
 Clone the accessor using polymorphism. More...
 
DataType value () override
 Get the field value. More...
 
void setValue (const DataType &value) override
 Set the value with the accessor. Will throw a std::runtime_exception if the accessor has limits and the value is outside those limits. More...
 

Detailed Description

template<class DataType>
class caffa::DataFieldDirectStorageAccessor< DataType >

Direct storage accessor, which stores data values in local memory.

Template Parameters
DataType

Constructor & Destructor Documentation

◆ DataFieldDirectStorageAccessor()

template<class DataType >
caffa::DataFieldDirectStorageAccessor< DataType >::DataFieldDirectStorageAccessor ( const DataType &  value)
inline

Construct a new Data Field Direct Storage Accessor object with a default value.

Parameters
valueDefault value

Member Function Documentation

◆ clone()

template<class DataType >
std::unique_ptr<DataFieldAccessor<DataType> > caffa::DataFieldDirectStorageAccessor< DataType >::clone ( ) const
inlineoverridevirtual

Clone the accessor using polymorphism.

Returns
A unique pointer to object of implementation class.

Implements caffa::DataFieldAccessor< DataType >.

◆ setValue()

template<class DataType >
void caffa::DataFieldDirectStorageAccessor< DataType >::setValue ( const DataType &  value)
inlineoverridevirtual

Set the value with the accessor. Will throw a std::runtime_exception if the accessor has limits and the value is outside those limits.

Parameters
valueThe value to set

Implements caffa::DataFieldAccessor< DataType >.

◆ value()

template<class DataType >
DataType caffa::DataFieldDirectStorageAccessor< DataType >::value ( )
inlineoverridevirtual

Get the field value.

Returns
Field value

Implements caffa::DataFieldAccessor< DataType >.


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