#include <otsdaq/CoreSupervisors/ConfigurationSupervisorBase.h>

Inheritance diagram for ots::ConfigurationSupervisorBase:

Classes
struct	GroupAliasEdit
	One group-alias assignment for setGroupAliasesInActiveBackbone() More...

Static Public Member Functions
static std::pair< std::string, TableGroupKey >	setGroupAliasesInActiveBackbone (ConfigurationManagerRW *cfgMgr, const std::vector< GroupAliasEdit > &aliasEdits)

static void	getConfigurationStatusXML (HttpXmlDocument &xmlOut, ConfigurationManagerRW *cfgMgr, const std::string &username)
	getConfigurationStatusXML

static TableVersion	saveModifiedVersionXML (HttpXmlDocument &xmlOut, ConfigurationManagerRW cfgMgr, const std::string &tableName, TableVersion originalVersion, bool makeTemporary, TableBase config, TableVersion temporaryModifiedVersion, bool ignoreDuplicates=false, bool lookForEquivalent=false)

static void	handleCreateTableXML (HttpXmlDocument &xmlOut, ConfigurationManagerRW *cfgMgr, const std::string &tableName, TableVersion version, bool makeTemporary, const std::string &data, const int &dataOffset, const std::string &author, const std::string &comment, bool sourceTableAsIs, bool lookForEquivalent)

static void	handleCreateTableGroupXML (HttpXmlDocument &xmlOut, ConfigurationManagerRW *cfgMgr, const std::string &groupName, const std::string &configList, bool allowDuplicates=false, bool ignoreWarnings=false, const std::string &groupComment="", bool lookForEquivalent=false)

static void	handleGetTableGroupXML (HttpXmlDocument &xmlOut, ConfigurationManagerRW *cfgMgr, const std::string &groupName, TableGroupKey groupKey, bool ignoreWarnings=false, bool cacheOnly=false)

static bool	handleAddDesktopIconXML (HttpXmlDocument &xmlOut, ConfigurationManagerRW *cfgMgr, const std::string &iconCaption, const std::string &iconAltText, const std::string &iconFolderPath, const std::string &iconImageURL, const std::string &iconWindowURL, const std::string &iconPermissions, std::string windowLinkedApp="", unsigned int windowLinkedAppLID=0, bool enforceOneWindowInstance=false, const std::string &windowParameters="")

static void	recursiveCopyTreeUIDNode (HttpXmlDocument &xmlOut, ConfigurationManagerRW cfgMgr, std::map< std::string, TableVersion > &modifiedTablesMap, const unsigned int startingDepth, const unsigned int depth, const unsigned int numberOfInstances, TableView cfgView, const std::string &uidToCopy)

Detailed Description

ConfigurationSupervisorBase This class provides supervisor level features for manipulating the configuration

Definition at line 15 of file ConfigurationSupervisorBase.h.

Member Function Documentation

◆ handleCreateTableGroupXML()

void ConfigurationSupervisorBase::handleCreateTableGroupXML	(	HttpXmlDocument &	xmlOut,
		ConfigurationManagerRW *	cfgMgr,
		const std::string &	groupName,
		const std::string &	tableList,
		bool	allowDuplicates = `false`,
		bool	ignoreWarnings = `false`,
		const std::string &	groupComment = `""`,
		bool	lookForEquivalent = `false`
	)

static

handleCreateTableGroupXML

Save a new TableGroup:
    Search for existing TableGroupKeys for this TableGroup
    Append a "bumped" system key to name
    Save based on list of tableName/TableVersion

tableList parameter is comma separated table name and version

Note: if version of -1 (INVALID/MOCKUP) is given and there are no other existing

table versions... a new table version is generated using the mockup table.

Table Version Alias Handling:
    Allow table versions to be specified as an alias with ALIAS: preamble. Aliased

versions will be translated according to the active backbone at activation time.

Definition at line 335 of file ConfigurationSupervisorBase.cc.

◆ handleCreateTableXML()

void ConfigurationSupervisorBase::handleCreateTableXML	(	HttpXmlDocument &	xmlOut,
		ConfigurationManagerRW *	cfgMgr,
		const std::string &	tableName,
		TableVersion	version,
		bool	makeTemporary,
		const std::string &	data,
		const int &	dataOffset,
		const std::string &	author,
		const std::string &	comment,
		bool	sourceTableAsIs,
		bool	lookForEquivalent
	)

static

handleCreateTableXML

Save the detail of specific table specified by tableName and version ...starting from dataOffset

Note: if starting version is -1 start from mock-up

Definition at line 78 of file ConfigurationSupervisorBase.cc.

◆ handleGetTableGroupXML()

void ConfigurationSupervisorBase::handleGetTableGroupXML	(	HttpXmlDocument &	xmlOut,
		ConfigurationManagerRW *	cfgMgr,
		const std::string &	groupName,
		TableGroupKey	groupKey,
		bool	ignoreWarnings = `false`,
		bool	cacheOnly = `false`
	)

static

handleGetTableGroupXML

give the detail of specific table specified groupKey=-1 returns latest

Find historical group keys and figure out all member configurations versions

Use cacheOnly to only return group info previously cached (avoid reloading from database)

return this information <group name=xxx key=xxx>> <historical key=xxx>> <historical key=xxx>> .... <historical version=xxx>> <historical version=xxx>> ...

..

Lambda function to output historic values in spans

Definition at line 723 of file ConfigurationSupervisorBase.cc.

◆ saveModifiedVersionXML()

TableVersion ConfigurationSupervisorBase::saveModifiedVersionXML	(	HttpXmlDocument &	xmlOut,
		ConfigurationManagerRW *	cfgMgr,
		const std::string &	tableName,
		TableVersion	originalVersion,
		bool	makeTemporary,
		TableBase *	table,
		TableVersion	temporaryModifiedVersion,
		bool	ignoreDuplicates = `false`,
		bool	lookForEquivalent = `false`
	)

static

saveModifiedVersionXML

once source version has been modified in temporary version this function finishes it off.

Definition at line 283 of file ConfigurationSupervisorBase.cc.

◆ setGroupAliasesInActiveBackbone()

std::pair< std::string, TableGroupKey > ConfigurationSupervisorBase::setGroupAliasesInActiveBackbone	(	ConfigurationManagerRW *	cfgMgr,
		const std::vector< GroupAliasEdit > &	aliasEdits
	)

static

Create or overwrite group aliases in the active Backbone, then save and activate the resulting Backbone group. Author is cfgMgr->getUsername(). Returns the (name, key) of the Backbone group that is active afterwards.

Definition at line 1504 of file ConfigurationSupervisorBase.cc.

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

otsdaq/otsdaq/CoreSupervisors/ConfigurationSupervisorBase.h
otsdaq/otsdaq/CoreSupervisors/ConfigurationSupervisorBase.cc

Classes

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ handleCreateTableGroupXML()

◆ handleCreateTableXML()

◆ handleGetTableGroupXML()

◆ saveModifiedVersionXML()

◆ setGroupAliasesInActiveBackbone()