DataProperty Class Reference

#include <data_property.h>

Inheritance diagram for DataProperty:

Collaboration diagram for DataProperty:

Public Member 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
uint8_t	read (uint16_t start, uint8_t count, uint8_t *data) const override
uint8_t	write (uint16_t start, uint8_t count, const uint8_t *data) override
uint8_t *	save (uint8_t *buffer) override
	This method is called when the object should save its state to the buffer. More...
const uint8_t *	restore (const uint8_t *buffer) override
	This method is called when the object should restore its state from the buffer. More...
uint16_t	saveSize () override
const uint8_t *	data ()
const uint8_t *	data (uint16_t elementIndex)
Public Member Functions inherited from Property
	Property (PropertyID id, bool writeEnable, PropertyDataType type, uint16_t maxElements, uint8_t access)
virtual	~Property ()
PropertyID	Id () const
bool	WriteEnable () const
PropertyDataType	Type () const
uint16_t	MaxElements () const
uint8_t	Access () const
uint8_t	ElementSize () const
virtual void	command (uint8_t *data, uint8_t length, uint8_t *resultData, uint8_t &resultLength)
virtual void	state (uint8_t *data, uint8_t length, uint8_t *resultData, uint8_t &resultLength)
uint8_t	read (uint8_t &value) const
uint8_t	read (uint16_t &value) const
uint8_t	read (uint32_t &value) const
uint8_t	read (uint8_t *value) const
uint8_t	write (uint8_t value)
uint8_t	write (uint16_t value)
uint8_t	write (uint16_t position, uint16_t value)
uint8_t	write (uint32_t value)
uint8_t	write (const uint8_t *value)

Additional Inherited Members
Protected Attributes inherited from Property
PropertyID	_id
bool	_writeEnable
PropertyDataType	_type
uint16_t	_maxElements
uint8_t	_access

Detailed Description

Definition at line 5 of file data_property.h.

Constructor & Destructor Documentation

DataProperty() [1/5]

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

Definition at line 78 of file data_property.cpp.

DataProperty() [2/5]

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

Definition at line 103 of file data_property.cpp.

Here is the call graph for this function:

DataProperty() [3/5]

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

Definition at line 89 of file data_property.cpp.

Here is the call graph for this function:

DataProperty() [4/5]

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

Definition at line 96 of file data_property.cpp.

Here is the call graph for this function:

DataProperty() [5/5]

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

Definition at line 110 of file data_property.cpp.

Here is the call graph for this function:

~DataProperty()

DataProperty::~DataProperty ( )

override

Definition at line 83 of file data_property.cpp.

Member Function Documentation

data() [1/2]

const uint8_t * DataProperty::data

(

)

Definition at line 155 of file data_property.cpp.

Here is the caller graph for this function:

data() [2/2]

const uint8_t * DataProperty::data

(

uint16_t

elementIndex

)

Definition at line 160 of file data_property.cpp.

Here is the call graph for this function:

read()

uint8_t DataProperty::read ( uint16_t  start, uint8_t  count, uint8_t *  data  ) const

overridevirtual

Implements Property.

Definition at line 6 of file data_property.cpp.

Here is the call graph for this function:

restore()

const uint8_t * DataProperty::restore ( const uint8_t *  buffer )

overridevirtual

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.

Reimplemented from SaveRestore.

Definition at line 123 of file data_property.cpp.

Here is the call graph for this function:

save()

uint8_t * DataProperty::save ( uint8_t *  buffer )

overridevirtual

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.

Reimplemented from SaveRestore.

Definition at line 144 of file data_property.cpp.

Here is the call graph for this function:

saveSize()

uint16_t DataProperty::saveSize ( )

overridevirtual

Returns

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

Reimplemented from SaveRestore.

Definition at line 117 of file data_property.cpp.

Here is the call graph for this function:

write()

uint8_t DataProperty::write ( uint16_t  start, uint8_t  count, const uint8_t *  data  )

overridevirtual

Implements Property.

Definition at line 27 of file data_property.cpp.

Here is the call graph for this function:

---

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

• src/knx/data_property.h
• src/knx/data_property.cpp