pwiz::msdata::id Namespace Reference

Functions
PWIZ_API_DECL std::map < std::string, std::string >	parse (const std::string &id)
	parses an id string into a map<string,string>
PWIZ_API_DECL std::string	value (const std::string &id, const std::string &name)
	convenience function to extract a named value from an id string
template<typename value_type >
value_type	valueAs (const std::string &id, const std::string &name)
	templated convenience function to extract a named value from an id string
PWIZ_API_DECL CVID	getDefaultNativeIDFormat (const MSData &msd)
	returns the nativeID format from the defaultSourceFilePtr if set, or from sourceFilePtrs[0] if the list isn't empty, or CVID_Unknown
PWIZ_API_DECL std::string	translateScanNumberToNativeID (CVID nativeIDFormat, const std::string &scanNumber)
	translates a "scan number" to a string that is correct for the given nativeID format; semantic validity requires that scanNumber be parseable as an integer; some nativeID formats cannot be translated to and will always return an empty string currently supported formats: Thermo, Bruker/Agilent YEP, Bruker BAF, mzXML, MGF, and mzData
PWIZ_API_DECL std::string	translateNativeIDToScanNumber (CVID nativeIDFormat, const std::string &id)
	translates a nativeID in the given nativeID format to a simple integer "scan number"; some nativeID formats cannot be translated from and will always return an empty string currently supported formats: Thermo, Bruker/Agilent YEP, Bruker BAF, mzXML, MGF, and mzData
PWIZ_API_DECL std::string	abbreviate (const std::string &id, char delimiter= '.')
	abbreviates a nativeID ("name1=value1 name2=value2" translates to "value1.value2")

---

Function Documentation

PWIZ_API_DECL std::map<std::string,std::string> pwiz::msdata::id::parse

(

const std::string &

id

)

parses an id string into a map<string,string>

Referenced by demo(), test(), testBadXML(), testDone(), testIDParsing(), testNested(), and testNoAutoUnescape().

PWIZ_API_DECL std::string pwiz::msdata::id::value	(	const std::string &	id,
		const std::string &	name
	)

convenience function to extract a named value from an id string

Referenced by pwiz::data::CVParam::empty(), pwiz::util::env::get(), boost::lexical_cast(), pwiz::data::CVParam::operator==(), pwiz::data::ParamContainer::set(), test(), pwiz::minimxml::SAXParser::Handler::Attributes::test_invariant(), testDefaultTabHandler(), testIDParsing(), pwiz::data::CVParam::valueAs(), pwiz::data::UserParam::valueAs(), and valueAs().

template<typename value_type >

value_type pwiz::msdata::id::valueAs	(	const std::string &	id,
		const std::string &	name
	)

templated convenience function to extract a named value from an id string

Definition at line 915 of file MSData.hpp.

References boost::lexical_cast(), and value().

{
    std::string result = value(id, name);
    return !result.empty() ? boost::lexical_cast<value_type>(result) 
                          : boost::lexical_cast<value_type>(0);
}

PWIZ_API_DECL CVID pwiz::msdata::id::getDefaultNativeIDFormat

(

const MSData &

msd

)

returns the nativeID format from the defaultSourceFilePtr if set, or from sourceFilePtrs[0] if the list isn't empty, or CVID_Unknown

PWIZ_API_DECL std::string pwiz::msdata::id::translateScanNumberToNativeID	(	CVID	nativeIDFormat,
		const std::string &	scanNumber
	)

translates a "scan number" to a string that is correct for the given nativeID format; semantic validity requires that scanNumber be parseable as an integer; some nativeID formats cannot be translated to and will always return an empty string currently supported formats: Thermo, Bruker/Agilent YEP, Bruker BAF, mzXML, MGF, and mzData

Referenced by testIDParsing().

PWIZ_API_DECL std::string pwiz::msdata::id::translateNativeIDToScanNumber	(	CVID	nativeIDFormat,
		const std::string &	id
	)

translates a nativeID in the given nativeID format to a simple integer "scan number"; some nativeID formats cannot be translated from and will always return an empty string currently supported formats: Thermo, Bruker/Agilent YEP, Bruker BAF, mzXML, MGF, and mzData

Referenced by testIDParsing().

PWIZ_API_DECL std::string pwiz::msdata::id::abbreviate	(	const std::string &	id,
		char	delimiter = '.'
	)

abbreviates a nativeID ("name1=value1 name2=value2" translates to "value1.value2")

Referenced by testIDParsing().