echomap::AddChannelMappingNotification Struct Reference

A notification indicating that a new channel mapping should be established. More...

#include <AddChannelMappingNotification.hpp>

Public Member Functions
	AddChannelMappingNotification (id_type project_id, id_type signal_id, id_type sensor_id)
	Create a new AddChannelMappingNotification to indicate that the Signal and Sensor within a Project should be mapped.
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 detaining the Signal and Sensor.
id_type	signal_id
	The ID of the participating Signal.
id_type	sensor_id
	The ID of the participating Sensor.

Detailed Description

A notification indicating that a new channel mapping should be established.

Definition at line 25 of file AddChannelMappingNotification.hpp.

Constructor & Destructor Documentation

AddChannelMappingNotification()

echomap::AddChannelMappingNotification::AddChannelMappingNotification	(	id_type	project_id,
		id_type	signal_id,
		id_type	sensor_id )

Create a new AddChannelMappingNotification to indicate that the Signal and Sensor within a Project should be mapped.

Parameters

project_id	The ID of the Project detaining the Signal and Sensor.
signal_id	The ID of the participating Signal.
sensor_id	The ID of the participating Sensor.

Definition at line 18 of file AddChannelMappingNotification.cpp.

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

Member Function Documentation

verify_project()

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

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

Member Data Documentation

project_id

id_type echomap::AddChannelMappingNotification::project_id

The ID of the Project detaining the Signal and Sensor.

Definition at line 49 of file AddChannelMappingNotification.hpp.

sensor_id

id_type echomap::AddChannelMappingNotification::sensor_id

The ID of the participating Sensor.

Definition at line 51 of file AddChannelMappingNotification.hpp.

signal_id

id_type echomap::AddChannelMappingNotification::signal_id

The ID of the participating Signal.

Definition at line 50 of file AddChannelMappingNotification.hpp.

---

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

• src/notifications/AddChannelMappingNotification.hpp
• src/notifications/AddChannelMappingNotification.cpp