used to iterate through sequences and mappings. More...

#include <opencv2/core/persistence.hpp>

Public Member Functions
	FileNodeIterator ()
	The constructors.

	FileNodeIterator (const FileNode &node, bool seekEnd)

	FileNodeIterator (const FileNodeIterator &it)

bool	equalTo (const FileNodeIterator &it) const

FileNode	operator* () const
	returns the currently observed element

FileNodeIterator &	operator++ ()
	moves iterator to the next node

FileNodeIterator	operator++ (int)
	moves iterator to the next node

FileNodeIterator &	operator+= (int ofs)
	moves iterator forward by the specified offset (possibly negative)

FileNodeIterator &	readRaw (const String &fmt, void *vec, size_t maxCount=(size_t) INT_MAX)
	Reads node elements to the buffer with the specified format.

size_t	remaining () const
	returns the number of remaining (not read yet) elements

Protected Attributes
size_t	blockIdx

size_t	blockSize

const FileStorage *	fs

size_t	idx

size_t	nodeNElems

size_t	ofs

Related Functions
(Note that these are not member functions.)

template<typename _Tp >
static FileNodeIterator &	operator>> (FileNodeIterator &it, _Tp &value)
	Reads data from a file storage.

template<typename _Tp >
static FileNodeIterator &	operator>> (FileNodeIterator &it, std::vector< _Tp > &vec)
	Reads data from a file storage.


bool	operator== (const FileNodeIterator &it1, const FileNodeIterator &it2)

bool	operator!= (const FileNodeIterator &it1, const FileNodeIterator &it2)

static ptrdiff_t	operator- (const FileNodeIterator &it1, const FileNodeIterator &it2)

static bool	operator< (const FileNodeIterator &it1, const FileNodeIterator &it2)

Detailed Description

used to iterate through sequences and mappings.

A standard STL notation, with node.begin(), node.end() denoting the beginning and the end of a sequence, stored in node. See the data reading sample in the beginning of the section.

Examples:: samples/cpp/filestorage.cpp.

Constructor & Destructor Documentation

cv::FileNodeIterator::FileNodeIterator ( )

The constructors.

These constructors are used to create a default iterator, set it to specific element in a file node or construct it from another iterator.

cv::FileNodeIterator::FileNodeIterator	(	const FileNode &	node,
		bool	seekEnd
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

node	File node - the collection to iterate over; it can be a scalar (equivalent to 1-element collection) or "none" (equivalent to empty collection).
seekEnd	- true if iterator needs to be set after the last element of the node; that is: node.begin() => FileNodeIterator(node, false) node.end() => FileNodeIterator(node, true)

cv::FileNodeIterator::FileNodeIterator ( const FileNodeIterator & it )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

it	Iterator to be used as initialization for the created iterator.

Member Function Documentation

bool cv::FileNodeIterator::equalTo ( const FileNodeIterator & it ) const

FileNode cv::FileNodeIterator::operator* ( ) const

returns the currently observed element

FileNodeIterator& cv::FileNodeIterator::operator++ ( )

moves iterator to the next node

FileNodeIterator cv::FileNodeIterator::operator++ ( int )

moves iterator to the next node

FileNodeIterator& cv::FileNodeIterator::operator+= ( int ofs )

moves iterator forward by the specified offset (possibly negative)

FileNodeIterator& cv::FileNodeIterator::readRaw	(	const String &	fmt,
		void *	vec,
		size_t	maxCount = `(size_t) INT_MAX`
	)

Reads node elements to the buffer with the specified format.

Usually it is more convenient to use operator >> instead of this method.

Parameters

fmt	Specification of each array element. See format specification
vec	Pointer to the destination array.
maxCount	Number of elements to read. If it is greater than number of remaining elements then all of them will be read.

size_t cv::FileNodeIterator::remaining ( ) const

returns the number of remaining (not read yet) elements

Friends And Related Function Documentation

bool operator!=	(	const FileNodeIterator &	it1,
		const FileNodeIterator &	it2
	)

static ptrdiff_t operator-	(	const FileNodeIterator &	it1,
		const FileNodeIterator &	it2
	)

static bool operator<	(	const FileNodeIterator &	it1,
		const FileNodeIterator &	it2
	)

bool operator==	(	const FileNodeIterator &	it1,
		const FileNodeIterator &	it2
	)

static FileNodeIterator & operator>>	(	FileNodeIterator &	it,
		_Tp &	value
	)

template<typename _Tp >

static FileNodeIterator & operator>>	(	FileNodeIterator &	it,
		std::vector< _Tp > &	vec
	)

Member Data Documentation

size_t cv::FileNodeIterator::blockIdx

protected

size_t cv::FileNodeIterator::blockSize

protected

const FileStorage* cv::FileNodeIterator::fs

protected

size_t cv::FileNodeIterator::idx

protected

size_t cv::FileNodeIterator::nodeNElems

protected

size_t cv::FileNodeIterator::ofs

protected

The documentation for this class was generated from the following file:

persistence.hpp

Public Member Functions

Protected Attributes

Related Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation