File Storage Node class. [詳解]

#include <persistence.hpp>

公開型
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 }
	ファイルストレージノードの種類[【詳解】（英語］

公開メンバ関数
CV_WRAP	FileNode ()
	コンストラクタには[【詳解】（英語］

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

	FileNode (const FileNode &node)

FileNode &	operator= (const FileNode &node)

FileNode	operator[] (const String &nodename) const
	戻り値：マッピングノードまたはシーケンスノードの要素[【詳解】（英語］

	CV_WRAP_AS (getNode) FileNode operator[](const char *nodename) const

	CV_WRAP_AS (at) FileNode operator[](int i) const

CV_WRAP std::vector< String >	keys () const
	マッピングノードのキーを返します。[【詳解】（英語］

CV_WRAP int	type () const
	ノードのタイプを返します。[【詳解】（英語］

CV_WRAP bool	empty () const
	ノードが空の場合はtrueを返します。

CV_WRAP bool	isNone () const
	ノードが "none "オブジェクトの場合はtrueを返します。

CV_WRAP bool	isSeq () const
	ノードがシーケンスの場合はtrueを返します。

CV_WRAP bool	isMap () const
	ノードがマッピングの場合はtrueを返します。

CV_WRAP bool	isInt () const
	ノードが整数の場合はtrueを返します。

CV_WRAP bool	isReal () const
	ノードが浮動小数点数の場合はtrueを返します。

CV_WRAP bool	isString () const
	ノードがテキスト文字列の場合はtrueを返します。

CV_WRAP bool	isNamed () const
	ノードに名前がある場合はtrueを返します。

CV_WRAP std::string	name () const
	ノードの名前を返します。ノードに名前がない場合は、空の文字列を返します。

CV_WRAP size_t	size () const
	ノードがシーケンスやマッピングの場合は要素数を，そうでない場合は1を返します。

CV_WRAP size_t	rawSize () const
	ノードの生のサイズをFileNodeの生のサイズをバイト数で返します。

	operator int () const
	は，ノードの内容を整数で返します。ノードが浮動小数点数を格納している場合は，丸められます。

	operator float () const
	ノードの内容をfloatで返します。

	operator double () const
	ノードの内容をdoubleで返します。

	operator std::string () const
	ノードの内容を文字列で返します

uchar *	ptr ()

const uchar *	ptr () const

FileNodeIterator	begin () const
	最初のノード要素を指すイテレータを返す

FileNodeIterator	end () const
	最後のノード要素の次の要素を指すイテレータを返す

void	readRaw (const String &fmt, void *vec, size_t len) const
	function1：指定されたフォーマットでノード要素をバッファに読み込みます。[【詳解】（英語］

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

CV_WRAP double	real () const
	バインディングで使用するための簡素化された読み込みAPIです。

CV_WRAP std::string	string () const
	バインディングで使用するための簡素化された読み込みAPIです。

CV_WRAP Mat	mat () const
	バインディングで使用するための簡素化された読み込みAPIです。

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

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

static bool	isSeq (int flags)

static bool	isCollection (int flags)

static bool	isEmptyCollection (int flags)

static bool	isFlow (int flags)

公開変数類
FileStorage::Impl *	fs

size_t	blockIdx

size_t	ofs

関連関数
（これらはメソッドではありません）

CV_EXPORTS void	read (const FileNode &node, int &value, int default_value)

CV_EXPORTS void	read (const FileNode &node, float &value, float default_value)

CV_EXPORTS void	read (const FileNode &node, double &value, double default_value)

CV_EXPORTS void	read (const FileNode &node, std::string &value, const std::string &default_value)

CV_EXPORTS void	read (const FileNode &node, Mat &mat, const Mat &default_mat=Mat())

CV_EXPORTS void	read (const FileNode &node, SparseMat &mat, const SparseMat &default_mat=SparseMat())

CV_EXPORTS void	read (const FileNode &node, std::vector< KeyPoint > &keypoints)

CV_EXPORTS void	read (const FileNode &node, std::vector< DMatch > &matches)

CV_EXPORTS void	read (const FileNode &node, KeyPoint &value, const KeyPoint &default_value)

CV_EXPORTS void	read (const FileNode &node, DMatch &value, const DMatch &default_value)

template<typename _Tp >
static void	read (const FileNode &node, Point_< _Tp > &value, const Point_< _Tp > &default_value)

template<typename _Tp >
static void	read (const FileNode &node, Point3_< _Tp > &value, const Point3_< _Tp > &default_value)

template<typename _Tp >
static void	read (const FileNode &node, Size_< _Tp > &value, const Size_< _Tp > &default_value)

template<typename _Tp >
static void	read (const FileNode &node, Complex< _Tp > &value, const Complex< _Tp > &default_value)

template<typename _Tp >
static void	read (const FileNode &node, Rect_< _Tp > &value, const Rect_< _Tp > &default_value)

template<typename _Tp , int cn>
static void	read (const FileNode &node, Vec< _Tp, cn > &value, const Vec< _Tp, cn > &default_value)

template<typename _Tp , int m, int n>
static void	read (const FileNode &node, Matx< _Tp, m, n > &value, const Matx< _Tp, m, n > &default_matx=Matx< _Tp, m, n >())

template<typename _Tp >
static void	read (const FileNode &node, Scalar_< _Tp > &value, const Scalar_< _Tp > &default_value)

static void	read (const FileNode &node, Range &value, const Range &default_value)


static void	read (const FileNode &node, bool &value, bool default_value)

static void	read (const FileNode &node, uchar &value, uchar default_value)

static void	read (const FileNode &node, schar &value, schar default_value)

static void	read (const FileNode &node, ushort &value, ushort default_value)

static void	read (const FileNode &node, short &value, short default_value)

template<typename _Tp >
static void	read (FileNodeIterator &it, std::vector< _Tp > &vec, size_t maxCount=(size_t) INT_MAX)

template<typename _Tp , typename std::enable_if< std::is_enum< _Tp >::value >::type * = nullptr>
static void	read (const FileNode &node, _Tp &value, const _Tp &default_value=static_cast< _Tp >(0))

template<typename _Tp >
static void	read (const FileNode &node, std::vector< _Tp > &vec, const std::vector< _Tp > &default_value=std::vector< _Tp >())

static void	read (const FileNode &node, std::vector< KeyPoint > &vec, const std::vector< KeyPoint > &default_value)

static void	read (const FileNode &node, std::vector< DMatch > &vec, const std::vector< DMatch > &default_value)


template<typename _Tp >
static void	operator>> (const FileNode &n, _Tp &value)
	ファイルストレージからデータを読み込みます。

template<typename _Tp >
static void	operator>> (const FileNode &n, std::vector< _Tp > &vec)
	ファイルストレージからデータを読み込みます。

static void	operator>> (const FileNode &n, KeyPoint &kpt)
	ファイルストレージからの読み込みKeyPointをファイルストレージから読み込みます。

static void	operator>> (const FileNode &n, std::vector< KeyPoint > &vec)

static void	operator>> (const FileNode &n, std::vector< DMatch > &vec)

static void	operator>> (const FileNode &n, DMatch &m)
	ファイルストレージからの読み込みDMatchをファイルストレージから読み込みます。

詳解

ファイルの保存Nodeクラスである。

ノードは、読み取り用に開かれたファイルストレージの各要素を格納するために使用されます。XML/YAMLファイルが読み込まれると、まずそれが解析され、ノードの階層的なコレクションとしてメモリに格納されます。各ノードは、1つの数値や文字列を含む「リーフ」であったり、他のノードのコレクションであったりします。各要素が名前を持ち、名前でアクセスされる名前付きコレクション（マッピング）と、要素が名前を持たずインデックスでアクセスされる順序付きコレクション（シーケンス）があります。ファイルノードのタイプは以下の方法で決定できます。FileNode::typeメソッドを実行します。

ファイルノードは，読み取り用にオープンされたファイルストレージをナビゲートするためにのみ使用されることに注意してください．ファイルストレージが書き込み用にオープンされている場合、書き込んだ後にデータがメモリに保存されることはありません。

列挙型メンバ詳解

◆ anonymous enum

anonymous enum

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

列挙値
NONE	空のノード
INT	整数
REAL	浮動小数点数
FLOAT	同義語またはREAL
STR	UTF-8エンコーディングの文字列
STRING	STRの同義語
SEQ	シーケンス
マップ	マッピング
フロー	シーケンスやマッピングのコンパクトな表現。YAMLライターでのみ使用
UNIFORM	UNIFORMは読み込み時にのみ使用されます。FileStorageFLOWは書き込み時にのみ使用されます。つまり，両者は同じビットを共有していますがセットされていれば，すべてのコレクション要素が同じ型の数値（realまたはint）であることを意味します。
EMPTY	空の構造体（シーケンスやマッピング）。
名前付き	ノードに名前が付いている（つまり，マッピングの要素である）ことを示します．

構築子と解体子

◆ FileNode() [1/3]

CV_WRAP cv::FileNode::FileNode ( )

コンストラクタには

これらのコンストラクタは，デフォルトのファイルノードを作成したり，廃止された構造体や別のファイルノードからノードを作成したりするために使用されます。

◆ FileNode() [2/3]

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

これはオーバーロードされたメンバ関数です。利便性のために用意されています。元の関数との違いは引き数のみです。

引数

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

非推奨:

◆ FileNode() [3/3]

cv::FileNode::FileNode ( const FileNode & node )

これはオーバーロードされたメンバ関数です。利便性のために用意されています。元の関数との違いは引き数のみです。

引数

node	作成されたファイルノードの初期化として使用されるファイルノード。

関数詳解

◆ CV_WRAP_AS() [1/2]

cv::FileNode::CV_WRAP_AS ( at ) const

これはオーバーロードされたメンバ関数です。利便性のために用意されています。元の関数との違いは引き数のみです。

引数

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

◆ CV_WRAP_AS() [2/2]

cv::FileNode::CV_WRAP_AS ( getNode ) const

これはオーバーロードされたメンバ関数です。利便性のために用意されています。元の関数との違いは引き数のみです。

引数

nodename マッピングノードの要素の名前です。

◆ keys()

CV_WRAP std::vector< String > cv::FileNode::keys ( ) const

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

戻り値: マッピングノードのキーを返します。

◆ operator[]()

FileNode cv::FileNode::operator[] ( const String & nodename ) const

戻り値：マッピングノードまたはシーケンスノードの要素

引数

nodename マッピングノードの要素の名前です。

戻り値: 指定された識別子の要素を返します。

◆ readRaw()

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

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

通常は、このメソッドの代わりに、演算子>>を使った方が便利です。

引数

fmt	配列の各要素を指定します。参照format specification
vec	読み込み先の配列へのポインタ。
len	読み込むバイト数（バッファサイズの制限）。これが残りの要素数より大きい場合は、すべての要素が読み込まれます。

◆ setValue()

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

読み込み時に使用される内部メソッドFileStorage. 先に作成されたノードの型（int、real、string）と値を設定します。

◆ type()

CV_WRAP int cv::FileNode::type ( ) const

ノードのタイプを返します。

戻り値: ノードのタイプです。関連項目： FileNode::Type

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

persistence.hpp

公開型

公開メンバ関数

静的公開メンバ関数

公開変数類

関連関数

詳解

列挙型メンバ詳解

◆ anonymous enum

構築子と解体子

◆ FileNode() [1/3]

◆ FileNode() [2/3]

◆ FileNode() [3/3]

関数詳解

◆ CV_WRAP_AS() [1/2]

◆ CV_WRAP_AS() [2/2]

◆ keys()

◆ operator[]()

◆ readRaw()

◆ setValue()

◆ type()