HF::Core::GroupManagement::CreateResponse Struct Reference

Message payload for a HF::GroupManagement::CREATE_CMD response. More...

#include <group_management.h>

Inheritance diagram for HF::Core::GroupManagement::CreateResponse:

Collaboration diagram for HF::Core::GroupManagement::CreateResponse:

Public Member Functions
	CreateResponse (uint16_t address)
	Constructor. More...
	CreateResponse (Common::Result code=Common::Result::OK, uint16_t address=GroupAddress::NO_ADDR)
	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...
Public Member Functions inherited from HF::Protocol::Response
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...
Public Member Functions inherited from HF::Core::GroupManagement::GroupAddress
	GroupAddress (uint16_t address=0)
	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...

Static Public Attributes
static constexpr uint16_t	min_size = Protocol::Response::min_size
	Minimum pack/unpack required data size.
Static Public Attributes inherited from HF::Protocol::Response
static constexpr uint16_t	min_size = sizeof(uint8_t)
	Minimum number of bytes required by this message.
Static Public Attributes inherited from HF::Core::GroupManagement::GroupAddress
static constexpr uint16_t	NO_ADDR = 0x0000
	Empty Group Address. More...
static constexpr uint16_t	START_ADDR = 0x0001
	First HAN-FUN Group Address. More...
static constexpr uint16_t	END_ADDR = 0x7FFF
	Last HAN-FUN Group Address. More...
static constexpr uint16_t	min_size = sizeof(uint16_t)
	Minimum pack/unpack required data size.

Additional Inherited Members
Data Fields inherited from HF::Core::GroupManagement::GroupAddress
uint16_t	address
	Group Address

Detailed Description

Message payload for a HF::GroupManagement::CREATE_CMD response.

Definition at line 396 of file group_management.h.

Constructor & Destructor Documentation

CreateResponse() [1/2]

HF::Core::GroupManagement::CreateResponse::CreateResponse ( uint16_t  address )

inline

Constructor.

Parameters

[in]

address

group address.

Definition at line 403 of file group_management.h.

                                            :
               Protocol::Response(), GroupAddress(address)
            {}

CreateResponse() [2/2]

HF::Core::GroupManagement::CreateResponse::CreateResponse ( Common::Result  code = Common::Result::OK, uint16_t  address = GroupAddress::NO_ADDR  )

inline

Constructor.

Parameters

[in]	code	response code.
[in]	address	group address

Definition at line 413 of file group_management.h.

                                                                  :
               Protocol::Response(code), GroupAddress(address)
            {}

Member Function Documentation

pack()

uint16_t HF::Core::GroupManagement::CreateResponse::pack	(	Common::ByteArray &	array,
		uint16_t	offset = 0
	)		const

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.

size()

uint16_t HF::Core::GroupManagement::CreateResponse::size

(

)

const

Number bytes needed to serialize the message.

Returns

number of bytes the message requires to be serialized.

unpack()

uint16_t HF::Core::GroupManagement::CreateResponse::unpack	(	const Common::ByteArray &	array,
		uint16_t	offset = 0
	)

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.

---

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

• group_management.h