ITK  6.0.0
Insight Toolkit
Static Public Member Functions | List of all members
itk::StringTools Class Reference
Group IO » Module ITKIOXML

#include <itkStringTools.h>

Detailed Description

A set of tools to manipulate a string.

This class defines a collection of methods that aid users to perform string-based I/O operations, e.g., data reading/writing, string parsing, comparison, etc.

Definition at line 39 of file itkStringTools.h.

Static Public Member Functions

static bool ContainSub (const std::string &s1, const std::string &s2, bool ignoreCase=true)
 
static bool EndWith (const std::string &s1, const std::string &s2, bool ignoreCase=true)
 
template<typename T >
static std::string & FromData (std::string &s, const Array< T > &data)
 
template<typename T >
static std::string & FromData (std::string &s, const std::vector< T > &data)
 
template<typename T >
static std::string & FromData (std::string &s, const T &data)
 
static bool MatchWith (const std::string &s1, const std::string &s2, bool ignoreCase=true)
 
static void Split (const std::string &s, std::map< std::string, std::string > &result, const std::string &delims=";|")
 
static void Split (const std::string &s, std::string &lpart, std::string &rpart, const std::string &delims="=:")
 
static void Split (const std::string &s, std::vector< std::string > &result, const std::string &delims=";|")
 
static bool StartWith (const std::string &s1, const std::string &s2, bool ignoreCase=true)
 
template<typename T >
static std::string & ToData (std::string &s, T &data)
 
static std::string & ToLowerCase (std::string &str)
 
static std::string & ToUpperCase (std::string &str)
 
static std::string & Trim (std::string &str, const std::string &dislike=" \t\n\r")
 
static std::string & TrimLeft (std::string &str, const std::string &dislike=" \t\n\r")
 
static std::string & TrimRight (std::string &str, const std::string &dislike=" \t\n\r")
 
template<typename T >
static std::string & ToData (std::string &s, std::vector< T > &data, int count=-1)
 
template<typename T >
static std::string & ToData (std::string &s, Array< T > &data, int count=-1)
 

Member Function Documentation

◆ ContainSub()

static bool itk::StringTools::ContainSub ( const std::string &  s1,
const std::string &  s2,
bool  ignoreCase = true 
)
static

Method to test whether a string contains a user-given sub-string.

◆ EndWith()

static bool itk::StringTools::EndWith ( const std::string &  s1,
const std::string &  s2,
bool  ignoreCase = true 
)
static

Method to test whether a string ends with a user-given sub-string.

◆ FromData() [1/3]

template<typename T >
static std::string& itk::StringTools::FromData ( std::string &  s,
const Array< T > &  data 
)
static

Functions to convert an array of type itk::Array<T> to a string. An exception will be thrown if errors were encountered during the conversion.

◆ FromData() [2/3]

template<typename T >
static std::string& itk::StringTools::FromData ( std::string &  s,
const std::vector< T > &  data 
)
static

Functions to convert a vector of type std::vector<T> to a string. An exception will be thrown if errors were encountered during the conversion.

◆ FromData() [3/3]

template<typename T >
static std::string& itk::StringTools::FromData ( std::string &  s,
const T &  data 
)
static

Functions to convert a value of basic data type to a string. An exception will be thrown if errors were encountered during the conversion.

◆ MatchWith()

static bool itk::StringTools::MatchWith ( const std::string &  s1,
const std::string &  s2,
bool  ignoreCase = true 
)
static

Method to test whether one string matches with another.

◆ Split() [1/3]

static void itk::StringTools::Split ( const std::string &  s,
std::map< std::string, std::string > &  result,
const std::string &  delims = ";|" 
)
static

Method to split a string into a sequence of sub-strings with user-defined delimiters, then each sub-string is further split into a <key,value> pair with separators "=:".

◆ Split() [2/3]

static void itk::StringTools::Split ( const std::string &  s,
std::string &  lpart,
std::string &  rpart,
const std::string &  delims = "=:" 
)
static

Method to split a string into two parts with user-defined delimiters.

◆ Split() [3/3]

static void itk::StringTools::Split ( const std::string &  s,
std::vector< std::string > &  result,
const std::string &  delims = ";|" 
)
static

Method to split a string into a sequence of strings with user-defined delimiters.

◆ StartWith()

static bool itk::StringTools::StartWith ( const std::string &  s1,
const std::string &  s2,
bool  ignoreCase = true 
)
static

Method to test whether a string starts with a user-given sub-string.

◆ ToData() [1/3]

template<typename T >
static std::string& itk::StringTools::ToData ( std::string &  s,
Array< T > &  data,
int  count = -1 
)
static

Function to convert a string to an array of type itk::Array<T>. Number of elements to read is given by the parameter 'count': = 0, get the number of elements to read from data.size();

0, read number of 'count' elements, and resize the data if necessary;

< 0, default value (-1), automatically compute the number from the input stream.

An exception will be thrown if errors were encountered during the conversion.

◆ ToData() [2/3]

template<typename T >
static std::string& itk::StringTools::ToData ( std::string &  s,
std::vector< T > &  data,
int  count = -1 
)
static

Function to convert a string to a vector of type std::vector<T>. Number of elements to read is given by the parameter 'count': = 0, get the number of elements to read from data.size();

0, read number of 'count' elements, and resize the data if necessary;

< 0, default value (-1), automatically compute the number from the input stream.

An exception will be thrown if errors were encountered during the conversion.

◆ ToData() [3/3]

template<typename T >
static std::string& itk::StringTools::ToData ( std::string &  s,
T &  data 
)
static

Functions to convert a string to a value of basic data type. An exception will be thrown if errors were encountered during the conversion.

◆ ToLowerCase()

static std::string& itk::StringTools::ToLowerCase ( std::string &  str)
static

Method to covert upper-case characters to lower cases in a string.

◆ ToUpperCase()

static std::string& itk::StringTools::ToUpperCase ( std::string &  str)
static

Method to covert lower-case characters to upper cases in a string.

◆ Trim()

static std::string& itk::StringTools::Trim ( std::string &  str,
const std::string &  dislike = " \t\n\r" 
)
static

Method to trim the spaces or user-specified characters on both ends of a string.

◆ TrimLeft()

static std::string& itk::StringTools::TrimLeft ( std::string &  str,
const std::string &  dislike = " \t\n\r" 
)
static

Method to trim the spaces or user-specified characters on left end of a string.

◆ TrimRight()

static std::string& itk::StringTools::TrimRight ( std::string &  str,
const std::string &  dislike = " \t\n\r" 
)
static

Method to trim the spaces or user-specified characters on right end of a string.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16