#include <StringTokenizer.h>

Public Types
using	ConstIterator = std::vector< std::string >::const_iterator

using	Iterator = std::vector< std::string >::iterator

enum	Options { TOK_IGNORE_EMPTY = 1 , TOK_TRIM = 2 , TOK_IGNORE_FINAL_EMPTY_TOKEN = 4 }
	Specify tokenizer options. These can be combined using + or \|. More...

using	TokenVec = std::vector< std::string >

Public Member Functions
const TokenVec &	asVector ()
	Returns a vector of tokenized strings. More...

std::string &	at (std::size_t index)
	Get a reference to the index'th token. More...

const std::string &	at (std::size_t index) const
	Get a const reference to the index'th token. More...

Iterator	begin ()
	Iterator referring to first element in the container. More...

ConstIterator	begin () const
	Const iterator referring to first element in the container. More...

ConstIterator	cbegin () const
	Const iterator referring to first element in the container. More...

ConstIterator	cend () const
	Const iterator referring to the past-the-end element in the container. More...

std::size_t	count () const
	Get the total number of tokens. More...

Iterator	end ()
	Iterator referring to the past-the-end element in the container. More...

ConstIterator	end () const
	Const iterator referring to the past-the-end element in the container. More...

std::string &	operator[] (std::size_t index)
	Get a const reference to the index'th token. More...

const std::string &	operator[] (std::size_t index) const
	Get a const reference to the index'th token. More...

std::size_t	size () const noexcept
	Get the total number of tokens. More...

	StringTokenizer ()=default
	Constructs an object from an empty string. More...

	StringTokenizer (const std::string &str, const std::string &separators, unsigned options=0)
	Constructor requiring a string to tokenize and a string of separators. More...

	~StringTokenizer ()=default
	Destroys the tokenizer. More...

Private Attributes
std::vector< std::string >	m_tokens

Detailed Description

Definition at line 27 of file StringTokenizer.h.

Member Typedef Documentation

◆ ConstIterator

using Mantid::Kernel::StringTokenizer::ConstIterator = std::vector<std::string>::const_iterator

Definition at line 37 of file StringTokenizer.h.

◆ Iterator

using Mantid::Kernel::StringTokenizer::Iterator = std::vector<std::string>::iterator

Definition at line 36 of file StringTokenizer.h.

◆ TokenVec

using Mantid::Kernel::StringTokenizer::TokenVec = std::vector<std::string>

Definition at line 35 of file StringTokenizer.h.

Member Enumeration Documentation

◆ Options

enum Mantid::Kernel::StringTokenizer::Options

Specify tokenizer options. These can be combined using + or |.

Enumerator
TOK_IGNORE_EMPTY	ignore empty tokens
TOK_TRIM	remove leading and trailing whitespace from tokens
TOK_IGNORE_FINAL_EMPTY_TOKEN	ignore an empty token at the end of the string.

Definition at line 30 of file StringTokenizer.h.

Constructor & Destructor Documentation

◆ StringTokenizer() [1/2]

Mantid::Kernel::StringTokenizer::StringTokenizer ( )

default

Constructs an object from an empty string.

◆ StringTokenizer() [2/2]

Mantid::Kernel::StringTokenizer::StringTokenizer	(	const std::string &	str,
		const std::string &	separators,
		unsigned	options = `0`
	)

Constructor requiring a string to tokenize and a string of separators.

Parameters

str	Input string to be separated into tokens.
separators	List of characters used to separate the input string.
options	tokenizer settings. The number can be found using the StringTokenizer::Options enum

Exceptions

Throws std::runtime_error if options > 7.

Returns: a const reference to the index'th token.

Definition at line 106 of file StringTokenizer.cpp.

References m_tokens, std::to_string(), TOK_IGNORE_EMPTY, TOK_IGNORE_FINAL_EMPTY_TOKEN, and TOK_TRIM.

◆ ~StringTokenizer()

Mantid::Kernel::StringTokenizer::~StringTokenizer ( )

default

Destroys the tokenizer.

Member Function Documentation

◆ asVector()

const TokenVec & Mantid::Kernel::StringTokenizer::asVector ( )

inline

Returns a vector of tokenized strings.

Definition at line 91 of file StringTokenizer.h.

Referenced by Mantid::API::IFunction::categories(), Mantid::API::Algorithm::categories(), Mantid::DataHandling::getGroupNames(), Mantid::Geometry::operator>>(), Mantid::Kernel::UserStringParser::separateComma(), Mantid::Algorithms::SampleLogsBehaviour::setSampleMap(), Mantid::Kernel::Strings::StrParts(), Mantid::Kernel::UserStringParser::Tokenize(), and Mantid::API::Algorithm::workspaceMethodOn().

◆ at() [1/2]

std::string & Mantid::Kernel::StringTokenizer::at ( std::size_t index )

inline

Get a reference to the index'th token.

Parameters

index Index of the requested token.

Returns: a reference to the index'th token.

Exceptions

Throws std::out_of_range if the index is out of range.

Definition at line 105 of file StringTokenizer.h.

References index.

◆ at() [2/2]

const std::string & Mantid::Kernel::StringTokenizer::at ( std::size_t index ) const

inline

Get a const reference to the index'th token.

Parameters

index Index of the requested token.

Returns: a const reference to the index'th token.

Exceptions

Throws std::out_of_range if the index is out of range.

Definition at line 98 of file StringTokenizer.h.

References index.

◆ begin() [1/2]

Iterator Mantid::Kernel::StringTokenizer::begin ( )

inline

Iterator referring to first element in the container.

Returns: an iterator referring to the first element in the container.

Definition at line 49 of file StringTokenizer.h.

Referenced by Mantid::WorkflowAlgorithms::DgsDiagnose::exec(), Mantid::API::AlgorithmFactoryImpl::fillHiddenCategories(), Mantid::API::FileFinderImpl::findRuns(), Mantid::API::FunctionFactoryImpl::getFunctionNamesGUI(), Mantid::DataHandling::GroupDetectors2::RangeHelper::getList(), Mantid::API::Expression::parse(), Mantid::DataHandling::UpdateInstrumentFromFile::parseAsciiHeader(), Mantid::CurveFitting::Functions::CrystalFieldControl::parseStringListAttribute(), Mantid::DataHandling::GroupDetectors2::readInt(), Mantid::API::ExperimentInfo::readParameterMap(), Mantid::DataHandling::PDLoadCharacterizations::readVersion1(), Mantid::Algorithms::ReadGroupsFromFile::readXMLGroupingFile(), Mantid::Algorithms::SampleLogsBehaviour::setSampleMap(), and Mantid::DataHandling::CheckMantidVersion::splitVersionString().

◆ begin() [2/2]

ConstIterator Mantid::Kernel::StringTokenizer::begin ( ) const

inline

Const iterator referring to first element in the container.

Returns: a const iterator referring to the first element in the container.

Definition at line 59 of file StringTokenizer.h.

◆ cbegin()

ConstIterator Mantid::Kernel::StringTokenizer::cbegin ( ) const

inline

Const iterator referring to first element in the container.

Returns: a const iterator referring to the first element in the container.

Definition at line 69 of file StringTokenizer.h.

Referenced by Mantid::API::BoxControllerSettingsAlgorithm::initBoxControllerProps(), Mantid::DataHandling::LoadSwans::loadMetaData(), Mantid::Geometry::IsotropicAtomBraggScattererParser::operator()(), Mantid::DataHandling::SampleEnvironmentSpecParser::parseTranslationVector(), Mantid::DataHandling::LoadSpec::readLine(), Mantid::DataHandling::LoadRKH::readUnit(), Mantid::Geometry::strToUnitCell(), and Mantid::Kernel::VMDBase< TYPE >::VMDBase().

◆ cend()

ConstIterator Mantid::Kernel::StringTokenizer::cend ( ) const

inline

Const iterator referring to the past-the-end element in the container.

Returns: a const iterator referring to the past-the-end element in the container.

Definition at line 74 of file StringTokenizer.h.

Referenced by Mantid::API::BoxControllerSettingsAlgorithm::initBoxControllerProps(), Mantid::DataHandling::LoadSwans::loadMetaData(), Mantid::Geometry::IsotropicAtomBraggScattererParser::operator()(), Mantid::DataHandling::SampleEnvironmentSpecParser::parseTranslationVector(), Mantid::DataHandling::LoadSpec::readLine(), Mantid::DataHandling::LoadRKH::readUnit(), Mantid::Geometry::strToUnitCell(), and Mantid::Kernel::VMDBase< TYPE >::VMDBase().

◆ count()

std::size_t Mantid::Kernel::StringTokenizer::count ( ) const

inline

Get the total number of tokens.

Returns: the total number of tokens.

Definition at line 110 of file StringTokenizer.h.

◆ end() [1/2]

Iterator Mantid::Kernel::StringTokenizer::end ( )

inline

Iterator referring to the past-the-end element in the container.

Returns: an iterator referring to the past-the-end element in the container.

Definition at line 54 of file StringTokenizer.h.

Referenced by Mantid::WorkflowAlgorithms::DgsDiagnose::exec(), Mantid::API::AlgorithmFactoryImpl::fillHiddenCategories(), Mantid::API::FileFinderImpl::findRuns(), Mantid::API::FunctionFactoryImpl::getFunctionNamesGUI(), Mantid::DataHandling::GroupDetectors2::RangeHelper::getList(), Mantid::DataHandling::UpdateInstrumentFromFile::parseAsciiHeader(), Mantid::CurveFitting::Functions::CrystalFieldControl::parseStringListAttribute(), Mantid::DataHandling::GroupDetectors2::readInt(), Mantid::API::ExperimentInfo::readParameterMap(), Mantid::DataHandling::PDLoadCharacterizations::readVersion1(), Mantid::Algorithms::ReadGroupsFromFile::readXMLGroupingFile(), Mantid::Algorithms::SampleLogsBehaviour::setSampleMap(), and Mantid::DataHandling::CheckMantidVersion::splitVersionString().

◆ end() [2/2]

ConstIterator Mantid::Kernel::StringTokenizer::end ( ) const

inline

Const iterator referring to the past-the-end element in the container.

Returns: a const iterator referring to the past-the-end element in the container.

Definition at line 64 of file StringTokenizer.h.

◆ operator[]() [1/2]

std::string & Mantid::Kernel::StringTokenizer::operator[] ( std::size_t index )

inline

Get a const reference to the index'th token.

Indexing an out-of-range element won't throw, but is otherwise undefined behavior.

Parameters

index Index of the requested token.

Returns: a const reference to the index'th token.

Definition at line 88 of file StringTokenizer.h.

References index.

◆ operator[]() [2/2]

const std::string & Mantid::Kernel::StringTokenizer::operator[] ( std::size_t index ) const

inline

Get a const reference to the index'th token.

Indexing an out-of-range element won't throw, but is otherwise undefined behavior.

Parameters

index Index of the requested token.

Returns: a const reference to the index'th token.

Definition at line 81 of file StringTokenizer.h.

References index.

◆ size()

std::size_t Mantid::Kernel::StringTokenizer::size ( ) const

inlinenoexcept

Get the total number of tokens.

Returns: the total number of tokens.

Definition at line 115 of file StringTokenizer.h.

Referenced by Mantid::API::FileFinderImpl::findRuns(), Mantid::DataHandling::LoadSwans::loadMetaData(), Mantid::Geometry::IsotropicAtomBraggScattererParser::operator()(), Mantid::DataHandling::LoadSpec::readLine(), and Mantid::Geometry::strToUnitCell().

Member Data Documentation

◆ m_tokens

std::vector<std::string> Mantid::Kernel::StringTokenizer::m_tokens

private

Definition at line 118 of file StringTokenizer.h.

Referenced by StringTokenizer().

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

Framework/Kernel/inc/MantidKernel/StringTokenizer.h
Framework/Kernel/src/StringTokenizer.cpp

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ConstIterator

◆ Iterator

◆ TokenVec

Member Enumeration Documentation

◆ Options

Constructor & Destructor Documentation

◆ StringTokenizer() [1/2]

◆ StringTokenizer() [2/2]

◆ ~StringTokenizer()

Member Function Documentation

◆ asVector()

◆ at() [1/2]

◆ at() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ cend()

◆ count()

◆ end() [1/2]

◆ end() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ size()

Member Data Documentation

◆ m_tokens