FSTR::Vector< ObjectType > Class Template Reference

Class to access a Vector of objects stored in flash. More...

#include <Vector.hpp>

Inheritance diagram for FSTR::Vector< ObjectType >:
Collaboration diagram for FSTR::Vector< ObjectType >:

Public Member Functions

template<typename ValueType , typename T = ObjectType>
std::enable_if< std::is_same< T, String >::value, int >::type indexOf (const ValueType &value, bool ignoreCase=true) const
 
const ObjectType & valueAt (unsigned index) const
 
const ObjectType & operator[] (unsigned index) const
 
ArrayPrinter< Vectorprinter () const
 
size_t printTo (Print &p) const
 
- Public Member Functions inherited from FSTR::Object< Vector< ObjectType >, ObjectType * >
 Object ()
 Creates a null object. More...
 
 Object (const Object &obj)
 Copy constructor. More...
 
Iterator begin () const
 
Iterator end () const
 
size_t length () const
 Get the length of the content in elements. More...
 
int indexOf (const ValueType &value) const
 
ObjectType * valueAt (unsigned index) const
 
ObjectType * operator[] (unsigned index) const
 Array operator[]. More...
 
size_t elementSize () const
 
const ObjectType * * data () const
 
size_t read (size_t index, ObjectType * *buffer, size_t count) const
 Read content into RAM. More...
 
size_t readFlash (size_t index, ObjectType * *buffer, size_t count) const
 Read content into RAM,using flashmem_read() More...
 
- Public Member Functions inherited from FSTR::ObjectBase
size_t length () const
 Get the length of the object data in bytes. More...
 
size_t size () const
 Get the object data size in bytes. More...
 
template<class ObjectType >
constexpr const ObjectType & as () const
 Cast to a different object type. More...
 
const uint8_t * data () const
 Get a pointer to the flash data. More...
 
size_t read (size_t offset, void *buffer, size_t count) const
 Read contents of a String into RAM. More...
 
size_t readFlash (size_t offset, void *buffer, size_t count) const
 Read contents of a String into RAM, using flashread() More...
 
bool isCopy () const
 
bool isNull () const
 Indicates an invalid String, used for return value from lookups, etc. More...
 

Additional Inherited Members

- Public Types inherited from FSTR::Object< Vector< ObjectType >, ObjectType * >
using Iterator = ObjectIterator< Vector< ObjectType >, ObjectType * >
 
- Static Public Member Functions inherited from FSTR::Object< Vector< ObjectType >, ObjectType * >
static const Vector< ObjectType > & empty ()
 Return an empty object which evaluates to null. More...
 
- Public Attributes inherited from FSTR::ObjectBase
uint32_t flashLength_
 
- Protected Member Functions inherited from FSTR::ObjectBase
void invalidate ()
 
void copy (const ObjectBase &obj)
 
- Static Protected Attributes inherited from FSTR::ObjectBase
static const ObjectBase empty_
 

Detailed Description

template<class ObjectType>
class FSTR::Vector< ObjectType >

Class to access a Vector of objects stored in flash.

Template Parameters
ObjectType

Member Function Documentation

◆ indexOf()

template<class ObjectType >
template<typename ValueType , typename T = ObjectType>
std::enable_if<std::is_same<T, String>::value, int>::type FSTR::Vector< ObjectType >::indexOf ( const ValueType &  value,
bool  ignoreCase = true 
) const
inline

◆ operator[]()

template<class ObjectType >
const ObjectType& FSTR::Vector< ObjectType >::operator[] ( unsigned  index) const
inline

◆ printer()

template<class ObjectType >
ArrayPrinter<Vector> FSTR::Vector< ObjectType >::printer ( ) const
inline

◆ printTo()

template<class ObjectType >
size_t FSTR::Vector< ObjectType >::printTo ( Print p) const
inline

◆ valueAt()

template<class ObjectType >
const ObjectType& FSTR::Vector< ObjectType >::valueAt ( unsigned  index) const
inline

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