knx
ETS configurable knx-stack
GroupObjectTableObject Class Reference

#include <group_object_table_object.h>

Inheritance diagram for GroupObjectTableObject:
Collaboration diagram for GroupObjectTableObject:

Public Member Functions

 GroupObjectTableObject (Memory &memory)
 
virtual ~GroupObjectTableObject ()
 
uint16_t entryCount ()
 
GroupObjectget (uint16_t asap)
 
GroupObjectnextUpdatedObject (bool &valid)
 
void groupObjects (GroupObject *objs, uint16_t size)
 
const uint8_t * restore (const uint8_t *buffer) override
 This method is called when the object should restore its state from the buffer. More...
 
- Public Member Functions inherited from TableObject
 TableObject (Memory &memory)
 The constuctor. More...
 
virtual ~TableObject ()
 The destructor. More...
 
LoadState loadState ()
 This method returns the LoadState of the interface object. More...
 
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
 
- Public Member Functions inherited from InterfaceObject
virtual ~InterfaceObject ()
 Destructor. More...
 
virtual void readProperty (PropertyID id, uint16_t start, uint8_t &count, uint8_t *data)
 Read a property of the interface object. More...
 
virtual void writeProperty (PropertyID id, uint16_t start, uint8_t *data, uint8_t &count)
 Write property of the interface object. More...
 
virtual uint8_t propertySize (PropertyID id)
 Gets the size of of property in bytes. More...
 
virtual void command (PropertyID id, uint8_t *data, uint8_t length, uint8_t *resultData, uint8_t &resultLength)
 Call command of a function property of the interface object. More...
 
virtual void state (PropertyID id, uint8_t *data, uint8_t length, uint8_t *resultData, uint8_t &resultLength)
 Get state of a function property of the interface object. More...
 
void readPropertyDescription (uint8_t &propertyId, uint8_t &propertyIndex, bool &writeEnable, uint8_t &type, uint16_t &numberOfElements, uint8_t &access)
 Read the Description of a property of the interface object. More...
 
virtual void masterReset (EraseCode eraseCode, uint8_t channel)
 
Propertyproperty (PropertyID id)
 Gets property with PropertyID id if it exists and nullptr otherwise. More...
 
template<typename T >
propertyValue (PropertyID id)
 
template<typename T >
void propertyValue (PropertyID id, T value)
 
const uint8_t * propertyData (PropertyID id)
 
const uint8_t * propertyData (PropertyID id, uint16_t elementIndex)
 
const Propertyproperty (PropertyID id) const
 Gets const property with PropertyID id if it exists and nullptr otherwise. More...
 

Protected Member Functions

void beforeStateChange (LoadState &newState) override
 This method is called before the interface object enters a new LoadState. More...
 
- Protected Member Functions inherited from TableObject
uint8_t * data ()
 returns the internal data of the interface object. More...
 
void errorCode (ErrorCode errorCode)
 Set the reason for a state change failure. More...
 
void initializeProperties (size_t propertiesSize, Property **properties) override
 Intializes the Property-array the the supplied values. More...
 

Friends

class GroupObject
 

Additional Inherited Members

- Static Public Member Functions inherited from TableObject
static void beforeTablesUnloadCallback (BeforeTablesUnloadCallback func)
 
static BeforeTablesUnloadCallback beforeTablesUnloadCallback ()
 
- Protected Attributes inherited from InterfaceObject
Property ** _properties = nullptr
 
uint8_t _propertyCount = 0
 
- Static Protected Attributes inherited from TableObject
static BeforeTablesUnloadCallback _beforeTablesUnload = 0
 

Detailed Description

Definition at line 6 of file group_object_table_object.h.

Constructor & Destructor Documentation

◆ GroupObjectTableObject()

GroupObjectTableObject::GroupObjectTableObject ( Memory memory)

Definition at line 8 of file group_object_table_object.cpp.

Here is the call graph for this function:

◆ ~GroupObjectTableObject()

GroupObjectTableObject::~GroupObjectTableObject ( )
virtual

Definition at line 18 of file group_object_table_object.cpp.

Member Function Documentation

◆ beforeStateChange()

void GroupObjectTableObject::beforeStateChange ( LoadState newState)
overrideprotectedvirtual

This method is called before the interface object enters a new LoadState.

If there is a error changing the state newState should be set to LS_ERROR and errorCode() to a reason for the failure.

Reimplemented from TableObject.

Definition at line 78 of file group_object_table_object.cpp.

Here is the call graph for this function:

◆ entryCount()

uint16_t GroupObjectTableObject::entryCount ( )

Definition at line 23 of file group_object_table_object.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get()

GroupObject & GroupObjectTableObject::get ( uint16_t  asap)

Definition at line 31 of file group_object_table_object.cpp.

Here is the caller graph for this function:

◆ groupObjects()

void GroupObjectTableObject::groupObjects ( GroupObject objs,
uint16_t  size 
)

Definition at line 70 of file group_object_table_object.cpp.

◆ nextUpdatedObject()

GroupObject & GroupObjectTableObject::nextUpdatedObject ( bool &  valid)

Definition at line 46 of file group_object_table_object.cpp.

Here is the call graph for this function:

◆ restore()

const uint8_t * GroupObjectTableObject::restore ( const uint8_t *  buffer)
overridevirtual

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

Parameters
bufferThe 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 36 of file group_object_table_object.cpp.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ GroupObject

friend class GroupObject
friend

Definition at line 8 of file group_object_table_object.h.


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