ConfigDB::ArrayBase Class Reference

Base class to provide array of properties. More...

#include <ArrayBase.h>

Inheritance diagram for ConfigDB::ArrayBase:

Collaboration diagram for ConfigDB::ArrayBase:

Public Member Functions
unsigned	getItemCount () const
bool	removeItem (unsigned index)
void *	getItem (unsigned index)
const void *	getItem (unsigned index) const
void	addItem (const void *value)
void	clear ()
void	dispose ()
	Object ()
	Object (const Object &other)
	Object (Object &&)=delete
	Object (const PropertyInfo &propinfo)
	Object (Object &parent, const PropertyInfo &prop, uint16_t dataRef)
	Object (const Object &parent, const PropertyInfo &prop, uint16_t dataRef)
	Object (Object &parent, unsigned propIndex, uint16_t dataRef=0)
	Object (const Object &parent, unsigned propIndex, uint16_t dataRef=0)
Public Member Functions inherited from ConfigDB::Object
	Object ()
	Object (const Object &other)
	Object (Object &&)=delete
Object &	operator= (const Object &other)
	Object (const PropertyInfo &propinfo)
	Object (Object &parent, const PropertyInfo &prop, uint16_t dataRef)
	Object (const Object &parent, const PropertyInfo &prop, uint16_t dataRef)
	Object (Object &parent, unsigned propIndex, uint16_t dataRef=0)
	Object (const Object &parent, unsigned propIndex, uint16_t dataRef=0)
	operator bool () const
bool	typeIs (ObjectType type) const
bool	isArray () const
bool	isStore () const
	Determine if this object is a store (not just a reference to it) More...
Store &	getStore ()
const Store &	getStore () const
Database &	getDatabase ()
const Database &	getDatabase () const
unsigned	getObjectCount () const
	Get number of child objects. More...
Object	getObject (unsigned index)
	Get child object by index. More...
const Object	getObject (unsigned index) const
Object	findObject (const char *name, size_t length)
	Find child object by name. More...
unsigned	getPropertyCount () const
	Get number of properties. More...
Property	getProperty (unsigned index)
	Get properties. More...
PropertyConst	getProperty (unsigned index) const
Property	findProperty (const char *name, size_t length)
	Find property by name. More...
void	clear ()
	Reset contents to defaults (except arrays, which are cleared) More...
void	loadArrayDefaults ()
	Clear and load all contained arrays with defaults from schema. More...
void	resetToDefaults ()
	Does a 'clear' followed by 'loadArrayDefaults'. More...
bool	commit ()
	Commit changes to the store. More...
void	clearDirty ()
	Clear store dirty flag so changes don't get committed. More...
String	getName () const
String	getPath () const
size_t	printTo (Print &p) const
bool	exportToStream (const Format &format, Print &output) const
bool	exportToFile (const Format &format, const String &filename) const
Status	importFromStream (const Format &format, Stream &source)
Status	importFromFile (const Format &format, const String &filename)
const PropertyInfo &	propinfo () const
const ObjectInfo &	typeinfo () const
PropertyData *	getPropertyData (unsigned index)
const PropertyData *	getPropertyData (unsigned index) const
void	queueUpdate (UpdateCallback callback)
	Called from OuterObjectTemplate::update to queue an update. More...

Protected Member Functions
ArrayId &	getId ()
ArrayId	getId () const
ArrayData &	getArray ()
const ArrayData &	getArray () const
Protected Member Functions inherited from ConfigDB::Object
StoreRef	openStore (Database &db, unsigned storeIndex)
StoreUpdateRef	openStoreForUpdate (Database &db, unsigned storeIndex)
void	disposeArrays ()
void	initArrays ()
bool	isWriteable () const
StoreUpdateRef	lockStore (StoreRef &store)
bool	writeCheck () const
void *	getDataPtr ()
const void *	getDataPtr () const
String	getPropertyString (unsigned index, StringId id) const
String	getPropertyString (unsigned index) const
StringId	getStringId (const PropertyInfo &prop, const char *value, uint16_t valueLength)
StringId	getStringId (const PropertyInfo &prop, const String &value)
template<typename T >
StringId	getStringId (const PropertyInfo &prop, const T &value)
int	findStringId (const char *value, uint16_t valueLength) const
void	setPropertyValue (unsigned index, const void *value)
void	setPropertyValue (unsigned index, const String &value)

Additional Inherited Members
Public Types inherited from ConfigDB::Object
using	UpdateCallback = Delegate< void(Store &store)>
	Callback invoked by asynchronous updater. More...
Public Attributes inherited from ConfigDB::Object
uint16_t	streamPos {}
Protected Attributes inherited from ConfigDB::Object
const PropertyInfo *	propinfoPtr
Object *	parent {}
uint16_t	dataRef {}

Detailed Description

Base class to provide array of properties.

Member Function Documentation

addItem()

void ConfigDB::ArrayBase::addItem ( const void *  value )

inline

clear()

void ConfigDB::ArrayBase::clear

(

)

dispose()

void ConfigDB::ArrayBase::dispose

(

)

getArray() [1/2]

ArrayData& ConfigDB::ArrayBase::getArray ( )

protected

getArray() [2/2]

const ArrayData& ConfigDB::ArrayBase::getArray ( ) const

protected

getId() [1/2]

ArrayId& ConfigDB::ArrayBase::getId ( )

inlineprotected

getId() [2/2]

ArrayId ConfigDB::ArrayBase::getId ( ) const

inlineprotected

getItem() [1/2]

void* ConfigDB::ArrayBase::getItem ( unsigned  index )

inline

getItem() [2/2]

const void* ConfigDB::ArrayBase::getItem ( unsigned  index ) const

inline

getItemCount()

unsigned ConfigDB::ArrayBase::getItemCount ( ) const

inline

Object() [1/8]

ConfigDB::Object::Object

inline

Object() [2/8]

ConfigDB::Object::Object

inline

Object() [3/8]

ConfigDB::Object::Object

inline

Object() [4/8]

ConfigDB::Object::Object

inline

Object() [5/8]

ConfigDB::Object::Object

inlineexplicit

Object() [6/8]

ConfigDB::Object::Object

delete

Object() [7/8]

ConfigDB::Object::Object

inline

Object() [8/8]

ConfigDB::Object::Object

inline

removeItem()

bool ConfigDB::ArrayBase::removeItem ( unsigned  index )

inline

---

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

• ArrayBase.h