Property metadata. More...

#include <PropertyInfo.h>

Collaboration diagram for ConfigDB::PropertyInfo:

Classes

struct  RangePtrTemplate
 
struct  RangeTemplate
 
union  Variant
 

Public Member Functions

 operator bool () const
 
bool isStringType () const
 
uint8_t getSize () const
 Get number of bytes required to store this property value within a structure. More...
 
int findObject (const char *name, unsigned length) const
 Find named object information. More...
 
int findProperty (const char *name, unsigned length) const
 Find named object information. More...
 
const PropertyInfogetObject (unsigned index) const
 Get child object by index. More...
 

Public Attributes

PropertyType type
 
const FlashStringname
 
uint32_t offset
 Location of property data in parent object, OR Alias property index. More...
 
Variant variant
 

Static Public Attributes

static const PropertyInfo empty
 

Detailed Description

Property metadata.

Member Function Documentation

◆ findObject()

int ConfigDB::PropertyInfo::findObject ( const char *  name,
unsigned  length 
) const

Find named object information.

◆ findProperty()

int ConfigDB::PropertyInfo::findProperty ( const char *  name,
unsigned  length 
) const

Find named object information.

◆ getObject()

const PropertyInfo& ConfigDB::PropertyInfo::getObject ( unsigned  index) const

Get child object by index.

◆ getSize()

uint8_t ConfigDB::PropertyInfo::getSize ( ) const
inline

Get number of bytes required to store this property value within a structure.

◆ isStringType()

bool ConfigDB::PropertyInfo::isStringType ( ) const
inline

◆ operator bool()

ConfigDB::PropertyInfo::operator bool ( ) const
inlineexplicit

Member Data Documentation

◆ empty

const PropertyInfo ConfigDB::PropertyInfo::empty
static

◆ name

const FlashString& ConfigDB::PropertyInfo::name

◆ offset

uint32_t ConfigDB::PropertyInfo::offset

Location of property data in parent object, OR Alias property index.

◆ type

PropertyType ConfigDB::PropertyInfo::type

◆ variant

Variant ConfigDB::PropertyInfo::variant

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