OpenRTM-aist-Python 2.0.2
クラス | 関数
StringUtil.py ファイル

String operation utility [詳解]

クラス

class  OpenRTM_aist.StringUtil.escape_functor
 
class  OpenRTM_aist.StringUtil.unescape_functor
 
class  OpenRTM_aist.StringUtil.unique_strvec
 

関数

 OpenRTM_aist.StringUtil.isEscaped (_str, pos)
 
 OpenRTM_aist.StringUtil.for_each (_str, instance)
 
 OpenRTM_aist.StringUtil.escape (_str)
 
 OpenRTM_aist.StringUtil.unescape (_str)
 
 OpenRTM_aist.StringUtil.eraseBlank (_str)
 
 OpenRTM_aist.StringUtil.eraseHeadBlank (_str)
 
 OpenRTM_aist.StringUtil.eraseTailBlank (_str)
 
 OpenRTM_aist.StringUtil.replaceString (_str, _from, _to)
 
 OpenRTM_aist.StringUtil.split (input, delimiter)
 
 OpenRTM_aist.StringUtil.toBool (_str, yes, no, default_value=None)
 
 OpenRTM_aist.StringUtil.includes (_list, value, ignore_case=True)
 
 OpenRTM_aist.StringUtil.isAbsolutePath (str)
 
 OpenRTM_aist.StringUtil.isURL (str)
 
 OpenRTM_aist.StringUtil.otos (n)
 
 OpenRTM_aist.StringUtil._stringToList (_type, _str)
 
 OpenRTM_aist.StringUtil.stringTo (_type, _str)
 
 OpenRTM_aist.StringUtil.unique_sv (sv)
 
 OpenRTM_aist.StringUtil.flatten (sv, delimiter=", ")
 
 OpenRTM_aist.StringUtil.toArgv (args)
 
 OpenRTM_aist.StringUtil.urlparam2map (_str)
 
 OpenRTM_aist.StringUtil.replaceEnv (_str)
 
 OpenRTM_aist.StringUtil.findFile (dir, filename, filelist)
 
 OpenRTM_aist.StringUtil.getFileList (dir, ext, filelist=None)
 
 OpenRTM_aist.StringUtil.parseArgs (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.

関数詳解

◆ _stringToList()

OpenRTM_aist.StringUtil._stringToList ( _type,
_str )
protected

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

引数で指定された文字列を｢,｣で分割し、リストに変換する。

引数
_str変換元文字列
戻り値
リスト変換処理結果

◆ eraseBlank()

OpenRTM_aist.StringUtil.eraseBlank ( _str)

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

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

引数
str(list)空白文字削除処理文字列のリスト

◆ eraseHeadBlank()

OpenRTM_aist.StringUtil.eraseHeadBlank ( _str)

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

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

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

◆ eraseTailBlank()

OpenRTM_aist.StringUtil.eraseTailBlank ( _str)

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

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

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

◆ escape()

OpenRTM_aist.StringUtil.escape ( _str)

文字列をエスケープする

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

◆ findFile()

OpenRTM_aist.StringUtil.findFile ( dir,
filename,
filelist )

指定ファイル名を指定ディレクトリから探査する

引数
dirディレクトリパス
filenameファイル名
filelistファイル一覧

◆ flatten()

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

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

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

引数
svCSV変換対象文字列リスト
delimiter接続される文字列の間の文字 (デフォルト: ", ")
戻り値
CSV変換結果文字列

◆ for_each()

OpenRTM_aist.StringUtil.for_each ( _str,
instance )

インスタンス生成用functor

◆ getFileList()

OpenRTM_aist.StringUtil.getFileList ( dir,
ext,
filelist = None )

ファイル一覧を指定ディレクトリから探査する

引数
dirディレクトリパス
ext拡張子
filelistファイル一覧

◆ includes()

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);

◆ isAbsolutePath()

OpenRTM_aist.StringUtil.isAbsolutePath ( str)

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

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

  • 先頭文字が'/' (UNIXの場合)
  • 先頭３文字がアルファベット＋'/'＋'\' (Windowsの場合)
  • 先頭２文字が'\\' (Windowsネットワークパスの場合)
引数
str判定対象文字列
戻り値
絶対パス判定結果

◆ isEscaped()

OpenRTM_aist.StringUtil.isEscaped ( _str,
pos )

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

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

引数
_strエスケープされているかどうか判断する文字を含む文字列
posエスケープされているかどうか判断する文字の位置
戻り値
指定した文字がエスケープされていれば true, それ以外は false

◆ isURL()

OpenRTM_aist.StringUtil.isURL ( str)

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

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

引数
str判定対象文字列
戻り値
URL判定結果

◆ otos()

OpenRTM_aist.StringUtil.otos ( n)

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

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

引数
n変換対象オブジェクト
戻り値
文字列変換結果

◆ parseArgs()

OpenRTM_aist.StringUtil.parseArgs ( args)

文字列を引数として解釈する

引数
args文字列
戻り値
引数リスト

◆ replaceEnv()

OpenRTM_aist.StringUtil.replaceEnv ( _str)

文字列中の環境変数を置き換える

文字列中に${}で囲まれた文字列がある場合に、環境変数と置き換える 例：${RTM_ROOT}\bin -> C:\Program Files (x86)\OpenRTM-aist\1.1.2\

引数
_str置き換え前の文字列
戻り値
置き換え後の文字列

◆ replaceString()

OpenRTM_aist.StringUtil.replaceString ( _str,
_from,
_to )

文字列を置き換える

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

引数
str置き換え処理対象文字列
_from置換元文字
_to置換先文字
戻り値
置き換え結果文字列

◆ split()

OpenRTM_aist.StringUtil.split ( input,
delimiter )

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

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

引数
input分割対象文字列
delimiter分割文字列(デリミタ)
戻り値
文字列分割結果リスト

◆ stringTo()

OpenRTM_aist.StringUtil.stringTo ( _type,
_str )

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

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

引数
_str変換元文字列
戻り値
変換処理実行結果

◆ toArgv()

OpenRTM_aist.StringUtil.toArgv ( args)

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

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

引数
args変換対象文字列リスト
戻り値
引数変換結果文字列

◆ toBool()

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

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

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

引数
_str判断対象文字列
yestrue表現文字列
nofalse表現文字列
default_valueデフォルト値(デフォルト値:None)

◆ unescape()

OpenRTM_aist.StringUtil.unescape ( _str)

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

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

◆ unique_sv()

OpenRTM_aist.StringUtil.unique_sv ( sv)

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

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

引数
sv確認元文字列リスト
戻り値
重複削除処理結果リスト

◆ urlparam2map()

OpenRTM_aist.StringUtil.urlparam2map ( _str)

URLパラメータをmapstringに分解して返す

URLパラメータ表現 something?key0=value0&key1=value1.... のうち '?' 以降の部分を分解して、std.map<std.string, std.string> 形式 に変換する。与えられた文字列を左からサーチし、'?' より右側の部分に ついて解析を行う。'&'で分割し、左から '=' を検索し、最初の '=' の 右辺と左辺をそれぞれ、key と value として map に格納する。

引数
str分解対象文字列
戻り値
mapstring 型の key/valueデータ
構築: doxygen 1.11.0