NuDockFactory.h File Reference

Factory utilities for creating and configuring NuDock communication objects. More...

#include <Manager/Manager.h>
#include "nudock.hpp"

Include dependency graph for NuDockFactory.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
_MaCh3_Safe_Include_Start_ _MaCh3_Safe_Include_End_ void	InitialiseNuDockObj (Manager *man, std::unique_ptr< NuDock > &nudock_ptr)
	Initialise a NuDock communication object from a manager configuration. More...
void	FormatOscParsForNuDock (const std::string &param_name, double &param_value)
	Convert an oscillation parameter value from MaCh3 convention to NuDock convention. More...
void	FormatOscParsForMaCh3 (const std::string &param_name, double &param_value)
	Convert an oscillation parameter value from NuDock convention to MaCh3 convention. More...

Variables
const std::unordered_map< std::string, std::string >	NuDockOscNameMap
	Map from NuDock oscillation parameter names to MaCh3 names. More...
const std::unordered_map< std::string, std::string >	NuDockOscNameMap_r
	Map from MaCh3 oscillation parameter names to NuDock names. More...

Detailed Description

Factory utilities for creating and configuring NuDock communication objects.

Provides helper functions to initialise NuDock instances from MaCh3 configuration, as well as conversion utilities between MaCh3 and NuDock oscillation parameter conventions.

Author

Hank Hua

Definition in file NuDockFactory.h.

Function Documentation

FormatOscParsForMaCh3()

void FormatOscParsForMaCh3	(	const std::string &	param_name,
		double &	param_value
	)

Convert an oscillation parameter value from NuDock convention to MaCh3 convention.

Parameters

	param_name	The NuDock-side parameter name (e.g. "Theta12").
[in,out]	param_value	The parameter value to convert in-place.

Definition at line 111 of file NuDockFactory.cpp.

                                                                             {
  if (param_name == "Theta12" || param_name == "Theta13" || param_name == "Theta23") {
    param_value = std::sin(param_value) * std::sin(param_value);
  }
}

FormatOscParsForNuDock()

void FormatOscParsForNuDock	(	const std::string &	param_name,
		double &	param_value
	)

Convert an oscillation parameter value from MaCh3 convention to NuDock convention.

Parameters

	param_name	The MaCh3-side parameter name (e.g. "Theta12").
[in,out]	param_value	The parameter value to convert in-place.

Definition at line 105 of file NuDockFactory.cpp.

                                                                              {
  if (param_name == "Theta12" || param_name == "Theta13" || param_name == "Theta23") {
    param_value = std::asin(std::sqrt(param_value));
  }
}

InitialiseNuDockObj()

_MaCh3_Safe_Include_Start_ _MaCh3_Safe_Include_End_ void InitialiseNuDockObj	(	Manager *	man,
		std::unique_ptr< NuDock > &	nudock_ptr
	)

Initialise a NuDock communication object from a manager configuration.

Parameters

	man	Pointer to the MaCh3 manager holding the NuDock YAML config block.
[in,out]	nudock_ptr	Unique pointer that will own the newly created NuDock object.

Exceptions

MaCh3Exception

if no NuDock configuration is found, or if an unsupported communication type / verbosity level is specified.

Definition at line 43 of file NuDockFactory.cpp.

                                                                   {
  // Here man can be either the sample manager or the fit manager, as long as it
  // has the NuDock config
  if (nudock_ptr) {
    MACH3LOG_INFO("NuDock object has already been created so I am not "
                  "re-initialising the object");
    return;
  }
  std::string nudock_conf_name = "NuDock";
  if (!man->raw()["NuDock"]) {
    if (!man->raw()["NuDockClient"]) {
      MACH3LOG_ERROR(
          "No NuDock configuration found in the provided manager object");
      throw MaCh3Exception(__FILE__, __LINE__);
    } else {
      MACH3LOG_INFO("Setting up NuDock client.");
      nudock_conf_name = "NuDockClient";
    }
  } else {
    MACH3LOG_INFO("Setting up NuDock server.");
  }
 
  bool useDebug = GetFromManager(man->raw()[nudock_conf_name]["Debug"], false);
  std::string schemaLocation = GetFromManager<std::string>(
      man->raw()[nudock_conf_name]["SchemaLocation"], "");
  std::string commTypeStr = GetFromManager<std::string>(
      man->raw()[nudock_conf_name]["CommunicationType"], "LOCALHOST");
  int port = GetFromManager<int>(man->raw()[nudock_conf_name]["Port"], 1234);
  std::string verbosity =
      GetFromManager<std::string>(man->raw()[nudock_conf_name]["NuDockVerbosity"], "INFO");
 
  CommunicationType commType;
  if (CommunicationTypeMap.find(commTypeStr) != CommunicationTypeMap.end()) {
    commType = CommunicationTypeMap.at(commTypeStr);
  } else {
    MACH3LOG_ERROR(
        "Unsupported communication type for NuDock: {}. Supported types "
        "are LOCALHOST, UNIX_DOMAIN_SOCKET, and TCP.",
        commTypeStr);
    throw MaCh3Exception(__FILE__, __LINE__);
  }
 
  VerbosityLevel verbLevel;
  if (VerbosityLevelMap.find(verbosity) != VerbosityLevelMap.end()) {
    verbLevel = VerbosityLevelMap.at(verbosity);
  } else {
    MACH3LOG_ERROR(
        "Unsupported verbosity level for NuDock: {}. Supported levels are "
        "DEBUG, INFO, WARN, and ERROR.",
        verbosity);
    throw MaCh3Exception(__FILE__, __LINE__);
  }
 
  nudock_ptr =
      std::make_unique<NuDock>(useDebug, schemaLocation, commType, port, verbLevel);
  MACH3LOG_INFO("NuDock object created with communication type: {} on port: {}", commTypeStr, port);
  MACH3LOG_INFO("NuDock schema location: {}", schemaLocation);
  MACH3LOG_INFO("NuDock debug mode: {}", useDebug);
  MACH3LOG_INFO("NuDock verbosity level: {}", verbosity);
}

Variable Documentation

NuDockOscNameMap

const std::unordered_map<std::string, std::string> NuDockOscNameMap

extern

Map from NuDock oscillation parameter names to MaCh3 names.

Keys are NuDock-style names (e.g. "Theta12"), values are MaCh3-style names (e.g. "sin2th_12").

Map from NuDock oscillation parameter names to MaCh3 names.

Definition at line 9 of file NuDockFactory.cpp.

NuDockOscNameMap_r

const std::unordered_map<std::string, std::string> NuDockOscNameMap_r

extern

Map from MaCh3 oscillation parameter names to NuDock names.

Keys are MaCh3-style names (e.g. "sin2th_12"), values are NuDock-style names (e.g. "Theta12").

Map from MaCh3 oscillation parameter names to NuDock names.

Definition at line 19 of file NuDockFactory.cpp.