echomap::ModifySensorColourNotification Struct Reference

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

#include <ModifySensorColourNotification.hpp>

Public Member Functions
	ModifySensorColourNotification (id_type project_id, id_type sensor_id, const Colour &colour)
	Create a new ModifySensorPositionNotification to indicate that a Sensor has changed in colour.
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.
Colour	colour
	The new Colour of the referenced Sensor.

Detailed Description

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

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

Definition at line 28 of file ModifySensorColourNotification.hpp.

Constructor & Destructor Documentation

ModifySensorColourNotification()

echomap::ModifySensorColourNotification::ModifySensorColourNotification ( id_type project_id, id_type sensor_id, const Colour & colour )

explicit

Create a new ModifySensorPositionNotification to indicate that a Sensor has changed in colour.

Parameters

project_id	The ID of the Project which owns the updated Sensor.
sensor_id	The ID of the moved Sensor.
colour	The new Colour of the referenced Sensor.

Definition at line 18 of file ModifySensorColourNotification.cpp.

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

Member Function Documentation

verify_project()

void echomap::ModifySensorColourNotification::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 ModifySensorColourNotification.cpp.

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

Member Data Documentation

colour

Colour echomap::ModifySensorColourNotification::colour

The new Colour of the referenced Sensor.

Definition at line 53 of file ModifySensorColourNotification.hpp.

project_id

id_type echomap::ModifySensorColourNotification::project_id

The ID of the Project which owns the updated Sensor.

Definition at line 51 of file ModifySensorColourNotification.hpp.

sensor_id

id_type echomap::ModifySensorColourNotification::sensor_id

The ID of the moved Sensor.

Definition at line 52 of file ModifySensorColourNotification.hpp.

---

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

• src/notifications/ModifySensorColourNotification.hpp
• src/notifications/ModifySensorColourNotification.cpp