MeshX Model

Functions
	meshXModel< meshxBaseModel_t, meshx_send_packet_params_t >::meshXModel (MESHX_MODEL *p_plat_model, uint32_t model_id, meshXElementIF *parent_element=nullptr, uint16_t model_func_id=0)
	Constructs a new meshXModel instance.
void	meshXModel< meshxBaseModel_t, meshx_send_packet_params_t >::set_plat_model (MESHX_MODEL *p_model) override
	Set the platform-specific model instance.
virtual	meshXModel< meshxBaseModel_t, meshx_send_packet_params_t >::~meshXModel ()
	Destructor for meshXModel.
meshx_err_t	meshXModel< meshxBaseModel_t, meshx_send_packet_params_t >::send_to_parent_element (meshx_ptr_t msg_ptr, size_t msg_size)
	Send message to parent element.
meshx_err_t	meshXModel< meshxBaseModel_t, meshx_send_packet_params_t >::model_handle_from_ble_cb (dev_struct_t *p_dev, evt_model_id_t evt_model_id, meshx_ptr_t params)
	Handle upstream BLE Mesh events.
	meshXServerModel< meshxBaseServerModel_t, meshx_send_packet_params_t >::meshXServerModel (MESHX_MODEL *p_plat_model, uint32_t model_id, meshXElementIF *parent_element=nullptr, meshx_ptr_t parent_element_state=nullptr, uint16_t model_func_id=0)
	Construct a new Server Model.
	meshXClientModel< meshxBaseClientModel_t, meshx_send_packet_params_t >::meshXClientModel (MESHX_MODEL *p_plat_model, uint32_t model_id, meshXElementIF *parent_element=nullptr, meshx_ptr_t parent_element_state=nullptr, uint16_t model_func_id=0)
	Construct a new meshXClientModel.
meshx_err_t	meshXClientModel< meshxBaseClientModel_t, meshx_send_packet_params_t >::plat_model_create (MESHX_MODEL *p_plat_model_ptr=nullptr) final
	Create platform-specific client model instance.
meshx_err_t	meshXClientModel< meshxBaseClientModel_t, meshx_send_packet_params_t >::plat_model_delete (void) final
	Delete platform-specific client model instance.
void	meshXClientModel< meshxBaseClientModel_t, meshx_send_packet_params_t >::update_element_state_change_header (meshx_err_t element_state_change, meshx_ptr_t msg_ptr) override
	Update element_state_change field in client message header.
void	meshXServerModel< meshxBaseServerModel_t, meshx_send_packet_params_t >::update_element_state_change_header (meshx_err_t element_state_change, meshx_ptr_t msg_ptr) override
	Update element_state_change field in server message header.

Detailed Description

Function Documentation

meshXClientModel()

template<typename meshxBaseClientModel_t, typename meshx_send_packet_params_t>

meshXClientModel< meshxBaseClientModel_t, meshx_send_packet_params_t >::meshXClientModel	(	MESHX_MODEL *	p_plat_model,
		uint32_t	model_id,
		meshXElementIF *	parent_element = nullptr,
		meshx_ptr_t	parent_element_state = nullptr,
		uint16_t	model_func_id = 0 )

Construct a new meshXClientModel.

Constructs a new meshXClientModel instance.

Parameters

[in]	p_plat_model	Platform model instance
[in]	model_id	Model identifier
[in]	parent_element	Parent element interface (optional)
[in]	parent_element_state	Parent element state pointer (optional)
[in]	model_func_id	Model function ID within the element (optional)

Note

This constructor delegates to the base meshXModel constructor. Derived client models should use this constructor to ensure proper initialization.

    : meshXModel MESHX_CLIENT_MODEL_TEMPLATE_PARAMS (p_plat_model, model_id, parent_element, model_func_id)
{
    this->set_parent_element_state(parent_element_state);
}

meshXModel()

template<typename meshxBaseModel_t, typename meshx_send_packet_params_t>

meshXModel< meshxBaseModel_t, meshx_send_packet_params_t >::meshXModel	(	MESHX_MODEL *	p_plat_model,
		uint32_t	model_id,
		meshXElementIF *	parent_element = nullptr,
		uint16_t	model_func_id = 0 )

Constructs a new meshXModel instance.

This constructor initializes a meshXModel object with the given platform model, model ID, and optional parent element. It sets up the base model and model interface for BLE mesh communication.

Parameters

[in]	p_plat_model	Pointer to the platform model instance
[in]	model_id	Unique identifier for this model
[in]	parent_element	Optional pointer to the parent element
[in]	model_func_id	Optional model function ID within the element

Note

The constructor allocates memory for the base model and model interface. If memory allocation fails, the status will be set to MESHX_NO_MEM.

    : meshXModelIF(p_plat_model)
{
    this->set_model_func_id(model_func_id);
    this->set_parent_element(parent_element);
    this->model_id = (uint16_t)model_id;
    this->status = MESHX_SUCCESS;
 
    /* base_model needs to be used logically by the element composition */
    base_model = new meshxBaseModel_t(model_id, p_plat_model,
        [this](dev_struct_t *dev, control_task_msg_evt_t evt, meshx_ptr_t param) -> meshx_err_t {
            return this->model_handle_from_ble_cb(dev, evt, param);
        });
 
    this->set_plat_model(p_plat_model);
 
    /* Create logical model instance is now handled by derived classes or post-construction */
    status = MESHX_SUCCESS;
}

meshXServerModel()

template<typename meshxBaseServerModel_t, typename meshx_send_packet_params_t>

meshXServerModel< meshxBaseServerModel_t, meshx_send_packet_params_t >::meshXServerModel	(	MESHX_MODEL *	p_plat_model,
		uint32_t	model_id,
		meshXElementIF *	parent_element = nullptr,
		meshx_ptr_t	parent_element_state = nullptr,
		uint16_t	model_func_id = 0 )

Construct a new Server Model.

Constructs a new meshXServerModel instance.

Parameters

[in]	p_plat_model	Platform-specific model instance
[in]	model_id	Unique identifier for this model
[in]	parent_element	Parent element interface (optional)
[in]	parent_element_state	Parent element state pointer (optional)
[in]	model_func_id	Model function ID within the element (optional)

Initializes a server model with platform-specific implementation and associates it with an optional parent element

Note

This constructor delegates to the base meshXModel constructor.

    : meshXModel MESHX_SERVER_MODEL_TEMPLATE_PARAMS (p_plat_model, model_id, parent_element, model_func_id)
{
    this->set_parent_element_state(parent_element_state);
}

model_handle_from_ble_cb()

template<typename meshxBaseModel_t, typename meshx_send_packet_params_t>

meshx_err_t meshXModel< meshxBaseModel_t, meshx_send_packet_params_t >::model_handle_from_ble_cb	(	dev_struct_t *	p_dev,
		evt_model_id_t	evt_model_id,
		meshx_ptr_t	params )

Handle upstream BLE Mesh events.

Callback function invoked when a BLE event is received for the model.

Static callback function that routes messages and events coming from the BLE Mesh network to the appropriate model instance. This function extracts the model instance from the device structure and invokes the instance's model_from_ble_cb method.

Parameters

[in]	p_dev	Device structure containing sender information
[in]	evt_model_id	Event type indicating the nature of the message
[in]	params	Event-specific data payload

Returns

MESHX_SUCCESS if event handled successfully, error code otherwise

{
    meshx_err_t err = MESHX_SUCCESS;
 
    // Call derived class implementation
    err = this->model_from_ble_cb(p_dev, evt_model_id, params);
    if(err)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "Error in model_from_ble_cb: %d", err);
        return err;
    }
 
    // Get message from derived class
    meshx_ptr_t msg_ptr = nullptr;
    size_t msg_size = 0;
    err = this->prepare_element_msg(&msg_ptr, &msg_size);
    if(err)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "Error in prepare_element_msg: %d", err);
        return err;
    }
 
    // Send to parent element using common implementation
    return this->send_to_parent_element(msg_ptr, msg_size);
}

plat_model_create()

template<typename meshxBaseClientModel_t, typename meshx_send_packet_params_t>

meshx_err_t meshXClientModel< meshxBaseClientModel_t, meshx_send_packet_params_t >::plat_model_create ( MESHX_MODEL * p_plat_model_ptr = nullptr )

finalprivatevirtual

Create platform-specific client model instance.

Creates and initializes a client model instance.

Final implementation of the model creation process for client models. This function handles the initialization of client-specific features and cannot be overridden by derived classes.

Returns

MESHX_SUCCESS on successful model creation and initialization, error code otherwise

This function handles the platform-specific model creation process for client models. It initializes client-specific features and cannot be overridden by derived classes.

Template Parameters

MESHX_MODEL	Platform-specific model type
meshxBaseModel_t	Base model implementation type
meshx_send_packet_params_t	Type for send packet parameters

Returns

meshx_err_t Returns an error code indicating the result of the operation.

• MESHX_SUCCESS on successful model creation and initialization
• MESHX_ERR_NO_MEM if memory allocation fails
• Other error codes for platform-specific failures

Note

This is a final function and cannot be overridden by derived classes.

Implements meshXModelIF.

{
    meshx_err_t err = MESHX_SUCCESS;
 
    meshx_ptr_t p_pub = this->get_pub_struct();
    meshx_ptr_t p_gen = this->get_gen_struct();
 
    if (p_plat_model_ptr) {
        this->set_plat_model(p_plat_model_ptr);
    }
 
    MESHX_MODEL* p_use = (MESHX_MODEL*)this->get_plat_model();
    if (!p_use)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "No platform model pointer available");
        return MESHX_INVALID_STATE;
    }
 
    err = meshx_plat_client_create(p_use, &p_pub, &p_gen, this->get_model_id());
    if (err)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "Failed to create client model");
        err = plat_model_delete();
        if (err)
        {
            MESHX_LOGE(MODULE_ID_COMMON, "Failed to delete client model");
        }
    }
    else
    {
        /* Set the publication and generic structures */
        this->set_pub_struct(p_pub);
        this->set_gen_struct(p_gen);
    }
    return err;
}

plat_model_delete()

template<typename meshxBaseClientModel_t, typename meshx_send_packet_params_t>

meshx_err_t meshXClientModel< meshxBaseClientModel_t, meshx_send_packet_params_t >::plat_model_delete ( void )

finalprivatevirtual

Delete platform-specific client model instance.

Deletes the client model instance.

Final implementation of the model deletion process for client models. This function handles the cleanup of client-specific resources and cannot be overridden by derived classes.

This function is responsible for deleting the client model instance and releasing any associated resources.

Returns

meshx_err_t Returns an error code indicating the result of the operation.

• MESHX_SUCCESS on successful deletion
• Other error codes for platform-specific failures

Note

This is a final function and cannot be overridden by derived classes.

Implements meshXModelIF.

{
    meshx_ptr_t p_pub = this->get_pub_struct();
    meshx_ptr_t p_gen = this->get_gen_struct();
 
    meshx_err_t err = meshx_plat_client_delete(
        this->get_plat_model(),
        &p_pub,
        &p_gen);
 
    if (err == MESHX_SUCCESS)
    {
        this->set_pub_struct(p_pub);
        this->set_gen_struct(p_gen);
    }
 
    return err;
}

send_to_parent_element()

template<typename meshxBaseModel_t, typename meshx_send_packet_params_t>

meshx_err_t meshXModel< meshxBaseModel_t, meshx_send_packet_params_t >::send_to_parent_element	(	meshx_ptr_t	msg_ptr,
		size_t	msg_size )

Send message to parent element.

Common implementation for sending messages to the parent element. This handles the common pattern of checking parent element, calling element_state_change_handle(), and calling on_model_cb(). Type-specific header casting is delegated to update_element_state_change_header().

Parameters

[in]	msg_ptr	Pointer to the message structure
[in]	msg_size	Size of the message structure

Returns

MESHX_SUCCESS if message sent successfully, error code otherwise

Common implementation to send a message to the parent element.

{
    if (!msg_ptr || msg_size == 0)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "Invalid message parameters");
        return MESHX_INVALID_ARG;
    }
 
    /* Send the state change event to the respective Element */
    if (this->get_parent_element())
    {
        meshx_err_t state_change_result = MESHX_SUCCESS;
 
        if(this->get_parent_element_state() || this->get_model_id() == MESHX_MODEL_ID_CONFIG_SRV)
        {
            state_change_result = this->element_state_change_handle();
        }
        else
        {
            MESHX_LOGE(MODULE_ID_COMMON, "Parent element state is null for model_id: %04x", this->get_model_id());
            state_change_result = MESHX_NOT_FOUND;
        }
 
        // Delegate type-specific header casting to derived class
        this->update_element_state_change_header(state_change_result, msg_ptr);
 
        return this->get_parent_element()->on_model_cb(msg_ptr, msg_size);
    }
    else
    {
        MESHX_LOGE(MODULE_ID_COMMON, "Parent element is null");
    }
 
    return MESHX_INVALID_STATE;
}

set_plat_model()

template<typename meshxBaseModel_t, typename meshx_send_packet_params_t>

void meshXModel< meshxBaseModel_t, meshx_send_packet_params_t >::set_plat_model ( MESHX_MODEL * p_model )

overridevirtual

Set the platform-specific model instance.

Parameters

[in]

p_model

Pointer to the platform model instance

Reimplemented from meshXModelIF.

{
    meshXModelIF::set_plat_model(p_model);
    if (base_model)
    {
        base_model->set_plat_model_ptr((meshx_ptr_t)p_model);
    }
}

update_element_state_change_header() [1/2]

template<typename meshxBaseClientModel_t, typename meshx_send_packet_params_t>

void meshXClientModel< meshxBaseClientModel_t, meshx_send_packet_params_t >::update_element_state_change_header ( meshx_err_t element_state_change, meshx_ptr_t msg_ptr )

overrideprotectedvirtual

Update element_state_change field in client message header.

Overrides base class implementation to handle client-specific header structure (meshx_cli_model_send_param_header_t) which includes err_code and ctx fields.

Parameters

[in]	element_state_change	Result from element_state_change_handle()
[in]	msg_ptr	Pointer to the message structure

Implements meshXModel< meshxBaseClientModel_t, meshx_send_packet_params_t >.

{
    // Cast to client header - safe because this is a client model
    auto *cli_header = static_cast<meshx_cli_model_send_param_header_t*>(msg_ptr);
    cli_header->element_state_change = element_state_change;
}

update_element_state_change_header() [2/2]

template<typename meshxBaseServerModel_t, typename meshx_send_packet_params_t>

void meshXServerModel< meshxBaseServerModel_t, meshx_send_packet_params_t >::update_element_state_change_header ( meshx_err_t element_state_change, meshx_ptr_t msg_ptr )

overrideprotectedvirtual

Update element_state_change field in server message header.

Overrides base class implementation to handle server-specific header structure (meshx_srv_model_send_param_header_t) which doesn't include err_code and ctx.

Parameters

[in]	element_state_change	Result from element_state_change_handle()
[in]	msg_ptr	Pointer to the message structure

Implements meshXModel< meshxBaseServerModel_t, meshx_send_packet_params_t >.

{
    // Cast to server header - safe because this is a server model
    auto *srv_header = static_cast<meshx_srv_model_send_param_header_t*>(msg_ptr);
    srv_header->element_state_change = element_state_change;
}

~meshXModel()

template<typename meshxBaseModel_t, typename meshx_send_packet_params_t>

meshXModel< meshxBaseModel_t, meshx_send_packet_params_t >::~meshXModel ( )

virtual

Destructor for meshXModel.

Virtual destructor to ensure proper cleanup of derived classes and the base_model member.

{
    /* Delete logical model instance is now handled by derived classes */
    if (base_model)
    {
        delete base_model;
        base_model = nullptr;
    }
}