/tmp/workspace/03_openrtm-python-build-tags/OpenRTM_aist/StringUtil.py ファイル

String operation utility. [詳解]

クラス
class	OpenRTM_aist.StringUtil.escape_functor
	文字列エスケープ処理用functor [詳解]
class	OpenRTM_aist.StringUtil.unescape_functor
	文字列アンエスケープ処理用functor [詳解]
class	OpenRTM_aist.StringUtil.unique_strvec
	重複文字削除処理用functor [詳解]

関数
def	OpenRTM_aist.StringUtil.isEscaped (_str, pos)
	文字列がエスケープされているか判断する [詳解]
def	OpenRTM_aist.StringUtil.for_each (_str, instance)
	インスタンス生成用functor
def	OpenRTM_aist.StringUtil.escape (_str)
	文字列をエスケープする [詳解]
def	OpenRTM_aist.StringUtil.unescape (_str)
	文字列のエスケープを戻す [詳解]
def	OpenRTM_aist.StringUtil.eraseBlank (str)
	文字列の空白文字を削除する [詳解]
def	OpenRTM_aist.StringUtil.eraseHeadBlank (_str)
	文字列の先頭の空白文字を削除する [詳解]
def	OpenRTM_aist.StringUtil.eraseTailBlank (_str)
	文字列の末尾の空白文字を削除する [詳解]
def	OpenRTM_aist.StringUtil.replaceString (str, _from, _to)
	文字列を置き換える [詳解]
def	OpenRTM_aist.StringUtil.split (input, delimiter)
	文字列を分割文字で分割する [詳解]
def	OpenRTM_aist.StringUtil.toBool (_str, yes, no, default_value=None)
	与えられた文字列をbool値に変換する [詳解]
def	OpenRTM_aist.StringUtil.includes (_list, value, ignore_case=True)
	文字列リスト中にある文字列が含まれるかどうか [詳解]
def	OpenRTM_aist.StringUtil.isAbsolutePath (str)
	与えられた文字列が絶対パスかどうかを判断する [詳解]
def	OpenRTM_aist.StringUtil.isURL (str)
	与えられた文字列がURLかどうかを判断する [詳解]
def	OpenRTM_aist.StringUtil.otos (n)
	与えられたオブジェクトを文字列に変換 [詳解]
def	OpenRTM_aist.StringUtil.stringTo (_type, _str)
	与えられた文字列をオブジェクトに変換 [詳解]
def	OpenRTM_aist.StringUtil.unique_sv (sv)
	与えられた文字列リストから重複を削除 [詳解]
def	OpenRTM_aist.StringUtil.flatten (sv, delimiter=")
	与えられた文字列リストからCSVを生成 [詳解]
def	OpenRTM_aist.StringUtil.toArgv (args)
	与えられた文字列リストを引数リストに変換 [詳解]

詳解

String operation utility.

日付

Date

著者

Noriaki Ando n-and.nosp@m.o@ai.nosp@m.st.go.nosp@m..jp and Shinji Kurihara

Copyright (C) 2003-2008 Task-intelligence Research Group, Intelligent Systems Research Institute, National Institute of Advanced Industrial Science and Technology (AIST), Japan All rights reserved.

関数詳解

def OpenRTM_aist.StringUtil.eraseBlank

(

str

)

文字列の空白文字を削除する

与えられた文字列の空白文字を削除する。 空白文字として扱うのは' '(スペース)と'\t'(タブ)。

引数

str(list)

空白文字削除処理文字列のリスト

def OpenRTM_aist.StringUtil.eraseHeadBlank

(

_str

)

文字列の先頭の空白文字を削除する

与えられた文字列の先頭に存在する空白文字を削除する。 空白文字として扱うのは' '(スペース)と'\t'(タブ)。

引数

_str	先頭空白文字削除処理文字列

def OpenRTM_aist.StringUtil.eraseTailBlank

(

_str

)

文字列の末尾の空白文字を削除する

与えられた文字列の末尾に存在する空白文字を削除する。 空白文字として扱うのは' '(スペース)と'\t'(タブ)。

引数

_str	末尾空白文字削除処理文字列

def OpenRTM_aist.StringUtil.escape

(

_str

)

文字列をエスケープする

次の文字をエスケープシーケンスに変換する。
HT -> "\t"
LF -> "\n"
CR -> "\r"
FF -> "\f"
シングルクオート、ダブルクオートについてはとくに処理はしない。

def OpenRTM_aist.StringUtil.flatten	(		sv,
			delimiter = "
	)

与えられた文字列リストからCSVを生成

引数で与えられた文字列リストの各要素を並べたCSVを生成する。 文字列リストが空の場合には空白文字を返す。

引数

sv	CSV変換対象文字列リスト
delimiter	接続される文字列の間の文字 (デフォルト: ", ")

戻り値

CSV変換結果文字列

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

文字列リスト中にある文字列が含まれるかどうか

第1引数にカンマ区切りのリストを、第2引数に探索対象文字列を指定し、 その文字列が第1引数の中に含まれるかを判断する。

引数

list	対象リスト
value	探索文字列

戻り値

true: 含まれる、false: 含まれない

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

def OpenRTM_aist.StringUtil.isAbsolutePath

(

str

)

与えられた文字列が絶対パスかどうかを判断する

与えられた文字列が絶対パス表現であるかどうかを判断する。 文字列が以下の場合には絶対パスとして判断する。

• 先頭文字が'/' (UNIXの場合)
• 先頭３文字がアルファベット＋'/'＋'\' (Windowsの場合)
• 先頭２文字が'\\' (Windowsネットワークパスの場合)

引数

str

判定対象文字列

戻り値

絶対パス判定結果

def OpenRTM_aist.StringUtil.isEscaped	(		_str,
			pos
	)

文字列がエスケープされているか判断する

指定された文字がエスケープされているかどうかを判断する。

引数

_str	エスケープされているかどうか判断する文字を含む文字列
pos	エスケープされているかどうか判断する文字の位置

戻り値

指定した文字がエスケープされていれば true, それ以外は false

def OpenRTM_aist.StringUtil.isURL

(

str

)

与えられた文字列がURLかどうかを判断する

与えられた文字列がURL表現かどうかを判断する。 与えられた文字列中に、'://'という文字列が含まれている場合には URL表現として判断する。

引数

str

判定対象文字列

戻り値

URL判定結果

def OpenRTM_aist.StringUtil.otos

(

n

)

与えられたオブジェクトを文字列に変換

引数で指定されたオブジェクトを文字列に変換する。

引数

n	変換対象オブジェクト

戻り値

文字列変換結果

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

文字列を置き換える

与えられた文字列に対して、指定した文字の置き換えを行う。

引数

str	置き換え処理対象文字列
_from	置換元文字
_to	置換先文字

def OpenRTM_aist.StringUtil.split	(		input,
			delimiter
	)

文字列を分割文字で分割する

設定された文字列を与えられたデリミタで分割する。

引数

input	分割対象文字列
delimiter	分割文字列(デリミタ)

戻り値

文字列分割結果リスト

def OpenRTM_aist.StringUtil.stringTo	(		_type,
			_str
	)

与えられた文字列をオブジェクトに変換

引数で与えられた文字列を指定されたオブジェクトに変換する。

引数

_type	変換先オブジェクト
_str	変換元文字列

戻り値

変換処理実行結果

def OpenRTM_aist.StringUtil.toArgv

(

args

)

与えられた文字列リストを引数リストに変換

引数で与えられた文字列リストの各要素末尾に'\0'を加え、 引数リストに変換する。
※本モジュールでは引数をそのまま返す

引数

args	変換対象文字列リスト

戻り値

引数変換結果文字列

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

与えられた文字列をbool値に変換する

指定された文字列を、true表現文字列、false表現文字列と比較し、その結果を bool値として返す。 比較の結果、true表現文字列、false表現文字列のどちらとも一致しない場合は、 与えられたデフォルト値を返す。

引数

_str	判断対象文字列
yes	true表現文字列
no	false表現文字列
default_value	デフォルト値(デフォルト値:None)

def OpenRTM_aist.StringUtil.unescape

(

_str

)

文字列のエスケープを戻す

次のエスケープシーケンスを文字に変換する。
"\t" -> HT
"\n" -> LF
"\r" -> CR
"\f" -> FF
"\"" -> "
"\'" -> '

def OpenRTM_aist.StringUtil.unique_sv

(

sv

)

与えられた文字列リストから重複を削除

引数で与えられた文字列リストから重複を削除したリストを作成する。

引数

sv

確認元文字列リスト

戻り値

重複削除処理結果リスト