#include <router_object.h>

Inheritance diagram for RouterObject:

Collaboration diagram for RouterObject:

Public Member Functions
	RouterObject (Memory &memory, uint32_t staticTableAdr=0, uint32_t staticTableSize=0)

void	initialize1x (DptMedium mediumType, uint16_t maxApduSize)

void	initialize20 (uint8_t objIndex, DptMedium mediumType, RouterObjectType rtType, uint16_t maxApduSize)

void	initialize (CouplerModel model, uint8_t objIndex, DptMedium mediumType, RouterObjectType rtType, uint16_t maxApduSize)

bool	isGroupAddressInFilterTable (uint16_t groupAddress)

bool	isRfSbcRoutingEnabled ()

bool	isIpSbcRoutingEnabled ()

void	masterReset (EraseCode eraseCode, uint8_t channel) override

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, uint32_t staticTableAdr=0, uint32_t staticTableSize=0)
	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	readPropertyLength (PropertyID id, uint16_t &length)
	Read length of a property of the interface object. 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...

Property *	property (PropertyID id)
	Gets property with PropertyID id if it exists and nullptr otherwise. More...

template<typename T >
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 Property *	property (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...

Additional Inherited Members
Static Public Member Functions inherited from TableObject
static void	beforeTablesUnloadCallback (BeforeTablesUnloadCallback func)

static BeforeTablesUnloadCallback	beforeTablesUnloadCallback ()

Protected Attributes inherited from TableObject
Memory &	_memory

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 23 of file router_object.h.

Constructor & Destructor Documentation

◆ RouterObject()

RouterObject::RouterObject	(	Memory &	memory,
		uint32_t	staticTableAdr = `0`,
		uint32_t	staticTableSize = `0`
	)

Definition at line 29 of file router_object.cpp.

Member Function Documentation

◆ beforeStateChange()

void RouterObject::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 546 of file router_object.cpp.

Here is the call graph for this function:

◆ initialize()

void RouterObject::initialize	(	CouplerModel	model,
		uint8_t	objIndex,
		DptMedium	mediumType,
		RouterObjectType	rtType,
		uint16_t	maxApduSize
	)

Definition at line 45 of file router_object.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initialize1x()

void RouterObject::initialize1x	(	DptMedium	mediumType,
		uint16_t	maxApduSize
	)

Definition at line 34 of file router_object.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initialize20()

void RouterObject::initialize20	(	uint8_t	objIndex,
		DptMedium	mediumType,
		RouterObjectType	rtType,
		uint16_t	maxApduSize
	)

Definition at line 40 of file router_object.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isGroupAddressInFilterTable()

bool RouterObject::isGroupAddressInFilterTable ( uint16_t groupAddress )

Definition at line 572 of file router_object.cpp.

Here is the call graph for this function:

◆ isIpSbcRoutingEnabled()

bool RouterObject::isIpSbcRoutingEnabled ( )

Definition at line 537 of file router_object.cpp.

Here is the call graph for this function:

◆ isRfSbcRoutingEnabled()

bool RouterObject::isRfSbcRoutingEnabled ( )

Definition at line 508 of file router_object.cpp.

Here is the call graph for this function:

◆ masterReset()

void RouterObject::masterReset	(	EraseCode	eraseCode,
		uint8_t	channel
	)

overridevirtual

Reimplemented from InterfaceObject.

Definition at line 556 of file router_object.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ restore()

const uint8_t * RouterObject::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 InterfaceObject.

Definition at line 186 of file router_object.cpp.

Here is the call graph for this function:

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

src/knx/router_object.h
src/knx/router_object.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RouterObject()

Member Function Documentation

◆ beforeStateChange()

◆ initialize()

◆ initialize1x()

◆ initialize20()

◆ isGroupAddressInFilterTable()

◆ isIpSbcRoutingEnabled()

◆ isRfSbcRoutingEnabled()

◆ masterReset()

◆ restore()