IOVDbParser Class Reference

#include <IOVDbParser.h>

Collaboration diagram for IOVDbParser:

Public Member Functions
	IOVDbParser ()=delete
	IOVDbParser (const std::string &input, MsgStream &log)
bool	isValid () const
std::pair< std::string, bool >	at (const std::string &searchKey, const std::string &defaultValue="") const
	'at' accessor with an optional default; the bool is true if the key was found
bool	getKey (const std::string &key, const std::string &devvalue, std::string &value) const
	original 'getKey' method, now implemented using 'at'
std::string	folderName () const
	give the folder name contained in the parsed description
std::string	key () const
bool	hasKey () const
std::string	tag () const
std::string	eventStoreName () const
bool	timebaseIs_nsOfEpoch () const
std::string	cache () const
int	cachehint () const
bool	named () const
std::string	addressHeader () const
std::vector< std::string >	symLinks () const
bool	noTagOverride () const
CLID	classId (MsgStream &msg) const
bool	onlyReadMetadata () const
bool	extensible () const
unsigned	applyOverrides (const IOVDbParser &other, MsgStream &log)
bool	overridesIov (MsgStream &msg) const
	return true if this description overrides the timestamp or runlumi
bool	overridesIov (MsgStream &msg, const bool folderIs_nsOfEpoch) const
	as for overridesIov(), but with a check that the folder time unit is compatible with the override time unit
unsigned long long	iovOverrideValue (MsgStream &msg) const
bool	operator== (const IOVDbParser &other) const
std::string	toString () const

Private Types
typedef std::map< std::string, std::string, std::less<> >	KeyValMap

Private Member Functions
bool	overridesIovImpl (MsgStream &msg, const bool performFolderCheck, const bool folderIs_nsOfEpoch=true) const
	implementation of overridesIov, with or without check on folder compatibility

Private Attributes
bool	m_valid {}
KeyValMap	m_keys

Detailed Description

Definition at line 19 of file IOVDbParser.h.

Member Typedef Documentation

KeyValMap

typedef std::map<std::string, std::string, std::less<> > IOVDbParser::KeyValMap

private

Definition at line 59 of file IOVDbParser.h.

Constructor & Destructor Documentation

IOVDbParser() [1/2]

IOVDbParser::IOVDbParser ( )

delete

IOVDbParser() [2/2]

IOVDbParser::IOVDbParser	(	const std::string &	input,
		MsgStream &	log )

Definition at line 12 of file IOVDbParser.cxx.

                                                                :
  m_valid(true)
{
  // parse the input string as XML, decode into Key/Value pairs
  m_keys.clear();
  // slot for the data outside of XML
  m_keys[""]="";
  // work through the string to build list of tags
  std::string::size_type iofs=0;
  std::string::size_type len=input.size();
  while (iofs!=std::string::npos && iofs<len) {
    // look for the start of the next XML tag
    std::string::size_type iofs1=input.find('<',iofs);
    if (iofs1>iofs && iofs1!=std::string::npos) {
      // take any unmarked-up text into the 'outside' data slot
      m_keys[""]+=IOVDbNamespace::spaceStrip(input.substr(iofs,iofs1-iofs));
    }
    if (iofs1!=std::string::npos) {
      // have an opening XML tag - process it
      // first find the end of the tag, either '>' or ' ', whichever first
      std::string::size_type iofs2=input.find('>',iofs1);
      std::string::size_type iofs3=input.find("/>",iofs1);
      bool noClosingTag = (iofs2 == std::string::npos);
      if (noClosingTag){
        log << MSG::FATAL << 
            "Badly formed XML string, no closing tag in " << input << endmsg;
        m_valid=false;
        iofs=std::string::npos;
        return;
      }
      if (iofs2!=std::string::npos && iofs2<iofs3) {
        // found a closing >, so tag is standard <tag>value</tag> form
        std::string tag=IOVDbNamespace::spaceStrip(input.substr(iofs1+1,iofs2-iofs1-1));
        // now need to find the closing </tag>
        std::string::size_type iofs4=input.find("</"+tag,iofs2+1);
        if (iofs4!=std::string::npos) {
          // found closing tag, store tag and text
          m_keys[tag]=IOVDbNamespace::spaceStrip(input.substr(iofs2+1,iofs4-iofs2-1));
          // advance to the next part of the string, after '>' on closing tag
          iofs=input.find('>',iofs4);
          if (iofs == std::string::npos) {
            log << MSG::FATAL << 
              "Badly formed XML string, no closing tag in " << input << endmsg;
            m_valid=false;
            iofs=std::string::npos;
            return;
          } else {
            iofs+=1;
          }          
        } else {
          log << MSG::FATAL << 
            "Badly formed XML string, no closing tag in " << input << endmsg;
          m_valid=false;
          iofs=std::string::npos;
          return;
        }
      } else if (iofs3!=std::string::npos) {
        // found a />, so tag is of form <tag values info/>
        // find the end of the tag part to see if a value is present
        std::string::size_type iofs4=input.find(' ',iofs1+1);
        std::string value,tag;
        if (iofs4!=std::string::npos && iofs4<iofs3) {
          value=IOVDbNamespace::spaceStrip(input.substr(iofs4,iofs3-iofs4));
          tag=IOVDbNamespace::spaceStrip(input.substr(iofs1+1,iofs4-iofs1-1));
        } else {
          tag=input.substr(iofs1+1,iofs3-iofs1-1);
          value="";
        }
        m_keys[tag]=IOVDbNamespace::spaceStrip(value);
        // advance to next part of string after closing />
        iofs=iofs3+2;
      } else {
        // found a < but no closing >
        log << MSG::FATAL << "Badly formed XML string, no closing > in input " <<
          input << endmsg;
        iofs=std::string::npos;
        m_valid=false;
        return;
      }
    } else {
      // no more < in input, take the rest into 'outside' data slot
      m_keys[""]+=IOVDbNamespace::spaceStrip(input.substr(iofs));
      iofs=len;
    }
  }
 
  if (log.level()<=MSG::VERBOSE) {
    log << MSG::VERBOSE << "parseXML processed input string: " << input << endmsg;
    for (KeyValMap::const_iterator itr=m_keys.begin();itr!=m_keys.end();++itr) {
      log << MSG::VERBOSE << "Key: " << itr->first << " value:" << 
      itr->second << endmsg;
    }
  }
}

Member Function Documentation

addressHeader()

std::string IOVDbParser::addressHeader

(

)

const

Definition at line 206 of file IOVDbParser.cxx.

                                {
  return at("addrHeader").first;
}

applyOverrides()

unsigned IOVDbParser::applyOverrides	(	const IOVDbParser &	other,
		MsgStream &	log )

Definition at line 223 of file IOVDbParser.cxx.

                                                                     {
  unsigned keyCounter=0;
  for (const auto& otherKeyValue : other.m_keys) {
    const std::string& otherKey=otherKeyValue.first;
    const std::string& otherValue=otherKeyValue.second;
    if (otherKey.empty()) continue; //Ignore Foldername
    if (otherKey=="prefix") continue; //Ignore prefix
    KeyValMap::iterator it=m_keys.find(otherKey);
    if (it==m_keys.end()) {
      log << MSG::INFO << "Folder " << m_keys[""] << ", adding new key " << otherKey 
           << " with value " << otherValue << endmsg; 
      m_keys[otherKey]=otherValue;
    }
    else {
      log << MSG::INFO << "Folder " << m_keys[""] << ", Key: " << otherKey 
           <<  "Overriding existing value " << m_keys[otherKey] << " to new value " << otherValue << endmsg;
      it->second=otherValue;
    }
    ++keyCounter;
  } //End loop over keys in other
  return keyCounter;
}

at()

std::pair< std::string, bool > IOVDbParser::at	(	const std::string &	searchKey,
		const std::string &	defaultValue = "" ) const

'at' accessor with an optional default; the bool is true if the key was found

Definition at line 123 of file IOVDbParser.cxx.

                                                                               {
  KeyValMap::const_iterator it = m_keys.find(searchKey);
  if (it != m_keys.end()) {
    //may contain return or newline character
    return std::pair<std::string, bool>(IOVDbNamespace::spaceStrip(it->second), true);
  }
  return std::pair<std::string, bool> (defaultValue, false);
}

cache()

std::string IOVDbParser::cache

(

)

const

Definition at line 163 of file IOVDbParser.cxx.

                        {
  return at("cache").first;
}

cachehint()

int IOVDbParser::cachehint

(

)

const

Definition at line 168 of file IOVDbParser.cxx.

                            {
  auto valuePair=at("cachehint");
  return valuePair.second ? std::stoi(valuePair.first) : 0;
}

classId()

CLID IOVDbParser::classId

(

MsgStream &

msg

)

const

Definition at line 190 of file IOVDbParser.cxx.

                                        {
  CLID result{};
  auto [addrHeader,foundHeader]=at("addrHeader");
  if (foundHeader) {
    IOVDbNamespace::replaceServiceType71(addrHeader);
    msg << MSG::DEBUG <<"Decode addrHeader "<< addrHeader << endmsg;
    IOVDbParser addrH(addrHeader,msg);
    if (auto addrPair=addrH.at("address_header");addrPair.second) {
      result = IOVDbNamespace::parseClid(addrPair.first);
      msg << MSG::DEBUG << "Got CLID " << result << " from " << addrPair.first << endmsg;
    }
  }
  return result;
}

eventStoreName()

std::string IOVDbParser::eventStoreName

(

)

const

Definition at line 153 of file IOVDbParser.cxx.

                                 {
  return at("eventStoreName","StoreGateSvc").first;
}

extensible()

bool IOVDbParser::extensible

(

)

const

Definition at line 184 of file IOVDbParser.cxx.

                             {
  return at("extensible").second;
}

folderName()

std::string IOVDbParser::folderName

(

)

const

give the folder name contained in the parsed description

Definition at line 133 of file IOVDbParser.cxx.

                              {
  return at("").first;
}

getKey()

bool IOVDbParser::getKey	(	const std::string &	key,
		const std::string &	devvalue,
		std::string &	value ) const

original 'getKey' method, now implemented using 'at'

Definition at line 108 of file IOVDbParser.cxx.

                                                 {
  // check if key is present in keyval, if so set value to it
  // if not set value to supplied default
  // return true or false depending on whether a matching key was found
  if (!m_valid) {
    value=defvalue;
    return false;
  }
  auto [theValue,found] = at(key,defvalue);
  value=std::move(theValue);
  return found;
}

hasKey()

bool IOVDbParser::hasKey

(

)

const

Definition at line 143 of file IOVDbParser.cxx.

                         {
  return at("key").second;
}

iovOverrideValue()

unsigned long long IOVDbParser::iovOverrideValue

(

MsgStream &

msg

)

const

Definition at line 291 of file IOVDbParser.cxx.

                                                 {
  unsigned long long value{};
  if (not overridesIov(msg)) return value;
  auto pTsPair = m_keys.find("forceTimestamp");
  if (pTsPair!=m_keys.end()){
    value = IOVDbNamespace::iovFromTimeString(pTsPair->second);
  }
  else {
    auto pRunPair = m_keys.find("forceRunNumber");
    auto pLumiPair = m_keys.find("forceLumiblockNumber");
    const auto & runString = (pRunPair!=m_keys.end()) ? pRunPair->second : "";
    const auto & lumiString = (pLumiPair!=m_keys.end()) ? pLumiPair->second : "";
    //could check that values were actually given here
    value = IOVDbNamespace::iovFromRunString(runString) + IOVDbNamespace::iovFromLumiBlockString(lumiString);
  }
  return value;
}

isValid()

bool IOVDbParser::isValid ( ) const

inline

Definition at line 66 of file IOVDbParser.h.

{ return m_valid; }

key()

std::string IOVDbParser::key

(

)

const

Definition at line 138 of file IOVDbParser.cxx.

                       {
  return at("key",folderName()).first;
}

named()

bool IOVDbParser::named

(

)

const

Definition at line 174 of file IOVDbParser.cxx.

                        {
  return at("named").second;
}

noTagOverride()

bool IOVDbParser::noTagOverride

(

)

const

Definition at line 217 of file IOVDbParser.cxx.

                                {
  return at("noover").second;
}

onlyReadMetadata()

bool IOVDbParser::onlyReadMetadata

(

)

const

Definition at line 179 of file IOVDbParser.cxx.

                                   {
  return at("metaOnly").second;
}

operator==()

bool IOVDbParser::operator==

(

const IOVDbParser &

other

)

const

Definition at line 247 of file IOVDbParser.cxx.

                                                    {
  return ((this->m_keys) == other.m_keys);
}

overridesIov() [1/2]

bool IOVDbParser::overridesIov

(

MsgStream &

msg

)

const

return true if this description overrides the timestamp or runlumi

Definition at line 252 of file IOVDbParser.cxx.

                                             {
  //no check on folder time unit compatibility
  return overridesIovImpl(msg, false);
}

overridesIov() [2/2]

bool IOVDbParser::overridesIov	(	MsgStream &	msg,
		const bool	folderIs_nsOfEpoch ) const

as for overridesIov(), but with a check that the folder time unit is compatible with the override time unit

Definition at line 258 of file IOVDbParser.cxx.

                                                                             {
  //check folder time unit compatibility
  return overridesIovImpl(msg ,true, folderIs_nsOfEpoch);
}

overridesIovImpl()

bool IOVDbParser::overridesIovImpl ( MsgStream & msg, const bool performFolderCheck, const bool folderIs_nsOfEpoch = true ) const

private

implementation of overridesIov, with or without check on folder compatibility

Definition at line 264 of file IOVDbParser.cxx.

                                                                                                              {
  bool overrideIs_nsEpochIov{true};
  const bool overridingTimestamp=(m_keys.find("forceTimestamp")!=m_keys.end());
  const bool overridingRun=(m_keys.find("forceRunNumber")!=m_keys.end());
  const bool overridingLumi=(m_keys.find("forceLumiblockNumber")!=m_keys.end());
  //check for nonsense scenarios:
  //1. overriding Lumi but not the Run number
  if (overridingLumi and not overridingRun){
    msg << MSG::WARNING<<"Trying to override lumi block without specifying the run"<<endmsg;
    return false;
  }
  //2. Trying to override both
  if (overridingRun and overridingTimestamp){
    msg << MSG::WARNING<<"Trying to override using both run-lumi and ns timestamp"<<endmsg;
    return false;
  }
  // now we are consistent, so set the 'is_ns' variable if it's different from default
  if (overridingRun) overrideIs_nsEpochIov=false;
  //3. Overriding a folder in ns format with a run-lumi IOV, or folder in run-lumi with ns timestamp
  if (performFolderCheck and (overrideIs_nsEpochIov != folderIs_nsOfEpoch)){
    msg << MSG::WARNING<<"Trying to override run-lumi for a ns folder, or ns for a run-lumi folder"<<endmsg;
    return false;
  }
  return (overridingTimestamp or overridingRun);
}

symLinks()

std::vector< std::string > IOVDbParser::symLinks

(

)

const

Definition at line 211 of file IOVDbParser.cxx.

                           {
  const auto & symLinkString = at("symlinks").first;
  return IOVDbNamespace::parseLinkNames(symLinkString);
}

tag()

std::string IOVDbParser::tag

(

)

const

Definition at line 148 of file IOVDbParser.cxx.

                       {
  return at("tag").first;
}

timebaseIs_nsOfEpoch()

bool IOVDbParser::timebaseIs_nsOfEpoch

(

)

const

Definition at line 158 of file IOVDbParser.cxx.

                                       {
  return (at("timeStamp").first=="time");
}

toString()

std::string IOVDbParser::toString

(

)

const

Definition at line 310 of file IOVDbParser.cxx.

                            {
  std::stringstream retval;
  retval <<"Folder:";
  retval << folderName();
  retval << ", Attributes: ";
  auto it=m_keys.begin();
  auto it_e=m_keys.end();
  for (;it!=it_e;++it) {
    if (it->first.empty()) continue;
    retval << "[" << it->first << ":" << it->second << "] "; 
  }
  return retval.str();
 
}

Member Data Documentation

m_keys

KeyValMap IOVDbParser::m_keys

private

Definition at line 60 of file IOVDbParser.h.

m_valid

bool IOVDbParser::m_valid {}

private

Definition at line 58 of file IOVDbParser.h.

{};

---

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

• IOVDbParser.h
• IOVDbParser.cxx