OpenRTM_aist.StringUtil Namespace Reference

Classes
class	escape_functor
class	unescape_functor
class	unique_strvec

Functions
def	_stringToList (_type, _str)
def	eraseBlank (str)
	Erase blank characters of string. More...
def	eraseHeadBlank (_str)
	Erase the head blank characters of string. More...
def	eraseTailBlank (_str)
	Erase the tail blank characters of string. More...
def	escape (_str)
	Escape string. More...
def	flatten (sv)
def	for_each (_str, instance)
def	includes (_list, value, ignore_case=True)
	Include if a string is included in string list. More...
def	isAbsolutePath (str)
	Investigate whether the given string is absolute path or not. More...
def	isEscaped (_str, pos)
	Whether the character is escaped or not. More...
def	isURL (str)
	Investigate whether the given string is URL or not. More...
def	normalize (_str)
def	otos (n)
	Convert the given object to st::string. More...
def	replaceString (str, _from, _to)
	Replace string. More...
def	split (input, delimiter)
	Split string by delimiter. More...
def	stringTo (_type, _str)
	Convert the given object to st::string. More...
def	toArgv (args)
def	toBool (_str, yes, no, default_value=None)
	Convert given string to bool value. More...
def	unescape (_str)
	Unescape string. More...
def	unique_sv (sv)

Function Documentation

_stringToList()

def OpenRTM_aist.StringUtil._stringToList (   _type,   _str  )

private

Definition at line 507 of file StringUtil.py.

eraseBlank()

def OpenRTM_aist.StringUtil.eraseBlank

(

str

)

Erase blank characters of string.

Erase blank characters that exist at the head of the given string. Space ' 'and tab '\t' are supported as the blank character.

Parameters

str	The target blank characters of string for the erase

Definition at line 223 of file StringUtil.py.

eraseHeadBlank()

def OpenRTM_aist.StringUtil.eraseHeadBlank

(

_str

)

Erase the head blank characters of string.

Definition at line 255 of file StringUtil.py.

eraseTailBlank()

def OpenRTM_aist.StringUtil.eraseTailBlank

(

_str

)

Erase the tail blank characters of string.

Definition at line 271 of file StringUtil.py.

escape()

def OpenRTM_aist.StringUtil.escape

(

_str

)

Escape string.

The following characters are converted.
HT -> "\t"
LF -> "\n"
CR -> "\r"
FF -> "\f"
Single quote and dobule quote are not processed.

Definition at line 172 of file StringUtil.py.

flatten()

def OpenRTM_aist.StringUtil.flatten

(

sv

)

Definition at line 608 of file StringUtil.py.

for_each()

def OpenRTM_aist.StringUtil.for_each	(		_str,
			instance
	)

Definition at line 142 of file StringUtil.py.

includes()

def OpenRTM_aist.StringUtil.includes	(		_list,
			value,
			ignore_case = True
	)

Include if a string is included in string list.

if the second argument is included in the comma separated string list of the first argument, This operation returns "true value".

Parameters

list	The target comma separated string
value	The searched string

Returns

true: included, false: not included

bool includes(const vstring& list, std::string value, bool ignore_case = true);

Definition at line 400 of file StringUtil.py.

isAbsolutePath()

def OpenRTM_aist.StringUtil.isAbsolutePath

(

str

)

Investigate whether the given string is absolute path or not.

Definition at line 436 of file StringUtil.py.

isEscaped()

def OpenRTM_aist.StringUtil.isEscaped	(		_str,
			pos
	)

Whether the character is escaped or not.

This operation returns true if the specified character is escaped, and if the specified character is not escaped, it returns false

Parameters

str	The string thath includes the character to be investigated.
pos	The position of the character to be investigated.

Returns

true: the character is escaped, false: the character is not escaped.

Definition at line 44 of file StringUtil.py.

isURL()

def OpenRTM_aist.StringUtil.isURL

(

str

)

Investigate whether the given string is URL or not.

Definition at line 462 of file StringUtil.py.

normalize()

def OpenRTM_aist.StringUtil.normalize

(

_str

)

Definition at line 287 of file StringUtil.py.

otos()

def OpenRTM_aist.StringUtil.otos

(

n

)

Convert the given object to st::string.

Definition at line 487 of file StringUtil.py.

replaceString()

def OpenRTM_aist.StringUtil.replaceString	(		str,
			_from,
			_to
	)

Replace string.

Definition at line 305 of file StringUtil.py.

split()

def OpenRTM_aist.StringUtil.split	(		input,
			delimiter
	)

Split string by delimiter.

Definition at line 323 of file StringUtil.py.

stringTo()

def OpenRTM_aist.StringUtil.stringTo	(		_type,
			_str
	)

Convert the given object to st::string.

Definition at line 555 of file StringUtil.py.

toArgv()

def OpenRTM_aist.StringUtil.toArgv

(

args

)

Definition at line 632 of file StringUtil.py.

toBool()

def OpenRTM_aist.StringUtil.toBool	(		_str,
			yes,
			no,
			default_value = None
	)

Convert given string to bool value.

Definition at line 360 of file StringUtil.py.

unescape()

def OpenRTM_aist.StringUtil.unescape

(

_str

)

Unescape string.

The following characters are converted.
"\t" -> HT
"\n" -> LF
"\r" -> CR
"\f" -> FF
"\'" -> '
"\"" -> "

Definition at line 200 of file StringUtil.py.

unique_sv()

def OpenRTM_aist.StringUtil.unique_sv

(

sv

)

Definition at line 590 of file StringUtil.py.