QNdefFilter Class | Qt NFC 6.5.1
Description: The QNdefFilter class provides a filter for matching NDEF messages.

- Qt 6.5
- Qt NFC
- C++ Classes
- QNdefFilter
- Qt 6.5.1 Reference Documentation

# QNdefFilter Class

The QNdefFilter class provides a filter for matching NDEF messages. More...

Header: | #include <QNdefFilter>
CMake: | find_package(Qt6 REQUIRED COMPONENTS Nfc) target_link_libraries(mytarget PRIVATE Qt6::Nfc)
qmake: | QT += nfc

- List of all members, including inherited members

## Public Types

struct | Record

## Public Functions

| QNdefFilter()
| QNdefFilter(const QNdefFilter &other)
| ~QNdefFilter()
bool | appendRecord(unsigned int min = 1, unsigned int max = 1)
bool | appendRecord(QNdefRecord::TypeNameFormat typeNameFormat, const QByteArray &type, unsigned int min = 1, unsigned int max = 1)
bool | appendRecord(const QNdefFilter::Record &record)
void | clear()
bool | match(const QNdefMessage &message) const
bool | orderMatch() const
QNdefFilter::Record | recordAt(qsizetype i) const
qsizetype | recordCount() const
void | setOrderMatch(bool on)
QNdefFilter & | operator=(const QNdefFilter &other)

## Detailed Description

The QNdefFilter encapsulates the structure of an NDEF message and is used for matching messages that have a particular structure.

The following filter matches NDEF messages that contain a single smart poster record:

     QNdefFilter filter;
     filter.append(QNdefRecord::NfcRtd, "Sp");

The following filter matches NDEF messages that contain a URI, a localized piece of text and an optional JPEG image. The order of the records must be in the order specified:

     QNdefFilter filter;
     filter.setOrderMatch(true);
     filter.appendRecord(QNdefRecord::NfcRtd, "U");
     filter.appendRecord<QNdefNfcTextRecord>();
     filter.appendRecord(QNdefRecord::Mime, "image/jpeg", 0, 1);

The match() method can be used to check if a message matches the filter.

### Matching Algorithms

The filter behavior depends on the value of orderMatch() parameter.

Note: In the discussion below we will consider the filter records to be equal if their `typeNameFormat` and `type` parameters match. Joining two records means adding their `minimum` and `maximum` values, respectively.

#### Unordered Matching

If the record order is not taken into account, all the equal records in the filter can be joined. The resulting filter will contain only unique records, each with the updated `minimum` and `maximum` value.

Consider the following example:

     QNdefFilter filter;
     filter.appendRecord<QNdefNfcTextRecord>(0, 1);
     filter.appendRecord<QNdefNfcTextRecord>(0, 1);
     filter.appendRecord(QNdefRecord::Mime, "", 1, 1);
     filter.appendRecord<QNdefNfcTextRecord>(1, 1);
     filter.setOrderMatch(false);

With the unordered matching, the filter will be simplified to the following:

     QNdefFilter filter;
     filter.appendRecord<QNdefNfcTextRecord>(1, 3);
     filter.appendRecord(QNdefRecord::Mime, "", 1, 1);
     filter.setOrderMatch(false);

Once the filter contains only the unique records, the matching algorithm iterates through the message and calculates the actual amount of records of each type. If all the actual amounts fit in the corresponding [minimum, maximum] ranges, the matching algorithm returns `true`.

#### Ordered Matching

If the record order is important, a different approach is applied. In this case the equal records can't be simply joined together. However, the consecutive equal records can still be joined. Then, the matching algorithm iterates through the message, this time also taking the positions of the records into account.

#### Handling Empty Type in Filter Record

It's possible to add a filter record with an empty `type`. In this case the empty type will act as a wildcard for any type.

For example, the filter can be defined as follows:

     QNdefFilter filter;
     filter.addRecord(QNdefRecord::Mime, "", 1, 1);

This filter specifies that the message must contain exactly one NDEF record with Mime typeNameFormat(), and any type().

#### Handling Extra Records in the Message

If the message contains some records that do not match any record in the filter, the matching algorithm will return `false`.

#### Filter Examples

In the table below, each filter record is specified by the following parameters (in the given order):

- `typeNameFormat` - contains the typeNameFormat() of the record.
- `type` - contains the type() of the record.
- `minimum` - contains the minimum amount of occurrences of the record in the message.
- `maximum` - contains the maximum amount of occurrences of the record in the message.

The filter contains multiple records.

The message consists of multiple QNdefRecords. In the table below, only the typeNameFormat() and type() of each record will be shown, because the other parameters do not matter for filtering.

Filter | Message | Match Result | Comment
--- | --- | --- | ---
Empty filter | Empty message | Match |
Empty filter | Non-empty message | No match |
Non-empty filter | Empty message | No match |
[(QNdefRecord::NfcRtd, "T", 1, 2), (QNdefRecord::Mime, "", 1, 1), (QNdefRecord::Empty, "", 0, 100)] | [(QNdefRecord::Mime, "image/jpeg"), (QNdefRecord::Empty, ""), (QNdefRecord::NfcRtd, "T"), (QNdefRecord::Empty, ""), (QNdefRecord::NfcRtd, "T")] | Unordered: match | Ordered filter does not match because the message must start with a QNdefRecord::NfcRtd record, but it starts with QNdefRecord::Mime.
Ordered: no match
[(QNdefRecord::NfcRtd, "T", 0, 2), (QNdefRecord::Mime, "", 1, 1), (QNdefRecord::NfcRtd, "T", 1, 1)] | [(QNdefRecord::NfcRtd, "T"), (QNdefRecord::NfcRtd, "T"), (QNdefRecord::Mime, "image/jpeg")] | Unordered: match | Ordered filter does not match because an QNdefRecord::NfcRtd record is expected after QNdefRecord::Mime, but the message does not have it.
Ordered: no match
[(QNdefRecord::NfcRtd, "T", 0, 2), (QNdefRecord::NfcRtd, "T", 1, 1), (QNdefRecord::Mime, "", 1, 1)] | [(QNdefRecord::NfcRtd, "T"), (QNdefRecord::Mime, "image/jpeg")] | Unordered: match | Both cases match because the message contains the required minimum of records in the correct order.
Ordered: match

## Member Function Documentation

### QNdefFilter::QNdefFilter()

Constructs a new NDEF filter.

### QNdefFilter::QNdefFilter(const QNdefFilter &other)

Constructs a new NDEF filter that is a copy of other.

### QNdefFilter::~QNdefFilter()

Destroys the NDEF filter.

### template <typename T> bool QNdefFilter::appendRecord(unsigned int min = 1, unsigned int max = 1)

Appends a record matching the template parameter to the NDEF filter. The record must occur between min and max times in the NDEF message.

Returns `true` if the record was appended successfully. Otherwise returns `false`.

### bool QNdefFilter::appendRecord(QNdefRecord::TypeNameFormat typeNameFormat, const QByteArray &type, unsigned int min = 1, unsigned int max = 1)

Appends a record with type name format typeNameFormat and type type to the NDEF filter. The record must occur between min and max times in the NDEF message.

Returns `true` if the record was appended successfully. Otherwise returns `false`.

### bool QNdefFilter::appendRecord(const QNdefFilter::Record &record)

Verifies the record and appends it to the NDEF filter.

Returns `true` if the record was appended successfully. Otherwise returns `false`.

### void QNdefFilter::clear()

Clears the filter.

### `[since 6.2]` bool QNdefFilter::match(const QNdefMessage &message) const

Returns `true` if the message matches the given filter. Otherwise returns `false`.

See Matching Algorithms for more detailed explanation of matching.

This function was introduced in Qt 6.2.

### bool QNdefFilter::orderMatch() const

Returns `true` if the filter takes NDEF record order into account when matching. Otherwise returns `false`.

See also setOrderMatch().

### QNdefFilter::Record QNdefFilter::recordAt(qsizetype i) const

Returns the NDEF record at index i.

i must be a valid index (i.e. 0 <= i < recordCount()).

See also recordCount().

### qsizetype QNdefFilter::recordCount() const

Returns the number of NDEF records in the filter.

### void QNdefFilter::setOrderMatch(bool on)

Sets the ordering requirements of the filter. If on is `true`, the filter will only match if the order of records in the filter matches the order of the records in the NDEF message. If on is `false`, the order of the records is not taken into account when matching.

By default record order is not taken into account.

See also orderMatch().

### QNdefFilter &QNdefFilter::operator=(const QNdefFilter &other)

Assigns other to this filter and returns a reference to this filter.