meshXBaseSensorServerModel Class Reference

#include <meshx_base_model_sensor.hpp>

Inheritance diagram for meshXBaseSensorServerModel:

Public Member Functions
meshx_err_t	plat_model_init (void) override
	Initialization function for the Sensor Server model.
meshx_err_t	validate_server_status_opcode (uint16_t opcode) override
	Validate a sensor server status opcode.
meshx_err_t	server_state_restore (meshx_sensor_server_restore_params_t *param) override
	Restores the state of the Sensor Server model.
meshx_err_t	plat_send_msg (meshx_sensor_server_send_params_t *params) override
	Sends a status message for the Sensor Server model.
	meshXBaseSensorServerModel (uint32_t model_id, meshx_ptr_t p_plat_model, const control_msg_cb &from_ble_cb)
	meshXBaseSensorServerModel ()=delete
	~meshXBaseSensorServerModel () override=default
Public Member Functions inherited from meshXBaseServerModel< meshXBaseSensorServerModel, meshx_sensor_server_send_params_t, meshx_sensor_server_restore_params_t, meshx_sensor_server_cb_param_t >
	meshXBaseServerModel ()=delete
virtual	~meshXBaseServerModel ()=default
meshx_err_t	from_ble_dereg_cb (void) const override
	Deregister BLE message callback for this model.
void	set_plat_model_ptr (meshx_ptr_t p_model)
	Set the platform model pointer and update the registration list.
Public Member Functions inherited from meshXBaseModel< meshx_sensor_server_send_params_t >
meshx_err_t	from_ble_reg_cb (void) const
	Register BLE message callback for this model.
meshx_err_t	get_status (void) const
	Get the current status of the model.
uint32_t	get_model_id (void) const
	Get the model identifier.
control_task_msg_handle_t	get_from_ble_cb (void) const
	Get the BLE message callback function.
meshXBaseModelType_t	get_model_type (void) const
	Get the model type (server/client).
void	set_status (meshx_err_t err)
	Set the model status.
void	set_model_id (uint32_t id)
	Set the model identifier.
void	set_from_ble_cb (control_task_msg_handle_t cb)
	Set the BLE message callback function.
void	set_model_type (meshXBaseModelType_t type)
	Set the model type.
	meshXBaseModel (uint32_t model_id, control_task_msg_handle_t from_ble_cb, meshXBaseModelType_t model_type)
	Construct a new meshXBaseModel object.
virtual	~meshXBaseModel ()
	Virtual destructor for meshXBaseModel.

Additional Inherited Members
Static Protected Member Functions inherited from meshXBaseServerModel< meshXBaseSensorServerModel, meshx_sensor_server_send_params_t, meshx_sensor_server_restore_params_t, meshx_sensor_server_cb_param_t >
static meshx_err_t	base_from_ble_msg_handle (dev_struct_t *pdev, control_task_msg_evt_t evt, meshx_ptr_t params)
	Sends a BLE message from a server model.
Protected Attributes inherited from meshXBaseServerModel< meshXBaseSensorServerModel, meshx_sensor_server_send_params_t, meshx_sensor_server_restore_params_t, meshx_sensor_server_cb_param_t >
meshx_ptr_t	p_plat_model
Protected Attributes inherited from meshXBaseModel< meshx_sensor_server_send_params_t >
uint32_t	model_id
meshXBaseModelType_t	model_type
control_task_msg_handle_t	from_ble_cb
meshx_err_t	status
Static Protected Attributes inherited from meshXBaseServerModel< meshXBaseSensorServerModel, meshx_sensor_server_send_params_t, meshx_sensor_server_restore_params_t, meshx_sensor_server_cb_param_t >
static std::once_flag	plat_server_init_flag
static std::forward_list< base_server_model_cb_reg_t >	base_server_model_cb_list

Constructor & Destructor Documentation

meshXBaseSensorServerModel() [1/2]

meshXBaseSensorServerModel::meshXBaseSensorServerModel	(	uint32_t	model_id,
		meshx_ptr_t	p_plat_model,
		const control_msg_cb &	from_ble_cb )

    : meshXBaseServerModel<meshXBaseSensorServerModel, meshx_sensor_server_send_params_t, meshx_sensor_server_restore_params_t, meshx_sensor_server_cb_param_t>(model_id, p_plat_model, from_ble_cb)
{
    set_status(meshXBaseSensorServerModel::plat_model_init());
    if (get_status() != MESHX_SUCCESS)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "plat_model_init failed");
        return;
    }
}

meshXBaseSensorServerModel() [2/2]

meshXBaseSensorServerModel::meshXBaseSensorServerModel ( )

delete

~meshXBaseSensorServerModel()

meshXBaseSensorServerModel::~meshXBaseSensorServerModel ( )

overridedefault

Member Function Documentation

plat_model_init()

meshx_err_t meshXBaseSensorServerModel::plat_model_init ( void )

overridevirtual

Initialization function for the Sensor Server model.

Implements meshXBaseModel< meshx_sensor_server_send_params_t >.

{
    return MESHX_SUCCESS;
}

plat_send_msg()

meshx_err_t meshXBaseSensorServerModel::plat_send_msg ( meshx_sensor_server_send_params_t * params )

overridevirtual

Sends a status message for the Sensor Server model.

Implements meshXBaseModel< meshx_sensor_server_send_params_t >.

{
    if (!params || !params->model || !params->ctx)
    {
        return MESHX_INVALID_ARG;
    }
 
    return meshx_plat_sensor_srv_send_status(
        (meshx_model_t*)params->model,
        (meshx_ctx_t*)params->ctx,
        &params->state
    );
}

server_state_restore()

meshx_err_t meshXBaseSensorServerModel::server_state_restore ( meshx_sensor_server_restore_params_t * param )

overridevirtual

Restores the state of the Sensor Server model.

Implements meshXBaseServerModel< meshXBaseSensorServerModel, meshx_sensor_server_send_params_t, meshx_sensor_server_restore_params_t, meshx_sensor_server_cb_param_t >.

{
    return MESHX_SUCCESS;
}

validate_server_status_opcode()

meshx_err_t meshXBaseSensorServerModel::validate_server_status_opcode ( uint16_t opcode )

overridevirtual

Validate a sensor server status opcode.

Implements meshXBaseServerModel< meshXBaseSensorServerModel, meshx_sensor_server_send_params_t, meshx_sensor_server_restore_params_t, meshx_sensor_server_cb_param_t >.

{
    switch(opcode)
    {
        case MESHX_MODEL_OP_SENSOR_STATUS:
        case MESHX_MODEL_OP_SENSOR_COLUMN_STATUS:
        case MESHX_MODEL_OP_SENSOR_SERIES_STATUS:
            return MESHX_SUCCESS;
        default:
            return MESHX_FAIL;
    }
}

---

The documentation for this class was generated from the following files:

• meshx_base_model_sensor.hpp
• meshx_base_model_sensor.cpp