FSTR::Object< ObjectType, ElementType > Class Template Reference

Base class template for all types. More...

#include <Object.hpp>

Inheritance diagram for FSTR::Object< ObjectType, ElementType >:

Collaboration diagram for FSTR::Object< ObjectType, ElementType >:

Public Types
using	Iterator = ObjectIterator< ObjectType, ElementType >

Public Member Functions
	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...
template<typename ValueType >
int	indexOf (const ValueType &value) const
ElementType	valueAt (unsigned index) const
ElementType	operator[] (unsigned index) const
	Array operator[]. More...
size_t	elementSize () const
const ElementType *	data () const
size_t	read (size_t index, ElementType *buffer, size_t count) const
	Read content into RAM. More...
size_t	readFlash (size_t index, ElementType *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...

Static Public Member Functions
static const ObjectType &	empty ()
	Return an empty object which evaluates to null. More...

Additional Inherited Members
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, typename ElementType>
class FSTR::Object< ObjectType, ElementType >

Base class template for all types.

Template Parameters

ObjectType	The object type actually being instantiated
ElementType

See also

https://en.wikipedia.org/wiki/Curiously_recurring_template_pattern

Member Typedef Documentation

Iterator

template<class ObjectType , typename ElementType >

using FSTR::Object< ObjectType, ElementType >::Iterator = ObjectIterator<ObjectType, ElementType>

Constructor & Destructor Documentation

Object() [1/2]

template<class ObjectType , typename ElementType >

FSTR::Object< ObjectType, ElementType >::Object ( )

inline

Creates a null object.

Object() [2/2]

template<class ObjectType , typename ElementType >

FSTR::Object< ObjectType, ElementType >::Object ( const Object< ObjectType, ElementType > &  obj )

inline

Copy constructor.

Note

Objects are usually passed around by reference or as a pointer, but for ease of use we need a working copy constructor.

Member Function Documentation

begin()

template<class ObjectType , typename ElementType >

Iterator FSTR::Object< ObjectType, ElementType >::begin ( ) const

inline

data()

template<class ObjectType , typename ElementType >

const ElementType* FSTR::Object< ObjectType, ElementType >::data ( ) const

inline

elementSize()

template<class ObjectType , typename ElementType >

size_t FSTR::Object< ObjectType, ElementType >::elementSize ( ) const

inline

empty()

template<class ObjectType , typename ElementType >

static const ObjectType& FSTR::Object< ObjectType, ElementType >::empty ( )

inlinestatic

Return an empty object which evaluates to null.

end()

template<class ObjectType , typename ElementType >

Iterator FSTR::Object< ObjectType, ElementType >::end ( ) const

inline

indexOf()

template<class ObjectType , typename ElementType >

template<typename ValueType >

int FSTR::Object< ObjectType, ElementType >::indexOf ( const ValueType &  value ) const

inline

length()

template<class ObjectType , typename ElementType >

size_t FSTR::Object< ObjectType, ElementType >::length ( ) const

inline

Get the length of the content in elements.

operator[]()

template<class ObjectType , typename ElementType >

ElementType FSTR::Object< ObjectType, ElementType >::operator[] ( unsigned  index ) const

inline

Array operator[].

read()

template<class ObjectType , typename ElementType >

size_t FSTR::Object< ObjectType, ElementType >::read ( size_t  index, ElementType *  buffer, size_t  count  ) const

inline

Read content into RAM.

Parameters

index	First element to read
buffer	Where to store data
count	How many elements to read

Return values

size_t

Number of elements actually read

readFlash()

template<class ObjectType , typename ElementType >

size_t FSTR::Object< ObjectType, ElementType >::readFlash ( size_t  index, ElementType *  buffer, size_t  count  ) const

inline

Read content into RAM,using flashmem_read()

Parameters

index	First element to read
buffer	Where to store data
count	How many elements to read

Return values

size_t

Number of elements actually read

valueAt()

template<class ObjectType , typename ElementType >

ElementType FSTR::Object< ObjectType, ElementType >::valueAt ( unsigned  index ) const

inline

---

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

• Object.hpp