Cascoda SDK
Cascoda SDK for building software to run with CA-821x transceivers
ca::DeviceListFilter Class Reference

#include <posix/app/chilictl/common/DeviceList.hpp>

Public Member Functions

 DeviceListFilter ()
 Default constructor. More...
 
void SetAvailable (bool aTarget)
 Enable the 'available' filter and set the parameters. More...
 
void SetExtFlashAvailable (bool aTarget)
 Enable the 'ext-flash-available' filter and set the parameters. More...
 
void ClearAvailable ()
 Disable the available filter. More...
 
void AddSerialNo (const char *aSerialNo)
 Add serial number to filter. More...
 
void SetAppName (const char *aAppName)
 Set the app name filter. More...
 
void SetMinVersion (const char *aMinVersion)
 
bool IsFilterPass (const DeviceInfo &aDeviceInfo) const
 Run the filter on the given DeviceInfo. More...
 

Friends

class DeviceList
 

Constructor & Destructor Documentation

◆ DeviceListFilter()

ca::DeviceListFilter::DeviceListFilter ( )
inline

Default constructor.

Member Function Documentation

◆ AddSerialNo()

void ca::DeviceListFilter::AddSerialNo ( const char *  aSerialNo)
inline

Add serial number to filter.

If none are added then there is no filter. If multiple are added, then the filter passes if any match.

Parameters
aSerialNoThe desired serial number

◆ ClearAvailable()

void ca::DeviceListFilter::ClearAvailable ( )
inline

Disable the available filter.

◆ IsFilterPass()

bool ca::DeviceListFilter::IsFilterPass ( const DeviceInfo aDeviceInfo) const

Run the filter on the given DeviceInfo.

Parameters
aDeviceInfoThe DeviceInfo to filter
Returns
True if aDeviceInfo passes the filter, False if it should be filtered out

◆ SetAppName()

void ca::DeviceListFilter::SetAppName ( const char *  aAppName)
inline

Set the app name filter.

An empty string means no filter.

Parameters
aAppNameThe desired app name

◆ SetAvailable()

void ca::DeviceListFilter::SetAvailable ( bool  aTarget)
inline

Enable the 'available' filter and set the parameters.

Parameters
aTargetThe desired value of 'Available' in the results.

◆ SetExtFlashAvailable()

void ca::DeviceListFilter::SetExtFlashAvailable ( bool  aTarget)
inline

Enable the 'ext-flash-available' filter and set the parameters.

Parameters
aTargetThe desired value of 'ExtFlashAvailable' in the results.

◆ SetMinVersion()

void ca::DeviceListFilter::SetMinVersion ( const char *  aMinVersion)
inline

Friends And Related Function Documentation

◆ DeviceList

friend class DeviceList
friend

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