Class DataProperty

• Defined in File data_property.h

Inheritance Relationships

Base Type

• public Property (Class Property)

Class Documentation

class DataProperty : public Property

Public Functions

DataProperty(PropertyID id, bool writeEnable, PropertyDataType type, uint16_t maxElements, uint8_t access)

DataProperty(PropertyID id, bool writeEnable, PropertyDataType type, uint16_t maxElements, uint8_t access, uint8_t value)

DataProperty(PropertyID id, bool writeEnable, PropertyDataType type, uint16_t maxElements, uint8_t access, uint16_t value)

DataProperty(PropertyID id, bool writeEnable, PropertyDataType type, uint16_t maxElements, uint8_t access, uint32_t value)

DataProperty(PropertyID id, bool writeEnable, PropertyDataType type, uint16_t maxElements, uint8_t access, const uint8_t *value)

~DataProperty() override

virtual uint8_t read(uint16_t start, uint8_t count, uint8_t *data) const override

virtual uint8_t write(uint16_t start, uint8_t count, const uint8_t *data) override

virtual uint8_t *save(uint8_t *buffer) override

This method is called when the object should save its state to the buffer.

Parameters

buffer – The buffer the object should save its state to.

Returns

The buffer plus the size of the object state. The next object will use this value as the start of its buffer.

virtual const uint8_t *restore(const uint8_t *buffer) override

This method is called when the object should restore its state from the buffer.

Parameters

buffer – The buffer the object should restore its state from.

Returns

The buffer plus the size of the object state. The next object will use this value as the start of its buffer.

virtual uint16_t saveSize() override

Returns

The maximum number of bytes the object needs to save its state.

const uint8_t *data()

const uint8_t *data(uint16_t elementIndex)