eoIDFilter Class Reference

uses EnOcean IDs as filter base More...

#include <eoIDFilter.h>

Inheritance diagram for eoIDFilter:

Collaboration diagram for eoIDFilter:

Public Member Functions
bool	Filter (eoMessage &msg)
bool	Filter (eoTelegram &tel)
virtual uint8_t	Serialize (eoArchive &arch)
void	Add (uint32_t id)
void	Remove (uint32_t id)
void	RemoveAll ()

Additional Inherited Members
Public Attributes inherited from eoIFilter
uint8_t	type
	Type.

Detailed Description

uses EnOcean IDs as filter base

eoIDFilter is an easy filter, which allows you to filter a Telegram / Message via the ID GatewayFiltered_example.cpp

Examples:

GatewayFiltered_example.cpp, sendTelegram_example.cpp, tutorial1.cpp, tutorial6.cpp, and vld_example.cpp.

Member Function Documentation

Add()

void eoIDFilter::Add

(

uint32_t

id

)

Adds an EnOcean ID to the filter

Parameters

id	uint32_t ID

Examples:

GatewayFiltered_example.cpp, and tutorial1.cpp.

Filter() [1/2]

bool eoIDFilter::Filter ( eoMessage &  msg )

virtual

Filters the Message using the internal ID List

Parameters

msg	Message to Filter

Returns

true when the Message::sourceID is in the Filter list.

Reimplemented from eoIFilter.

Filter() [2/2]

bool eoIDFilter::Filter ( eoTelegram &  tel )

virtual

Filters the Message using the internal ID List

Parameters

tel	Telegram to Filter

Returns

true when the Message::sourceID is in the Filter list.

Reimplemented from eoIFilter.

Remove()

void eoIDFilter::Remove

(

uint32_t

id

)

Removes an EnOcean ID to the filter

Parameters

id	uint32_t ID

RemoveAll()

void eoIDFilter::RemoveAll ( )

virtual

Remove all IDS.

Reimplemented from eoIFilter.

Serialize()

virtual uint8_t eoIDFilter::Serialize ( eoArchive &  arch )

virtual

Serialization Function which will be called by the eoStorageManager This function will be called by the eoArchive(inside of the eoStorageManager) and allows the class to be Serialized.

Parameters

&arch

Archive where to Load or to Store.

Reimplemented from eoIFilter.