cv::FileNode クラス

File Storage の Node クラス。 続き...

#include <opencv2/core/persistence.hpp>

Collaboration diagram for cv::FileNode:

公開型
enum	{   NONE = 0 ,   INT = 1 ,   REAL = 2 ,   FLOAT = REAL ,   STR = 3 ,   STRING = STR ,   SEQ = 4 ,   MAP = 5 ,   TYPE_MASK = 7 ,   FLOW = 8 ,   UNIFORM = 8 ,   EMPTY = 16 ,   NAMED = 32 }
	ファイルストレージノードの型 詳細...

公開メンバ関数
	FileNode ()
	コンストラクタ。
	FileNode (const FileNode &node)
	FileNode (const FileStorage *fs, size_t blockIdx, size_t ofs)
	FileNode (FileStorage::Impl *fs, size_t blockIdx, size_t ofs)
FileNodeIterator	begin () const
	最初のノード要素を指すイテレータを返す
bool	empty () const
	ノードが空であれば true を返す
FileNodeIterator	end () const
	最後のノード要素の次の要素を指すイテレータを返す
bool	isInt () const
	ノードが整数であれば true を返す
bool	isMap () const
	ノードがマッピングであれば true を返す
bool	isNamed () const
	ノードが名前を持つ場合に true を返す
bool	isNone () const
	ノードが「none」オブジェクトであれば true を返す
bool	isReal () const
	ノードが浮動小数点数であれば true を返す
bool	isSeq () const
	ノードがシーケンスであれば true を返す
bool	isString () const
	ノードがテキスト文字列であれば true を返す
std::vector< String >	keys () const
	マッピングノードのキーを返す。
Mat	mat () const
	バインディングで使用する簡易読み込みAPI。
std::string	name () const
	ノード名を返す。名前のないノードの場合は空文字列を返す。
	operator double () const
	ノードの内容を double として返す。
	operator float () const
	ノードの内容を float として返す。
	operator int64_t () const
	ノードの内容を符号付き64ビット整数として返す。ノードが浮動小数点数を格納している場合は丸められる。
	operator std::string () const
	ノードの内容をテキスト文字列として返す。
FileNode &	operator= (const FileNode &node)
FileNode	operator[] (const char *nodename) const
FileNode	operator[] (const String &nodename) const
	マッピングノードまたはシーケンスノードの要素を返す。
FileNode	operator[] (int i) const
uchar *	ptr ()
const uchar *	ptr () const
size_t	rawSize () const
	FileNode の生サイズをバイト単位で返す。
void	readRaw (const String &fmt, void *vec, size_t len) const
	指定されたフォーマットでノード要素をバッファに読み込む。
double	real () const
	バインディングで使用する簡易読み込みAPI。
void	setValue (int type, const void *value, int len=-1)
size_t	size () const
	ノードがシーケンスまたはマッピングの場合はその要素数を、そうでない場合は1を返す。
std::string	string () const
	バインディングで使用する簡易読み込みAPI。
int	type () const
	ノードの型を返す。

静的公開メンバ関数
static bool	isCollection (int flags)
static bool	isEmptyCollection (int flags)
static bool	isFlow (int flags)
static bool	isMap (int flags)
static bool	isSeq (int flags)

公開変数類
size_t	blockIdx
FileStorage::Impl *	fs
size_t	ofs

詳細説明

File Storage の Node クラス。

このノードは、読み込み用に開いたファイルストレージのすべての要素を格納するために使われる。XML/YAMLファイルを読み込むと、まず解析され、ノードの階層的なコレクションとしてメモリに格納される。各ノードは、単一の数値や文字列を格納する「リーフ」であることも、他のノードのコレクションであることもある。各要素が名前を持ち名前でアクセスされる名前付きコレクション(マッピング)と、要素が名前を持たずインデックスでアクセスされる順序付きコレクション(シーケンス)が存在しうる。ファイルノードの型は FileNode::type メソッドで判定できる。

ファイルノードは、読み込み用に開いたファイルストレージを走査する目的でのみ使われることに注意。書き込み用にファイルストレージを開いた場合、データは書き込まれた後メモリには格納されない。

例

samples/cpp/tutorial_code/core/file_input_output/file_input_output.cpp.

列挙型メンバ詳解

anonymous enum

anonymous enum

ファイルストレージノードの型

列挙値
NONE	空ノード
INT	整数
REAL	浮動小数点数
FLOAT	REAL の同義語
STR	UTF-8エンコーディングのテキスト文字列
STRING	STR の同義語
SEQ	シーケンス
MAP	マッピング
TYPE_MASK
FLOW	シーケンスまたはマッピングのコンパクト表現。YAMLライタでのみ使用される
UNIFORM	UNIFORM は FileStorage の読み込み時のみに使用され、FLOW は書き込み時のみに使用される。そのため両者は同じビットを共有する。 設定された場合、コレクションのすべての要素が同じ型（real または int）の数値であることを意味する。
EMPTY	空の構造（シーケンスまたはマッピング）
NAMED	ノードが名前を持つ（すなわちマッピングの要素である）。

構築子と解体子の詳解

FileNode() [1/4]

cv::FileNode::FileNode

(

)

Python:
	cv.FileNode(		) ->	<FileNode object>

コンストラクタ。

これらのコンストラクタは、デフォルトのファイルノードを作成したり、旧式の構造や別のファイルノードから構築したりするために使われる。

FileNode() [2/4]

cv::FileNode::FileNode	(	const FileStorage *	fs,
		size_t	blockIdx,
		size_t	ofs )

Python:
	cv.FileNode(		) ->	<FileNode object>

これは利便性のために提供されているオーバーロードされたメンバ関数である。上記の関数とは、受け取る引数のみが異なる。

引数

fs	ファイルストレージ構造体へのポインタ。
blockIdx	ファイルノードが格納されているメモリブロックのインデックス
ofs	シリアライズされたストレージの先頭からのバイト単位のオフセット

非推奨Deprecated

FileNode() [3/4]

cv::FileNode::FileNode

(

const FileNode &

node

)

Python:
	cv.FileNode(		) ->	<FileNode object>

これは利便性のために提供されているオーバーロードされたメンバ関数である。上記の関数とは、受け取る引数のみが異なる。

引数

node	作成されるファイルノードの初期化に使用するファイルノード。

FileNode() [4/4]

cv::FileNode::FileNode	(	FileStorage::Impl *	fs,
		size_t	blockIdx,
		size_t	ofs )

Python:
	cv.FileNode(		) ->	<FileNode object>

メンバ関数詳解

begin()

FileNodeIterator cv::FileNode::begin

(

)

const

最初のノード要素を指すイテレータを返す。

例

samples/cpp/tutorial_code/core/file_input_output/file_input_output.cpp.

empty()

bool cv::FileNode::empty

(

)

const

Python:
	cv.FileNode.empty(		) ->	retval

ノードが空の場合は true を返す。

例

samples/cpp/tutorial_code/core/file_input_output/file_input_output.cpp.

end()

FileNodeIterator cv::FileNode::end

(

)

const

最後のノード要素の次を指すイテレータを返す。

例

samples/cpp/tutorial_code/core/file_input_output/file_input_output.cpp.

isCollection()

static bool cv::FileNode::isCollection ( int flags )

static

isEmptyCollection()

static bool cv::FileNode::isEmptyCollection ( int flags )

static

isFlow()

static bool cv::FileNode::isFlow ( int flags )

static

isInt()

bool cv::FileNode::isInt

(

)

const

Python:
	cv.FileNode.isInt(		) ->	retval

ノードが整数の場合は true を返す。

isMap() [1/2]

bool cv::FileNode::isMap

(

)

const

Python:
	cv.FileNode.isMap(		) ->	retval

ノードがマッピングの場合は true を返す。

isMap() [2/2]

static bool cv::FileNode::isMap ( int flags )

static

Python:
	cv.FileNode.isMap(		) ->	retval

isNamed()

bool cv::FileNode::isNamed

(

)

const

Python:
	cv.FileNode.isNamed(		) ->	retval

ノードが名前を持つ場合は true を返す。

isNone()

bool cv::FileNode::isNone

(

)

const

Python:
	cv.FileNode.isNone(		) ->	retval

ノードが "none" オブジェクトの場合は true を返す。

isReal()

bool cv::FileNode::isReal

(

)

const

Python:
	cv.FileNode.isReal(		) ->	retval

ノードが浮動小数点数の場合は true を返す。

isSeq() [1/2]

bool cv::FileNode::isSeq

(

)

const

Python:
	cv.FileNode.isSeq(		) ->	retval

ノードがシーケンスの場合は true を返す。

isSeq() [2/2]

static bool cv::FileNode::isSeq ( int flags )

static

Python:
	cv.FileNode.isSeq(		) ->	retval

isString()

bool cv::FileNode::isString

(

)

const

Python:
	cv.FileNode.isString(		) ->	retval

ノードがテキスト文字列の場合は true を返す。

keys()

std::vector< String > cv::FileNode::keys

(

)

const

Python:
	cv.FileNode.keys(		) ->	retval

マッピングノードのキーを返す。

戻り値

マッピングノードのキー。

mat()

Mat cv::FileNode::mat

(

)

const

Python:
	cv.FileNode.mat(		) ->	retval

バインディングで使用するための簡略化された読み込みAPI。

name()

std::string cv::FileNode::name

(

)

const

Python:
	cv.FileNode.name(		) ->	retval

ノード名を返す。名前のないノードの場合は空文字列を返す。

operator double()

cv::FileNode::operator double

(

)

const

ノードの内容を double として返す。

operator float()

cv::FileNode::operator float

(

)

const

ノードの内容を float として返す。

operator int64_t()

cv::FileNode::operator int64_t

(

)

const

ノードの内容を符号付き64ビット整数として返す。ノードが浮動小数点数を格納している場合は丸められる。

operator std::string()

cv::FileNode::operator std::string ( ) const

inline

ノードの内容をテキスト文字列として返す。

この関数の呼び出しグラフ:

operator=()

FileNode & cv::FileNode::operator=

(

const FileNode &

node

)

operator[]() [1/3]

FileNode cv::FileNode::operator[]

(

const char *

nodename

)

const

Python:
	cv.FileNode.at(	i	) ->	retval
	cv.FileNode.getNode(	nodename	) ->	retval

これは利便性のために提供されているオーバーロードされたメンバ関数である。上記の関数とは、受け取る引数のみが異なる。

引数

nodename

マッピングノード内の要素の名前。

operator[]() [2/3]

FileNode cv::FileNode::operator[]

(

const String &

nodename

)

const

Python:
	cv.FileNode.at(	i	) ->	retval
	cv.FileNode.getNode(	nodename	) ->	retval

マッピングノードまたはシーケンスノードの要素を返す。

引数

nodename

マッピングノード内の要素の名前。

戻り値

指定された識別子を持つ要素を返す。

operator[]() [3/3]

FileNode cv::FileNode::operator[]

(

int

i

)

const

Python:
	cv.FileNode.at(	i	) ->	retval
	cv.FileNode.getNode(	nodename	) ->	retval

これは利便性のために提供されているオーバーロードされたメンバ関数である。上記の関数とは、受け取る引数のみが異なる。

引数

i	シーケンスノード内の要素のインデックス。

ptr() [1/2]

uchar * cv::FileNode::ptr

(

)

ptr() [2/2]

const uchar * cv::FileNode::ptr

(

)

const

rawSize()

size_t cv::FileNode::rawSize

(

)

const

Python:
	cv.FileNode.rawSize(		) ->	retval

FileNode の生サイズをバイト単位で返す。

readRaw()

void cv::FileNode::readRaw	(	const String &	fmt,
		void *	vec,
		size_t	len ) const

指定されたフォーマットでノード要素をバッファに読み込む。

通常、このメソッドの代わりに演算子 >> を使う方が便利である。

引数

fmt	各配列要素の指定。フォーマット指定を参照のこと。
vec	出力先配列へのポインタ。
len	読み込むバイト数（バッファサイズの上限）。残りの要素数より大きい場合は、それらすべてが読み込まれる。

real()

double cv::FileNode::real

(

)

const

Python:
	cv.FileNode.real(		) ->	retval

バインディングで使用するための簡略化された読み込みAPI。

setValue()

void cv::FileNode::setValue	(	int	type,
		const void *	value,
		int	len = -1 )

FileStorage の読み込み時に使われる内部メソッド。事前に作成されたノードの型(int、realまたはstring)と値を設定する。

size()

size_t cv::FileNode::size

(

)

const

Python:
	cv.FileNode.size(		) ->	retval

ノードがシーケンスまたはマッピングの場合はその要素数を、そうでない場合は1を返す。

string()

std::string cv::FileNode::string

(

)

const

Python:
	cv.FileNode.string(		) ->	retval

バインディングで使用するための簡略化された読み込みAPI。

type()

int cv::FileNode::type

(

)

const

Python:
	cv.FileNode.type(		) ->	retval

ノードの型を返す。

戻り値

ノードの型。FileNode::Type を参照。

例

samples/cpp/tutorial_code/core/file_input_output/file_input_output.cpp.

メンバ変数詳解

blockIdx

size_t cv::FileNode::blockIdx

fs

FileStorage::Impl* cv::FileNode::fs

ofs

size_t cv::FileNode::ofs

---

このクラス詳解は次のファイルから抽出されました:

• opencv2/core/persistence.hpp