Property Class Reference

#include <property.h>

Inheritance diagram for Property:

Collaboration diagram for Property:

Public Member Functions
	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 uint8_t	read (uint16_t start, uint8_t count, uint8_t *data) const =0
virtual uint8_t	write (uint16_t start, uint8_t count, const uint8_t *data)=0
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)
Public Member Functions inherited from SaveRestore
virtual uint8_t *	save (uint8_t *buffer)
	This method is called when the object should save its state to the buffer. More...
virtual const uint8_t *	restore (const uint8_t *buffer)
	This method is called when the object should restore its state from the buffer. More...
virtual uint16_t	saveSize ()

Protected Attributes
PropertyID	_id
bool	_writeEnable
PropertyDataType	_type
uint16_t	_maxElements
uint8_t	_access

Detailed Description

Definition at line 262 of file property.h.

Constructor & Destructor Documentation

Property()

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

Definition at line 128 of file property.cpp.

~Property()

Property::~Property ( )

virtual

Definition at line 133 of file property.cpp.

Member Function Documentation

Access()

uint8_t Property::Access

(

)

const

Definition at line 26 of file property.cpp.

Here is the caller graph for this function:

command()

void Property::command ( uint8_t *  data, uint8_t  length, uint8_t *  resultData, uint8_t &  resultLength  )

virtual

Reimplemented in FunctionProperty< T >.

Definition at line 231 of file property.cpp.

Here is the caller graph for this function:

ElementSize()

uint8_t Property::ElementSize

(

)

const

Definition at line 31 of file property.cpp.

Here is the caller graph for this function:

Id()

PropertyID Property::Id

(

)

const

Definition at line 6 of file property.cpp.

Here is the caller graph for this function:

MaxElements()

uint16_t Property::MaxElements

(

)

const

Definition at line 21 of file property.cpp.

Here is the caller graph for this function:

read() [1/5]

uint8_t Property::read

(

uint16_t &

value

)

const

Definition at line 146 of file property.cpp.

Here is the call graph for this function:

read() [2/5]

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

pure virtual

Implemented in FunctionProperty< T >, DataProperty, and CallbackProperty< T >.

Here is the caller graph for this function:

read() [3/5]

uint8_t Property::read

(

uint32_t &

value

)

const

Definition at line 163 of file property.cpp.

Here is the call graph for this function:

read() [4/5]

uint8_t Property::read

(

uint8_t &

value

)

const

Definition at line 137 of file property.cpp.

Here is the call graph for this function:

read() [5/5]

uint8_t Property::read

(

uint8_t *

value

)

const

Definition at line 179 of file property.cpp.

Here is the call graph for this function:

state()

void Property::state ( uint8_t *  data, uint8_t  length, uint8_t *  resultData, uint8_t &  resultLength  )

virtual

Reimplemented in FunctionProperty< T >.

Definition at line 239 of file property.cpp.

Here is the caller graph for this function:

Type()

PropertyDataType Property::Type

(

)

const

Definition at line 16 of file property.cpp.

Here is the caller graph for this function:

write() [1/6]

uint8_t Property::write

(

const uint8_t *

value

)

Definition at line 215 of file property.cpp.

Here is the call graph for this function:

write() [2/6]

uint8_t Property::write	(	uint16_t	position,
		uint16_t	value
	)

Definition at line 221 of file property.cpp.

Here is the call graph for this function:

write() [3/6]

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

pure virtual

Implemented in FunctionProperty< T >, DataProperty, and CallbackProperty< T >.

Here is the caller graph for this function:

write() [4/6]

uint8_t Property::write

(

uint16_t

value

)

Definition at line 193 of file property.cpp.

Here is the call graph for this function:

write() [5/6]

uint8_t Property::write

(

uint32_t

value

)

Definition at line 204 of file property.cpp.

Here is the call graph for this function:

write() [6/6]

uint8_t Property::write

(

uint8_t

value

)

Definition at line 184 of file property.cpp.

Here is the call graph for this function:

WriteEnable()

bool Property::WriteEnable

(

)

const

Definition at line 11 of file property.cpp.

Here is the caller graph for this function:

Member Data Documentation

_access

uint8_t Property::_access

protected

Definition at line 291 of file property.h.

_id

PropertyID Property::_id

protected

Definition at line 287 of file property.h.

_maxElements

uint16_t Property::_maxElements

protected

Definition at line 290 of file property.h.

_type

PropertyDataType Property::_type

protected

Definition at line 289 of file property.h.

_writeEnable

bool Property::_writeEnable

protected

Definition at line 288 of file property.h.

---

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

• src/knx/property.h
• src/knx/property.cpp