#include "/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-02-25/DatabaseUtils/cxx/include/DAQConfig/GlobalNameSpec.h"

Public Member Functions
	GlobalNameSpec (const std::string &configName, const std::string &dcmOperatingMode, const std::string &detectorId)

	GlobalNameSpec (const std::string &configName, const std::string &dcmOperatingMode, const std::string &detectorId, const std::string &timestamp)

std::string	getConfigName () const

std::string	getDCMOpMode () const

std::string	getDetectorId () const

std::string	getDetectorName () const

bool	hasTimestamp () const

std::string	getTimestamp () const

bool	skipInvalidStateTest () const

bool	isSlowControlsConfiguration () const

bool	isDAQConfiguration () const

int	getUsageCount () const

std::string	toString (int overallIndent=0) const

void	skipInvalidStateTest (bool setting)

void	isSlowControlsConfiguration (bool setting)

void	isDAQConfiguration (bool setting)

void	setUsageCount (int value)

void	setSortIndex (int value)

bool	operator< (const GlobalNameSpec &other) const

Private Member Functions
void	_addSpaces (std::string &workString, int count) const

Private Attributes
std::string	_configName

std::string	_dcmOperatingMode

std::string	_detectorId

bool	_hasTimestamp

std::string	_timestamp

bool	_skipInvalidStateTest

bool	_isSlowControlsConfig

int	_usageCount

int	_sortIndex

Detailed Description

Simple container class to hold the identifiers that specify a particular named global configuration.

Author: Kurt Biery

Version

Revision: 1.7.24.1

Date: 2019/09/27 00:07:03

Definition at line 17 of file GlobalNameSpec.h.

Constructor & Destructor Documentation

dbutils::daqconfig::GlobalNameSpec::GlobalNameSpec	(	const std::string &	configName,
		const std::string &	dcmOperatingMode,
		const std::string &	detectorId
	)

Creates a global name specification object from the specified configuration name DCM operating mode, and detector ID.

Parameters

configName	The named global configuration of interest.
dcmOperatingMode	The operating mode of interest (e.g. DCS or DSO).
detectorId	The detector of interest (e.g. NDOS or FarDet).

Definition at line 16 of file GlobalNameSpec.cpp.

                                             :
     _configName(configName), _dcmOperatingMode(dcmOperatingMode),
     _detectorId(detectorId), _hasTimestamp(false),
     _skipInvalidStateTest(false), _isSlowControlsConfig(false),
     _usageCount(0), _sortIndex(-1)
 {
 }

dbutils::daqconfig::GlobalNameSpec::GlobalNameSpec	(	const std::string &	configName,
		const std::string &	dcmOperatingMode,
		const std::string &	detectorId,
		const std::string &	timestamp
	)

Creates a global name specification object from the specified configuration name, DCM operating mode, detector ID, and timestamp.

Parameters

configName	The named global configuration of interest.
dcmOperatingMode	The operating mode of interest (e.g. DCS or DSO).
detectorId	The detector of interest (e.g. NDOS or FarDet).
timestamp	The date/time string that should be used to determine the time-based validity context for the named configuration. Supported formats include "yyyy-mm-dd HH:MM:SS".

Definition at line 38 of file GlobalNameSpec.cpp.

                                            :
     _configName(configName), _dcmOperatingMode(dcmOperatingMode),
     _detectorId(detectorId), _hasTimestamp(true), _timestamp(timestamp),
     _skipInvalidStateTest(false), _isSlowControlsConfig(false),
     _usageCount(0), _sortIndex(-1)
 {
 }

Member Function Documentation

void dbutils::daqconfig::GlobalNameSpec::_addSpaces	(	std::string &	workString,
		int	count
	)		const

private

Adds a specified number of spaces to a string.

Definition at line 126 of file GlobalNameSpec.cpp.

References confusionMatrixTree::count, and compare_h5_caf::idx.

Referenced by setSortIndex(), and toString().

 {
     for (int idx = 0; idx < count; ++idx) {
         workString.append(" ");
     }
 }

std::string dbutils::daqconfig::GlobalNameSpec::getConfigName ( ) const

inline

Definition at line 38 of file GlobalNameSpec.h.

References _configName.

Referenced by dbutils::daqconfig::NamedConfigUtils::getGlobalConfigDetailAncestry(), dbutils::daqconfig::NamedConfigUtils::getGlobalConfigId(), dbutils::daqconfig::NamedConfigUtils::getGlobalConfigIdAncestry(), dbutils::gui::TabbedSetOfTableEditors::saveChanges(), dbutils::gui::TabbedSetOfTreeEditors::saveChanges(), and dbutils::gui::SettingsDisplay::updateNamedConfiguration().

38 {return _configName;}

dbutils::daqconfig::GlobalNameSpec::_configName

std::string _configName

Definition: GlobalNameSpec.h:80

std::string dbutils::daqconfig::GlobalNameSpec::getDCMOpMode ( ) const

inline

Definition at line 39 of file GlobalNameSpec.h.

References _dcmOperatingMode.

Referenced by dbutils::daqconfig::NamedConfigUtils::getGlobalConfigDetailAncestry(), dbutils::daqconfig::NamedConfigUtils::getGlobalConfigId(), dbutils::daqconfig::NamedConfigUtils::getGlobalConfigIdAncestry(), dbutils::gui::TabbedSetOfTableEditors::saveChanges(), dbutils::gui::TabbedSetOfTreeEditors::saveChanges(), and dbutils::gui::SettingsDisplay::updateNamedConfiguration().

39 {return _dcmOperatingMode;}

dbutils::daqconfig::GlobalNameSpec::_dcmOperatingMode

std::string _dcmOperatingMode

Definition: GlobalNameSpec.h:81

std::string dbutils::daqconfig::GlobalNameSpec::getDetectorId ( ) const

inline

Definition at line 40 of file GlobalNameSpec.h.

References _detectorId.

Referenced by dbutils::daqconfig::NamedConfigUtils::getGlobalConfigDetailAncestry(), dbutils::daqconfig::NamedConfigUtils::getGlobalConfigId(), and dbutils::daqconfig::NamedConfigUtils::getGlobalConfigIdAncestry().

40 {return _detectorId;}

dbutils::daqconfig::GlobalNameSpec::_detectorId

std::string _detectorId

Definition: GlobalNameSpec.h:82

std::string dbutils::daqconfig::GlobalNameSpec::getDetectorName ( ) const

inline

Definition at line 41 of file GlobalNameSpec.h.

References _detectorId.

Referenced by dbutils::gui::SettingsDisplay::updateNamedConfiguration().

41 {return _detectorId;}

dbutils::daqconfig::GlobalNameSpec::_detectorId

std::string _detectorId

Definition: GlobalNameSpec.h:82

std::string dbutils::daqconfig::GlobalNameSpec::getTimestamp ( ) const

inline

Definition at line 44 of file GlobalNameSpec.h.

References _timestamp.

Referenced by dbutils::daqconfig::NamedConfigUtils::getGlobalConfigDetailAncestry(), dbutils::daqconfig::NamedConfigUtils::getGlobalConfigId(), dbutils::daqconfig::NamedConfigUtils::getGlobalConfigIdAncestry(), and dbutils::gui::SettingsDisplay::updateNamedConfiguration().

44 {return _timestamp;}

dbutils::daqconfig::GlobalNameSpec::_timestamp

std::string _timestamp

Definition: GlobalNameSpec.h:85

int dbutils::daqconfig::GlobalNameSpec::getUsageCount ( ) const

inline

Definition at line 50 of file GlobalNameSpec.h.

References _usageCount, string, and toString().

50 {return _usageCount;}

dbutils::daqconfig::GlobalNameSpec::_usageCount

int _usageCount

Definition: GlobalNameSpec.h:90

bool dbutils::daqconfig::GlobalNameSpec::hasTimestamp ( ) const

inline

Definition at line 43 of file GlobalNameSpec.h.

References _hasTimestamp.

Referenced by dbutils::daqconfig::NamedConfigUtils::getGlobalConfigDetailAncestry(), dbutils::daqconfig::NamedConfigUtils::getGlobalConfigId(), dbutils::daqconfig::NamedConfigUtils::getGlobalConfigIdAncestry(), and dbutils::gui::SettingsDisplay::updateNamedConfiguration().

43 {return _hasTimestamp;}

dbutils::daqconfig::GlobalNameSpec::_hasTimestamp

bool _hasTimestamp

Definition: GlobalNameSpec.h:84

bool dbutils::daqconfig::GlobalNameSpec::isDAQConfiguration ( ) const

inline

Definition at line 48 of file GlobalNameSpec.h.

References _isSlowControlsConfig.

48 {return (! _isSlowControlsConfig);}

dbutils::daqconfig::GlobalNameSpec::_isSlowControlsConfig

bool _isSlowControlsConfig

Definition: GlobalNameSpec.h:88

void dbutils::daqconfig::GlobalNameSpec::isDAQConfiguration ( bool setting )

inline

Definition at line 64 of file GlobalNameSpec.h.

References _isSlowControlsConfig.

                                           {
         _isSlowControlsConfig = (! setting);
     }

bool dbutils::daqconfig::GlobalNameSpec::isSlowControlsConfiguration ( ) const

inline

Definition at line 47 of file GlobalNameSpec.h.

References _isSlowControlsConfig.

Referenced by dbutils::dcs::APDSettings::APDSettings(), dbutils::daqconfig::NamedConfigUtils::getGlobalConfigDetailAncestry(), dbutils::daqconfig::NamedConfigUtils::getGlobalConfigId(), dbutils::daqconfig::NamedConfigUtils::getGlobalConfigIdAncestry(), and dbutils::daqconfig::NamedConfigUtils::getSubsystemConfigIdFromGlobalName().

47 {return _isSlowControlsConfig;}

dbutils::daqconfig::GlobalNameSpec::_isSlowControlsConfig

bool _isSlowControlsConfig

Definition: GlobalNameSpec.h:88

void dbutils::daqconfig::GlobalNameSpec::isSlowControlsConfiguration ( bool setting )

inline

Definition at line 61 of file GlobalNameSpec.h.

References _isSlowControlsConfig.

                                                    {
         _isSlowControlsConfig = setting;
     }

bool dbutils::daqconfig::GlobalNameSpec::operator< ( const GlobalNameSpec & other ) const

Tests if this instance is less than the specified one.

Definition at line 94 of file GlobalNameSpec.cpp.

References _configName, _dcmOperatingMode, _detectorId, _sortIndex, _timestamp, and _usageCount.

Referenced by setSortIndex(), and toString().

 {
     if (this->_sortIndex > -1 && other._sortIndex > -1) {
         return (this->_sortIndex < other._sortIndex);
     }
 
     if (this->_usageCount > other._usageCount) {return false;}
     if (this->_usageCount < other._usageCount) {return true;}
     // else _usageCount is equal
 
     if (this->_detectorId > other._detectorId) {return false;}
     if (this->_detectorId < other._detectorId) {return true;}
     // else _detectorId is equal
 
     if (this->_configName > other._configName) {return false;}
     if (this->_configName < other._configName) {return true;}
     // else _configName is equal
 
     if (this->_dcmOperatingMode > other._dcmOperatingMode) {return false;}
     if (this->_dcmOperatingMode < other._dcmOperatingMode) {return true;}
     // else _dcmOperatingMode is equal
 
     if (this->_timestamp > other._timestamp) {return false;}
     if (this->_timestamp < other._timestamp) {return true;}
     // else _timestamp is equal
 
     return false;
 }

void dbutils::daqconfig::GlobalNameSpec::setSortIndex ( int value )

inline

Definition at line 68 of file GlobalNameSpec.h.

References _addSpaces(), _sortIndex, confusionMatrixTree::count, operator<(), fhicl::other, and string.

Referenced by dbutils::daqconfig::NamedConfigUtils::getAvailableGlobalConfigs().

68 {_sortIndex = value;}

dbutils::daqconfig::GlobalNameSpec::_sortIndex

int _sortIndex

Definition: GlobalNameSpec.h:91

value

const XML_Char int const XML_Char * value

Definition: expat.h:331

void dbutils::daqconfig::GlobalNameSpec::setUsageCount ( int value )

inline

Definition at line 67 of file GlobalNameSpec.h.

References _usageCount.

Referenced by dbutils::daqconfig::NamedConfigUtils::getAvailableGlobalConfigs().

67 {_usageCount = value;}

value

const XML_Char int const XML_Char * value

Definition: expat.h:331

dbutils::daqconfig::GlobalNameSpec::_usageCount

int _usageCount

Definition: GlobalNameSpec.h:90

bool dbutils::daqconfig::GlobalNameSpec::skipInvalidStateTest ( ) const

inline

Definition at line 46 of file GlobalNameSpec.h.

References _skipInvalidStateTest.

Referenced by dbutils::daqconfig::NamedConfigUtils::getGlobalConfigDetailAncestry(), dbutils::daqconfig::NamedConfigUtils::getGlobalConfigId(), and dbutils::daqconfig::NamedConfigUtils::getGlobalConfigIdAncestry().

46 {return _skipInvalidStateTest;}

dbutils::daqconfig::GlobalNameSpec::_skipInvalidStateTest

bool _skipInvalidStateTest

Definition: GlobalNameSpec.h:87

void dbutils::daqconfig::GlobalNameSpec::skipInvalidStateTest ( bool setting )

inline

Definition at line 58 of file GlobalNameSpec.h.

References _skipInvalidStateTest.

                                             {
         _skipInvalidStateTest = setting;
     }

std::string dbutils::daqconfig::GlobalNameSpec::toString ( int overallIndent = 0 ) const

Creates a string representation of the name specification.

Definition at line 52 of file GlobalNameSpec.cpp.

References _addSpaces(), _configName, _dcmOperatingMode, _detectorId, _hasTimestamp, _isSlowControlsConfig, _skipInvalidStateTest, _timestamp, _usageCount, operator<(), and string.

Referenced by getUsageCount().

 {
     std::string workString;
     if (overallIndent > 0) {_addSpaces(workString, overallIndent);}
     workString.append("Named Global Configuration:\n");
     if (overallIndent > 0) {_addSpaces(workString, overallIndent);}
     workString.append("  configuration name: " + _configName + "\n");
     if (overallIndent > 0) {_addSpaces(workString, overallIndent);}
     workString.append("  DCM operating mode: " + _dcmOperatingMode + "\n");
     if (overallIndent > 0) {_addSpaces(workString, overallIndent);}
     workString.append("  detector name: " + _detectorId + "\n");
 
     if (overallIndent > 0) {_addSpaces(workString, overallIndent);}
     if (_hasTimestamp) {
         workString.append("  timestamp: " + _timestamp);
     }
     else {
         workString.append("  no timestamp");
     }
     workString.append("\n");
 
     if (overallIndent > 0) {_addSpaces(workString, overallIndent);}
     workString.append("  usage count: " +
                       boost::lexical_cast<std::string>(_usageCount) + "\n");
 
     if (overallIndent > 0) {_addSpaces(workString, overallIndent);}
     workString.append("  DAQ or Slow Controls: ");
     workString.append((_isSlowControlsConfig ? "Slow Controls" : "DAQ"));
 
     if (_skipInvalidStateTest) {
         workString.append("\n");
         if (overallIndent > 0) {_addSpaces(workString, overallIndent);}
         workString.append("  Skipping the Invalid State tests");
     }
 
     return workString;
 }

Member Data Documentation

std::string dbutils::daqconfig::GlobalNameSpec::_configName

private

Definition at line 80 of file GlobalNameSpec.h.

Referenced by getConfigName(), operator<(), and toString().

std::string dbutils::daqconfig::GlobalNameSpec::_dcmOperatingMode

private

Definition at line 81 of file GlobalNameSpec.h.

Referenced by getDCMOpMode(), operator<(), and toString().

std::string dbutils::daqconfig::GlobalNameSpec::_detectorId

private

Definition at line 82 of file GlobalNameSpec.h.

Referenced by getDetectorId(), getDetectorName(), operator<(), and toString().

bool dbutils::daqconfig::GlobalNameSpec::_hasTimestamp

private

Definition at line 84 of file GlobalNameSpec.h.

Referenced by hasTimestamp(), and toString().

bool dbutils::daqconfig::GlobalNameSpec::_isSlowControlsConfig

private

Definition at line 88 of file GlobalNameSpec.h.

Referenced by isDAQConfiguration(), isSlowControlsConfiguration(), and toString().

bool dbutils::daqconfig::GlobalNameSpec::_skipInvalidStateTest

private

Definition at line 87 of file GlobalNameSpec.h.

Referenced by skipInvalidStateTest(), and toString().

int dbutils::daqconfig::GlobalNameSpec::_sortIndex

private

Definition at line 91 of file GlobalNameSpec.h.

Referenced by operator<(), and setSortIndex().

std::string dbutils::daqconfig::GlobalNameSpec::_timestamp

private

Definition at line 85 of file GlobalNameSpec.h.

Referenced by getTimestamp(), operator<(), and toString().

int dbutils::daqconfig::GlobalNameSpec::_usageCount

private

Definition at line 90 of file GlobalNameSpec.h.

Referenced by getUsageCount(), operator<(), setUsageCount(), and toString().

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

/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-02-25/DatabaseUtils/cxx/include/DAQConfig/GlobalNameSpec.h
/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-02-25/DatabaseUtils/cxx/src/DAQConfig/GlobalNameSpec.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation