nl::Weave::Profiles::SoftwareUpdate::ProductSpec

#include <src/lib/profiles/software-update/SoftwareUpdateProfile.h>

An auxiliary class that representing a product specification.

Summary

Constructors and Destructors
`ProductSpec(uint16_t aVendor, uint16_t aProduct, uint16_t aRevision)` A constructor for the ProductSpec object.
`ProductSpec()` A default constructor that creates an invalid ProductSpec object.

Public attributes
`productId`	`uint16_t` A 16-bit product ID drawn from a vendor-managed namespace.
`productRev`	`uint16_t` A 16-bit product revision drawn from a vendor managed namespace.
`vendorId`	`uint16_t` Weave Vendor ID drawn from the Weave Vendor Identifier Registry.

Public functions
`operator==(const ProductSpec &) const`	`bool` An equality operator.

uint16_t productId

A 16-bit product ID drawn from a vendor-managed namespace.

uint16_t productRev

A 16-bit product revision drawn from a vendor managed namespace.

uint16_t vendorId

Weave Vendor ID drawn from the Weave Vendor Identifier Registry.

 ProductSpec(
  uint16_t aVendor,
  uint16_t aProduct,
  uint16_t aRevision
)

A constructor for the ProductSpec object.

Details

Parameters

`[in] aVendor`	The vendor identifier for the specified product
`[in] aProduct`	Vendor-specific product identifier
`[in] aRevision`	Vendor-specific product revision number

 ProductSpec()

A default constructor that creates an invalid ProductSpec object.

Used in cases where the object is being deserialized from a message.

bool operator==(
  const ProductSpec &
) const

An equality operator.

Details

Parameters

another

A ProductSpec to check against this ProductSpec

Returns

true if all the fields in both objects are equal, false otherwise