HF::Protocol::SetAttributePack::Response::Result Struct Reference

Set attribute operation result. More...

#include <attributes.h>

Collaboration diagram for HF::Protocol::SetAttributePack::Response::Result:

Public Member Functions
	Result (uint8_t uid, Common::Result code)
	Constructor. More...
uint16_t	size () const
	Number bytes needed to serialize the message. More...
uint16_t	pack (Common::ByteArray &array, uint16_t offset=0) const
	Write the object on to a ByteArray so it can be sent over the network. More...
uint16_t	unpack (const Common::ByteArray &array, uint16_t offset=0)
	Read a message from a ByteArray. More...

Data Fields
uint8_t	uid
	Attribute UID. More...
Common::Result	code
	Command result. More...

Static Public Attributes
static constexpr uint16_t	min_size = sizeof(uint8_t) + sizeof(uint8_t)
	Minimum pack/unpack required data size.

Detailed Description

Set attribute operation result.

Definition at line 1057 of file attributes.h.

Constructor & Destructor Documentation

Result()

HF::Protocol::SetAttributePack::Response::Result::Result ( uint8_t  uid, Common::Result  code  )

inline

Constructor.

Parameters

[in]	uid	attribute's UID.
[in]	code	operation result code.

Definition at line 1070 of file attributes.h.

                                                     :
                  uid(uid), code(code)
               {}

Member Function Documentation

pack()

uint16_t HF::Protocol::SetAttributePack::Response::Result::pack ( Common::ByteArray &  array, uint16_t  offset = 0  ) const

inline

Write the object on to a ByteArray so it can be sent over the network.

The buffer passed in MUST have enough size to hold the serialized object, e.g.,

Serializable obj;
ByteArray payload(obj.size());
obj.pack(payload);

Parameters

[in,out]	array	ByteArray reference to write the object to.
[in]	offset	offset to start writing to.

Returns

the number of bytes written.

Definition at line 1084 of file attributes.h.

References code, HF_SERIALIZABLE_CHECK, min_size, uid, and HF::Common::ByteArray::write().

               {
                  HF_SERIALIZABLE_CHECK(array, offset, min_size);

                  offset += array.write(offset, (uint8_t) uid);

                  array.write(offset, (uint8_t) code);

                  return min_size;
               }

Here is the call graph for this function:

size()

uint16_t HF::Protocol::SetAttributePack::Response::Result::size ( ) const

inline

Number bytes needed to serialize the message.

Returns

number of bytes the message requires to be serialized.

Definition at line 1078 of file attributes.h.

References min_size.

               {
                  return min_size;
               }

unpack()

uint16_t HF::Protocol::SetAttributePack::Response::Result::unpack ( const Common::ByteArray &  array, uint16_t  offset = 0  )

inline

Read a message from a ByteArray.

Parameters

[in]	array	ByteArray reference to read the message from.
[in]	offset	offset to start reading from.

Returns

the number of bytes read.

Definition at line 1096 of file attributes.h.

References code, HF_SERIALIZABLE_CHECK, min_size, HF::Common::ByteArray::read(), and uid.

               {
                  HF_SERIALIZABLE_CHECK(array, offset, min_size);

                  offset += array.read(offset, uid);

                  uint8_t temp;
                  array.read(offset, temp);
                  code = static_cast<Common::Result>(temp);

                  return min_size;
               }

Here is the call graph for this function:

Field Documentation

code

Common::Result HF::Protocol::SetAttributePack::Response::Result::code

Command result.

Definition at line 1060 of file attributes.h.

Referenced by pack(), and unpack().

uid

uint8_t HF::Protocol::SetAttributePack::Response::Result::uid

Attribute UID.

Definition at line 1059 of file attributes.h.

Referenced by pack(), and unpack().

---

The documentation for this struct was generated from the following file:

• attributes.h