echomap::ModifySensorPositionNotification Struct Reference

A notification indicating that the position of a Sensor should be changed. More...

#include <ModifySensorPositionNotification.hpp>

Public Member Functions
	ModifySensorPositionNotification (id_type project_id, id_type sensor_id, const Position &position)
	Create a new ModifySensorPositionNotification to indicate that a Sensor has moved.
void	verify_project (const Project *context) const
	Verify that the given Project matches the intended target.

Public Attributes
id_type	project_id
	The ID of the Project which owns the updated Sensor.
id_type	sensor_id
	The ID of the moved Sensor.
Position	position
	The new Position of the referenced Sensor.

Detailed Description

A notification indicating that the position of a Sensor should be changed.

Produced by the SensorGeometryPanel when the user requests to move the position of a Sensor from the front-end.

Definition at line 28 of file ModifySensorPositionNotification.hpp.

Constructor & Destructor Documentation

ModifySensorPositionNotification()

echomap::ModifySensorPositionNotification::ModifySensorPositionNotification ( id_type project_id, id_type sensor_id, const Position & position )

explicit

Create a new ModifySensorPositionNotification to indicate that a Sensor has moved.

Parameters

project_id	The ID of the Project which owns the updated Sensor.
sensor_id	The ID of the moved Sensor.
position	The new Position of the referenced Sensor.

Definition at line 18 of file ModifySensorPositionNotification.cpp.

  :
    project_id(project_id),
    sensor_id(sensor_id),
    position(position)
{
}

Member Function Documentation

verify_project()

void echomap::ModifySensorPositionNotification::verify_project

(

const Project *

context

)

const

Verify that the given Project matches the intended target.

Parameters

context

The context to which the notification will apply.

Exceptions

IgnoredWarning

The notification does not apply to the given context and should be ignored.

Definition at line 29 of file ModifySensorPositionNotification.cpp.

{
    if (context == nullptr)
        throw IgnoredWarning("Dropping ModifySensorPositionNotification due to empty project.");
 
    if (context->get_id() != project_id)
        throw IgnoredWarning(
                std::format(
                        "Dropping ModifySensorPositionNotification due to invalid project: requested {}, but have {}.",
                        project_id,
                        context->get_id()
                )
        );
}

Member Data Documentation

position

Position echomap::ModifySensorPositionNotification::position

The new Position of the referenced Sensor.

Definition at line 53 of file ModifySensorPositionNotification.hpp.

project_id

id_type echomap::ModifySensorPositionNotification::project_id

The ID of the Project which owns the updated Sensor.

Definition at line 51 of file ModifySensorPositionNotification.hpp.

sensor_id

id_type echomap::ModifySensorPositionNotification::sensor_id

The ID of the moved Sensor.

Definition at line 52 of file ModifySensorPositionNotification.hpp.

---

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

• src/notifications/ModifySensorPositionNotification.hpp
• src/notifications/ModifySensorPositionNotification.cpp