EMANE  1.0.1
EMANE::Application::ConfigurationController Class Reference

External application interface to the configuration service. More...

#include <configurationcontroller.h>

Static Public Member Functions

static ConfigurationUpdate buildUpdates (BuildId buildId, const ConfigurationUpdateRequest &parameters)
 
static ConfigurationManifest getConfigurationManifest (BuildId buildId)
 

Detailed Description

External application interface to the configuration service.

Definition at line 45 of file configurationcontroller.h.

Member Function Documentation

◆ buildUpdates()

EMANE::ConfigurationUpdate EMANE::Application::ConfigurationController::buildUpdates ( BuildId  buildId,
const ConfigurationUpdateRequest parameters 
)
static

Builds a ConfigurationUpdate for processing by a component. Local configuration cache is updated and future calls to getConfigurationInfos will reflect the latest values processed by buildUpdates. Cache update only occurs if the entire update request is successfully validated.

Parameters
buildIdBuild id of the component
parametersName string values pairs of requested configuration updates.
Returns
ConfigurationInfos container holding configuration information.
Exceptions
ConfigurationExceptionThrown when a configuration validation error occurs. Errors include values or instance counts out of range, incorrect data type, string to data type conversion errors and unregistered configuration targets.

Definition at line 37 of file configurationcontroller.cc.

◆ getConfigurationManifest()

EMANE::ConfigurationManifest EMANE::Application::ConfigurationController::getConfigurationManifest ( BuildId  buildId)
static

Gets the configuration manifest for the specified Buildable

Parameters
buildIdTarget component build Id
Returns
configuration manifest

Definition at line 44 of file configurationcontroller.cc.


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